AWS SDK for PHP 3.x

Client: Aws\ChimeSDKIdentity\ChimeSDKIdentityClient

Service ID: chime-sdk-identity

Version: 2021-04-20

This page describes the parameters and results for the operations of the Amazon Chime SDK Identity (2021-04-20), and shows how to use the Aws\ChimeSDKIdentity\ChimeSDKIdentityClient object to call the described operations. This documentation is specific to the 2021-04-20 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateAppInstance ( array $params = [] ): Creates an Amazon Chime SDK messaging AppInstance under an AWS account.
CreateAppInstanceAdmin ( array $params = [] ): Promotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin.
CreateAppInstanceBot ( array $params = [] ): Creates a bot under an Amazon Chime AppInstance.
CreateAppInstanceUser ( array $params = [] ): Creates a user under an Amazon Chime AppInstance.
DeleteAppInstance ( array $params = [] ): Deletes an AppInstance and all associated data asynchronously.
DeleteAppInstanceAdmin ( array $params = [] ): Demotes an AppInstanceAdmin to an AppInstanceUser or AppInstanceBot.
DeleteAppInstanceBot ( array $params = [] ): Deletes an AppInstanceBot.
DeleteAppInstanceUser ( array $params = [] ): Deletes an AppInstanceUser.
DeregisterAppInstanceUserEndpoint ( array $params = [] ): Deregisters an AppInstanceUserEndpoint.
DescribeAppInstance ( array $params = [] ): Returns the full details of an AppInstance.
DescribeAppInstanceAdmin ( array $params = [] ): Returns the full details of an AppInstanceAdmin.
DescribeAppInstanceBot ( array $params = [] ): The AppInstanceBot's information.
DescribeAppInstanceUser ( array $params = [] ): Returns the full details of an AppInstanceUser.
DescribeAppInstanceUserEndpoint ( array $params = [] ): Returns the full details of an AppInstanceUserEndpoint.
GetAppInstanceRetentionSettings ( array $params = [] ): Gets the retention settings for an AppInstance.
ListAppInstanceAdmins ( array $params = [] ): Returns a list of the administrators in the AppInstance.
ListAppInstanceBots ( array $params = [] ): Lists all AppInstanceBots created under a single AppInstance.
ListAppInstanceUserEndpoints ( array $params = [] ): Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.
ListAppInstanceUsers ( array $params = [] ): List all AppInstanceUsers created under a single AppInstance.
ListAppInstances ( array $params = [] ): Lists all Amazon Chime AppInstances created under a single AWS account.
ListTagsForResource ( array $params = [] ): Lists the tags applied to an Amazon Chime SDK identity resource.
PutAppInstanceRetentionSettings ( array $params = [] ): Sets the amount of time in days that a given AppInstance retains data.
PutAppInstanceUserExpirationSettings ( array $params = [] ): Sets the number of days before the AppInstanceUser is automatically deleted.
RegisterAppInstanceUserEndpoint ( array $params = [] ): Registers an endpoint under an Amazon Chime AppInstanceUser.
TagResource ( array $params = [] ): Applies the specified tags to the specified Amazon Chime SDK identity resource.
UntagResource ( array $params = [] ): Removes the specified tags from the specified Amazon Chime SDK identity resource.
UpdateAppInstance ( array $params = [] ): Updates AppInstance metadata.
UpdateAppInstanceBot ( array $params = [] ): Updates the name and metadata of an AppInstanceBot.
UpdateAppInstanceUser ( array $params = [] ): Updates the details of an AppInstanceUser.
UpdateAppInstanceUserEndpoint ( array $params = [] ): Updates the details of an AppInstanceUserEndpoint.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListAppInstanceAdmins
ListAppInstanceBots
ListAppInstanceUserEndpoints
ListAppInstanceUsers
ListAppInstances

Operations

CreateAppInstance

$result = $client->createAppInstance([/* ... */]);
$promise = $client->createAppInstanceAsync([/* ... */]);

Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.

identity

Parameter Syntax

