Address - Identity Store
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

Address

The address associated with the specified user.

Contents

Country

The country of the address.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r   ]+

Required: No

Formatted

A string containing a formatted version of the address for display.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r   ]+

Required: No

Locality

A string of the address locality.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r   ]+

Required: No

PostalCode

The postal code of the address.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r   ]+

Required: No

Primary

A Boolean value representing whether this is the primary address for the associated resource.

Type: Boolean

Required: No

Region

The region of the address.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r   ]+

Required: No

StreetAddress

The street of the address.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r   ]+

Required: No

Type

A string representing the type of address. For example, "Home."

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r   ]+

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: