'2.0', 'service' => '

The Identity Store service used by AWS IAM Identity Center (successor to AWS Single Sign-On) provides a single place to retrieve all of your identities (users and groups). For more information, see the IAM Identity Center User Guide.

 <note> <p>Although AWS Single Sign-On was renamed, the <code>sso</code> and <code>identitystore</code> API namespaces will continue to retain their original name for backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">IAM Identity Center rename</a>.</p> </note> <p>This reference guide describes the identity store operations that you can call programatically and includes detailed information about data types and errors.</p>
', 'operations' => [ 'CreateGroup' => '

Creates a group within the specified identity store.

', 'CreateGroupMembership' => '

Creates a relationship between a member and a group. The following identifiers must be specified: GroupId, IdentityStoreId, and MemberId.

', 'CreateUser' => '

Creates a user within the specified identity store.

', 'DeleteGroup' => '

Delete a group within an identity store given GroupId.

', 'DeleteGroupMembership' => '

Delete a membership within a group given MembershipId.

', 'DeleteUser' => '

Deletes a user within an identity store given UserId.

', 'DescribeGroup' => '

Retrieves the group metadata and attributes from GroupId in an identity store.

', 'DescribeGroupMembership' => '

Retrieves membership metadata and attributes from MembershipId in an identity store.

', 'DescribeUser' => '

Retrieves the user metadata and attributes from the UserId in an identity store.

', 'GetGroupId' => '

Retrieves GroupId in an identity store.

', 'GetGroupMembershipId' => '

Retrieves the MembershipId in an identity store.

', 'GetUserId' => '

Retrieves the UserId in an identity store.

', 'IsMemberInGroups' => '

Checks the user\'s membership in all requested groups and returns if the member exists in all queried groups.

', 'ListGroupMemberships' => '

For the specified group in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.

', 'ListGroupMembershipsForMember' => '

For the specified member in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.

', 'ListGroups' => '

Lists all groups in the identity store. Returns a paginated list of complete Group objects. Filtering for a Group by the DisplayName attribute is deprecated. Instead, use the GetGroupId API action.

', 'ListUsers' => '

Lists all users in the identity store. Returns a paginated list of complete User objects. Filtering for a User by the UserName attribute is deprecated. Instead, use the GetUserId API action.

', 'UpdateGroup' => '

For the specified group in the specified identity store, updates the group metadata and attributes.

', 'UpdateUser' => '

For the specified user in the specified identity store, updates the user metadata and attributes.

', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => '

You do not have sufficient access to perform this action.

', 'refs' => [], ], 'Address' => [ 'base' => '

The address associated with the specified user.

', 'refs' => [ 'Addresses$member' => NULL, ], ], 'Addresses' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$Addresses' => '

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

', 'DescribeUserResponse$Addresses' => '

The physical address of the user.

', 'User$Addresses' => '

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

', ], ], 'AlternateIdentifier' => [ 'base' => '

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.

', 'refs' => [ 'GetGroupIdRequest$AlternateIdentifier' => '

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 the unique attribute, the only valid path is displayName.

', 'GetUserIdRequest$AlternateIdentifier' => '

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 the unique attribute, the only valid paths are userName and emails.value.

', ], ], 'AttributeOperation' => [ 'base' => '

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

', 'refs' => [ 'AttributeOperations$member' => NULL, ], ], 'AttributeOperations' => [ 'base' => NULL, 'refs' => [ 'UpdateGroupRequest$Operations' => '

A list of AttributeOperation objects to apply to the requested group. These operations might add, replace, or remove an attribute.

', 'UpdateUserRequest$Operations' => '

A list of AttributeOperation objects to apply to the requested user. These operations might add, replace, or remove an attribute.

', ], ], 'AttributePath' => [ 'base' => NULL, 'refs' => [ 'AttributeOperation$AttributePath' => '

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

', '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.

', 'UniqueAttribute$AttributePath' => '

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

', ], ], 'AttributeValue' => [ 'base' => '

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.

', 'refs' => [ '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.

', '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.

', ], ], 'ConflictException' => [ 'base' => '

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

', 'refs' => [], ], 'ConflictExceptionReason' => [ 'base' => NULL, 'refs' => [ 'ConflictException$Reason' => '

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