$result = $client->createAppInstance([
    'ClientRequestToken' => '<string>', // REQUIRED
    'Metadata' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ClientRequestToken

Required: Yes
Type: string

The unique ID of the request. Use different tokens to create different AppInstances.

Metadata

Type: string

The metadata of the AppInstance. Limited to a 1KB string in UTF-8.

Name

Required: Yes
Type: string

The name of the AppInstance.

Tags

Type: Array of Tag structures

Tags assigned to the AppInstance.

Result Syntax

[
    'AppInstanceArn' => '<string>',
]

Result Details

Members

AppInstanceArn

Type: string

The Amazon Resource Number (ARN) of the AppInstance.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ConflictException:
The request could not be processed because of conflict in the current state of the resource.
ForbiddenException:
The client is permanently forbidden from making the request.
ResourceLimitExceededException:
The request exceeds the resource limit.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

CreateAppInstanceAdmin

$result = $client->createAppInstanceAdmin([/* ... */]);
$promise = $client->createAppInstanceAdminAsync([/* ... */]);

Promotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin. The promoted entity can perform the following actions.

ChannelModerator actions across all channels in the AppInstance.
DeleteChannelMessage actions.

Only an AppInstanceUser and AppInstanceBot can be promoted to an AppInstanceAdmin role.

Parameter Syntax

$result = $client->createAppInstanceAdmin([
    'AppInstanceAdminArn' => '<string>', // REQUIRED
    'AppInstanceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

AppInstanceAdminArn

Required: Yes
Type: string

The ARN of the administrator of the current AppInstance.

AppInstanceArn

Required: Yes
Type: string

The ARN of the AppInstance.

Result Syntax

[
    'AppInstanceAdmin' => [
        'Arn' => '<string>',
        'Name' => '<string>',
    ],
    'AppInstanceArn' => '<string>',
]

Result Details

Members

AppInstanceAdmin

Type: Identity structure

The ARN and name of the administrator, the ARN of the AppInstance, and the created and last-updated timestamps. All timestamps use epoch milliseconds.

AppInstanceArn

Type: string

The ARN of the of the admin for the AppInstance.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ConflictException:
The request could not be processed because of conflict in the current state of the resource.
ForbiddenException:
The client is permanently forbidden from making the request.
ResourceLimitExceededException:
The request exceeds the resource limit.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

CreateAppInstanceBot

$result = $client->createAppInstanceBot([/* ... */]);
$promise = $client->createAppInstanceBotAsync([/* ... */]);

Creates a bot under an Amazon Chime AppInstance. The request consists of a unique Configuration and Name for that bot.

Parameter Syntax

$result = $client->createAppInstanceBot([
    'AppInstanceArn' => '<string>', // REQUIRED
    'ClientRequestToken' => '<string>', // REQUIRED
    'Configuration' => [ // REQUIRED
        'Lex' => [ // REQUIRED
            'InvokedBy' => [
                'StandardMessages' => 'AUTO|ALL|MENTIONS|NONE', // REQUIRED
                'TargetedMessages' => 'ALL|NONE', // REQUIRED
            ],
            'LexBotAliasArn' => '<string>', // REQUIRED
            'LocaleId' => '<string>', // REQUIRED
            'RespondsTo' => 'STANDARD_MESSAGES',
            'WelcomeIntent' => '<string>',
        ],
    ],
    'Metadata' => '<string>',
    'Name' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

AppInstanceArn

Required: Yes
Type: string

The ARN of the AppInstance request.

ClientRequestToken

Required: Yes
Type: string

The unique ID for the client making the request. Use different tokens for different AppInstanceBots.

Configuration

Required: Yes
Type: Configuration structure

Configuration information about the Amazon Lex V2 V2 bot.

Metadata

Type: string

The request metadata. Limited to a 1KB string in UTF-8.

Name

Type: string

The user's name.

Tags

Type: Array of Tag structures

The tags assigned to the AppInstanceBot.

Result Syntax

[
    'AppInstanceBotArn' => '<string>',
]

Result Details

Members

AppInstanceBotArn

Type: string

The ARN of the AppinstanceBot.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ConflictException:
The request could not be processed because of conflict in the current state of the resource.
ForbiddenException:
The client is permanently forbidden from making the request.
ResourceLimitExceededException:
The request exceeds the resource limit.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

CreateAppInstanceUser

$result = $client->createAppInstanceUser([/* ... */]);
$promise = $client->createAppInstanceUserAsync([/* ... */]);

Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.

Parameter Syntax

$result = $client->createAppInstanceUser([
    'AppInstanceArn' => '<string>', // REQUIRED
    'AppInstanceUserId' => '<string>', // REQUIRED
    'ClientRequestToken' => '<string>', // REQUIRED
    'ExpirationSettings' => [
        'ExpirationCriterion' => 'CREATED_TIMESTAMP', // REQUIRED
        'ExpirationDays' => <integer>, // REQUIRED
    ],
    'Metadata' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

AppInstanceArn

Required: Yes
Type: string

The ARN of the AppInstance request.

AppInstanceUserId

Required: Yes
Type: string

The user ID of the AppInstance.

ClientRequestToken

Required: Yes
Type: string

The unique ID of the request. Use different tokens to request additional AppInstances.

ExpirationSettings

Type: ExpirationSettings structure

Settings that control the interval after which the AppInstanceUser is automatically deleted.

Metadata

Type: string

The request's metadata. Limited to a 1KB string in UTF-8.

Name

Required: Yes
Type: string

The user's name.

Tags

Type: Array of Tag structures

Tags assigned to the AppInstanceUser.

Result Syntax

[
    'AppInstanceUserArn' => '<string>',
]

Result Details

Members

AppInstanceUserArn

Type: string

The user's ARN.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ConflictException:
The request could not be processed because of conflict in the current state of the resource.
ForbiddenException:
The client is permanently forbidden from making the request.
ResourceLimitExceededException:
The request exceeds the resource limit.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

DeleteAppInstance

$result = $client->deleteAppInstance([/* ... */]);
$promise = $client->deleteAppInstanceAsync([/* ... */]);

Deletes an AppInstance and all associated data asynchronously.

Parameter Syntax

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

Parameter Details

Members

AppInstanceArn

Required: Yes
Type: string

The ARN of the AppInstance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ForbiddenException:
The client is permanently forbidden from making the request.
ResourceLimitExceededException:
The request exceeds the resource limit.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

DeleteAppInstanceAdmin

$result = $client->deleteAppInstanceAdmin([/* ... */]);
$promise = $client->deleteAppInstanceAdminAsync([/* ... */]);

Demotes an AppInstanceAdmin to an AppInstanceUser or AppInstanceBot. This action does not delete the user.

Parameter Syntax

$result = $client->deleteAppInstanceAdmin([
    'AppInstanceAdminArn' => '<string>', // REQUIRED
    'AppInstanceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

AppInstanceAdminArn

Required: Yes
Type: string

The ARN of the AppInstance's administrator.

AppInstanceArn

Required: Yes
Type: string

The ARN of the AppInstance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ConflictException:
The request could not be processed because of conflict in the current state of the resource.
ForbiddenException:
The client is permanently forbidden from making the request.
ResourceLimitExceededException:
The request exceeds the resource limit.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

DeleteAppInstanceBot

$result = $client->deleteAppInstanceBot([/* ... */]);
$promise = $client->deleteAppInstanceBotAsync([/* ... */]);

Deletes an AppInstanceBot.

Parameter Syntax

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

Parameter Details

Members

AppInstanceBotArn

Required: Yes
Type: string

The ARN of the AppInstanceBot being deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ConflictException:
The request could not be processed because of conflict in the current state of the resource.
ForbiddenException:
The client is permanently forbidden from making the request.
ResourceLimitExceededException:
The request exceeds the resource limit.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

DeleteAppInstanceUser

$result = $client->deleteAppInstanceUser([/* ... */]);
$promise = $client->deleteAppInstanceUserAsync([/* ... */]);

Deletes an AppInstanceUser.

Parameter Syntax

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

Parameter Details

Members

AppInstanceUserArn

Required: Yes
Type: string

The ARN of the user request being deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ConflictException:
The request could not be processed because of conflict in the current state of the resource.
ForbiddenException:
The client is permanently forbidden from making the request.
ResourceLimitExceededException:
The request exceeds the resource limit.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

DeregisterAppInstanceUserEndpoint

$result = $client->deregisterAppInstanceUserEndpoint([/* ... */]);
$promise = $client->deregisterAppInstanceUserEndpointAsync([/* ... */]);

Deregisters an AppInstanceUserEndpoint.

Parameter Syntax

$result = $client->deregisterAppInstanceUserEndpoint([
    'AppInstanceUserArn' => '<string>', // REQUIRED
    'EndpointId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AppInstanceUserArn

Required: Yes
Type: string

The ARN of the AppInstanceUser.

EndpointId

Required: Yes
Type: string

The unique identifier of the AppInstanceUserEndpoint.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ForbiddenException:
The client is permanently forbidden from making the request.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

DescribeAppInstance

$result = $client->describeAppInstance([/* ... */]);
$promise = $client->describeAppInstanceAsync([/* ... */]);

Returns the full details of an AppInstance.

Parameter Syntax

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

Parameter Details

Members

AppInstanceArn

Required: Yes
Type: string

The ARN of the AppInstance.

Result Syntax

[
    'AppInstance' => [
        'AppInstanceArn' => '<string>',
        'CreatedTimestamp' => <DateTime>,
        'LastUpdatedTimestamp' => <DateTime>,
        'Metadata' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

Members

AppInstance

Type: AppInstance structure

The ARN, metadata, created and last-updated timestamps, and the name of the AppInstance. All timestamps use epoch milliseconds.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ForbiddenException:
The client is permanently forbidden from making the request.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

DescribeAppInstanceAdmin

$result = $client->describeAppInstanceAdmin([/* ... */]);
$promise = $client->describeAppInstanceAdminAsync([/* ... */]);

Returns the full details of an AppInstanceAdmin.

Parameter Syntax

$result = $client->describeAppInstanceAdmin([
    'AppInstanceAdminArn' => '<string>', // REQUIRED
    'AppInstanceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

AppInstanceAdminArn

Required: Yes
Type: string

The ARN of the AppInstanceAdmin.

AppInstanceArn

Required: Yes
Type: string

The ARN of the AppInstance.

Result Syntax

[
    'AppInstanceAdmin' => [
        'Admin' => [
            'Arn' => '<string>',
            'Name' => '<string>',
        ],
        'AppInstanceArn' => '<string>',
        'CreatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members

AppInstanceAdmin

Type: AppInstanceAdmin structure

The ARN and name of the AppInstanceUser, the ARN of the AppInstance, and the created and last-updated timestamps. All timestamps use epoch milliseconds.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ForbiddenException:
The client is permanently forbidden from making the request.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

DescribeAppInstanceBot

$result = $client->describeAppInstanceBot([/* ... */]);
$promise = $client->describeAppInstanceBotAsync([/* ... */]);

The AppInstanceBot's information.

Parameter Syntax

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

Parameter Details

Members

AppInstanceBotArn

Required: Yes
Type: string

The ARN of the AppInstanceBot.

Result Syntax

[
    'AppInstanceBot' => [
        'AppInstanceBotArn' => '<string>',
        'Configuration' => [
            'Lex' => [
                'InvokedBy' => [
                    'StandardMessages' => 'AUTO|ALL|MENTIONS|NONE',
                    'TargetedMessages' => 'ALL|NONE',
                ],
                'LexBotAliasArn' => '<string>',
                'LocaleId' => '<string>',
                'RespondsTo' => 'STANDARD_MESSAGES',
                'WelcomeIntent' => '<string>',
            ],
        ],
        'CreatedTimestamp' => <DateTime>,
        'LastUpdatedTimestamp' => <DateTime>,
        'Metadata' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

Members

AppInstanceBot

Type: AppInstanceBot structure

The detials of the AppInstanceBot.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ForbiddenException:
The client is permanently forbidden from making the request.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
NotFoundException:
One or more of the resources in the request does not exist in the system.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

DescribeAppInstanceUser

$result = $client->describeAppInstanceUser([/* ... */]);
$promise = $client->describeAppInstanceUserAsync([/* ... */]);

Returns the full details of an AppInstanceUser.

Parameter Syntax

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

Parameter Details

Members

AppInstanceUserArn

Required: Yes
Type: string

The ARN of the AppInstanceUser.

Result Syntax

[
    'AppInstanceUser' => [
        'AppInstanceUserArn' => '<string>',
        'CreatedTimestamp' => <DateTime>,
        'ExpirationSettings' => [
            'ExpirationCriterion' => 'CREATED_TIMESTAMP',
            'ExpirationDays' => <integer>,
        ],
        'LastUpdatedTimestamp' => <DateTime>,
        'Metadata' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

Members

AppInstanceUser

Type: AppInstanceUser structure

The name of the AppInstanceUser.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ForbiddenException:
The client is permanently forbidden from making the request.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

DescribeAppInstanceUserEndpoint

$result = $client->describeAppInstanceUserEndpoint([/* ... */]);
$promise = $client->describeAppInstanceUserEndpointAsync([/* ... */]);

Returns the full details of an AppInstanceUserEndpoint.

Parameter Syntax

$result = $client->describeAppInstanceUserEndpoint([
    'AppInstanceUserArn' => '<string>', // REQUIRED
    'EndpointId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AppInstanceUserArn

Required: Yes
Type: string

The ARN of the AppInstanceUser.

EndpointId

Required: Yes
Type: string

The unique identifier of the AppInstanceUserEndpoint.

Result Syntax

[
    'AppInstanceUserEndpoint' => [
        'AllowMessages' => 'ALL|NONE',
        'AppInstanceUserArn' => '<string>',
        'CreatedTimestamp' => <DateTime>,
        'EndpointAttributes' => [
            'DeviceToken' => '<string>',
            'VoipDeviceToken' => '<string>',
        ],
        'EndpointId' => '<string>',
        'EndpointState' => [
            'Status' => 'ACTIVE|INACTIVE',
            'StatusReason' => 'INVALID_DEVICE_TOKEN|INVALID_PINPOINT_ARN',
        ],
        'LastUpdatedTimestamp' => <DateTime>,
        'Name' => '<string>',
        'ResourceArn' => '<string>',
        'Type' => 'APNS|APNS_SANDBOX|GCM',
    ],
]

Result Details

Members

AppInstanceUserEndpoint

Type: AppInstanceUserEndpoint structure

The full details of an AppInstanceUserEndpoint: the AppInstanceUserArn, ID, name, type, resource ARN, attributes, allow messages, state, and created and last updated timestamps. All timestamps use epoch milliseconds.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ForbiddenException:
The client is permanently forbidden from making the request.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

GetAppInstanceRetentionSettings

$result = $client->getAppInstanceRetentionSettings([/* ... */]);
$promise = $client->getAppInstanceRetentionSettingsAsync([/* ... */]);

Gets the retention settings for an AppInstance.

Parameter Syntax

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

Parameter Details

Members

AppInstanceArn

Required: Yes
Type: string

The ARN of the AppInstance.

Result Syntax

[
    'AppInstanceRetentionSettings' => [
        'ChannelRetentionSettings' => [
            'RetentionDays' => <integer>,
        ],
    ],
    'InitiateDeletionTimestamp' => <DateTime>,
]

Result Details

Members

AppInstanceRetentionSettings

Type: AppInstanceRetentionSettings structure

The retention settings for the AppInstance.

InitiateDeletionTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp representing the time at which the specified items are retained, in Epoch Seconds.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ForbiddenException:
The client is permanently forbidden from making the request.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

ListAppInstanceAdmins

$result = $client->listAppInstanceAdmins([/* ... */]);
$promise = $client->listAppInstanceAdminsAsync([/* ... */]);

Returns a list of the administrators in the AppInstance.

Parameter Syntax

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

Parameter Details

Members

AppInstanceArn

Required: Yes
Type: string

The ARN of the AppInstance.

MaxResults

Type: int

The maximum number of administrators that you want to return.

NextToken

Type: string

The token returned from previous API requests until the number of administrators is reached.

Result Syntax

[
    'AppInstanceAdmins' => [
        [
            'Admin' => [
                'Arn' => '<string>',
                'Name' => '<string>',
            ],
        ],
        // ...
    ],
    'AppInstanceArn' => '<string>',
    'NextToken' => '<string>',
]

Result Details

Members

AppInstanceAdmins

Type: Array of AppInstanceAdminSummary structures

The information for each administrator.

AppInstanceArn

Type: string

The ARN of the AppInstance.

NextToken

Type: string

The token returned from previous API requests until the number of administrators is reached.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ForbiddenException:
The client is permanently forbidden from making the request.
ResourceLimitExceededException:
The request exceeds the resource limit.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

ListAppInstanceBots

$result = $client->listAppInstanceBots([/* ... */]);
$promise = $client->listAppInstanceBotsAsync([/* ... */]);

Lists all AppInstanceBots created under a single AppInstance.

Parameter Syntax

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

Parameter Details

Members

AppInstanceArn

Required: Yes
Type: string

The ARN of the AppInstance.

MaxResults

Type: int

The maximum number of requests to return.

NextToken

Type: string

The token passed by previous API calls until all requested bots are returned.

Result Syntax

[
    'AppInstanceArn' => '<string>',
    'AppInstanceBots' => [
        [
            'AppInstanceBotArn' => '<string>',
            'Metadata' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

AppInstanceArn

Type: string

The ARN of the AppInstance.

AppInstanceBots

Type: Array of AppInstanceBotSummary structures

The information for each requested AppInstanceBot.

NextToken

Type: string

The token passed by previous API calls until all requested bots are returned.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ForbiddenException:
The client is permanently forbidden from making the request.
ResourceLimitExceededException:
The request exceeds the resource limit.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

ListAppInstanceUserEndpoints

$result = $client->listAppInstanceUserEndpoints([/* ... */]);
$promise = $client->listAppInstanceUserEndpointsAsync([/* ... */]);

Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.

Parameter Syntax

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

Parameter Details

Members

AppInstanceUserArn

Required: Yes
Type: string

The ARN of the AppInstanceUser.

MaxResults

Type: int

The maximum number of endpoints that you want to return.

NextToken

Type: string

The token passed by previous API calls until all requested endpoints are returned.

Result Syntax

[
    'AppInstanceUserEndpoints' => [
        [
            'AllowMessages' => 'ALL|NONE',
            'AppInstanceUserArn' => '<string>',
            'EndpointId' => '<string>',
            'EndpointState' => [
                'Status' => 'ACTIVE|INACTIVE',
                'StatusReason' => 'INVALID_DEVICE_TOKEN|INVALID_PINPOINT_ARN',
            ],
            'Name' => '<string>',
            'Type' => 'APNS|APNS_SANDBOX|GCM',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

AppInstanceUserEndpoints

Type: Array of AppInstanceUserEndpointSummary structures

The information for each requested AppInstanceUserEndpoint.

NextToken

Type: string

The token passed by previous API calls until all requested endpoints are returned.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ForbiddenException:
The client is permanently forbidden from making the request.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

ListAppInstanceUsers

$result = $client->listAppInstanceUsers([/* ... */]);
$promise = $client->listAppInstanceUsersAsync([/* ... */]);

List all AppInstanceUsers created under a single AppInstance.

Parameter Syntax

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

Parameter Details

Members

AppInstanceArn

Required: Yes
Type: string

The ARN of the AppInstance.

MaxResults

Type: int

The maximum number of requests that you want returned.

NextToken

Type: string

The token passed by previous API calls until all requested users are returned.

Result Syntax

[
    'AppInstanceArn' => '<string>',
    'AppInstanceUsers' => [
        [
            'AppInstanceUserArn' => '<string>',
            'Metadata' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

AppInstanceArn

Type: string

The ARN of the AppInstance.

AppInstanceUsers

Type: Array of AppInstanceUserSummary structures

The information for each requested AppInstanceUser.

NextToken

Type: string

The token passed by previous API calls until all requested users are returned.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ForbiddenException:
The client is permanently forbidden from making the request.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

ListAppInstances

$result = $client->listAppInstances([/* ... */]);
$promise = $client->listAppInstancesAsync([/* ... */]);

Lists all Amazon Chime AppInstances created under a single AWS account.

Parameter Syntax

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

Parameter Details

Members

MaxResults

Type: int

The maximum number of AppInstances that you want to return.

NextToken

Type: string

The token passed by previous API requests until you reach the maximum number of AppInstances.

Result Syntax

[
    'AppInstances' => [
        [
            'AppInstanceArn' => '<string>',
            'Metadata' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

AppInstances

Type: Array of AppInstanceSummary structures

The information for each AppInstance.

NextToken

Type: string

The token passed by previous API requests until the maximum number of AppInstances is reached.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ForbiddenException:
The client is permanently forbidden from making the request.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags applied to an Amazon Chime SDK identity resource.

Parameter Syntax

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

Parameter Details

Members

ResourceARN

Required: Yes
Type: string

The ARN of the resource.

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

Tags

Type: Array of Tag structures

The tag key-value pairs.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ForbiddenException:
The client is permanently forbidden from making the request.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ThrottledClientException:
The client exceeded its request rate limit.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

PutAppInstanceRetentionSettings

$result = $client->putAppInstanceRetentionSettings([/* ... */]);
$promise = $client->putAppInstanceRetentionSettingsAsync([/* ... */]);

Sets the amount of time in days that a given AppInstance retains data.

Parameter Syntax

$result = $client->putAppInstanceRetentionSettings([
    'AppInstanceArn' => '<string>', // REQUIRED
    'AppInstanceRetentionSettings' => [ // REQUIRED
        'ChannelRetentionSettings' => [
            'RetentionDays' => <integer>,
        ],
    ],
]);

Parameter Details

Members

AppInstanceArn

Required: Yes
Type: string

The ARN of the AppInstance.

AppInstanceRetentionSettings

Required: Yes
Type: AppInstanceRetentionSettings structure

The time in days to retain data. Data type: number.

Result Syntax

[
    'AppInstanceRetentionSettings' => [
        'ChannelRetentionSettings' => [
            'RetentionDays' => <integer>,
        ],
    ],
    'InitiateDeletionTimestamp' => <DateTime>,
]

Result Details

Members

AppInstanceRetentionSettings

Type: AppInstanceRetentionSettings structure

The time in days to retain data. Data type: number.

InitiateDeletionTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the API deletes data.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ForbiddenException:
The client is permanently forbidden from making the request.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

PutAppInstanceUserExpirationSettings

$result = $client->putAppInstanceUserExpirationSettings([/* ... */]);
$promise = $client->putAppInstanceUserExpirationSettingsAsync([/* ... */]);

Sets the number of days before the AppInstanceUser is automatically deleted.

A background process deletes expired AppInstanceUsers within 6 hours of expiration. Actual deletion times may vary.

Expired AppInstanceUsers that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.

Parameter Syntax

$result = $client->putAppInstanceUserExpirationSettings([
    'AppInstanceUserArn' => '<string>', // REQUIRED
    'ExpirationSettings' => [
        'ExpirationCriterion' => 'CREATED_TIMESTAMP', // REQUIRED
        'ExpirationDays' => <integer>, // REQUIRED
    ],
]);

Parameter Details

Members

AppInstanceUserArn

Required: Yes
Type: string

The ARN of the AppInstanceUser.

ExpirationSettings

Type: ExpirationSettings structure

Settings that control the interval after which an AppInstanceUser is automatically deleted.

Result Syntax

[
    'AppInstanceUserArn' => '<string>',
    'ExpirationSettings' => [
        'ExpirationCriterion' => 'CREATED_TIMESTAMP',
        'ExpirationDays' => <integer>,
    ],
]

Result Details

Members

AppInstanceUserArn

Type: string

The ARN of the AppInstanceUser.

ExpirationSettings

Type: ExpirationSettings structure

Settings that control the interval after which an AppInstanceUser is automatically deleted.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ConflictException:
The request could not be processed because of conflict in the current state of the resource.
ForbiddenException:
The client is permanently forbidden from making the request.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

RegisterAppInstanceUserEndpoint

$result = $client->registerAppInstanceUserEndpoint([/* ... */]);
$promise = $client->registerAppInstanceUserEndpointAsync([/* ... */]);

Registers an endpoint under an Amazon Chime AppInstanceUser. The endpoint receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.

Parameter Syntax

$result = $client->registerAppInstanceUserEndpoint([
    'AllowMessages' => 'ALL|NONE',
    'AppInstanceUserArn' => '<string>', // REQUIRED
    'ClientRequestToken' => '<string>', // REQUIRED
    'EndpointAttributes' => [ // REQUIRED
        'DeviceToken' => '<string>', // REQUIRED
        'VoipDeviceToken' => '<string>',
    ],
    'Name' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
    'Type' => 'APNS|APNS_SANDBOX|GCM', // REQUIRED
]);

Parameter Details

Members

AllowMessages

Type: string

Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint receives all messages. NONE indicates the endpoint receives no messages.

AppInstanceUserArn

Required: Yes
Type: string

The ARN of the AppInstanceUser.

ClientRequestToken

Required: Yes
Type: string

The unique ID assigned to the request. Use different tokens to register other endpoints.

EndpointAttributes

Required: Yes
Type: EndpointAttributes structure

The attributes of an Endpoint.

Name

Type: string

The name of the AppInstanceUserEndpoint.

ResourceArn

Required: Yes
Type: string

The ARN of the resource to which the endpoint belongs.

Type

Required: Yes
Type: string

The type of the AppInstanceUserEndpoint. Supported types:

APNS: The mobile notification service for an Apple device.
APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.
GCM: The mobile notification service for an Android device.

Populate the ResourceArn value of each type as PinpointAppArn.

Result Syntax

[
    'AppInstanceUserArn' => '<string>',
    'EndpointId' => '<string>',
]

Result Details

Members

AppInstanceUserArn

Type: string

The ARN of the AppInstanceUser.

EndpointId

Type: string

The unique identifier of the AppInstanceUserEndpoint.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ConflictException:
The request could not be processed because of conflict in the current state of the resource.
ForbiddenException:
The client is permanently forbidden from making the request.
ResourceLimitExceededException:
The request exceeds the resource limit.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Applies the specified tags to the specified Amazon Chime SDK identity resource.

Parameter Syntax

$result = $client->tagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ResourceARN

Required: Yes
Type: string

The resource ARN.

Tags

Required: Yes
Type: Array of Tag structures

The tag key-value pairs.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ForbiddenException:
The client is permanently forbidden from making the request.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ResourceLimitExceededException:
The request exceeds the resource limit.
ThrottledClientException:
The client exceeded its request rate limit.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes the specified tags from the specified Amazon Chime SDK identity resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceARN

Required: Yes
Type: string

The resource ARN.

TagKeys

Required: Yes
Type: Array of strings

The tag keys.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ForbiddenException:
The client is permanently forbidden from making the request.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ThrottledClientException:
The client exceeded its request rate limit.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

UpdateAppInstance

$result = $client->updateAppInstance([/* ... */]);
$promise = $client->updateAppInstanceAsync([/* ... */]);

Updates AppInstance metadata.

Parameter Syntax

$result = $client->updateAppInstance([
    'AppInstanceArn' => '<string>', // REQUIRED
    'Metadata' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

AppInstanceArn

Required: Yes
Type: string

The ARN of the AppInstance.

Metadata

Required: Yes
Type: string

The metadata that you want to change.

Name

Required: Yes
Type: string

The name that you want to change.

Result Syntax

[
    'AppInstanceArn' => '<string>',
]

Result Details

Members

AppInstanceArn

Type: string

The ARN of the AppInstance.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ConflictException:
The request could not be processed because of conflict in the current state of the resource.
ForbiddenException:
The client is permanently forbidden from making the request.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

UpdateAppInstanceBot

$result = $client->updateAppInstanceBot([/* ... */]);
$promise = $client->updateAppInstanceBotAsync([/* ... */]);

Updates the name and metadata of an AppInstanceBot.

Parameter Syntax

$result = $client->updateAppInstanceBot([
    'AppInstanceBotArn' => '<string>', // REQUIRED
    'Configuration' => [
        'Lex' => [ // REQUIRED
            'InvokedBy' => [
                'StandardMessages' => 'AUTO|ALL|MENTIONS|NONE', // REQUIRED
                'TargetedMessages' => 'ALL|NONE', // REQUIRED
            ],
            'LexBotAliasArn' => '<string>', // REQUIRED
            'LocaleId' => '<string>', // REQUIRED
            'RespondsTo' => 'STANDARD_MESSAGES',
            'WelcomeIntent' => '<string>',
        ],
    ],
    'Metadata' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

AppInstanceBotArn

Required: Yes
Type: string

The ARN of the AppInstanceBot.

Configuration

Type: Configuration structure

The configuration for the bot update.

Metadata

Required: Yes
Type: string

The metadata of the AppInstanceBot.

Name

Required: Yes
Type: string

The name of the AppInstanceBot.

Result Syntax

[
    'AppInstanceBotArn' => '<string>',
]

Result Details

Members

AppInstanceBotArn

Type: string

The ARN of the AppInstanceBot.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ConflictException:
The request could not be processed because of conflict in the current state of the resource.
ForbiddenException:
The client is permanently forbidden from making the request.
ResourceLimitExceededException:
The request exceeds the resource limit.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

UpdateAppInstanceUser

$result = $client->updateAppInstanceUser([/* ... */]);
$promise = $client->updateAppInstanceUserAsync([/* ... */]);

Updates the details of an AppInstanceUser. You can update names and metadata.

Parameter Syntax

$result = $client->updateAppInstanceUser([
    'AppInstanceUserArn' => '<string>', // REQUIRED
    'Metadata' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

AppInstanceUserArn

Required: Yes
Type: string

The ARN of the AppInstanceUser.

Metadata

Required: Yes
Type: string

The metadata of the AppInstanceUser.

Name

Required: Yes
Type: string

The name of the AppInstanceUser.

Result Syntax

[
    'AppInstanceUserArn' => '<string>',
]

Result Details

Members

AppInstanceUserArn

Type: string

The ARN of the AppInstanceUser.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ConflictException:
The request could not be processed because of conflict in the current state of the resource.
ForbiddenException:
The client is permanently forbidden from making the request.
ResourceLimitExceededException:
The request exceeds the resource limit.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

UpdateAppInstanceUserEndpoint

$result = $client->updateAppInstanceUserEndpoint([/* ... */]);
$promise = $client->updateAppInstanceUserEndpointAsync([/* ... */]);

Updates the details of an AppInstanceUserEndpoint. You can update the name and AllowMessage values.

Parameter Syntax

$result = $client->updateAppInstanceUserEndpoint([
    'AllowMessages' => 'ALL|NONE',
    'AppInstanceUserArn' => '<string>', // REQUIRED
    'EndpointId' => '<string>', // REQUIRED
    'Name' => '<string>',
]);

Parameter Details

Members

AllowMessages

Type: string

Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.

AppInstanceUserArn

Required: Yes
Type: string

The ARN of the AppInstanceUser.

EndpointId

Required: Yes
Type: string

The unique identifier of the AppInstanceUserEndpoint.

Name

Type: string

The name of the AppInstanceUserEndpoint.

Result Syntax

[
    'AppInstanceUserArn' => '<string>',
    'EndpointId' => '<string>',
]

Result Details

Members

AppInstanceUserArn

Type: string

The ARN of the AppInstanceUser.

EndpointId

Type: string

The unique identifier of the AppInstanceUserEndpoint.

Errors

BadRequestException:
The input parameters don't match the service's restrictions.
ConflictException:
The request could not be processed because of conflict in the current state of the resource.
ForbiddenException:
The client is permanently forbidden from making the request.
ThrottledClientException:
The client exceeded its request rate limit.
UnauthorizedClientException:
The client is not currently authorized to make the request.
ServiceUnavailableException:
The service is currently unavailable.
ServiceFailureException:
The service encountered an unexpected error.

Shapes

AppInstance

Description

The details of an AppInstance, an instance of an Amazon Chime SDK messaging application.

Members

AppInstanceArn

Type: string

The ARN of the messaging instance.

CreatedTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which an AppInstance was created. In epoch milliseconds.

LastUpdatedTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time an AppInstance was last updated. In epoch milliseconds.

Metadata

Type: string

The metadata of an AppInstance.

Name

Type: string

The name of an AppInstance.

AppInstanceAdmin

Description

The name and ARN of the admin for the AppInstance.

Members

Admin

Type: Identity structure

The AppInstanceAdmin data.

AppInstanceArn

Type: string

The ARN of the AppInstance for which the user is an administrator.

CreatedTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which an administrator was created.

AppInstanceAdminSummary

Description

Summary of the details of an AppInstanceAdmin.

Members

Admin

Type: Identity structure

The details of the AppInstanceAdmin.

AppInstanceBot

Description

An Amazon Lex V2 chat bot created under an AppInstance.

Members

AppInstanceBotArn

Type: string

The ARN of the AppInstanceBot.

Configuration

Type: Configuration structure

The data processing instructions for an AppInstanceBot.

CreatedTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the AppInstanceBot was created.

LastUpdatedTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the AppInstanceBot was last updated.

Metadata

Type: string

The metadata for an AppInstanceBot.

Name

Type: string

The name of the AppInstanceBot.

AppInstanceBotSummary

Description

High-level information about an AppInstanceBot.

Members

AppInstanceBotArn

Type: string

The ARN of the AppInstanceBot.

Metadata

Type: string

The metadata of the AppInstanceBot.

Name

Type: string

The name of the AppInstanceBox.

AppInstanceRetentionSettings

Description

The details of the data-retention settings for an AppInstance.

Members

ChannelRetentionSettings

Type: ChannelRetentionSettings structure

The length of time in days to retain the messages in a channel.

AppInstanceSummary

Description

Summary of the data for an AppInstance.

Members

AppInstanceArn

Type: string

The AppInstance ARN.

Metadata

Type: string

The metadata of the AppInstance.

Name

Type: string

The name of the AppInstance.

AppInstanceUser

Description

The details of an AppInstanceUser.

Members

AppInstanceUserArn

Type: string

The ARN of the AppInstanceUser.

CreatedTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the AppInstanceUser was created.

ExpirationSettings

Type: ExpirationSettings structure

The interval after which an AppInstanceUser is automatically deleted.

LastUpdatedTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the AppInstanceUser was last updated.

Metadata

Type: string

The metadata of the AppInstanceUser.

Name

Type: string

The name of the AppInstanceUser.

AppInstanceUserEndpoint

Description

An endpoint under an Amazon Chime AppInstanceUser that receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.

Members

AllowMessages

Type: string

AppInstanceUserArn

Type: string

The ARN of the AppInstanceUser.

CreatedTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which an AppInstanceUserEndpoint was created.

EndpointAttributes

Type: EndpointAttributes structure

The attributes of an Endpoint.

EndpointId

Type: string

The unique identifier of the AppInstanceUserEndpoint.

EndpointState

Type: EndpointState structure

A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values:

ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE, the EndpointStatusReason remains empty.
INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive message. When INACTIVE, the corresponding reason will be conveyed through EndpointStatusReason.
INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device token
INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input through the ResourceArn field.

LastUpdatedTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which an AppInstanceUserEndpoint was last updated.

Name

Type: string

The name of the AppInstanceUserEndpoint.

ResourceArn

Type: string

The ARN of the resource to which the endpoint belongs.

Type

Type: string

The type of the AppInstanceUserEndpoint.

AppInstanceUserEndpointSummary

Description

Summary of the details of an AppInstanceUserEndpoint.

Members

AllowMessages

Type: string

BBoolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.

AppInstanceUserArn

Type: string

The ARN of the AppInstanceUser.

EndpointId

Type: string

The unique identifier of the AppInstanceUserEndpoint.

EndpointState

Type: EndpointState structure

A read-only field that represent the state of an AppInstanceUserEndpoint.

Name

Type: string

The name of the AppInstanceUserEndpoint.

Type

Type: string

The type of the AppInstanceUserEndpoint.

AppInstanceUserSummary

Description

Summary of the details of an AppInstanceUser.

Members

AppInstanceUserArn

Type: string

The ARN of the AppInstanceUser.

Metadata

Type: string

The metadata of the AppInstanceUser.

Name

Type: string

The name of an AppInstanceUser.

BadRequestException

Description

The input parameters don't match the service's restrictions.

Members

Code

Type: string

Message

Type: string

ChannelRetentionSettings

Description

The details of the retention settings for a channel.

Members

RetentionDays

Type: int

The time in days to retain the messages in a channel.

Configuration

Description

A structure that contains configuration data.

Members

Lex

Required: Yes
Type: LexConfiguration structure

The configuration for an Amazon Lex V2 bot.

ConflictException

Description

The request could not be processed because of conflict in the current state of the resource.

Members

Code

Type: string

Message

Type: string

EndpointAttributes

Description

The attributes of an Endpoint.

Members

DeviceToken

Required: Yes
Type: string

The device token for the GCM, APNS, and APNS_SANDBOX endpoint types.

VoipDeviceToken

Type: string

The VOIP device token for the APNS and APNS_SANDBOX endpoint types.

EndpointState

Description

A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values:

ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE, the EndpointStatusReason remains empty.
INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive message. When INACTIVE, the corresponding reason will be conveyed through EndpointStatusReason.
INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device token
INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input through the ResourceArn field.

Members

Status

Required: Yes
Type: string

Enum that indicates the Status of an AppInstanceUserEndpoint.

StatusReason

Type: string

The reason for the EndpointStatus.

ExpirationSettings

Description

Determines the interval after which an AppInstanceUser is automatically deleted.

Members

ExpirationCriterion

Required: Yes
Type: string

Specifies the conditions under which an AppInstanceUser will expire.

ExpirationDays

Required: Yes
Type: int

The period in days after which an AppInstanceUser will be automatically deleted.

ForbiddenException

Description

The client is permanently forbidden from making the request.

Members

Code

Type: string

Message

Type: string

Identity

Description

The details of a user or bot.

Members

Arn

Type: string

The ARN in an Identity.

Name

Type: string

The name in an Identity.

InvokedBy

Description

Specifies the type of message that triggers a bot.

Members

StandardMessages

Required: Yes
Type: string

Sets standard messages as the bot trigger. For standard messages:

ALL: The bot processes all standard messages.
AUTO: The bot responds to ALL messages when the channel has one other non-hidden member, and responds to MENTIONS when the channel has more than one other non-hidden member.
MENTIONS: The bot processes all standard messages that have a message attribute with CHIME.mentions and a value of the bot ARN.
NONE: The bot processes no standard messages.

TargetedMessages

Required: Yes
Type: string

Sets targeted messages as the bot trigger. For targeted messages:

ALL: The bot processes all TargetedMessages sent to it. The bot then responds with a targeted message back to the sender.
NONE: The bot processes no targeted messages.

LexConfiguration

Description

The configuration for an Amazon Lex V2 bot.

Members

InvokedBy

Type: InvokedBy structure

Specifies the type of message that triggers a bot.

LexBotAliasArn

Required: Yes
Type: string

The ARN of the Amazon Lex V2 bot's alias. The ARN uses this format: arn:aws:lex:REGION:ACCOUNT:bot-alias/MYBOTID/MYBOTALIAS

LocaleId

Required: Yes
Type: string

Identifies the Amazon Lex V2 bot's language and locale. The string must match one of the supported locales in Amazon Lex V2. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages in the Amazon Lex V2 Developer Guide.

RespondsTo

Type: string

Deprecated. Use InvokedBy instead.

Determines whether the Amazon Lex V2 bot responds to all standard messages. Control messages are not supported.

WelcomeIntent

Type: string

The name of the welcome intent configured in the Amazon Lex V2 bot.

NotFoundException

Description

One or more of the resources in the request does not exist in the system.

Members

Code

Type: string

Message

Type: string

ResourceLimitExceededException

Description

The request exceeds the resource limit.

Members

Code

Type: string

Message

Type: string

ServiceFailureException

Description

The service encountered an unexpected error.

Members

Code

Type: string

Message

Type: string

ServiceUnavailableException

Description

The service is currently unavailable.

Members

Code

Type: string

Message

Type: string

ThrottledClientException

Description

The client exceeded its request rate limit.

Members

Code

Type: string

Message

Type: string

UnauthorizedClientException

Description

The client is not currently authorized to make the request.

Members

Code

Type: string

Message

Type: string

Amazon Chime SDK Identity 2021-04-20

Operation Summary

Paginators

Operations

CreateAppInstance

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateAppInstanceAdmin

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateAppInstanceBot

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateAppInstanceUser

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteAppInstance

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteAppInstanceAdmin

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteAppInstanceBot

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteAppInstanceUser

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeregisterAppInstanceUserEndpoint

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DescribeAppInstance

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeAppInstanceAdmin