'2.0', 'service' => '

The Amazon Chime SDK Identity APIs in this section allow software developers to create and manage unique instances of their messaging applications. These APIs provide the overarching framework for creating and sending messages. For more information about the identity APIs, refer to Amazon Chime SDK identity.

', 'operations' => [ 'CreateAppInstance' => '

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

', 'CreateAppInstanceAdmin' => '

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.

', 'CreateAppInstanceBot' => '

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

', 'CreateAppInstanceUser' => '

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

', 'DeleteAppInstance' => '

Deletes an AppInstance and all associated data asynchronously.

', 'DeleteAppInstanceAdmin' => '

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

', 'DeleteAppInstanceBot' => '

Deletes an AppInstanceBot.

', 'DeleteAppInstanceUser' => '

Deletes an AppInstanceUser.

', 'DeregisterAppInstanceUserEndpoint' => '

Deregisters an AppInstanceUserEndpoint.

', 'DescribeAppInstance' => '

Returns the full details of an AppInstance.

', 'DescribeAppInstanceAdmin' => '

Returns the full details of an AppInstanceAdmin.

', 'DescribeAppInstanceBot' => '

The AppInstanceBot\'s information.

', 'DescribeAppInstanceUser' => '

Returns the full details of an AppInstanceUser.

', 'DescribeAppInstanceUserEndpoint' => '

Returns the full details of an AppInstanceUserEndpoint.

', 'GetAppInstanceRetentionSettings' => '

Gets the retention settings for an AppInstance.

', 'ListAppInstanceAdmins' => '

Returns a list of the administrators in the AppInstance.

', 'ListAppInstanceBots' => '

Lists all AppInstanceBots created under a single AppInstance.

', 'ListAppInstanceUserEndpoints' => '

Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.

', 'ListAppInstanceUsers' => '

List all AppInstanceUsers created under a single AppInstance.

', 'ListAppInstances' => '

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

', 'ListTagsForResource' => '

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

', 'PutAppInstanceRetentionSettings' => '

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

', 'PutAppInstanceUserExpirationSettings' => '

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.

', 'RegisterAppInstanceUserEndpoint' => '

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.

', 'TagResource' => '

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

', 'UntagResource' => '

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

', 'UpdateAppInstance' => '

Updates AppInstance metadata.

', 'UpdateAppInstanceBot' => '

Updates the name and metadata of an AppInstanceBot.

', 'UpdateAppInstanceUser' => '

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

', 'UpdateAppInstanceUserEndpoint' => '

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

', ], 'shapes' => [ 'AllowMessages' => [ 'base' => NULL, 'refs' => [ 'AppInstanceUserEndpoint$AllowMessages' => '

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.

', 'AppInstanceUserEndpointSummary$AllowMessages' => '

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.

', 'RegisterAppInstanceUserEndpointRequest$AllowMessages' => '

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.

', 'UpdateAppInstanceUserEndpointRequest$AllowMessages' => '

', ], ], 'AppInstance' => [ 'base' => '

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

', 'refs' => [ 'DescribeAppInstanceResponse$AppInstance' => '

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

', ], ], 'AppInstanceAdmin' => [ 'base' => '

The name and ARN of the admin for the AppInstance.

', 'refs' => [ 'DescribeAppInstanceAdminResponse$AppInstanceAdmin' => '

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

', ], ], 'AppInstanceAdminList' => [ 'base' => NULL, 'refs' => [ 'ListAppInstanceAdminsResponse$AppInstanceAdmins' => '

The information for each administrator.

', ], ], 'AppInstanceAdminSummary' => [ 'base' => '

Summary of the details of an AppInstanceAdmin.

', 'refs' => [ 'AppInstanceAdminList$member' => NULL, ], ], 'AppInstanceBot' => [ 'base' => '

An Amazon Lex V2 chat bot created under an AppInstance.

', 'refs' => [ 'DescribeAppInstanceBotResponse$AppInstanceBot' => '

The detials of the AppInstanceBot.

', ], ], 'AppInstanceBotList' => [ 'base' => NULL, 'refs' => [ 'ListAppInstanceBotsResponse$AppInstanceBots' => '

