API version 2020-06-15 of the Amazon SSO Identity Store SDK configuration.

You do not have sufficient access to perform this action.

This request cannot be completed for one of the following reasons:

• Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
• The requested resource was being concurrently modified by another request.

The request processing has failed because of an unknown error, exception or failure with an internal server.

Indicates that a requested resource is not found.

The request would cause the number of users or groups in the identity store to exceed the maximum allowed.

Indicates that the principal has crossed the throttling limits of the API operations.

The request failed because it contains a syntax error.

The address associated with the specified user.

See: newAddress smart constructor.

Create a value of Address with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:country:Address', address_country - The country of the address.

$sel:formatted:Address', address_formatted - A string containing a formatted version of the address for display.

$sel:locality:Address', address_locality - A string of the address locality.

$sel:postalCode:Address', address_postalCode - The postal code of the address.

$sel:primary:Address', address_primary - A Boolean value representing whether this is the primary address for the associated resource.

$sel:region:Address', address_region - The region of the address.

$sel:streetAddress:Address', address_streetAddress - The street of the address.

$sel:type':Address', address_type - A string representing the type of address. For example, "Home."

The country of the address.

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

A string of the address locality.

The postal code of the address.

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

The region of the address.

The street of the address.

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

A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For example, a unique GroupDisplayName.

See: newAlternateIdentifier smart constructor.

Create a value of AlternateIdentifier with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:externalId:AlternateIdentifier', alternateIdentifier_externalId - The identifier issued to this resource by an external identity provider.

$sel:uniqueAttribute:AlternateIdentifier', alternateIdentifier_uniqueAttribute - An entity attribute that's unique to a specific entity.

The identifier issued to this resource by an external identity provider.

An entity attribute that's unique to a specific entity.

An operation that applies to the requested group. This operation might add, replace, or remove an attribute.

See: newAttributeOperation smart constructor.

Create a value of AttributeOperation with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attributeValue:AttributeOperation', attributeOperation_attributeValue - The value of the attribute. This is a Document type. This type is not supported by Java V1, Go V1, and older versions of the AWS CLI.

$sel:attributePath:AttributeOperation', attributeOperation_attributePath - A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.

The value of the attribute. This is a Document type. This type is not supported by Java V1, Go V1, and older versions of the AWS CLI.

A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.

The value of the attribute. This is a Document type. This type is not supported by Java V1, Go V1, and older versions of the AWS CLI.

See: newAttributeValue smart constructor.

Create a value of AttributeValue with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The email address associated with the user.

See: newEmail smart constructor.

Create a value of Email with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:primary:Email', email_primary - A Boolean value representing whether this is the primary email address for the associated resource.

$sel:type':Email', email_type - A string representing the type of address. For example, "Work."

$sel:value:Email', email_value - A string containing an email address. For example, "johndoe@amazon.com."

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

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

A string containing an email address. For example, "johndoe@amazon.com."

The identifier issued to this resource by an external identity provider.

See: newExternalId smart constructor.

Create a value of ExternalId with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:issuer:ExternalId', externalId_issuer - The issuer for an external identifier.

$sel:id:ExternalId', externalId_id - The identifier issued to this resource by an external identity provider.

The issuer for an external identifier.

The identifier issued to this resource by an external identity provider.

A query filter used by ListUsers and ListGroups. This filter object provides the attribute name and attribute value to search users or groups.

See: newFilter smart constructor.

Create a value of Filter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attributePath:Filter', filter_attributePath - The attribute path that is used to specify which attribute name to search. Length limit is 255 characters. For example, UserName is a valid attribute path for the ListUsers API, and DisplayName is a valid attribute path for the ListGroups API.

$sel:attributeValue:Filter', filter_attributeValue - Represents the data for an attribute. Each attribute value is described as a name-value pair.

The attribute path that is used to specify which attribute name to search. Length limit is 255 characters. For example, UserName is a valid attribute path for the ListUsers API, and DisplayName is a valid attribute path for the ListGroups API.

Represents the data for an attribute. Each attribute value is described as a name-value pair.

A group object that contains a specified group’s metadata and attributes.

See: newGroup smart constructor.

Create a value of Group with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:description:Group', group_description - A string containing a description of the specified group.

$sel:displayName:Group', group_displayName - The group’s display name value. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.

$sel:externalIds:Group', group_externalIds - A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

$sel:groupId:Group', group_groupId - The identifier for a group in the identity store.

$sel:identityStoreId:Group', group_identityStoreId - The globally unique identifier for the identity store.

A string containing a description of the specified group.

The group’s display name value. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.

A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

The identifier for a group in the identity store.

The globally unique identifier for the identity store.

Contains the identifiers for a group, a group member, and a GroupMembership object in the identity store.

See: newGroupMembership smart constructor.

Create a value of GroupMembership with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:groupId:GroupMembership', groupMembership_groupId - The identifier for a group in the identity store.

$sel:memberId:GroupMembership', groupMembership_memberId - An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

$sel:membershipId:GroupMembership', groupMembership_membershipId - The identifier for a GroupMembership object in an identity store.

$sel:identityStoreId:GroupMembership', groupMembership_identityStoreId - The globally unique identifier for the identity store.

