String code
Identity invitedBy
The identifier of the member who invited another member.
String type
The membership types set for the channel members.
List<E> members
The users successfully added to the request.
String channelArn
The ARN of the channel to which you're adding members.
String subChannelId
The ID of the SubChannel.
String channelArn
The ARN of the channel to which you're adding users or bots.
String type
The membership type of a user, DEFAULT or HIDDEN. Default members are always returned
as part of ListChannelMemberships. Hidden members are only returned if the type filter in
ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This
is only supported by moderators.
List<E> memberArns
The ARNs of the members you want to add to the channel. Only AppInstanceUsers and
AppInstanceBots can be added as a channel member.
String chimeBearer
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
String subChannelId
The ID of the SubChannel in the request.
Only required when creating membership in a SubChannel for a moderator in an elastic channel.
BatchChannelMemberships batchChannelMemberships
The list of channel memberships in the response.
List<E> errors
If the action fails for one or more of the memberships in the request, a list of the memberships is returned, along with error codes and error messages.
String name
The name of a channel.
String channelArn
The ARN of a channel.
String mode
The mode of the channel.
String privacy
The channel's privacy setting.
String metadata
The channel's metadata.
Identity createdBy
The AppInstanceUser who created the channel.
Date createdTimestamp
The time at which the AppInstanceUser created the channel.
Date lastMessageTimestamp
The time at which a member sent the last message in the channel.
Date lastUpdatedTimestamp
The time at which a channel was last updated.
String channelFlowArn
The ARN of the channel flow.
ElasticChannelConfiguration elasticChannelConfiguration
The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.
ExpirationSettings expirationSettings
Settings that control when a channel expires.
Identity member
The member being banned from the channel.
String channelArn
The ARN of the channel from which a member is being banned.
Date createdTimestamp
The time at which the ban was created.
Identity createdBy
The AppInstanceUser who created the ban.
Identity member
The member being banned from a channel.
String channelFlowArn
The ARN of the channel flow.
List<E> processors
Information about the processor Lambda functions.
String name
The name of the channel flow.
Date createdTimestamp
The time at which the channel flow was created.
Date lastUpdatedTimestamp
The time at which a channel flow was updated.
String callbackId
The identifier passed to the processor by the service when invoked. Use the identifier to call back the service.
String channelArn
The ARN of the channel.
Boolean deleteResource
When a processor determines that a message needs to be DENIED, pass this parameter with a value of
true.
ChannelMessageCallback channelMessage
Stores information about the processed message.
Identity invitedBy
The identifier of the member who invited another member.
String type
The membership type set for the channel member.
Identity member
The data of the channel member.
String channelArn
The ARN of the member's channel.
Date createdTimestamp
The time at which the channel membership was created.
Date lastUpdatedTimestamp
The time at which a channel membership was last updated.
String subChannelId
The ID of the SubChannel that a user belongs to.
ChannelSummary channelSummary
Returns the channel data for an AppInstance.
AppInstanceUserMembershipSummary appInstanceUserMembershipSummary
Returns the channel membership data for an AppInstance.
PushNotificationPreferences pushNotifications
The push notification configuration of a message.
Identity member
A member's summary data.
String channelArn
The ARN of the channel.
String messageId
The ID of a message.
String content
The content of the channel message. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
String metadata
The message metadata.
String type
The message type.
Date createdTimestamp
The time at which the message was created.
Date lastEditedTimestamp
The time at which a message was edited.
Date lastUpdatedTimestamp
The time at which a message was updated.
Identity sender
The message sender.
Boolean redacted
Hides the content of a message.
String persistence
The persistence setting for a channel message.
ChannelMessageStatusStructure status
The status of the channel message.
Map<K,V> messageAttributes
The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
String subChannelId
The ID of the SubChannel.
String contentType
The content type of the channel message. For Amazon Lex V2 bot responses, the content type is
application/amz-chime-lex-msgs for success responses and
application/amz-chime-lex-error for failure responses. For more information, refer to Processing
responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
List<E> target
The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.
String messageId
The message ID.
String content
The message content. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
String metadata
The message metadata.
PushNotificationConfiguration pushNotification
The push notification configuration of the message.
Map<K,V> messageAttributes
The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
String subChannelId
The ID of the SubChannel.
String contentType
The content type of the call-back message. For Amazon Lex V2 bot responses, the content type is
application/amz-chime-lex-msgs for success responses and
application/amz-chime-lex-error for failure responses. For more information, refer to Processing
responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
String messageId
The ID of the message.
String content
The content of the channel message. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
String metadata
The metadata of the message.
String type
The type of message.
Date createdTimestamp
The time at which the message summary was created.
Date lastUpdatedTimestamp
The time at which a message was last updated.
Date lastEditedTimestamp
The time at which a message was last edited.
Identity sender
The message sender.
Boolean redacted
Indicates whether a message was redacted.
ChannelMessageStatusStructure status
The message status. The status value is SENT for messages sent to a channel without a channel flow.
For channels associated with channel flow, the value determines the processing stage.
Map<K,V> messageAttributes
The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
String contentType
The content type of the channel message listed in the summary. For Amazon Lex V2 bot responses, the content type
is application/amz-chime-lex-msgs for success responses and
application/amz-chime-lex-error for failure responses. For more information, refer to Processing
responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
List<E> target
The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.
ChannelSummary channelSummary
Summary of the details of a Channel.
Identity moderator
The data for a moderator.
String name
The name of the channel.
String channelArn
The ARN of the channel.
String mode
The mode of the channel.
String privacy
The privacy setting of the channel.
String metadata
The metadata of the channel.
Date lastMessageTimestamp
The time at which the last persistent message visible to the caller in a channel was sent.
String code
String appInstanceArn
The ARN of the channel flow request.
List<E> processors
Information about the processor Lambda functions.
String name
The name of the channel flow.
List<E> tags
The tags for the creation request.
String clientRequestToken
The client token for the request. An Idempotency token.
String channelFlowArn
The ARN of the channel flow.
String channelArn
The ARN of the channel to which you're adding users.
String memberArn
The AppInstanceUserArn of the member you want to add to the channel.
String type
The membership type of a user, DEFAULT or HIDDEN. Default members are always returned
as part of ListChannelMemberships. Hidden members are only returned if the type filter in
ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This
is only supported by moderators.
String chimeBearer
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
String subChannelId
The ID of the SubChannel in the request.
Only required when creating membership in a SubChannel for a moderator in an elastic channel.
String appInstanceArn
The ARN of the channel request.
String name
The name of the channel.
String mode
The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and channel
members can add themselves and other members to unrestricted channels. Only administrators and moderators can add
members to restricted channels.
String privacy
The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable by
users outside the channel. Public channels are discoverable by anyone in the AppInstance.
String metadata
The metadata of the creation request. Limited to 1KB and UTF-8.
String clientRequestToken
The client token for the request. An Idempotency token.
List<E> tags
The tags for the creation request.
String chimeBearer
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
String channelId
The ID of the channel in the request.
List<E> memberArns
The ARNs of the channel members in the request.
List<E> moderatorArns
The ARNs of the channel moderators in the request.
ElasticChannelConfiguration elasticChannelConfiguration
The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.
ExpirationSettings expirationSettings
Settings that control the interval after which the channel is automatically deleted.
String channelArn
The ARN of the channel.
String channelFlowArn
The ARN of the channel flow.
String channelArn
The ARN of the channel from which you want to remove the user.
String memberArn
The AppInstanceUserArn of the member that you're removing from the channel.
String chimeBearer
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
String subChannelId
The ID of the SubChannel in the request.
Only for use by moderators.
String channelArn
The ARN of the channel.
String messageId
The ID of the message being deleted.
String chimeBearer
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
String subChannelId
The ID of the SubChannel in the request.
Only required when deleting messages in a SubChannel that the user belongs to.
String appInstanceArn
The ARN of the streaming configurations being deleted.
ChannelBan channelBan
The details of the ban.
String channelFlowArn
The ARN of the channel flow.
ChannelFlow channelFlow
The channel flow details.
ChannelMembershipForAppInstanceUserSummary channelMembership
The channel to which a user belongs.
String channelArn
The ARN of the channel.
String memberArn
The AppInstanceUserArn of the member.
String chimeBearer
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
String subChannelId
The ID of the SubChannel in the request. The response contains an ElasticChannelConfiguration
object.
Only required to get a user’s SubChannel membership details.
ChannelMembership channelMembership
The details of the membership.
ChannelModeratedByAppInstanceUserSummary channel
The moderated channel.
ChannelModerator channelModerator
The details of the channel moderator.
Channel channel
The channel details.
Integer maximumSubChannels
The maximum number of SubChannels that you want to allow in the elastic channel.
Integer targetMembershipsPerSubChannel
The maximum number of members allowed in a SubChannel.
Integer minimumMembershipPercentage
The minimum allowed percentage of TargetMembershipsPerSubChannel users. Ceil of the calculated value is used in balancing members among SubChannels of the elastic channel.
String code
String channelArn
The ARN of the channel.
Identity member
The details of a user.
ChannelMembershipPreferences preferences
The channel membership preferences for an AppInstanceUser .
String channelArn
The ARN of the channel.
String messageId
The ID of the message.
String chimeBearer
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
String subChannelId
The ID of the SubChannel in the request.
Only required when getting messages in a SubChannel that the user belongs to.
ChannelMessage channelMessage
The details of and content in the message.
String channelArn
The ARN of the channel
String messageId
The ID of the message.
String chimeBearer
The AppInstanceUserArn of the user making the API call.
String subChannelId
The ID of the SubChannel in the request.
Only required when getting message status in a SubChannel that the user belongs to.
ChannelMessageStatusStructure status
The message status and details.
MessagingSessionEndpoint endpoint
The endpoint returned in the response.
String appInstanceArn
The ARN of the streaming configurations.
String channelArn
The ARN of the channel.
Integer maxResults
The maximum number of bans that you want returned.
String nextToken
The token passed by previous API calls until all requested bans are returned.
String chimeBearer
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
String appInstanceUserArn
The ARN of the user or bot.
Integer maxResults
The maximum number of users that you want returned.
String nextToken
The token returned from previous API requests until the number of channel memberships is reached.
String chimeBearer
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
String channelArn
The maximum number of channel memberships that you want returned.
String type
The membership type of a user, DEFAULT or HIDDEN. Default members are returned as part
of ListChannelMemberships if no type is specified. Hidden members are only returned if the type
filter in ListChannelMemberships equals HIDDEN.
Integer maxResults
The maximum number of channel memberships that you want returned.
String nextToken
The token passed by previous API calls until all requested channel memberships are returned.
String chimeBearer
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
String subChannelId
The ID of the SubChannel in the request.
Only required when listing a user's memberships in a particular sub-channel of an elastic channel.
String channelArn
The ARN of the channel.
String sortOrder
The order in which you want messages sorted. Default is Descending, based on time created.
Date notBefore
The initial or starting time stamp for your requested messages.
Date notAfter
The final or ending time stamp for your requested messages.
Integer maxResults
The maximum number of messages that you want returned.
String nextToken
The token passed by previous API calls until all requested messages are returned.
String chimeBearer
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
String subChannelId
The ID of the SubChannel in the request.
Only required when listing the messages in a SubChannel that the user belongs to.
String channelArn
The ARN of the channel containing the requested messages.
String nextToken
The token passed by previous API calls until all requested messages are returned.
List<E> channelMessages
The information about, and content of, each requested message.
String subChannelId
The ID of the SubChannel in the response.
String channelArn
The ARN of the channel.
Integer maxResults
The maximum number of moderators that you want returned.
String nextToken
The token passed by previous API calls until all requested moderators are returned.
String chimeBearer
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
String appInstanceUserArn
The ARN of the user or bot in the moderated channel.
Integer maxResults
The maximum number of channels in the request.
String nextToken
The token returned from previous API requests until the number of channels moderated by the user is reached.
String chimeBearer
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
String appInstanceArn
The ARN of the AppInstance.
String privacy
The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves
private channels. Only an AppInstanceAdmin can retrieve private channels.
Integer maxResults
The maximum number of channels that you want to return.
String nextToken
The token passed by previous API calls until all requested channels are returned.
String chimeBearer
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
String channelArn
The ARN of elastic channel.
String chimeBearer
The AppInstanceUserArn of the user making the API call.
Integer maxResults
The maximum number of sub-channels that you want to return.
String nextToken
The token passed by previous API calls until all requested sub-channels are returned.
String resourceARN
The ARN of the resource.
String url
The endpoint to which you establish a websocket connection.
String code
String name
The name of the channel flow.
ProcessorConfiguration configuration
The information about the type of processor and its identifier.
Integer executionOrder
The sequence in which processors run. If you have multiple processors in a channel flow, message processing goes through each processor in the sequence. The value determines the sequence. At this point, we support only 1 processor within a flow.
String fallbackAction
Determines whether to continue with message processing or stop it in cases where communication with a processor
fails. If a processor has a fallback action of ABORT and communication with it fails, the processor
sets the message status to FAILED and does not send the message to any recipients. Note that if the
last processor in the channel flow sequence has a fallback action of CONTINUE and communication with
the processor fails, then the message is considered processed and sent to recipients of the channel.
LambdaConfiguration lambda
Indicates that the processor is of type Lambda.
String allowNotifications
Enum value that indicates which push notifications to send to the requested member of a channel. ALL
sends all push notifications, NONE sends no push notifications, FILTERED sends only
filtered push notifications.
String filterRule
The simple JSON object used to send a subset of a push notification to the requested member.
String channelArn
The ARN of the channel.
String chimeBearer
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
ExpirationSettings expirationSettings
Settings that control the interval after which a channel is deleted.
String channelArn
The channel ARN.
ExpirationSettings expirationSettings
Settings that control the interval after which a channel is deleted.
String channelArn
The ARN of the channel.
String memberArn
The ARN of the member setting the preferences.
String chimeBearer
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
ChannelMembershipPreferences preferences
The channel membership preferences of an AppInstanceUser .
String channelArn
The ARN of the channel.
Identity member
The details of a user.
ChannelMembershipPreferences preferences
The ARN and metadata of the member being added.
String channelArn
The ARN of the channel containing the messages that you want to redact.
String messageId
The ID of the message being redacted.
String chimeBearer
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
String subChannelId
The ID of the SubChannel in the request.
String channelArn
The ARN of the channel containing the messages that you want to redact.
String messageId
The ID of the message being redacted.
String subChannelId
The ID of the SubChannel in the response.
Only required when redacting messages in a SubChannel that the user belongs to.
String code
String chimeBearer
The AppInstanceUserArn of the user making the API call.
List<E> fields
A list of the Field objects in the channel being searched.
Integer maxResults
The maximum number of channels that you want returned.
String nextToken
The token returned from previous API requests until the number of channels is reached.
String key
An enum value that indicates the key to search the channel on. MEMBERS allows you to
search channels based on memberships. You can use it with the EQUALS operator to get channels whose
memberships are equal to the specified values, and with the INCLUDES operator to get channels whose
memberships include the specified values.
List<E> values
The values that you want to search for, a list of strings. The values must be AppInstanceUserArns
specified as a list of strings.
This operation isn't supported for AppInstanceUsers with large number of memberships.
String operator
The operator used to compare field values, currently EQUALS or INCLUDES. Use the
EQUALS operator to find channels whose memberships equal the specified values. Use the
INCLUDES operator to find channels whose memberships include the specified values.
String channelArn
The ARN of the channel.
String content
The content of the channel message.
String type
The type of message, STANDARD or CONTROL.
STANDARD messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can
use it in a variety of ways, such as containing a link to an attachment.
CONTROL messages are limited to 30 bytes and do not contain metadata.
String persistence
Boolean that controls whether the message is persisted on the back end. Required.
String metadata
The optional metadata for each message.
String clientRequestToken
The Idempotency token for each client request.
String chimeBearer
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
PushNotificationConfiguration pushNotification
The push notification configuration of the message.
Map<K,V> messageAttributes
The attributes for the message, used for message filtering along with a FilterRule defined in the
PushNotificationPreferences.
String subChannelId
The ID of the SubChannel in the request.
String contentType
The content type of the channel message.
List<E> target
The target of a message. Must be a member of the channel, such as another user, a bot, or the sender. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.
String channelArn
The ARN of the channel.
String messageId
The ID string assigned to each message.
ChannelMessageStatusStructure status
The status of the channel message.
String subChannelId
The ID of the SubChannel in the response.
String code
String code
String memberArn
The ARN of the target channel member.
String code
String code
String channelFlowArn
The ARN of the channel flow.
String channelArn
The ARN of the channel.
String messageId
The ID string of the message being updated.
String content
The content of the channel message.
String metadata
The metadata of the message being updated.
String chimeBearer
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
String subChannelId
The ID of the SubChannel in the request.
Only required when updating messages in a SubChannel that the user belongs to.
String contentType
The content type of the channel message.
String channelArn
The ARN of the channel.
String messageId
The ID string of the message being updated.
ChannelMessageStatusStructure status
The status of the message update.
String subChannelId
The ID of the SubChannel in the response.
String channelArn
The ARN of the channel.
String channelArn
The ARN of the channel.
String name
The name of the channel.
String mode
The mode of the update request.
String metadata
The metadata for the update request.
String chimeBearer
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
String channelArn
The ARN of the channel.
Copyright © 2023. All rights reserved.