The information for each requested AppInstanceBot.

', ], ], 'AppInstanceBotSummary' => [ 'base' => '

High-level information about an AppInstanceBot.

', 'refs' => [ 'AppInstanceBotList$member' => NULL, ], ], 'AppInstanceList' => [ 'base' => NULL, 'refs' => [ 'ListAppInstancesResponse$AppInstances' => '

The information for each AppInstance.

', ], ], 'AppInstanceRetentionSettings' => [ 'base' => '

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

', 'refs' => [ 'GetAppInstanceRetentionSettingsResponse$AppInstanceRetentionSettings' => '

The retention settings for the AppInstance.

', 'PutAppInstanceRetentionSettingsRequest$AppInstanceRetentionSettings' => '

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

', 'PutAppInstanceRetentionSettingsResponse$AppInstanceRetentionSettings' => '

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

', ], ], 'AppInstanceSummary' => [ 'base' => '

Summary of the data for an AppInstance.

', 'refs' => [ 'AppInstanceList$member' => NULL, ], ], 'AppInstanceUser' => [ 'base' => '

The details of an AppInstanceUser.

', 'refs' => [ 'DescribeAppInstanceUserResponse$AppInstanceUser' => '

The name of the AppInstanceUser.

', ], ], 'AppInstanceUserEndpoint' => [ 'base' => '

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.

', 'refs' => [ 'DescribeAppInstanceUserEndpointResponse$AppInstanceUserEndpoint' => '

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.

', ], ], 'AppInstanceUserEndpointSummary' => [ 'base' => '

Summary of the details of an AppInstanceUserEndpoint.

', 'refs' => [ 'AppInstanceUserEndpointSummaryList$member' => NULL, ], ], 'AppInstanceUserEndpointSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListAppInstanceUserEndpointsResponse$AppInstanceUserEndpoints' => '

The information for each requested AppInstanceUserEndpoint.

', ], ], 'AppInstanceUserEndpointType' => [ 'base' => NULL, 'refs' => [ 'AppInstanceUserEndpoint$Type' => '

The type of the AppInstanceUserEndpoint.

', 'AppInstanceUserEndpointSummary$Type' => '

The type of the AppInstanceUserEndpoint.

', 'RegisterAppInstanceUserEndpointRequest$Type' => '

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.

', ], ], 'AppInstanceUserList' => [ 'base' => NULL, 'refs' => [ 'ListAppInstanceUsersResponse$AppInstanceUsers' => '

The information for each requested AppInstanceUser.

', ], ], 'AppInstanceUserSummary' => [ 'base' => '

Summary of the details of an AppInstanceUser.

', 'refs' => [ 'AppInstanceUserList$member' => NULL, ], ], 'BadRequestException' => [ 'base' => '

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

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

The details of the retention settings for a channel.

', 'refs' => [ 'AppInstanceRetentionSettings$ChannelRetentionSettings' => '

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

', ], ], 'ChimeArn' => [ 'base' => NULL, 'refs' => [ 'AppInstance$AppInstanceArn' => '

The ARN of the messaging instance.

', 'AppInstanceAdmin$AppInstanceArn' => '

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

', 'AppInstanceBot$AppInstanceBotArn' => '

The ARN of the AppInstanceBot.

', 'AppInstanceBotSummary$AppInstanceBotArn' => '

The ARN of the AppInstanceBot.

', 'AppInstanceSummary$AppInstanceArn' => '

The AppInstance ARN.

', 'AppInstanceUser$AppInstanceUserArn' => '

The ARN of the AppInstanceUser.

', 'AppInstanceUserEndpoint$AppInstanceUserArn' => '

The ARN of the AppInstanceUser.

', 'AppInstanceUserEndpoint$ResourceArn' => '

The ARN of the resource to which the endpoint belongs.

', 'AppInstanceUserEndpointSummary$AppInstanceUserArn' => '

The ARN of the AppInstanceUser.

', 'AppInstanceUserSummary$AppInstanceUserArn' => '

The ARN of the AppInstanceUser.

