The unique identifier of the AppInstanceUserEndpoint.
The ARN of the AppInstanceAdmin.
The ARN of the AppInstance.
The ARN and name of the AppInstanceUser, the ARN of the AppInstance, and the created and last-updated timestamps. All timestamps use epoch milliseconds.
The ARN of the AppInstanceBot.
The detials of the AppInstanceBot.
The ARN of the AppInstance.
The ARN, metadata, created and last-updated timestamps, and the name of the AppInstance. All timestamps use epoch milliseconds.
The ARN of the AppInstanceUser.
The unique identifier of the 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.
The ARN of the AppInstanceUser.
The name of the AppInstanceUser.
The device token for the GCM, APNS, and APNS_SANDBOX endpoint types.
" }, "VoipDeviceToken":{ "shape":"NonEmptySensitiveString1600", "documentation":"The VOIP device token for the APNS and APNS_SANDBOX endpoint types.
" } }, "documentation":"The attributes of an Endpoint.
Enum that indicates the Status of an AppInstanceUserEndpoint.
The reason for the EndpointStatus.
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.
The period in days after which an AppInstanceUser will be automatically deleted.
Specifies the conditions under which an AppInstanceUser will expire.
Determines the interval after which an AppInstanceUser is automatically deleted.
The client is permanently forbidden from making the request.
", "error":{"httpStatusCode":403}, "exception":true }, "GetAppInstanceRetentionSettingsRequest":{ "type":"structure", "required":["AppInstanceArn"], "members":{ "AppInstanceArn":{ "shape":"ChimeArn", "documentation":"The ARN of the AppInstance.
The retention settings for the AppInstance.
The timestamp representing the time at which the specified items are retained, in Epoch Seconds.
" } } }, "Identity":{ "type":"structure", "members":{ "Arn":{ "shape":"ChimeArn", "documentation":"The ARN in an Identity.
" }, "Name":{ "shape":"ResourceName", "documentation":"The name in an Identity.
" } }, "documentation":"The details of a user or bot.
" }, "InvokedBy":{ "type":"structure", "required":[ "StandardMessages", "TargetedMessages" ], "members":{ "StandardMessages":{ "shape":"StandardMessages", "documentation":"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.
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.
Specifies the type of message that triggers a bot.
" }, "LexBotAliasArn":{ "type":"string", "max":2048, "min":15, "pattern":"arn:aws:lex:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:bot-alias/[A-Z0-9]{10}/[A-Z0-9]{10}" }, "LexConfiguration":{ "type":"structure", "required":[ "LexBotAliasArn", "LocaleId" ], "members":{ "RespondsTo":{ "shape":"RespondsTo", "documentation":" Deprecated. Use InvokedBy instead.
Determines whether the Amazon Lex V2 bot responds to all standard messages. Control messages are not supported.
" }, "InvokedBy":{ "shape":"InvokedBy", "documentation":"Specifies the type of message that triggers a bot.
" }, "LexBotAliasArn":{ "shape":"LexBotAliasArn", "documentation":"The ARN of the Amazon Lex V2 bot's alias. The ARN uses this format: arn:aws:lex:REGION:ACCOUNT:bot-alias/MYBOTID/MYBOTALIAS
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.
" }, "WelcomeIntent":{ "shape":"LexIntentName", "documentation":"The name of the welcome intent configured in the Amazon Lex V2 bot.
" } }, "documentation":"The configuration for an Amazon Lex V2 bot.
" }, "LexIntentName":{ "type":"string", "max":100, "min":1, "pattern":"^([A-Za-z]_?)+$" }, "ListAppInstanceAdminsRequest":{ "type":"structure", "required":["AppInstanceArn"], "members":{ "AppInstanceArn":{ "shape":"ChimeArn", "documentation":"The ARN of the AppInstance.
The maximum number of administrators that you want to return.
", "location":"querystring", "locationName":"max-results" }, "NextToken":{ "shape":"NextToken", "documentation":"The token returned from previous API requests until the number of administrators is reached.
", "location":"querystring", "locationName":"next-token" } } }, "ListAppInstanceAdminsResponse":{ "type":"structure", "members":{ "AppInstanceArn":{ "shape":"ChimeArn", "documentation":"The ARN of the AppInstance.
The information for each administrator.
" }, "NextToken":{ "shape":"NextToken", "documentation":"The token returned from previous API requests until the number of administrators is reached.
" } } }, "ListAppInstanceBotsRequest":{ "type":"structure", "required":["AppInstanceArn"], "members":{ "AppInstanceArn":{ "shape":"ChimeArn", "documentation":"The ARN of the AppInstance.
The maximum number of requests to return.
", "location":"querystring", "locationName":"max-results" }, "NextToken":{ "shape":"NextToken", "documentation":"The token passed by previous API calls until all requested bots are returned.
", "location":"querystring", "locationName":"next-token" } } }, "ListAppInstanceBotsResponse":{ "type":"structure", "members":{ "AppInstanceArn":{ "shape":"ChimeArn", "documentation":"The ARN of the AppInstance.
" }, "AppInstanceBots":{ "shape":"AppInstanceBotList", "documentation":"The information for each requested AppInstanceBot.
The token passed by previous API calls until all requested bots are returned.
" } } }, "ListAppInstanceUserEndpointsRequest":{ "type":"structure", "required":["AppInstanceUserArn"], "members":{ "AppInstanceUserArn":{ "shape":"SensitiveChimeArn", "documentation":"The ARN of the AppInstanceUser.
The maximum number of endpoints that you want to return.
", "location":"querystring", "locationName":"max-results" }, "NextToken":{ "shape":"NextToken", "documentation":"The token passed by previous API calls until all requested endpoints are returned.
", "location":"querystring", "locationName":"next-token" } } }, "ListAppInstanceUserEndpointsResponse":{ "type":"structure", "members":{ "AppInstanceUserEndpoints":{ "shape":"AppInstanceUserEndpointSummaryList", "documentation":"The information for each requested AppInstanceUserEndpoint.
The token passed by previous API calls until all requested endpoints are returned.
" } } }, "ListAppInstanceUsersRequest":{ "type":"structure", "required":["AppInstanceArn"], "members":{ "AppInstanceArn":{ "shape":"ChimeArn", "documentation":"The ARN of the AppInstance.
The maximum number of requests that you want returned.
", "location":"querystring", "locationName":"max-results" }, "NextToken":{ "shape":"NextToken", "documentation":"The token passed by previous API calls until all requested users are returned.
", "location":"querystring", "locationName":"next-token" } } }, "ListAppInstanceUsersResponse":{ "type":"structure", "members":{ "AppInstanceArn":{ "shape":"ChimeArn", "documentation":"The ARN of the AppInstance.
The information for each requested AppInstanceUser.
The token passed by previous API calls until all requested users are returned.
" } } }, "ListAppInstancesRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"MaxResults", "documentation":"The maximum number of AppInstances that you want to return.
The token passed by previous API requests until you reach the maximum number of AppInstances.
The information for each AppInstance.
The token passed by previous API requests until the maximum number of AppInstances is reached.
The ARN of the resource.
", "location":"querystring", "locationName":"arn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "Tags":{ "shape":"TagList", "documentation":"The tag key-value pairs.
" } } }, "MaxResults":{ "type":"integer", "max":50, "min":1 }, "Metadata":{ "type":"string", "max":1024, "min":0, "pattern":".*", "sensitive":true }, "NextToken":{ "type":"string", "max":2048, "min":0, "pattern":".*", "sensitive":true }, "NonEmptyResourceName":{ "type":"string", "max":256, "min":1, "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*", "sensitive":true }, "NonEmptySensitiveString1600":{ "type":"string", "max":1600, "min":1, "pattern":".*", "sensitive":true }, "NotFoundException":{ "type":"structure", "members":{ "Code":{"shape":"ErrorCode"}, "Message":{"shape":"String"} }, "documentation":"One or more of the resources in the request does not exist in the system.
", "error":{"httpStatusCode":404}, "exception":true }, "PutAppInstanceRetentionSettingsRequest":{ "type":"structure", "required":[ "AppInstanceArn", "AppInstanceRetentionSettings" ], "members":{ "AppInstanceArn":{ "shape":"ChimeArn", "documentation":"The ARN of the AppInstance.
The time in days to retain data. Data type: number.
" } } }, "PutAppInstanceRetentionSettingsResponse":{ "type":"structure", "members":{ "AppInstanceRetentionSettings":{ "shape":"AppInstanceRetentionSettings", "documentation":"The time in days to retain data. Data type: number.
" }, "InitiateDeletionTimestamp":{ "shape":"Timestamp", "documentation":"The time at which the API deletes data.
" } } }, "PutAppInstanceUserExpirationSettingsRequest":{ "type":"structure", "required":["AppInstanceUserArn"], "members":{ "AppInstanceUserArn":{ "shape":"ChimeArn", "documentation":"The ARN of the AppInstanceUser.
Settings that control the interval after which an AppInstanceUser is automatically deleted.
The ARN of the AppInstanceUser.
Settings that control the interval after which an AppInstanceUser is automatically deleted.
The ARN of the AppInstanceUser.
The name of the AppInstanceUserEndpoint.
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.
The ARN of the resource to which the endpoint belongs.
" }, "EndpointAttributes":{ "shape":"EndpointAttributes", "documentation":"The attributes of an Endpoint.
The unique ID assigned to the request. Use different tokens to register other endpoints.
", "idempotencyToken":true }, "AllowMessages":{ "shape":"AllowMessages", "documentation":"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.
The ARN of the AppInstanceUser.
The unique identifier of the AppInstanceUserEndpoint.
The request exceeds the resource limit.
", "error":{"httpStatusCode":400}, "exception":true }, "ResourceName":{ "type":"string", "max":256, "min":0, "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*", "sensitive":true }, "RespondsTo":{ "type":"string", "enum":["STANDARD_MESSAGES"] }, "RetentionDays":{ "type":"integer", "max":5475, "min":1 }, "SensitiveChimeArn":{ "type":"string", "max":1600, "min":5, "pattern":"arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "sensitive":true }, "SensitiveString1600":{ "type":"string", "max":1600, "min":0, "pattern":".*", "sensitive":true }, "ServiceFailureException":{ "type":"structure", "members":{ "Code":{"shape":"ErrorCode"}, "Message":{"shape":"String"} }, "documentation":"The service encountered an unexpected error.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "ServiceUnavailableException":{ "type":"structure", "members":{ "Code":{"shape":"ErrorCode"}, "Message":{"shape":"String"} }, "documentation":"The service is currently unavailable.
", "error":{"httpStatusCode":503}, "exception":true, "fault":true }, "StandardMessages":{ "type":"string", "enum":[ "AUTO", "ALL", "MENTIONS", "NONE" ] }, "String":{"type":"string"}, "String1600":{ "type":"string", "max":1600, "min":0, "pattern":".*" }, "String64":{ "type":"string", "max":64, "min":0, "pattern":".*" }, "Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagKey", "documentation":"The key in a tag.
" }, "Value":{ "shape":"TagValue", "documentation":"The value in a tag.
" } }, "documentation":"A tag object containing a key-value pair.
" }, "TagKey":{ "type":"string", "max":128, "min":1, "sensitive":true }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":50, "min":1 }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "max":50, "min":1 }, "TagResourceRequest":{ "type":"structure", "required":[ "ResourceARN", "Tags" ], "members":{ "ResourceARN":{ "shape":"ChimeArn", "documentation":"The resource ARN.
" }, "Tags":{ "shape":"TagList", "documentation":"The tag key-value pairs.
" } } }, "TagValue":{ "type":"string", "max":256, "min":1, "sensitive":true }, "TargetedMessages":{ "type":"string", "enum":[ "ALL", "NONE" ] }, "ThrottledClientException":{ "type":"structure", "members":{ "Code":{"shape":"ErrorCode"}, "Message":{"shape":"String"} }, "documentation":"The client exceeded its request rate limit.
", "error":{"httpStatusCode":429}, "exception":true }, "Timestamp":{"type":"timestamp"}, "UnauthorizedClientException":{ "type":"structure", "members":{ "Code":{"shape":"ErrorCode"}, "Message":{"shape":"String"} }, "documentation":"The client is not currently authorized to make the request.
", "error":{"httpStatusCode":401}, "exception":true }, "UntagResourceRequest":{ "type":"structure", "required":[ "ResourceARN", "TagKeys" ], "members":{ "ResourceARN":{ "shape":"ChimeArn", "documentation":"The resource ARN.
" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"The tag keys.
" } } }, "UpdateAppInstanceBotRequest":{ "type":"structure", "required":[ "AppInstanceBotArn", "Name", "Metadata" ], "members":{ "AppInstanceBotArn":{ "shape":"ChimeArn", "documentation":"The ARN of the AppInstanceBot.
The name of the AppInstanceBot.
The metadata of the AppInstanceBot.
The configuration for the bot update.
" } } }, "UpdateAppInstanceBotResponse":{ "type":"structure", "members":{ "AppInstanceBotArn":{ "shape":"ChimeArn", "documentation":"The ARN of the AppInstanceBot.
The ARN of the AppInstance.
The name that you want to change.
" }, "Metadata":{ "shape":"Metadata", "documentation":"The metadata that you want to change.
" } } }, "UpdateAppInstanceResponse":{ "type":"structure", "members":{ "AppInstanceArn":{ "shape":"ChimeArn", "documentation":"The ARN of the AppInstance.
The ARN of the AppInstanceUser.
The unique identifier of the AppInstanceUserEndpoint.