The identifier for a group in the identity store.

An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

The identifier for a GroupMembership object in an identity store.

The globally unique identifier for the identity store.

Indicates whether a resource is a member of a group in the identity store.

See: newGroupMembershipExistenceResult smart constructor.

Create a value of GroupMembershipExistenceResult with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:groupId:GroupMembershipExistenceResult', groupMembershipExistenceResult_groupId - The identifier for a group in the identity store.

$sel:memberId:GroupMembershipExistenceResult', groupMembershipExistenceResult_memberId - An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

$sel:membershipExists:GroupMembershipExistenceResult', groupMembershipExistenceResult_membershipExists - Indicates whether a membership relation exists or not.

The identifier for a group in the identity store.

An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

Indicates whether a membership relation exists or not.

An object containing the identifier of a group member.

See: newMemberId smart constructor.

Create a value of MemberId with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:userId:MemberId', memberId_userId - An object containing the identifiers of resources that can be members.

An object containing the identifiers of resources that can be members.

The full name of the user.

See: newName smart constructor.

Create a value of Name with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:familyName:Name', name_familyName - The family name of the user.

$sel:formatted:Name', name_formatted - A string containing a formatted version of the name for display.

$sel:givenName:Name', name_givenName - The given name of the user.

$sel:honorificPrefix:Name', name_honorificPrefix - The honorific prefix of the user. For example, "Dr."

$sel:honorificSuffix:Name', name_honorificSuffix - The honorific suffix of the user. For example, "M.D."

$sel:middleName:Name', name_middleName - The middle name of the user.

The family name of the user.

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

The given name of the user.

The honorific prefix of the user. For example, "Dr."

The honorific suffix of the user. For example, "M.D."

The middle name of the user.

The phone number associated with the user.

See: newPhoneNumber smart constructor.

Create a value of PhoneNumber with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:primary:PhoneNumber', phoneNumber_primary - A Boolean value representing whether this is the primary phone number for the associated resource.

$sel:type':PhoneNumber', phoneNumber_type - A string representing the type of a phone number. For example, "Mobile."

$sel:value:PhoneNumber', phoneNumber_value - A string containing a phone number. For example, "8675309" or "+1 (800) 123-4567".

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

A string representing the type of a phone number. For example, "Mobile."

A string containing a phone number. For example, "8675309" or "+1 (800) 123-4567".

An entity attribute that's unique to a specific entity.

See: newUniqueAttribute smart constructor.

Create a value of UniqueAttribute with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attributePath:UniqueAttribute', uniqueAttribute_attributePath - A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.

$sel:attributeValue:UniqueAttribute', uniqueAttribute_attributeValue - The value of the attribute. This is a Document type. This type is not supported by Java V1, Go V1, and older versions of the AWS CLI.

A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.

The value of the attribute. This is a Document type. This type is not supported by Java V1, Go V1, and older versions of the AWS CLI.

A user object that contains a specified user’s metadata and attributes.

See: newUser smart constructor.

Create a value of User with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:addresses:User', user_addresses - A list of Address objects containing addresses associated with the user.

$sel:displayName:User', user_displayName - A string containing the user's name that's formatted for display when the user is referenced. For example, "John Doe."

$sel:emails:User', user_emails - A list of Email objects containing email addresses associated with the user.

$sel:externalIds:User', user_externalIds - A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

$sel:locale:User', user_locale - A string containing the user's geographical region or location.

$sel:name:User', user_name - An object containing the user's name.

$sel:nickName:User', user_nickName - A string containing an alternate name for the user.

$sel:phoneNumbers:User', user_phoneNumbers - A list of PhoneNumber objects containing phone numbers associated with the user.

$sel:preferredLanguage:User', user_preferredLanguage - A string containing the preferred language of the user. For example, "American English" or "en-us."

$sel:profileUrl:User', user_profileUrl - A string containing a URL that may be associated with the user.

$sel:timezone:User', user_timezone - A string containing the user's time zone.

$sel:title:User', user_title - A string containing the user's title. Possible values depend on each customer's specific needs, so they are left unspecified.

$sel:userName:User', user_userName - A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

$sel:userType:User', user_userType - A string indicating the user's type. Possible values depend on each customer's specific needs, so they are left unspecified.

$sel:userId:User', user_userId - The identifier for a user in the identity store.

$sel:identityStoreId:User', user_identityStoreId - The globally unique identifier for the identity store.

A list of Address objects containing addresses associated with the user.

A string containing the user's name that's formatted for display when the user is referenced. For example, "John Doe."

A list of Email objects containing email addresses associated with the user.

A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

A string containing the user's geographical region or location.

An object containing the user's name.

A string containing an alternate name for the user.

A list of PhoneNumber objects containing phone numbers associated with the user.

A string containing the preferred language of the user. For example, "American English" or "en-us."

A string containing a URL that may be associated with the user.

A string containing the user's time zone.

A string containing the user's title. Possible values depend on each customer's specific needs, so they are left unspecified.

A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

A string indicating the user's type. Possible values depend on each customer's specific needs, so they are left unspecified.

The identifier for a user in the identity store.

The globally unique identifier for the identity store.