CreateGroup

$result = $client->createGroup([/* ... */]);
$promise = $client->createGroupAsync([/* ... */]);

Creates a group within the specified identity store.

Parameter Syntax

$result = $client->createGroup([
    'Description' => '<string>',
    'DisplayName' => '<string>',
    'IdentityStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'GroupArn' => '<string>',
    'GroupId' => '<string>',
    'IdentityStoreId' => '<string>',
    'Revision' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Indicates that a requested resource is not found.

ThrottlingException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

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.

InternalServerException:

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

ValidationException:

The request failed because it contains a syntax error.

ServiceQuotaExceededException:

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

CreateGroupMembership

$result = $client->createGroupMembership([/* ... */]);
$promise = $client->createGroupMembershipAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createGroupMembership([
    'GroupId' => '<string>', // REQUIRED
    'IdentityStoreId' => '<string>', // REQUIRED
    'MemberId' => [ // REQUIRED
        'UserId' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'IdentityStoreId' => '<string>',
    'MembershipArn' => '<string>',
    'MembershipId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Indicates that a requested resource is not found.

ThrottlingException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

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.

InternalServerException:

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

ValidationException:

The request failed because it contains a syntax error.

ServiceQuotaExceededException:

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

CreateUser

$result = $client->createUser([/* ... */]);
$promise = $client->createUserAsync([/* ... */]);

Creates a user within the specified identity store.

Parameter Syntax

$result = $client->createUser([
    'Addresses' => [
        [
            'Country' => '<string>',
            'Formatted' => '<string>',
            'Locality' => '<string>',
            'PostalCode' => '<string>',
            'Primary' => true || false,
            'Region' => '<string>',
            'StreetAddress' => '<string>',
            'Type' => '<string>',
        ],
        // ...
    ],
    'Birthdate' => '<string>',
    'DisplayName' => '<string>',
    'Emails' => [
        [
            'Primary' => true || false,
            'Type' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Extensions' => [
        '<ExtensionName>' => [
        ],
        // ...
    ],
    'IdentityStoreId' => '<string>', // REQUIRED
    'Locale' => '<string>',
    'Name' => [
        'FamilyName' => '<string>',
        'Formatted' => '<string>',
        'GivenName' => '<string>',
        'HonorificPrefix' => '<string>',
        'HonorificSuffix' => '<string>',
        'MiddleName' => '<string>',
    ],
    'NickName' => '<string>',
    'PhoneNumbers' => [
        [
            'Primary' => true || false,
            'Type' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Photos' => [
        [
            'Display' => '<string>',
            'Primary' => true || false,
            'Type' => '<string>',
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'PreferredLanguage' => '<string>',
    'ProfileUrl' => '<string>',
    'Roles' => [
        [
            'Primary' => true || false,
            'Type' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Timezone' => '<string>',
    'Title' => '<string>',
    'UserName' => '<string>',
    'UserType' => '<string>',
    'Website' => '<string>',
]);

Parameter Details

Result Syntax

[
    'IdentityStoreId' => '<string>',
    'Revision' => '<string>',
    'UserArn' => '<string>',
    'UserId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Indicates that a requested resource is not found.

ThrottlingException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

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.

InternalServerException:

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

ValidationException:

The request failed because it contains a syntax error.

ServiceQuotaExceededException:

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

DeleteGroup

$result = $client->deleteGroup([/* ... */]);
$promise = $client->deleteGroupAsync([/* ... */]);

Delete a group within an identity store given GroupId.

Parameter Syntax

$result = $client->deleteGroup([
    'GroupId' => '<string>', // REQUIRED
    'IdentityStoreId' => '<string>', // REQUIRED
    'Revision' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Indicates that a requested resource is not found.

ThrottlingException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

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.

InternalServerException:

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

ValidationException:

The request failed because it contains a syntax error.

DeleteGroupMembership

$result = $client->deleteGroupMembership([/* ... */]);
$promise = $client->deleteGroupMembershipAsync([/* ... */]);

Delete a membership within a group given MembershipId.

Parameter Syntax

$result = $client->deleteGroupMembership([
    'IdentityStoreId' => '<string>', // REQUIRED
    'MembershipId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Indicates that a requested resource is not found.

ThrottlingException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

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.

InternalServerException:

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

ValidationException:

The request failed because it contains a syntax error.

DeleteUser

$result = $client->deleteUser([/* ... */]);
$promise = $client->deleteUserAsync([/* ... */]);

Deletes a user within an identity store given UserId.

Parameter Syntax

$result = $client->deleteUser([
    'IdentityStoreId' => '<string>', // REQUIRED
    'Revision' => '<string>',
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Indicates that a requested resource is not found.

ThrottlingException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

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.

InternalServerException:

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

ValidationException:

The request failed because it contains a syntax error.

DescribeGroup

$result = $client->describeGroup([/* ... */]);
$promise = $client->describeGroupAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeGroup([
    'GroupId' => '<string>', // REQUIRED
    'IdentityStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'CreatedBy' => '<string>',
    'Description' => '<string>',
    'DisplayName' => '<string>',
    'ExternalIds' => [
        [
            'Id' => '<string>',
            'Issuer' => '<string>',
        ],
        // ...
    ],
    'GroupArn' => '<string>',
    'GroupId' => '<string>',
    'IdentityStoreId' => '<string>',
    'Revision' => '<string>',
    'UpdatedAt' => <DateTime>,
    'UpdatedBy' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Indicates that a requested resource is not found.

ThrottlingException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

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

ValidationException:

The request failed because it contains a syntax error.

DescribeGroupMembership

$result = $client->describeGroupMembership([/* ... */]);
$promise = $client->describeGroupMembershipAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeGroupMembership([
    'IdentityStoreId' => '<string>', // REQUIRED
    'MembershipId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'CreatedBy' => '<string>',
    'GroupId' => '<string>',
    'IdentityStoreId' => '<string>',
    'MemberId' => [
        'UserId' => '<string>',
    ],
    'MembershipArn' => '<string>',
    'MembershipId' => '<string>',
    'UpdatedAt' => <DateTime>,
    'UpdatedBy' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Indicates that a requested resource is not found.

ThrottlingException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

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

ValidationException:

The request failed because it contains a syntax error.

DescribeIdentityStore

$result = $client->describeIdentityStore([/* ... */]);
$promise = $client->describeIdentityStoreAsync([/* ... */]);

Retrieves details about the specified identity store, including its Amazon Resource Name (ARN) and network configuration.

Parameter Syntax

$result = $client->describeIdentityStore([
    'IdentityStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'IdentityStoreArn' => '<string>',
    'IdentityStoreId' => '<string>',
    'NetworkConfiguration' => [
        'ApiAllowSourceIps' => ['<string>', ...],
        'ApiRestrictSourceVpcs' => ['<string>', ...],
        'ScimAllowSourceIps' => ['<string>', ...],
        'VpceAccessRequired' => true || false,
    ],
]

Result Details

Errors

ResourceNotFoundException:

Indicates that a requested resource is not found.

ThrottlingException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

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

ValidationException:

The request failed because it contains a syntax error.

DescribeUser

$result = $client->describeUser([/* ... */]);
$promise = $client->describeUserAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeUser([
    'Extensions' => ['<string>', ...],
    'IdentityStoreId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Addresses' => [
        [
            'Country' => '<string>',
            'Formatted' => '<string>',
            'Locality' => '<string>',
            'PostalCode' => '<string>',
            'Primary' => true || false,
            'Region' => '<string>',
            'StreetAddress' => '<string>',
            'Type' => '<string>',
        ],
        // ...
    ],
    'Birthdate' => '<string>',
    'CreatedAt' => <DateTime>,
    'CreatedBy' => '<string>',
    'DisplayName' => '<string>',
    'Emails' => [
        [
            'Primary' => true || false,
            'Type' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Extensions' => [
        '<ExtensionName>' => [
        ],
        // ...
    ],
    'ExternalIds' => [
        [
            'Id' => '<string>',
            'Issuer' => '<string>',
        ],
        // ...
    ],
    'IdentityStoreId' => '<string>',
    'Locale' => '<string>',
    'Name' => [
        'FamilyName' => '<string>',
        'Formatted' => '<string>',
        'GivenName' => '<string>',
        'HonorificPrefix' => '<string>',
        'HonorificSuffix' => '<string>',
        'MiddleName' => '<string>',
    ],
    'NickName' => '<string>',
    'PhoneNumbers' => [
        [
            'Primary' => true || false,
            'Type' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Photos' => [
        [
            'Display' => '<string>',
            'Primary' => true || false,
            'Type' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'PreferredLanguage' => '<string>',
    'ProfileUrl' => '<string>',
    'Revision' => '<string>',
    'Roles' => [
        [
            'Primary' => true || false,
            'Type' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Timezone' => '<string>',
    'Title' => '<string>',
    'UpdatedAt' => <DateTime>,
    'UpdatedBy' => '<string>',
    'UserArn' => '<string>',
    'UserId' => '<string>',
    'UserName' => '<string>',
    'UserStatus' => 'ENABLED|DISABLED',
    'UserType' => '<string>',
    'Website' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Indicates that a requested resource is not found.

ThrottlingException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

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

ValidationException:

The request failed because it contains a syntax error.

GetGroupId

$result = $client->getGroupId([/* ... */]);
$promise = $client->getGroupIdAsync([/* ... */]);

Retrieves GroupId in an identity store.

Parameter Syntax

$result = $client->getGroupId([
    'AlternateIdentifier' => [ // REQUIRED
        'ExternalId' => [
            'Id' => '<string>', // REQUIRED
            'Issuer' => '<string>', // REQUIRED
        ],
        'UniqueAttribute' => [
            'AttributePath' => '<string>', // REQUIRED
            'AttributeValue' => [ // REQUIRED
            ],
        ],
    ],
    'IdentityStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'GroupArn' => '<string>',
    'GroupId' => '<string>',
    'IdentityStoreId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Indicates that a requested resource is not found.

ThrottlingException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

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

ValidationException:

The request failed because it contains a syntax error.

GetGroupMembershipId

$result = $client->getGroupMembershipId([/* ... */]);
$promise = $client->getGroupMembershipIdAsync([/* ... */]);

Retrieves the MembershipId in an identity store.

Parameter Syntax

$result = $client->getGroupMembershipId([
    'GroupId' => '<string>', // REQUIRED
    'IdentityStoreId' => '<string>', // REQUIRED
    'MemberId' => [ // REQUIRED
        'UserId' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'IdentityStoreId' => '<string>',
    'MembershipArn' => '<string>',
    'MembershipId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Indicates that a requested resource is not found.

ThrottlingException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

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

ValidationException:

The request failed because it contains a syntax error.

GetUserId

$result = $client->getUserId([/* ... */]);
$promise = $client->getUserIdAsync([/* ... */]);

Retrieves the UserId in an identity store.

Parameter Syntax

$result = $client->getUserId([
    'AlternateIdentifier' => [ // REQUIRED
        'ExternalId' => [
            'Id' => '<string>', // REQUIRED
            'Issuer' => '<string>', // REQUIRED
        ],
        'UniqueAttribute' => [
            'AttributePath' => '<string>', // REQUIRED
            'AttributeValue' => [ // REQUIRED
            ],
        ],
    ],
    'IdentityStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'IdentityStoreId' => '<string>',
    'UserArn' => '<string>',
    'UserId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Indicates that a requested resource is not found.

ThrottlingException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

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

ValidationException:

The request failed because it contains a syntax error.

IsMemberInGroups

$result = $client->isMemberInGroups([/* ... */]);
$promise = $client->isMemberInGroupsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->isMemberInGroups([
    'GroupIds' => ['<string>', ...], // REQUIRED
    'IdentityStoreId' => '<string>', // REQUIRED
    'MemberId' => [ // REQUIRED
        'UserId' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'Results' => [
        [
            'GroupId' => '<string>',
            'MemberId' => [
                'UserId' => '<string>',
            ],
            'MembershipExists' => true || false,
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

Indicates that a requested resource is not found.

ThrottlingException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

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

ValidationException:

The request failed because it contains a syntax error.

ListGroupMemberships

$result = $client->listGroupMemberships([/* ... */]);
$promise = $client->listGroupMembershipsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listGroupMemberships([
    'GroupId' => '<string>', // REQUIRED
    'IdentityStoreId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'GroupMemberships' => [
        [
            'CreatedAt' => <DateTime>,
            'CreatedBy' => '<string>',
            'GroupId' => '<string>',
            'IdentityStoreId' => '<string>',
            'MemberId' => [
                'UserId' => '<string>',
            ],
            'MembershipArn' => '<string>',
            'MembershipId' => '<string>',
            'UpdatedAt' => <DateTime>,
            'UpdatedBy' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Indicates that a requested resource is not found.

ThrottlingException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

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

ValidationException:

The request failed because it contains a syntax error.

ListGroupMembershipsForMember

$result = $client->listGroupMembershipsForMember([/* ... */]);
$promise = $client->listGroupMembershipsForMemberAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listGroupMembershipsForMember([
    'IdentityStoreId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'MemberId' => [ // REQUIRED
        'UserId' => '<string>',
    ],
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'GroupMemberships' => [
        [
            'CreatedAt' => <DateTime>,
            'CreatedBy' => '<string>',
            'GroupId' => '<string>',
            'IdentityStoreId' => '<string>',
            'MemberId' => [
                'UserId' => '<string>',
            ],
            'MembershipArn' => '<string>',
            'MembershipId' => '<string>',
            'UpdatedAt' => <DateTime>,
            'UpdatedBy' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Indicates that a requested resource is not found.

ThrottlingException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

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

ValidationException:

The request failed because it contains a syntax error.

ListGroups

$result = $client->listGroups([/* ... */]);
$promise = $client->listGroupsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listGroups([
    'Filters' => [
        [
            'AttributePath' => '<string>', // REQUIRED
            'AttributeValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'IdentityStoreId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Groups' => [
        [
            'CreatedAt' => <DateTime>,
            'CreatedBy' => '<string>',
            'Description' => '<string>',
            'DisplayName' => '<string>',
            'ExternalIds' => [
                [
                    'Id' => '<string>',
                    'Issuer' => '<string>',
                ],
                // ...
            ],
            'GroupArn' => '<string>',
            'GroupId' => '<string>',
            'IdentityStoreId' => '<string>',
            'Revision' => '<string>',
            'UpdatedAt' => <DateTime>,
            'UpdatedBy' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Indicates that a requested resource is not found.

ThrottlingException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

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

ValidationException:

The request failed because it contains a syntax error.

ListIdentityStores

$result = $client->listIdentityStores([/* ... */]);
$promise = $client->listIdentityStoresAsync([/* ... */]);

Lists the identity stores that you have access to. This operation returns only the identity store ID and Amazon Resource Name (ARN) of each identity store. To obtain additional information about an identity store, call DescribeIdentityStore.

This operation returns results in paginated form. Use the NextToken parameter to retrieve additional pages of results.

Parameter Syntax

$result = $client->listIdentityStores([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'IdentityStores' => [
        [
            'IdentityStoreArn' => '<string>',
            'IdentityStoreId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

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

ValidationException:

The request failed because it contains a syntax error.

ListUsers

$result = $client->listUsers([/* ... */]);
$promise = $client->listUsersAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listUsers([
    'Extensions' => ['<string>', ...],
    'Filters' => [
        [
            'AttributePath' => '<string>', // REQUIRED
            'AttributeValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'IdentityStoreId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Users' => [
        [
            'Addresses' => [
                [
                    'Country' => '<string>',
                    'Formatted' => '<string>',
                    'Locality' => '<string>',
                    'PostalCode' => '<string>',
                    'Primary' => true || false,
                    'Region' => '<string>',
                    'StreetAddress' => '<string>',
                    'Type' => '<string>',
                ],
                // ...
            ],
            'Birthdate' => '<string>',
            'CreatedAt' => <DateTime>,
            'CreatedBy' => '<string>',
            'DisplayName' => '<string>',
            'Emails' => [
                [
                    'Primary' => true || false,
                    'Type' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'Extensions' => [
                '<ExtensionName>' => [
                ],
                // ...
            ],
            'ExternalIds' => [
                [
                    'Id' => '<string>',
                    'Issuer' => '<string>',
                ],
                // ...
            ],
            'IdentityStoreId' => '<string>',
            'Locale' => '<string>',
            'Name' => [
                'FamilyName' => '<string>',
                'Formatted' => '<string>',
                'GivenName' => '<string>',
                'HonorificPrefix' => '<string>',
                'HonorificSuffix' => '<string>',
                'MiddleName' => '<string>',
            ],
            'NickName' => '<string>',
            'PhoneNumbers' => [
                [
                    'Primary' => true || false,
                    'Type' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'Photos' => [
                [
                    'Display' => '<string>',
                    'Primary' => true || false,
                    'Type' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'PreferredLanguage' => '<string>',
            'ProfileUrl' => '<string>',
            'Revision' => '<string>',
            'Roles' => [
                [
                    'Primary' => true || false,
                    'Type' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'Timezone' => '<string>',
            'Title' => '<string>',
            'UpdatedAt' => <DateTime>,
            'UpdatedBy' => '<string>',
            'UserArn' => '<string>',
            'UserId' => '<string>',
            'UserName' => '<string>',
            'UserStatus' => 'ENABLED|DISABLED',
            'UserType' => '<string>',
            'Website' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

Indicates that a requested resource is not found.

ThrottlingException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

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

ValidationException:

The request failed because it contains a syntax error.

UpdateGroup

$result = $client->updateGroup([/* ... */]);
$promise = $client->updateGroupAsync([/* ... */]);

Updates the specified group metadata and attributes in the specified identity store.

Parameter Syntax

$result = $client->updateGroup([
    'GroupId' => '<string>', // REQUIRED
    'IdentityStoreId' => '<string>', // REQUIRED
    'Operations' => [ // REQUIRED
        [
            'AttributePath' => '<string>', // REQUIRED
            'AttributeValue' => [
            ],
        ],
        // ...
    ],
    'Revision' => '<string>',
]);

Parameter Details

Result Syntax

[
    'GroupArn' => '<string>',
    'GroupId' => '<string>',
    'IdentityStoreId' => '<string>',
    'Revision' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Indicates that a requested resource is not found.

ThrottlingException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

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.

InternalServerException:

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

ValidationException:

The request failed because it contains a syntax error.

ServiceQuotaExceededException:

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

UpdateIdentityStore

$result = $client->updateIdentityStore([/* ... */]);
$promise = $client->updateIdentityStoreAsync([/* ... */]);

Updates the configuration of the specified identity store, including its network configuration.

Parameter Syntax

$result = $client->updateIdentityStore([
    'IdentityStoreId' => '<string>', // REQUIRED
    'NetworkConfiguration' => [
        'ApiAllowSourceIps' => ['<string>', ...],
        'ApiRestrictSourceVpcs' => ['<string>', ...],
        'ScimAllowSourceIps' => ['<string>', ...],
        'VpceAccessRequired' => true || false, // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'IdentityStoreArn' => '<string>',
    'IdentityStoreId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Indicates that a requested resource is not found.

ThrottlingException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

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.

InternalServerException:

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

ValidationException:

The request failed because it contains a syntax error.

UpdateUser

$result = $client->updateUser([/* ... */]);
$promise = $client->updateUserAsync([/* ... */]);

Updates the specified user metadata and attributes in the specified identity store.

Parameter Syntax

$result = $client->updateUser([
    'IdentityStoreId' => '<string>', // REQUIRED
    'Operations' => [ // REQUIRED
        [
            'AttributePath' => '<string>', // REQUIRED
            'AttributeValue' => [
            ],
        ],
        // ...
    ],
    'Revision' => '<string>',
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'IdentityStoreId' => '<string>',
    'Revision' => '<string>',
    'UserArn' => '<string>',
    'UserId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Indicates that a requested resource is not found.

ThrottlingException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

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.

InternalServerException:

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

ValidationException:

The request failed because it contains a syntax error.

ServiceQuotaExceededException:

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