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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.