String appInstanceArn
The ARN of the messaging instance.
String name
The name of an AppInstance.
Date createdTimestamp
The time at which an AppInstance was created. In epoch milliseconds.
Date lastUpdatedTimestamp
The time an AppInstance was last updated. In epoch milliseconds.
String metadata
The metadata of an AppInstance.
Identity admin
The details of the AppInstanceAdmin.
String appInstanceBotArn
The ARN of the AppInstanceBot.
String name
The name of the AppInstanceBot.
Configuration configuration
The data processing instructions for an AppInstanceBot.
Date createdTimestamp
The time at which the AppInstanceBot was created.
Date lastUpdatedTimestamp
The time at which the AppInstanceBot was last updated.
String metadata
The metadata for an AppInstanceBot.
ChannelRetentionSettings channelRetentionSettings
The length of time in days to retain the messages in a channel.
String appInstanceUserArn
The ARN of the AppInstanceUser.
String name
The name of the AppInstanceUser.
String metadata
The metadata of the AppInstanceUser.
Date createdTimestamp
The time at which the AppInstanceUser was created.
Date lastUpdatedTimestamp
The time at which the AppInstanceUser was last updated.
ExpirationSettings expirationSettings
The interval after which an AppInstanceUser is automatically deleted.
String appInstanceUserArn
The ARN of the AppInstanceUser.
String endpointId
The unique identifier of the AppInstanceUserEndpoint.
String name
The name of the AppInstanceUserEndpoint.
String type
The type of the AppInstanceUserEndpoint.
String resourceArn
The ARN of the resource to which the endpoint belongs.
EndpointAttributes endpointAttributes
The attributes of an Endpoint.
Date createdTimestamp
The time at which an AppInstanceUserEndpoint was created.
Date lastUpdatedTimestamp
The time at which an AppInstanceUserEndpoint was last updated.
String 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.
EndpointState 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.
String appInstanceUserArn
The ARN of the AppInstanceUser.
String endpointId
The unique identifier of the AppInstanceUserEndpoint.
String name
The name of the AppInstanceUserEndpoint.
String type
The type of the AppInstanceUserEndpoint.
String 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.
EndpointState endpointState
A read-only field that represent the state of an AppInstanceUserEndpoint.
String code
Integer retentionDays
The time in days to retain the messages in a channel.
LexConfiguration lex
The configuration for an Amazon Lex V2 bot.
String code
String appInstanceArn
The ARN of the AppInstance request.
String name
The user's name.
String metadata
The request metadata. Limited to a 1KB string in UTF-8.
String clientRequestToken
The unique ID for the client making the request. Use different tokens for different AppInstanceBots.
List<E> tags
The tags assigned to the AppInstanceBot.
Configuration configuration
Configuration information about the Amazon Lex V2 V2 bot.
String appInstanceBotArn
The ARN of the AppinstanceBot.
String name
The name of the AppInstance.
String metadata
The metadata of the AppInstance. Limited to a 1KB string in UTF-8.
String clientRequestToken
The unique ID of the request. Use different tokens to create different AppInstances.
List<E> tags
Tags assigned to the AppInstance.
String appInstanceArn
The Amazon Resource Number (ARN) of the AppInstance.
String appInstanceArn
The ARN of the AppInstance request.
String appInstanceUserId
The user ID of the AppInstance.
String name
The user's name.
String metadata
The request's metadata. Limited to a 1KB string in UTF-8.
String clientRequestToken
The unique ID of the request. Use different tokens to request additional AppInstances.
List<E> tags
Tags assigned to the AppInstanceUser.
ExpirationSettings expirationSettings
Settings that control the interval after which the AppInstanceUser is automatically deleted.
String appInstanceUserArn
The user's ARN.
String appInstanceBotArn
The ARN of the AppInstanceBot being deleted.
String appInstanceArn
The ARN of the AppInstance.
String appInstanceUserArn
The ARN of the user request being deleted.
AppInstanceAdmin 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.
String appInstanceBotArn
The ARN of the AppInstanceBot.
AppInstanceBot appInstanceBot
The detials of the AppInstanceBot.
String appInstanceArn
The ARN of the AppInstance.
AppInstance appInstance
The ARN, metadata, created and last-updated timestamps, and the name of the AppInstance. All
timestamps use epoch milliseconds.
AppInstanceUserEndpoint 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.
String appInstanceUserArn
The ARN of the AppInstanceUser.
AppInstanceUser appInstanceUser
The name of the AppInstanceUser.
String code
String appInstanceArn
The ARN of the AppInstance.
AppInstanceRetentionSettings appInstanceRetentionSettings
The retention settings for the AppInstance.
Date initiateDeletionTimestamp
The timestamp representing the time at which the specified items are retained, in Epoch Seconds.
String 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 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.
String respondsTo
Deprecated. Use InvokedBy instead.
Determines whether the Amazon Lex V2 bot responds to all standard messages. Control messages are not supported.
InvokedBy invokedBy
Specifies the type of message that triggers a bot.
String 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
String 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.
String welcomeIntent
The name of the welcome intent configured in the Amazon Lex V2 bot.
String resourceARN
The ARN of the resource.
String code
String appInstanceArn
The ARN of the AppInstance.
AppInstanceRetentionSettings appInstanceRetentionSettings
The time in days to retain data. Data type: number.
AppInstanceRetentionSettings appInstanceRetentionSettings
The time in days to retain data. Data type: number.
Date initiateDeletionTimestamp
The time at which the API deletes data.
String appInstanceUserArn
The ARN of the AppInstanceUser.
ExpirationSettings expirationSettings
Settings that control the interval after which an AppInstanceUser is automatically deleted.
String appInstanceUserArn
The ARN of the AppInstanceUser.
ExpirationSettings expirationSettings
Settings that control the interval after which an AppInstanceUser is automatically deleted.
String appInstanceUserArn
The ARN of the AppInstanceUser.
String name
The name of the AppInstanceUserEndpoint.
String 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.
String resourceArn
The ARN of the resource to which the endpoint belongs.
EndpointAttributes endpointAttributes
The attributes of an Endpoint.
String clientRequestToken
The unique ID assigned to the request. Use different tokens to register other endpoints.
String 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.
String code
String code
String code
String code
String code
String appInstanceBotArn
The ARN of the AppInstanceBot.
String name
The name of the AppInstanceBot.
String metadata
The metadata of the AppInstanceBot.
Configuration configuration
The configuration for the bot update.
String appInstanceBotArn
The ARN of the AppInstanceBot.
String appInstanceArn
The ARN of the AppInstance.
String appInstanceUserArn
The ARN of the AppInstanceUser.
String endpointId
The unique identifier of the AppInstanceUserEndpoint.
String name
The name of the AppInstanceUserEndpoint.
String 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.
String appInstanceUserArn
The ARN of the AppInstanceUser.
Copyright © 2025. All rights reserved.