', 'CreateAppInstanceAdminRequest$AppInstanceAdminArn' => '

The ARN of the administrator of the current AppInstance.

', 'CreateAppInstanceAdminRequest$AppInstanceArn' => '

The ARN of the AppInstance.

', 'CreateAppInstanceAdminResponse$AppInstanceArn' => '

The ARN of the of the admin for the AppInstance.

', 'CreateAppInstanceBotRequest$AppInstanceArn' => '

The ARN of the AppInstance request.

', 'CreateAppInstanceBotResponse$AppInstanceBotArn' => '

The ARN of the AppinstanceBot.

', 'CreateAppInstanceResponse$AppInstanceArn' => '

The Amazon Resource Number (ARN) of the AppInstance.

', 'CreateAppInstanceUserRequest$AppInstanceArn' => '

The ARN of the AppInstance request.

', 'CreateAppInstanceUserResponse$AppInstanceUserArn' => '

The user\'s ARN.

', 'DeleteAppInstanceAdminRequest$AppInstanceAdminArn' => '

The ARN of the AppInstance\'s administrator.

', 'DeleteAppInstanceAdminRequest$AppInstanceArn' => '

The ARN of the AppInstance.

', 'DeleteAppInstanceBotRequest$AppInstanceBotArn' => '

The ARN of the AppInstanceBot being deleted.

', 'DeleteAppInstanceRequest$AppInstanceArn' => '

The ARN of the AppInstance.

', 'DeleteAppInstanceUserRequest$AppInstanceUserArn' => '

The ARN of the user request being deleted.

', 'DeregisterAppInstanceUserEndpointRequest$AppInstanceUserArn' => '

The ARN of the AppInstanceUser.

', 'DescribeAppInstanceAdminRequest$AppInstanceAdminArn' => '

The ARN of the AppInstanceAdmin.

', 'DescribeAppInstanceAdminRequest$AppInstanceArn' => '

The ARN of the AppInstance.

', 'DescribeAppInstanceBotRequest$AppInstanceBotArn' => '

The ARN of the AppInstanceBot.

', 'DescribeAppInstanceRequest$AppInstanceArn' => '

The ARN of the AppInstance.

', 'DescribeAppInstanceUserRequest$AppInstanceUserArn' => '

The ARN of the AppInstanceUser.

', 'GetAppInstanceRetentionSettingsRequest$AppInstanceArn' => '

The ARN of the AppInstance.

', 'Identity$Arn' => '

The ARN in an Identity.

', 'ListAppInstanceAdminsRequest$AppInstanceArn' => '

The ARN of the AppInstance.

', 'ListAppInstanceAdminsResponse$AppInstanceArn' => '

The ARN of the AppInstance.

', 'ListAppInstanceBotsRequest$AppInstanceArn' => '

The ARN of the AppInstance.

', 'ListAppInstanceBotsResponse$AppInstanceArn' => '

The ARN of the AppInstance.

', 'ListAppInstanceUsersRequest$AppInstanceArn' => '

The ARN of the AppInstance.

', 'ListAppInstanceUsersResponse$AppInstanceArn' => '

The ARN of the AppInstance.

', 'ListTagsForResourceRequest$ResourceARN' => '

The ARN of the resource.

', 'PutAppInstanceRetentionSettingsRequest$AppInstanceArn' => '

The ARN of the AppInstance.

', 'PutAppInstanceUserExpirationSettingsRequest$AppInstanceUserArn' => '

The ARN of the AppInstanceUser.

', 'PutAppInstanceUserExpirationSettingsResponse$AppInstanceUserArn' => '

The ARN of the AppInstanceUser.

', 'RegisterAppInstanceUserEndpointRequest$ResourceArn' => '

The ARN of the resource to which the endpoint belongs.

', 'RegisterAppInstanceUserEndpointResponse$AppInstanceUserArn' => '

The ARN of the AppInstanceUser.

', 'TagResourceRequest$ResourceARN' => '

The resource ARN.

', 'UntagResourceRequest$ResourceARN' => '

The resource ARN.

