Skip to main content

IIdentityStoreAddress

Interface in AWS.IdentityStore

Interface for IdentityStore Address.

Properties​

Country​

property Country: string

The country or region portion of the address, such as USA or Germany.

This value represents the nation or territory associated with the address. AWS Identity Store expects ISO 3166 country names or commonly accepted variants.

Formatted​

property Formatted: string

A full mailing address formatted for display or printing.

This value provides a complete human-readable version of the address. It typically includes the street address, city, region, postal code, and country as a single formatted string. This property is useful for user interfaces, printed labels, or audit logs. It should match the structured address fields but is not validated against them by the Identity Store API.

Locality​

property Locality: string

The city or locality component of the address, such as Los Angeles or New York.

This value represents the municipality, town, or city portion of the user's physical address.

PostalCode​

property PostalCode: string

The postal or ZIP code portion of the address, such as 90038 or SW1A 1AA.

This value represents the regional postal code used for mail routing within the locality or country. Format varies by country and is not validated by AWS Identity Store.

Primary​

property Primary: TOptional<Boolean>

Indicates whether this address is the primary address for the user.

Set this property to true to designate the address as the user's primary address. Only one address in the list may be marked as primary.

Region​

property Region: string

The state, province, or region component of the address, such as CA or Queensland.

This value identifies the administrative region within the specified country or locality.

StreetAddress​

property StreetAddress: string

The street portion of the address, including building number and unit information.

This value typically includes the full street name, number, suite, or apartment designation, such as 7000 Romaine Street or 1600 Amphitheatre Pkwy Apt 5B.

Type​

property Type: string

The classification or usage context of the address, such as work or home.

This property describes the intended use of the address, but the value is not restricted by the API. Common conventions include:

  • work – Business or organizational address.
  • home – Residential or personal address.
  • other – Any address not fitting standard categories. Custom string values are also permitted.