', ], ], 'CreateGroupMembershipRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateGroupMembershipResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGroupMembershipRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGroupMembershipResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeGroupMembershipRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeGroupMembershipResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'Email' => [ 'base' => '

The email address associated with the user.

', 'refs' => [ 'Emails$member' => NULL, ], ], 'Emails' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$Emails' => '

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

', 'DescribeUserResponse$Emails' => '

The email address of the user.

', 'User$Emails' => '

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

', ], ], 'ExceptionMessage' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$Message' => NULL, 'ConflictException$Message' => NULL, 'InternalServerException$Message' => NULL, 'ResourceNotFoundException$Message' => NULL, 'ServiceQuotaExceededException$Message' => NULL, 'ThrottlingException$Message' => NULL, 'ValidationException$Message' => NULL, ], ], 'ExternalId' => [ 'base' => '

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

', 'refs' => [ 'AlternateIdentifier$ExternalId' => '

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

', 'ExternalIds$member' => NULL, ], ], 'ExternalIdIdentifier' => [ 'base' => NULL, 'refs' => [ 'ExternalId$Id' => '

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

', ], ], 'ExternalIdIssuer' => [ 'base' => NULL, 'refs' => [ 'ExternalId$Issuer' => '

The issuer for an external identifier.

', ], ], 'ExternalIds' => [ 'base' => NULL, 'refs' => [ 'DescribeGroupResponse$ExternalIds' => '

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

', 'DescribeUserResponse$ExternalIds' => '

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

', 'Group$ExternalIds' => '

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

', 'User$ExternalIds' => '

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

', ], ], 'Filter' => [ 'base' => '

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

', 'refs' => [ 'Filters$member' => NULL, ], ], 'Filters' => [ 'base' => NULL, 'refs' => [ 'ListGroupsRequest$Filters' => '

A list of Filter objects, which is used in the ListUsers and ListGroups requests.

', 'ListUsersRequest$Filters' => '

A list of Filter objects, which is used in the ListUsers and ListGroups requests.

', ], ], 'GetGroupIdRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetGroupIdResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetGroupMembershipIdRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetGroupMembershipIdResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetUserIdRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUserIdResponse' => [ 'base' => NULL, 'refs' => [], ], 'Group' => [ 'base' => '

A group object that contains the metadata and attributes for a specified group.

', 'refs' => [ 'Groups$member' => NULL, ], ], 'GroupDisplayName' => [ 'base' => NULL, 'refs' => [ 'CreateGroupRequest$DisplayName' => '

A string containing the name of the group. This value is commonly displayed when the group is referenced. "Administrator" and "AWSAdministrators" are reserved names and can\'t be used for users or groups.

', 'DescribeGroupResponse$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 that the group is created and stored as an attribute of the group object in the identity store.

', 'Group$DisplayName' => '

The display name value for the group. 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.

', ], ], 'GroupIds' => [ 'base' => NULL, 'refs' => [ 'IsMemberInGroupsRequest$GroupIds' => '

A list of identifiers for groups in the identity store.

', ], ], 'GroupMembership' => [ 'base' => '

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

', 'refs' => [ 'GroupMemberships$member' => NULL, ], ], 'GroupMembershipExistenceResult' => [ 'base' => '

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

', 'refs' => [ 'GroupMembershipExistenceResults$member' => NULL, ], ], 'GroupMembershipExistenceResults' => [ 'base' => NULL, 'refs' => [ 'IsMemberInGroupsResponse$Results' => '

A list containing the results of membership existence checks.

', ], ], 'GroupMemberships' => [ 'base' => NULL, 'refs' => [ 'ListGroupMembershipsForMemberResponse$GroupMemberships' => '

A list of GroupMembership objects in the group for a specified member.

', 'ListGroupMembershipsResponse$GroupMemberships' => '

A list of GroupMembership objects in the group.

', ], ], 'Groups' => [ 'base' => NULL, 'refs' => [ 'ListGroupsResponse$Groups' => '

A list of Group objects in the identity store.

', ], ], 'IdentityStoreId' => [ 'base' => NULL, 'refs' => [ 'CreateGroupMembershipRequest$IdentityStoreId' => '

The globally unique identifier for the identity store.

', 'CreateGroupMembershipResponse$IdentityStoreId' => '

The globally unique identifier for the identity store.

', 'CreateGroupRequest$IdentityStoreId' => '

The globally unique identifier for the identity store.

', 'CreateGroupResponse$IdentityStoreId' => '

The globally unique identifier for the identity store.

', 'CreateUserRequest$IdentityStoreId' => '

The globally unique identifier for the identity store.

', 'CreateUserResponse$IdentityStoreId' => '

The globally unique identifier for the identity store.

', 'DeleteGroupMembershipRequest$IdentityStoreId' => '

The globally unique identifier for the identity store.

', 'DeleteGroupRequest$IdentityStoreId' => '

The globally unique identifier for the identity store.

', 'DeleteUserRequest$IdentityStoreId' => '

The globally unique identifier for the identity store.

', 'DescribeGroupMembershipRequest$IdentityStoreId' => '

The globally unique identifier for the identity store.

', 'DescribeGroupMembershipResponse$IdentityStoreId' => '

The globally unique identifier for the identity store.

', 'DescribeGroupRequest$IdentityStoreId' => '

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

', 'DescribeGroupResponse$IdentityStoreId' => '

The globally unique identifier for the identity store.

', 'DescribeUserRequest$IdentityStoreId' => '

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

', 'DescribeUserResponse$IdentityStoreId' => '

The globally unique identifier for the identity store.

', 'GetGroupIdRequest$IdentityStoreId' => '

The globally unique identifier for the identity store.

', 'GetGroupIdResponse$IdentityStoreId' => '

The globally unique identifier for the identity store.

', 'GetGroupMembershipIdRequest$IdentityStoreId' => '

The globally unique identifier for the identity store.

', 'GetGroupMembershipIdResponse$IdentityStoreId' => '

The globally unique identifier for the identity store.

', 'GetUserIdRequest$IdentityStoreId' => '

The globally unique identifier for the identity store.

', 'GetUserIdResponse$IdentityStoreId' => '

The globally unique identifier for the identity store.

', 'Group$IdentityStoreId' => '

The globally unique identifier for the identity store.

', 'GroupMembership$IdentityStoreId' => '

The globally unique identifier for the identity store.

', 'IsMemberInGroupsRequest$IdentityStoreId' => '

The globally unique identifier for the identity store.

', 'ListGroupMembershipsForMemberRequest$IdentityStoreId' => '

The globally unique identifier for the identity store.

', 'ListGroupMembershipsRequest$IdentityStoreId' => '

The globally unique identifier for the identity store.

', 'ListGroupsRequest$IdentityStoreId' => '

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

', 'ListUsersRequest$IdentityStoreId' => '

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

', 'UpdateGroupRequest$IdentityStoreId' => '

The globally unique identifier for the identity store.

', 'UpdateUserRequest$IdentityStoreId' => '

The globally unique identifier for the identity store.

', 'User$IdentityStoreId' => '

The globally unique identifier for the identity store.

', ], ], 'InternalServerException' => [ 'base' => '

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

', 'refs' => [], ], 'IsMemberInGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'IsMemberInGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupMembershipsForMemberRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupMembershipsForMemberResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupMembershipsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupMembershipsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUsersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUsersResponse' => [ 'base' => NULL, 'refs' => [], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListGroupMembershipsForMemberRequest$MaxResults' => '

The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

', 'ListGroupMembershipsRequest$MaxResults' => '

The maximum number of results to be returned per request. This parameter is used in all List requests to specify how many results to return in one page.

', 'ListGroupsRequest$MaxResults' => '

The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

', 'ListUsersRequest$MaxResults' => '

The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

', ], ], 'MemberId' => [ 'base' => '

An object containing the identifier of a group member.

', 'refs' => [ 'CreateGroupMembershipRequest$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.

', 'DescribeGroupMembershipResponse$MemberId' => NULL, 'GetGroupMembershipIdRequest$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.

', '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.

', '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.

', 'IsMemberInGroupsRequest$MemberId' => '

An object containing the identifier of a group member.

', 'ListGroupMembershipsForMemberRequest$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.

', ], ], 'Name' => [ 'base' => '

The full name of the user.

', 'refs' => [ 'CreateUserRequest$Name' => '

An object containing the name of the user.

', 'DescribeUserResponse$Name' => '

The name of the user.

', 'User$Name' => '

An object containing the name of the user.

', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'ListGroupMembershipsForMemberRequest$NextToken' => '

The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

', 'ListGroupMembershipsForMemberResponse$NextToken' => '

The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

', 'ListGroupMembershipsRequest$NextToken' => '

The pagination token used for the ListUsers, ListGroups and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

', 'ListGroupMembershipsResponse$NextToken' => '

The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

', 'ListGroupsRequest$NextToken' => '

The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

', 'ListGroupsResponse$NextToken' => '

The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it1 is used in the API request to search for the next page.

', 'ListUsersRequest$NextToken' => '

The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

', 'ListUsersResponse$NextToken' => '

The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

', ], ], 'PhoneNumber' => [ 'base' => '

The phone number associated with the user.

', 'refs' => [ 'PhoneNumbers$member' => NULL, ], ], 'PhoneNumbers' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$PhoneNumbers' => '

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

', 'DescribeUserResponse$PhoneNumbers' => '

A list of PhoneNumber objects associated with a user.

', 'User$PhoneNumbers' => '

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

', ], ], 'RequestId' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$RequestId' => '

The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.

', 'ConflictException$RequestId' => '

The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.

', 'InternalServerException$RequestId' => '

The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.

', 'ResourceNotFoundException$RequestId' => '

The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.

', 'ServiceQuotaExceededException$RequestId' => '

The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.

', 'ThrottlingException$RequestId' => '

The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.

', 'ValidationException$RequestId' => '

The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.

', ], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'CreateGroupMembershipRequest$GroupId' => '

The identifier for a group in the identity store.

', 'CreateGroupMembershipResponse$MembershipId' => '

The identifier for a newly created GroupMembership in an identity store.

', 'CreateGroupResponse$GroupId' => '

The identifier of the newly created group in the identity store.

', 'CreateUserResponse$UserId' => '

The identifier of the newly created user in the identity store.

', 'DeleteGroupMembershipRequest$MembershipId' => '

The identifier for a GroupMembership in an identity store.

', 'DeleteGroupRequest$GroupId' => '

The identifier for a group in the identity store.

', 'DeleteUserRequest$UserId' => '

The identifier for a user in the identity store.

', 'DescribeGroupMembershipRequest$MembershipId' => '

The identifier for a GroupMembership in an identity store.

', 'DescribeGroupMembershipResponse$MembershipId' => '

The identifier for a GroupMembership in an identity store.

', 'DescribeGroupMembershipResponse$GroupId' => '

The identifier for a group in the identity store.

', 'DescribeGroupRequest$GroupId' => '

The identifier for a group in the identity store.

', 'DescribeGroupResponse$GroupId' => '

The identifier for a group in the identity store.

', 'DescribeUserRequest$UserId' => '

The identifier for a user in the identity store.

', 'DescribeUserResponse$UserId' => '

The identifier for a user in the identity store.

', 'GetGroupIdResponse$GroupId' => '

The identifier for a group in the identity store.

', 'GetGroupMembershipIdRequest$GroupId' => '

The identifier for a group in the identity store.

', 'GetGroupMembershipIdResponse$MembershipId' => '

The identifier for a GroupMembership in an identity store.

', 'GetUserIdResponse$UserId' => '

The identifier for a user in the identity store.

', 'Group$GroupId' => '

The identifier for a group in the identity store.

', 'GroupIds$member' => NULL, 'GroupMembership$MembershipId' => '

The identifier for a GroupMembership object in an identity store.

', 'GroupMembership$GroupId' => '

The identifier for a group in the identity store.

', 'GroupMembershipExistenceResult$GroupId' => '

The identifier for a group in the identity store.

', 'ListGroupMembershipsRequest$GroupId' => '

The identifier for a group in the identity store.

', 'MemberId$UserId' => '

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

', 'ResourceNotFoundException$ResourceId' => '

The identifier for a resource in the identity store that can be used as UserId or GroupId. The format for ResourceId is either UUID or 1234567890-UUID, where UUID is a randomly generated value for each resource when it is created and 1234567890 represents the IdentityStoreId string value. In the case that the identity store is migrated from a legacy SSO identity store, the ResourceId for that identity store will be in the format of UUID. Otherwise, it will be in the 1234567890-UUID format.

', 'UpdateGroupRequest$GroupId' => '

The identifier for a group in the identity store.

', 'UpdateUserRequest$UserId' => '

The identifier for a user in the identity store.

', 'User$UserId' => '

The identifier for a user in the identity store.

', ], ], 'ResourceNotFoundException' => [ 'base' => '

Indicates that a requested resource is not found.

', 'refs' => [], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ResourceNotFoundException$ResourceType' => '

An enum object indicating the type of resource in the identity store service. Valid values include USER, GROUP, and IDENTITY_STORE.

', ], ], 'RetryAfterSeconds' => [ 'base' => NULL, 'refs' => [ 'InternalServerException$RetryAfterSeconds' => '

The number of seconds to wait before retrying the next request.

', 'ThrottlingException$RetryAfterSeconds' => '

The number of seconds to wait before retrying the next request.

', ], ], 'SensitiveBooleanType' => [ 'base' => NULL, 'refs' => [ 'Address$Primary' => '

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

', 'Email$Primary' => '

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

', 'GroupMembershipExistenceResult$MembershipExists' => '

Indicates whether a membership relation exists or not.

', 'PhoneNumber$Primary' => '

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

', ], ], 'SensitiveStringType' => [ 'base' => NULL, 'refs' => [ 'Address$StreetAddress' => '

The street of the address.

', 'Address$Locality' => '

A string of the address locality.

', 'Address$Region' => '

The region of the address.

', 'Address$PostalCode' => '

The postal code of the address.

', 'Address$Country' => '

The country of the address.

', 'Address$Formatted' => '

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

', 'Address$Type' => '

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

', 'CreateGroupRequest$Description' => '

A string containing the description of the group.

', 'CreateUserRequest$DisplayName' => '

A string containing the name of the user. This value is typically formatted for display when the user is referenced. For example, "John Doe."

', 'CreateUserRequest$NickName' => '

A string containing an alternate name for the user.

', 'CreateUserRequest$ProfileUrl' => '

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

', 'CreateUserRequest$UserType' => '

A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.

', 'CreateUserRequest$Title' => '

A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.

', 'CreateUserRequest$PreferredLanguage' => '

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

', 'CreateUserRequest$Locale' => '

A string containing the geographical region or location of the user.

', 'CreateUserRequest$Timezone' => '

A string containing the time zone of the user.

', 'DescribeGroupResponse$Description' => '

A string containing a description of the group.

', 'DescribeUserResponse$DisplayName' => '

The display name of the user.

', 'DescribeUserResponse$NickName' => '

An alternative descriptive name for the user.

', 'DescribeUserResponse$ProfileUrl' => '

A URL link for the user\'s profile.

', 'DescribeUserResponse$UserType' => '

A string indicating the type of user.

', 'DescribeUserResponse$Title' => '

A string containing the title of the user.

', 'DescribeUserResponse$PreferredLanguage' => '

The preferred language of the user.

', 'DescribeUserResponse$Locale' => '

A string containing the geographical region or location of the user.

', 'DescribeUserResponse$Timezone' => '

The time zone for a user.

', 'Email$Value' => '

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

', 'Email$Type' => '

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

', 'Filter$AttributeValue' => '

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

', 'Group$Description' => '

A string containing a description of the specified group.

', 'Name$Formatted' => '

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

', 'Name$FamilyName' => '

The family name of the user.

', 'Name$GivenName' => '

The given name of the user.

', 'Name$MiddleName' => '

The middle name of the user.

', 'Name$HonorificPrefix' => '

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

', 'Name$HonorificSuffix' => '

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

', 'PhoneNumber$Value' => '

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

', 'PhoneNumber$Type' => '

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

', 'User$DisplayName' => '

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

', 'User$NickName' => '

A string containing an alternate name for the user.

', 'User$ProfileUrl' => '

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

', 'User$UserType' => '

A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.

', 'User$Title' => '

A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.

', 'User$PreferredLanguage' => '

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

', 'User$Locale' => '

A string containing the geographical region or location of the user.

', 'User$Timezone' => '

A string containing the time zone of the user.

', ], ], 'ServiceQuotaExceededException' => [ 'base' => '

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

', 'refs' => [], ], 'ThrottlingException' => [ 'base' => '

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

', 'refs' => [], ], 'UniqueAttribute' => [ 'base' => '

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

', 'refs' => [ 'AlternateIdentifier$UniqueAttribute' => '

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

', ], ], 'UpdateGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'User' => [ 'base' => '

A user object that contains the metadata and attributes for a specified user.

', 'refs' => [ 'Users$member' => NULL, ], ], 'UserName' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$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. "Administrator" and "AWSAdministrators" are reserved names and can\'t be used for users or groups.

', 'DescribeUserResponse$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.

', '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.

', ], ], 'Users' => [ 'base' => NULL, 'refs' => [ 'ListUsersResponse$Users' => '

A list of User objects in the identity store.

', ], ], 'ValidationException' => [ 'base' => '

The request failed because it contains a syntax error.

', 'refs' => [], ], ],];