', 'UpdateAppInstanceBotRequest$AppInstanceBotArn' => '

The ARN of the AppInstanceBot.

', 'UpdateAppInstanceBotResponse$AppInstanceBotArn' => '

The ARN of the AppInstanceBot.

', 'UpdateAppInstanceRequest$AppInstanceArn' => '

The ARN of the AppInstance.

', 'UpdateAppInstanceResponse$AppInstanceArn' => '

The ARN of the AppInstance.

', 'UpdateAppInstanceUserEndpointRequest$AppInstanceUserArn' => '

The ARN of the AppInstanceUser.

', 'UpdateAppInstanceUserEndpointResponse$AppInstanceUserArn' => '

The ARN of the AppInstanceUser.

', 'UpdateAppInstanceUserRequest$AppInstanceUserArn' => '

The ARN of the AppInstanceUser.

', 'UpdateAppInstanceUserResponse$AppInstanceUserArn' => '

The ARN of the AppInstanceUser.

', ], ], 'ClientRequestToken' => [ 'base' => NULL, 'refs' => [ 'CreateAppInstanceBotRequest$ClientRequestToken' => '

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

', 'CreateAppInstanceRequest$ClientRequestToken' => '

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

', 'CreateAppInstanceUserRequest$ClientRequestToken' => '

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

', 'RegisterAppInstanceUserEndpointRequest$ClientRequestToken' => '

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

', ], ], 'Configuration' => [ 'base' => '

A structure that contains configuration data.

', 'refs' => [ 'AppInstanceBot$Configuration' => '

The data processing instructions for an AppInstanceBot.

', 'CreateAppInstanceBotRequest$Configuration' => '

Configuration information about the Amazon Lex V2 V2 bot.

', 'UpdateAppInstanceBotRequest$Configuration' => '

The configuration for the bot update.

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

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

', 'refs' => [], ], 'CreateAppInstanceAdminRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppInstanceAdminResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppInstanceBotRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppInstanceBotResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppInstanceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppInstanceUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppInstanceUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppInstanceAdminRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppInstanceBotRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppInstanceUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterAppInstanceUserEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppInstanceAdminRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppInstanceAdminResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppInstanceBotRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppInstanceBotResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppInstanceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppInstanceUserEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppInstanceUserEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppInstanceUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAppInstanceUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'EndpointAttributes' => [ 'base' => '

The attributes of an Endpoint.

', 'refs' => [ 'AppInstanceUserEndpoint$EndpointAttributes' => '

The attributes of an Endpoint.

', 'RegisterAppInstanceUserEndpointRequest$EndpointAttributes' => '

The attributes of an Endpoint.

', ], ], 'EndpointState' => [ 'base' => '

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.

', 'refs' => [ 'AppInstanceUserEndpoint$EndpointState' => '

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.

', 'AppInstanceUserEndpointSummary$EndpointState' => '

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

', ], ], 'EndpointStatus' => [ 'base' => NULL, 'refs' => [ 'EndpointState$Status' => '

Enum that indicates the Status of an AppInstanceUserEndpoint.

', ], ], 'EndpointStatusReason' => [ 'base' => NULL, 'refs' => [ 'EndpointState$StatusReason' => '

The reason for the EndpointStatus.

', ], ], 'ErrorCode' => [ 'base' => NULL, 'refs' => [ 'BadRequestException$Code' => NULL, 'ConflictException$Code' => NULL, 'ForbiddenException$Code' => NULL, 'NotFoundException$Code' => NULL, 'ResourceLimitExceededException$Code' => NULL, 'ServiceFailureException$Code' => NULL, 'ServiceUnavailableException$Code' => NULL, 'ThrottledClientException$Code' => NULL, 'UnauthorizedClientException$Code' => NULL, ], ], 'ExpirationCriterion' => [ 'base' => NULL, 'refs' => [ 'ExpirationSettings$ExpirationCriterion' => '

Specifies the conditions under which an AppInstanceUser will expire.

', ], ], 'ExpirationDays' => [ 'base' => NULL, 'refs' => [ 'ExpirationSettings$ExpirationDays' => '

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

', ], ], 'ExpirationSettings' => [ 'base' => '

Determines the interval after which an AppInstanceUser is automatically deleted.

', 'refs' => [ 'AppInstanceUser$ExpirationSettings' => '

The interval after which an AppInstanceUser is automatically deleted.

', 'CreateAppInstanceUserRequest$ExpirationSettings' => '

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

', 'PutAppInstanceUserExpirationSettingsRequest$ExpirationSettings' => '

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

', 'PutAppInstanceUserExpirationSettingsResponse$ExpirationSettings' => '

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

', ], ], 'ForbiddenException' => [ 'base' => '

The client is permanently forbidden from making the request.

', 'refs' => [], ], 'GetAppInstanceRetentionSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAppInstanceRetentionSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'Identity' => [ 'base' => '

The details of a user or bot.

', 'refs' => [ 'AppInstanceAdmin$Admin' => '

The AppInstanceAdmin data.

', 'AppInstanceAdminSummary$Admin' => '

The details of the AppInstanceAdmin.

', 'CreateAppInstanceAdminResponse$AppInstanceAdmin' => '

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

', ], ], 'InvokedBy' => [ 'base' => '

Specifies the type of message that triggers a bot.

', 'refs' => [ 'LexConfiguration$InvokedBy' => '

Specifies the type of message that triggers a bot.

', ], ], 'LexBotAliasArn' => [ 'base' => NULL, 'refs' => [ 'LexConfiguration$LexBotAliasArn' => '

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

', ], ], 'LexConfiguration' => [ 'base' => '

The configuration for an Amazon Lex V2 bot.

', 'refs' => [ 'Configuration$Lex' => '

The configuration for an Amazon Lex V2 bot.

', ], ], 'LexIntentName' => [ 'base' => NULL, 'refs' => [ 'LexConfiguration$WelcomeIntent' => '

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

', ], ], 'ListAppInstanceAdminsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppInstanceAdminsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppInstanceBotsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppInstanceBotsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppInstanceUserEndpointsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppInstanceUserEndpointsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppInstanceUsersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppInstanceUsersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppInstancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppInstancesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListAppInstanceAdminsRequest$MaxResults' => '

The maximum number of administrators that you want to return.

', 'ListAppInstanceBotsRequest$MaxResults' => '

The maximum number of requests to return.

', 'ListAppInstanceUserEndpointsRequest$MaxResults' => '

The maximum number of endpoints that you want to return.

', 'ListAppInstanceUsersRequest$MaxResults' => '

The maximum number of requests that you want returned.

', 'ListAppInstancesRequest$MaxResults' => '

The maximum number of AppInstances that you want to return.

', ], ], 'Metadata' => [ 'base' => NULL, 'refs' => [ 'AppInstance$Metadata' => '

The metadata of an AppInstance.

', 'AppInstanceBot$Metadata' => '

The metadata for an AppInstanceBot.

', 'AppInstanceBotSummary$Metadata' => '

The metadata of the AppInstanceBot.

', 'AppInstanceSummary$Metadata' => '

The metadata of the AppInstance.

', 'AppInstanceUser$Metadata' => '

The metadata of the AppInstanceUser.

', 'AppInstanceUserSummary$Metadata' => '

The metadata of the AppInstanceUser.

', 'CreateAppInstanceBotRequest$Metadata' => '

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

', 'CreateAppInstanceRequest$Metadata' => '

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

', 'CreateAppInstanceUserRequest$Metadata' => '

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

', 'UpdateAppInstanceBotRequest$Metadata' => '

The metadata of the AppInstanceBot.

', 'UpdateAppInstanceRequest$Metadata' => '

The metadata that you want to change.

', 'UpdateAppInstanceUserRequest$Metadata' => '

The metadata of the AppInstanceUser.

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

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

', 'ListAppInstanceAdminsResponse$NextToken' => '

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

', 'ListAppInstanceBotsRequest$NextToken' => '

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

', 'ListAppInstanceBotsResponse$NextToken' => '

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

', 'ListAppInstanceUserEndpointsRequest$NextToken' => '

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

', 'ListAppInstanceUserEndpointsResponse$NextToken' => '

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

', 'ListAppInstanceUsersRequest$NextToken' => '

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

', 'ListAppInstanceUsersResponse$NextToken' => '

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

', 'ListAppInstancesRequest$NextToken' => '

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

', 'ListAppInstancesResponse$NextToken' => '

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

', ], ], 'NonEmptyResourceName' => [ 'base' => NULL, 'refs' => [ 'AppInstance$Name' => '

The name of an AppInstance.

', 'AppInstanceSummary$Name' => '

The name of the AppInstance.

', 'CreateAppInstanceRequest$Name' => '

The name of the AppInstance.

', 'UpdateAppInstanceRequest$Name' => '

The name that you want to change.

', ], ], 'NonEmptySensitiveString1600' => [ 'base' => NULL, 'refs' => [ 'EndpointAttributes$DeviceToken' => '

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

', 'EndpointAttributes$VoipDeviceToken' => '

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

', ], ], 'NotFoundException' => [ 'base' => '

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

', 'refs' => [], ], 'PutAppInstanceRetentionSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAppInstanceRetentionSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutAppInstanceUserExpirationSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAppInstanceUserExpirationSettingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'RegisterAppInstanceUserEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterAppInstanceUserEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'ResourceLimitExceededException' => [ 'base' => '

The request exceeds the resource limit.

', 'refs' => [], ], 'ResourceName' => [ 'base' => NULL, 'refs' => [ 'AppInstanceBot$Name' => '

The name of the AppInstanceBot.

', 'AppInstanceBotSummary$Name' => '

The name of the AppInstanceBox.

', 'CreateAppInstanceBotRequest$Name' => '

The user\'s name.

', 'Identity$Name' => '

The name in an Identity.

', 'UpdateAppInstanceBotRequest$Name' => '

The name of the AppInstanceBot.

', ], ], 'RespondsTo' => [ 'base' => NULL, 'refs' => [ 'LexConfiguration$RespondsTo' => '

Deprecated. Use InvokedBy instead.

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

', ], ], 'RetentionDays' => [ 'base' => NULL, 'refs' => [ 'ChannelRetentionSettings$RetentionDays' => '

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

', ], ], 'SensitiveChimeArn' => [ 'base' => NULL, 'refs' => [ 'ListAppInstanceUserEndpointsRequest$AppInstanceUserArn' => '

The ARN of the AppInstanceUser.

', 'RegisterAppInstanceUserEndpointRequest$AppInstanceUserArn' => '

The ARN of the AppInstanceUser.

', ], ], 'SensitiveString1600' => [ 'base' => NULL, 'refs' => [ 'AppInstanceUserEndpoint$Name' => '

The name of the AppInstanceUserEndpoint.

', 'AppInstanceUserEndpointSummary$Name' => '

The name of the AppInstanceUserEndpoint.

', 'RegisterAppInstanceUserEndpointRequest$Name' => '

The name of the AppInstanceUserEndpoint.

', 'UpdateAppInstanceUserEndpointRequest$Name' => '

The name of the AppInstanceUserEndpoint.

', ], ], 'ServiceFailureException' => [ 'base' => '

The service encountered an unexpected error.

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

The service is currently unavailable.

', 'refs' => [], ], 'StandardMessages' => [ 'base' => NULL, 'refs' => [ 'InvokedBy$StandardMessages' => '

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.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'BadRequestException$Message' => NULL, 'ConflictException$Message' => NULL, 'ForbiddenException$Message' => NULL, 'LexConfiguration$LocaleId' => '

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.

', 'NotFoundException$Message' => NULL, 'ResourceLimitExceededException$Message' => NULL, 'ServiceFailureException$Message' => NULL, 'ServiceUnavailableException$Message' => NULL, 'ThrottledClientException$Message' => NULL, 'UnauthorizedClientException$Message' => NULL, ], ], 'String1600' => [ 'base' => NULL, 'refs' => [ 'DescribeAppInstanceUserEndpointRequest$AppInstanceUserArn' => '

The ARN of the AppInstanceUser.

', ], ], 'String64' => [ 'base' => NULL, 'refs' => [ 'AppInstanceUserEndpoint$EndpointId' => '

The unique identifier of the AppInstanceUserEndpoint.

', 'AppInstanceUserEndpointSummary$EndpointId' => '

The unique identifier of the AppInstanceUserEndpoint.

', 'DeregisterAppInstanceUserEndpointRequest$EndpointId' => '

The unique identifier of the AppInstanceUserEndpoint.

', 'DescribeAppInstanceUserEndpointRequest$EndpointId' => '

The unique identifier of the AppInstanceUserEndpoint.

', 'RegisterAppInstanceUserEndpointResponse$EndpointId' => '

The unique identifier of the AppInstanceUserEndpoint.

', 'UpdateAppInstanceUserEndpointRequest$EndpointId' => '

The unique identifier of the AppInstanceUserEndpoint.

', 'UpdateAppInstanceUserEndpointResponse$EndpointId' => '

The unique identifier of the AppInstanceUserEndpoint.

', ], ], 'Tag' => [ 'base' => '

A tag object containing a key-value pair.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '

The key in a tag.

', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => '

The tag keys.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreateAppInstanceBotRequest$Tags' => '

The tags assigned to the AppInstanceBot.

', 'CreateAppInstanceRequest$Tags' => '

Tags assigned to the AppInstance.

', 'CreateAppInstanceUserRequest$Tags' => '

Tags assigned to the AppInstanceUser.

', 'ListTagsForResourceResponse$Tags' => '

The tag key-value pairs.

', 'TagResourceRequest$Tags' => '

The tag key-value pairs.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '

The value in a tag.

', ], ], 'TargetedMessages' => [ 'base' => NULL, 'refs' => [ 'InvokedBy$TargetedMessages' => '

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.

', ], ], 'ThrottledClientException' => [ 'base' => '

The client exceeded its request rate limit.

', 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'AppInstance$CreatedTimestamp' => '

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

', 'AppInstance$LastUpdatedTimestamp' => '

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

', 'AppInstanceAdmin$CreatedTimestamp' => '

The time at which an administrator was created.

', 'AppInstanceBot$CreatedTimestamp' => '

The time at which the AppInstanceBot was created.

', 'AppInstanceBot$LastUpdatedTimestamp' => '

The time at which the AppInstanceBot was last updated.

', 'AppInstanceUser$CreatedTimestamp' => '

The time at which the AppInstanceUser was created.

', 'AppInstanceUser$LastUpdatedTimestamp' => '

The time at which the AppInstanceUser was last updated.

', 'AppInstanceUserEndpoint$CreatedTimestamp' => '

The time at which an AppInstanceUserEndpoint was created.

', 'AppInstanceUserEndpoint$LastUpdatedTimestamp' => '

The time at which an AppInstanceUserEndpoint was last updated.

', 'GetAppInstanceRetentionSettingsResponse$InitiateDeletionTimestamp' => '

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

', 'PutAppInstanceRetentionSettingsResponse$InitiateDeletionTimestamp' => '

The time at which the API deletes data.

', ], ], 'UnauthorizedClientException' => [ 'base' => '

The client is not currently authorized to make the request.

', 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppInstanceBotRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppInstanceBotResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppInstanceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppInstanceUserEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppInstanceUserEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppInstanceUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppInstanceUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'UserId' => [ 'base' => NULL, 'refs' => [ 'CreateAppInstanceUserRequest$AppInstanceUserId' => '

The user ID of the AppInstance.

', ], ], 'UserName' => [ 'base' => NULL, 'refs' => [ 'AppInstanceUser$Name' => '

The name of the AppInstanceUser.

', 'AppInstanceUserSummary$Name' => '

The name of an AppInstanceUser.

', 'CreateAppInstanceUserRequest$Name' => '

The user\'s name.

', 'UpdateAppInstanceUserRequest$Name' => '

The name of the AppInstanceUser.

', ], ], ],];