import {Request} from '../lib/request'; import {Response} from '../lib/response'; import {AWSError} from '../lib/error'; import {Service} from '../lib/service'; import {ServiceConfigurationOptions} from '../lib/service'; import {ConfigBase as Config} from '../lib/config-base'; interface Blob {} declare class ChimeSDKMessaging extends Service { /** * Constructs a service object. This object has one method for each API operation. */ constructor(options?: ChimeSDKMessaging.Types.ClientConfiguration) config: Config & ChimeSDKMessaging.Types.ClientConfiguration; /** * Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the DisassociateChannelFlow API. Only administrators or channel moderators can associate a channel flow. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ associateChannelFlow(params: ChimeSDKMessaging.Types.AssociateChannelFlowRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the DisassociateChannelFlow API. Only administrators or channel moderators can associate a channel flow. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ associateChannelFlow(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Adds a specified number of users to a channel. */ batchCreateChannelMembership(params: ChimeSDKMessaging.Types.BatchCreateChannelMembershipRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.BatchCreateChannelMembershipResponse) => void): Request; /** * Adds a specified number of users to a channel. */ batchCreateChannelMembership(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.BatchCreateChannelMembershipResponse) => void): Request; /** * Calls back Chime SDK Messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API. You can return one of the following processing responses: Update message content or metadata Deny a message Make no changes to the message */ channelFlowCallback(params: ChimeSDKMessaging.Types.ChannelFlowCallbackRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ChannelFlowCallbackResponse) => void): Request; /** * Calls back Chime SDK Messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API. You can return one of the following processing responses: Update message content or metadata Deny a message Make no changes to the message */ channelFlowCallback(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ChannelFlowCallbackResponse) => void): Request; /** * Creates a channel to which you can add users and send messages. Restriction: You can't change a channel's privacy. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ createChannel(params: ChimeSDKMessaging.Types.CreateChannelRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.CreateChannelResponse) => void): Request; /** * Creates a channel to which you can add users and send messages. Restriction: You can't change a channel's privacy. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ createChannel(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.CreateChannelResponse) => void): Request; /** * Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels. If you ban a user who is already part of a channel, that user is automatically kicked from the channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ createChannelBan(params: ChimeSDKMessaging.Types.CreateChannelBanRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.CreateChannelBanResponse) => void): Request; /** * Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels. If you ban a user who is already part of a channel, that user is automatically kicked from the channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ createChannelBan(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.CreateChannelBanResponse) => void): Request; /** * Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors in the channel flow then take action on all messages sent to that channel. This is a developer API. Channel flows process the following items: New and updated messages Persistent and non-persistent messages The Standard message type Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK Messaging, refer to Message types in the Amazon Chime developer guide. */ createChannelFlow(params: ChimeSDKMessaging.Types.CreateChannelFlowRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.CreateChannelFlowResponse) => void): Request; /** * Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors in the channel flow then take action on all messages sent to that channel. This is a developer API. Channel flows process the following items: New and updated messages Persistent and non-persistent messages The Standard message type Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK Messaging, refer to Message types in the Amazon Chime developer guide. */ createChannelFlow(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.CreateChannelFlowResponse) => void): Request; /** * Adds a user to a channel. The InvitedBy response field is derived from the request header. A channel member can: List messages Send messages Receive messages Edit their own messages Leave the channel Privacy settings impact this action as follows: Public Channels: You do not need to be a member to list messages, but you must be a member to send messages. Private Channels: You must be a member to list or send messages. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ createChannelMembership(params: ChimeSDKMessaging.Types.CreateChannelMembershipRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.CreateChannelMembershipResponse) => void): Request; /** * Adds a user to a channel. The InvitedBy response field is derived from the request header. A channel member can: List messages Send messages Receive messages Edit their own messages Leave the channel Privacy settings impact this action as follows: Public Channels: You do not need to be a member to list messages, but you must be a member to send messages. Private Channels: You must be a member to list or send messages. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ createChannelMembership(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.CreateChannelMembershipResponse) => void): Request; /** * Creates a new ChannelModerator. A channel moderator can: Add and remove other members of the channel. Add and remove other moderators of the channel. Add and remove user bans for the channel. Redact messages in the channel. List messages in the channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ createChannelModerator(params: ChimeSDKMessaging.Types.CreateChannelModeratorRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.CreateChannelModeratorResponse) => void): Request; /** * Creates a new ChannelModerator. A channel moderator can: Add and remove other members of the channel. Add and remove other moderators of the channel. Add and remove user bans for the channel. Redact messages in the channel. List messages in the channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ createChannelModerator(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.CreateChannelModeratorResponse) => void): Request; /** * Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ deleteChannel(params: ChimeSDKMessaging.Types.DeleteChannelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ deleteChannel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Removes a user from a channel's ban list. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ deleteChannelBan(params: ChimeSDKMessaging.Types.DeleteChannelBanRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Removes a user from a channel's ban list. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ deleteChannelBan(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Deletes a channel flow, an irreversible process. This is a developer API. This API works only when the channel flow is not associated with any channel. To get a list of all channels that a channel flow is associated with, use the ListChannelsAssociatedWithChannelFlow API. Use the DisassociateChannelFlow API to disassociate a channel flow from all channels. */ deleteChannelFlow(params: ChimeSDKMessaging.Types.DeleteChannelFlowRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Deletes a channel flow, an irreversible process. This is a developer API. This API works only when the channel flow is not associated with any channel. To get a list of all channels that a channel flow is associated with, use the ListChannelsAssociatedWithChannelFlow API. Use the DisassociateChannelFlow API to disassociate a channel flow from all channels. */ deleteChannelFlow(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Removes a member from a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ deleteChannelMembership(params: ChimeSDKMessaging.Types.DeleteChannelMembershipRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Removes a member from a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ deleteChannelMembership(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ deleteChannelMessage(params: ChimeSDKMessaging.Types.DeleteChannelMessageRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ deleteChannelMessage(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Deletes a channel moderator. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ deleteChannelModerator(params: ChimeSDKMessaging.Types.DeleteChannelModeratorRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Deletes a channel moderator. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ deleteChannelModerator(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Returns the full details of a channel in an Amazon Chime AppInstance. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ describeChannel(params: ChimeSDKMessaging.Types.DescribeChannelRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.DescribeChannelResponse) => void): Request; /** * Returns the full details of a channel in an Amazon Chime AppInstance. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ describeChannel(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.DescribeChannelResponse) => void): Request; /** * Returns the full details of a channel ban. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ describeChannelBan(params: ChimeSDKMessaging.Types.DescribeChannelBanRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.DescribeChannelBanResponse) => void): Request; /** * Returns the full details of a channel ban. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ describeChannelBan(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.DescribeChannelBanResponse) => void): Request; /** * Returns the full details of a channel flow in an Amazon Chime AppInstance. This is a developer API. */ describeChannelFlow(params: ChimeSDKMessaging.Types.DescribeChannelFlowRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.DescribeChannelFlowResponse) => void): Request; /** * Returns the full details of a channel flow in an Amazon Chime AppInstance. This is a developer API. */ describeChannelFlow(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.DescribeChannelFlowResponse) => void): Request; /** * Returns the full details of a user's channel membership. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ describeChannelMembership(params: ChimeSDKMessaging.Types.DescribeChannelMembershipRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.DescribeChannelMembershipResponse) => void): Request; /** * Returns the full details of a user's channel membership. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ describeChannelMembership(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.DescribeChannelMembershipResponse) => void): Request; /** * Returns the details of a channel based on the membership of the specified AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ describeChannelMembershipForAppInstanceUser(params: ChimeSDKMessaging.Types.DescribeChannelMembershipForAppInstanceUserRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.DescribeChannelMembershipForAppInstanceUserResponse) => void): Request; /** * Returns the details of a channel based on the membership of the specified AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ describeChannelMembershipForAppInstanceUser(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.DescribeChannelMembershipForAppInstanceUserResponse) => void): Request; /** * Returns the full details of a channel moderated by the specified AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ describeChannelModeratedByAppInstanceUser(params: ChimeSDKMessaging.Types.DescribeChannelModeratedByAppInstanceUserRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.DescribeChannelModeratedByAppInstanceUserResponse) => void): Request; /** * Returns the full details of a channel moderated by the specified AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ describeChannelModeratedByAppInstanceUser(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.DescribeChannelModeratedByAppInstanceUserResponse) => void): Request; /** * Returns the full details of a single ChannelModerator. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ describeChannelModerator(params: ChimeSDKMessaging.Types.DescribeChannelModeratorRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.DescribeChannelModeratorResponse) => void): Request; /** * Returns the full details of a single ChannelModerator. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ describeChannelModerator(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.DescribeChannelModeratorResponse) => void): Request; /** * Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going through the channel flow processor. Only administrators or channel moderators can disassociate a channel flow. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ disassociateChannelFlow(params: ChimeSDKMessaging.Types.DisassociateChannelFlowRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going through the channel flow processor. Only administrators or channel moderators can disassociate a channel flow. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ disassociateChannelFlow(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Gets the full details of a channel message. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ getChannelMessage(params: ChimeSDKMessaging.Types.GetChannelMessageRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.GetChannelMessageResponse) => void): Request; /** * Gets the full details of a channel message. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ getChannelMessage(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.GetChannelMessageResponse) => void): Request; /** * Gets message status for a specified messageId. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to retrieving message status if the event was not received because a client wasn't connected to a websocket. Messages can have any one of these statuses. SENT Message processed successfully PENDING Ongoing processing FAILED Processing failed DENIED Messasge denied by the processor This API does not return statuses for denied messages, because we don't store them once the processor denies them. Only the message sender can invoke this API. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header */ getChannelMessageStatus(params: ChimeSDKMessaging.Types.GetChannelMessageStatusRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.GetChannelMessageStatusResponse) => void): Request; /** * Gets message status for a specified messageId. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to retrieving message status if the event was not received because a client wasn't connected to a websocket. Messages can have any one of these statuses. SENT Message processed successfully PENDING Ongoing processing FAILED Processing failed DENIED Messasge denied by the processor This API does not return statuses for denied messages, because we don't store them once the processor denies them. Only the message sender can invoke this API. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header */ getChannelMessageStatus(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.GetChannelMessageStatusResponse) => void): Request; /** * The details of the endpoint for the messaging session. */ getMessagingSessionEndpoint(params: ChimeSDKMessaging.Types.GetMessagingSessionEndpointRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.GetMessagingSessionEndpointResponse) => void): Request; /** * The details of the endpoint for the messaging session. */ getMessagingSessionEndpoint(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.GetMessagingSessionEndpointResponse) => void): Request; /** * Lists all the users banned from a particular channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannelBans(params: ChimeSDKMessaging.Types.ListChannelBansRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelBansResponse) => void): Request; /** * Lists all the users banned from a particular channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannelBans(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelBansResponse) => void): Request; /** * Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API. */ listChannelFlows(params: ChimeSDKMessaging.Types.ListChannelFlowsRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelFlowsResponse) => void): Request; /** * Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API. */ listChannelFlows(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelFlowsResponse) => void): Request; /** * Lists all channel memberships in a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannelMemberships(params: ChimeSDKMessaging.Types.ListChannelMembershipsRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelMembershipsResponse) => void): Request; /** * Lists all channel memberships in a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannelMemberships(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelMembershipsResponse) => void): Request; /** * Lists all channels that a particular AppInstanceUser is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannelMembershipsForAppInstanceUser(params: ChimeSDKMessaging.Types.ListChannelMembershipsForAppInstanceUserRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelMembershipsForAppInstanceUserResponse) => void): Request; /** * Lists all channels that a particular AppInstanceUser is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannelMembershipsForAppInstanceUser(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelMembershipsForAppInstanceUserResponse) => void): Request; /** * List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order. Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message. Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannelMessages(params: ChimeSDKMessaging.Types.ListChannelMessagesRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelMessagesResponse) => void): Request; /** * List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order. Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message. Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannelMessages(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelMessagesResponse) => void): Request; /** * Lists all the moderators for a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannelModerators(params: ChimeSDKMessaging.Types.ListChannelModeratorsRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelModeratorsResponse) => void): Request; /** * Lists all the moderators for a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannelModerators(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelModeratorsResponse) => void): Request; /** * Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results. Functionality & restrictions Use privacy = PUBLIC to retrieve all public channels in the account. Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannels(params: ChimeSDKMessaging.Types.ListChannelsRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelsResponse) => void): Request; /** * Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results. Functionality & restrictions Use privacy = PUBLIC to retrieve all public channels in the account. Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannels(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelsResponse) => void): Request; /** * Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer API. */ listChannelsAssociatedWithChannelFlow(params: ChimeSDKMessaging.Types.ListChannelsAssociatedWithChannelFlowRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelsAssociatedWithChannelFlowResponse) => void): Request; /** * Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer API. */ listChannelsAssociatedWithChannelFlow(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelsAssociatedWithChannelFlowResponse) => void): Request; /** * A list of the channels moderated by an AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannelsModeratedByAppInstanceUser(params: ChimeSDKMessaging.Types.ListChannelsModeratedByAppInstanceUserRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelsModeratedByAppInstanceUserResponse) => void): Request; /** * A list of the channels moderated by an AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ listChannelsModeratedByAppInstanceUser(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelsModeratedByAppInstanceUserResponse) => void): Request; /** * Lists the tags applied to an Amazon Chime SDK messaging resource. */ listTagsForResource(params: ChimeSDKMessaging.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListTagsForResourceResponse) => void): Request; /** * Lists the tags applied to an Amazon Chime SDK messaging resource. */ listTagsForResource(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListTagsForResourceResponse) => void): Request; /** * Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ redactChannelMessage(params: ChimeSDKMessaging.Types.RedactChannelMessageRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.RedactChannelMessageResponse) => void): Request; /** * Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ redactChannelMessage(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.RedactChannelMessageResponse) => void): Request; /** * Sends a message to a particular channel that the member is a part of. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no metadata. */ sendChannelMessage(params: ChimeSDKMessaging.Types.SendChannelMessageRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.SendChannelMessageResponse) => void): Request; /** * Sends a message to a particular channel that the member is a part of. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no metadata. */ sendChannelMessage(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.SendChannelMessageResponse) => void): Request; /** * Applies the specified tags to the specified Amazon Chime SDK messaging resource. */ tagResource(params: ChimeSDKMessaging.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Applies the specified tags to the specified Amazon Chime SDK messaging resource. */ tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Removes the specified tags from the specified Amazon Chime SDK messaging resource. */ untagResource(params: ChimeSDKMessaging.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Removes the specified tags from the specified Amazon Chime SDK messaging resource. */ untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Update a channel's attributes. Restriction: You can't change a channel's privacy. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ updateChannel(params: ChimeSDKMessaging.Types.UpdateChannelRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.UpdateChannelResponse) => void): Request; /** * Update a channel's attributes. Restriction: You can't change a channel's privacy. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ updateChannel(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.UpdateChannelResponse) => void): Request; /** * Updates channel flow attributes. This is a developer API. */ updateChannelFlow(params: ChimeSDKMessaging.Types.UpdateChannelFlowRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.UpdateChannelFlowResponse) => void): Request; /** * Updates channel flow attributes. This is a developer API. */ updateChannelFlow(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.UpdateChannelFlowResponse) => void): Request; /** * Updates the content of a message. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ updateChannelMessage(params: ChimeSDKMessaging.Types.UpdateChannelMessageRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.UpdateChannelMessageResponse) => void): Request; /** * Updates the content of a message. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ updateChannelMessage(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.UpdateChannelMessageResponse) => void): Request; /** * The details of the time when a user last read messages in a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ updateChannelReadMarker(params: ChimeSDKMessaging.Types.UpdateChannelReadMarkerRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.UpdateChannelReadMarkerResponse) => void): Request; /** * The details of the time when a user last read messages in a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. */ updateChannelReadMarker(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.UpdateChannelReadMarkerResponse) => void): Request; } declare namespace ChimeSDKMessaging { export interface AppInstanceUserMembershipSummary { /** * The type of ChannelMembership. */ Type?: ChannelMembershipType; /** * The time at which a message was last read. */ ReadMarkerTimestamp?: Timestamp; } export interface AssociateChannelFlowRequest { /** * The ARN of the channel. */ ChannelArn: ChimeArn; /** * The ARN of the channel flow. */ ChannelFlowArn: ChimeArn; /** * The AppInstanceUserArn of the user making the API call. */ ChimeBearer: ChimeArn; } export interface BatchChannelMemberships { /** * The identifier of the member who invited another member. */ InvitedBy?: Identity; /** * The membership types set for the channel users. */ Type?: ChannelMembershipType; /** * The users successfully added to the request. */ Members?: Members; /** * The ARN of the channel to which you're adding users. */ ChannelArn?: ChimeArn; } export interface BatchCreateChannelMembershipError { /** * The ARN of the member that the service couldn't add. */ MemberArn?: ChimeArn; /** * The error code. */ ErrorCode?: ErrorCode; /** * The error message. */ ErrorMessage?: String; } export type BatchCreateChannelMembershipErrors = BatchCreateChannelMembershipError[]; export interface BatchCreateChannelMembershipRequest { /** * The ARN of the channel to which you're adding users. */ ChannelArn: ChimeArn; /** * 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. */ Type?: ChannelMembershipType; /** * The ARNs of the members you want to add to the channel. */ MemberArns: MemberArns; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface BatchCreateChannelMembershipResponse { /** * The list of channel memberships in the response. */ BatchChannelMemberships?: BatchChannelMemberships; /** * 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. */ Errors?: BatchCreateChannelMembershipErrors; } export type CallbackIdType = string; export interface Channel { /** * The name of a channel. */ Name?: NonEmptyResourceName; /** * The ARN of a channel. */ ChannelArn?: ChimeArn; /** * The mode of the channel. */ Mode?: ChannelMode; /** * The channel's privacy setting. */ Privacy?: ChannelPrivacy; /** * The channel's metadata. */ Metadata?: Metadata; /** * The AppInstanceUser who created the channel. */ CreatedBy?: Identity; /** * The time at which the AppInstanceUser created the channel. */ CreatedTimestamp?: Timestamp; /** * The time at which a member sent the last message in the channel. */ LastMessageTimestamp?: Timestamp; /** * The time at which a channel was last updated. */ LastUpdatedTimestamp?: Timestamp; /** * The ARN of the channel flow. */ ChannelFlowArn?: ChimeArn; } export interface ChannelAssociatedWithFlowSummary { /** * The name of the channel flow. */ Name?: NonEmptyResourceName; /** * The ARN of the channel. */ ChannelArn?: ChimeArn; /** * The mode of the channel. */ Mode?: ChannelMode; /** * The channel's privacy setting. */ Privacy?: ChannelPrivacy; /** * The channel's metadata. */ Metadata?: Metadata; } export type ChannelAssociatedWithFlowSummaryList = ChannelAssociatedWithFlowSummary[]; export interface ChannelBan { /** * The member being banned from the channel. */ Member?: Identity; /** * The ARN of the channel from which a member is being banned. */ ChannelArn?: ChimeArn; /** * The time at which the ban was created. */ CreatedTimestamp?: Timestamp; /** * The AppInstanceUser who created the ban. */ CreatedBy?: Identity; } export interface ChannelBanSummary { /** * The member being banned from a channel. */ Member?: Identity; } export type ChannelBanSummaryList = ChannelBanSummary[]; export interface ChannelFlow { /** * The ARN of the channel flow. */ ChannelFlowArn?: ChimeArn; /** * Information about the processor Lambda functions. */ Processors?: ProcessorList; /** * The name of the channel flow. */ Name?: NonEmptyResourceName; /** * The time at which the channel flow was created. */ CreatedTimestamp?: Timestamp; /** * The time at which a channel flow was updated. */ LastUpdatedTimestamp?: Timestamp; } export interface ChannelFlowCallbackRequest { /** * The identifier passed to the processor by the service when invoked. Use the identifier to call back the service. */ CallbackId: CallbackIdType; /** * The ARN of the channel. */ ChannelArn: ChimeArn; /** * When a processor determines that a message needs to be DENIED, pass this parameter with a value of true. */ DeleteResource?: NonNullableBoolean; /** * Stores information about the processed message. */ ChannelMessage: ChannelMessageCallback; } export interface ChannelFlowCallbackResponse { /** * The ARN of the channel. */ ChannelArn?: ChimeArn; /** * The call back ID passed in the request. */ CallbackId?: CallbackIdType; } export type ChannelFlowExecutionOrder = number; export interface ChannelFlowSummary { /** * The ARN of the channel flow. */ ChannelFlowArn?: ChimeArn; /** * The name of the channel flow. */ Name?: NonEmptyResourceName; /** * Information about the processor Lambda functions. */ Processors?: ProcessorList; } export type ChannelFlowSummaryList = ChannelFlowSummary[]; export interface ChannelMembership { /** * The identifier of the member who invited another member. */ InvitedBy?: Identity; /** * The membership type set for the channel member. */ Type?: ChannelMembershipType; /** * The data of the channel member. */ Member?: Identity; /** * The ARN of the member's channel. */ ChannelArn?: ChimeArn; /** * The time at which the channel membership was created. */ CreatedTimestamp?: Timestamp; /** * The time at which a channel membership was last updated. */ LastUpdatedTimestamp?: Timestamp; } export interface ChannelMembershipForAppInstanceUserSummary { /** * Returns the channel data for an AppInstance. */ ChannelSummary?: ChannelSummary; /** * Returns the channel membership data for an AppInstance. */ AppInstanceUserMembershipSummary?: AppInstanceUserMembershipSummary; } export type ChannelMembershipForAppInstanceUserSummaryList = ChannelMembershipForAppInstanceUserSummary[]; export interface ChannelMembershipSummary { /** * A member's summary data. */ Member?: Identity; } export type ChannelMembershipSummaryList = ChannelMembershipSummary[]; export type ChannelMembershipType = "DEFAULT"|"HIDDEN"|string; export interface ChannelMessage { /** * The ARN of the channel. */ ChannelArn?: ChimeArn; /** * The ID of a message. */ MessageId?: MessageId; /** * The message content. */ Content?: Content; /** * The message metadata. */ Metadata?: Metadata; /** * The message type. */ Type?: ChannelMessageType; /** * The time at which the message was created. */ CreatedTimestamp?: Timestamp; /** * The time at which a message was edited. */ LastEditedTimestamp?: Timestamp; /** * The time at which a message was updated. */ LastUpdatedTimestamp?: Timestamp; /** * The message sender. */ Sender?: Identity; /** * Hides the content of a message. */ Redacted?: NonNullableBoolean; /** * The persistence setting for a channel message. */ Persistence?: ChannelMessagePersistenceType; /** * The status of the channel message. */ Status?: ChannelMessageStatusStructure; } export interface ChannelMessageCallback { /** * The message ID. */ MessageId: MessageId; /** * The message content. */ Content?: NonEmptyContent; /** * The message metadata. */ Metadata?: Metadata; } export type ChannelMessagePersistenceType = "PERSISTENT"|"NON_PERSISTENT"|string; export type ChannelMessageStatus = "SENT"|"PENDING"|"FAILED"|"DENIED"|string; export interface ChannelMessageStatusStructure { /** * The message status value. */ Value?: ChannelMessageStatus; /** * Contains more details about the messasge status. */ Detail?: StatusDetail; } export interface ChannelMessageSummary { /** * The ID of the message. */ MessageId?: MessageId; /** * The content of the message. */ Content?: Content; /** * The metadata of the message. */ Metadata?: Metadata; /** * The type of message. */ Type?: ChannelMessageType; /** * The time at which the message summary was created. */ CreatedTimestamp?: Timestamp; /** * The time at which a message was last updated. */ LastUpdatedTimestamp?: Timestamp; /** * The time at which a message was last edited. */ LastEditedTimestamp?: Timestamp; /** * The message sender. */ Sender?: Identity; /** * Indicates whether a message was redacted. */ Redacted?: NonNullableBoolean; /** * 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. */ Status?: ChannelMessageStatusStructure; } export type ChannelMessageSummaryList = ChannelMessageSummary[]; export type ChannelMessageType = "STANDARD"|"CONTROL"|string; export type ChannelMode = "UNRESTRICTED"|"RESTRICTED"|string; export interface ChannelModeratedByAppInstanceUserSummary { /** * Summary of the details of a Channel. */ ChannelSummary?: ChannelSummary; } export type ChannelModeratedByAppInstanceUserSummaryList = ChannelModeratedByAppInstanceUserSummary[]; export interface ChannelModerator { /** * The moderator's data. */ Moderator?: Identity; /** * The ARN of the moderator's channel. */ ChannelArn?: ChimeArn; /** * The time at which the moderator was created. */ CreatedTimestamp?: Timestamp; /** * The AppInstanceUser who created the moderator. */ CreatedBy?: Identity; } export interface ChannelModeratorSummary { /** * The data for a moderator. */ Moderator?: Identity; } export type ChannelModeratorSummaryList = ChannelModeratorSummary[]; export type ChannelPrivacy = "PUBLIC"|"PRIVATE"|string; export interface ChannelSummary { /** * The name of the channel. */ Name?: NonEmptyResourceName; /** * The ARN of the channel. */ ChannelArn?: ChimeArn; /** * The mode of the channel. */ Mode?: ChannelMode; /** * The privacy setting of the channel. */ Privacy?: ChannelPrivacy; /** * The metadata of the channel. */ Metadata?: Metadata; /** * The time at which the last message in a channel was sent. */ LastMessageTimestamp?: Timestamp; } export type ChannelSummaryList = ChannelSummary[]; export type ChimeArn = string; export type ClientRequestToken = string; export type Content = string; export interface CreateChannelBanRequest { /** * The ARN of the ban request. */ ChannelArn: ChimeArn; /** * The ARN of the member being banned. */ MemberArn: ChimeArn; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface CreateChannelBanResponse { /** * The ARN of the response to the ban request. */ ChannelArn?: ChimeArn; /** * The ChannelArn and BannedIdentity of the member in the ban response. */ Member?: Identity; } export interface CreateChannelFlowRequest { /** * The ARN of the channel flow request. */ AppInstanceArn: ChimeArn; /** * Information about the processor Lambda functions. */ Processors: ProcessorList; /** * The name of the channel flow. */ Name: NonEmptyResourceName; /** * The tags for the creation request. */ Tags?: TagList; /** * The client token for the request. An Idempotency token. */ ClientRequestToken: ClientRequestToken; } export interface CreateChannelFlowResponse { /** * The ARN of the channel flow. */ ChannelFlowArn?: ChimeArn; } export interface CreateChannelMembershipRequest { /** * The ARN of the channel to which you're adding users. */ ChannelArn: ChimeArn; /** * The ARN of the member you want to add to the channel. */ MemberArn: ChimeArn; /** * 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. */ Type: ChannelMembershipType; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface CreateChannelMembershipResponse { /** * The ARN of the channel. */ ChannelArn?: ChimeArn; /** * The ARN and metadata of the member being added. */ Member?: Identity; } export interface CreateChannelModeratorRequest { /** * The ARN of the channel. */ ChannelArn: ChimeArn; /** * The ARN of the moderator. */ ChannelModeratorArn: ChimeArn; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface CreateChannelModeratorResponse { /** * The ARN of the channel. */ ChannelArn?: ChimeArn; /** * The ARNs of the channel and the moderator. */ ChannelModerator?: Identity; } export interface CreateChannelRequest { /** * The ARN of the channel request. */ AppInstanceArn: ChimeArn; /** * The name of the channel. */ Name: NonEmptyResourceName; /** * 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. */ Mode?: ChannelMode; /** * 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. */ Privacy?: ChannelPrivacy; /** * The metadata of the creation request. Limited to 1KB and UTF-8. */ Metadata?: Metadata; /** * The client token for the request. An Idempotency token. */ ClientRequestToken: ClientRequestToken; /** * The tags for the creation request. */ Tags?: TagList; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface CreateChannelResponse { /** * The ARN of the channel. */ ChannelArn?: ChimeArn; } export interface DeleteChannelBanRequest { /** * The ARN of the channel from which the AppInstanceUser was banned. */ ChannelArn: ChimeArn; /** * The ARN of the AppInstanceUser that you want to reinstate. */ MemberArn: ChimeArn; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface DeleteChannelFlowRequest { /** * The ARN of the channel flow. */ ChannelFlowArn: ChimeArn; } export interface DeleteChannelMembershipRequest { /** * The ARN of the channel from which you want to remove the user. */ ChannelArn: ChimeArn; /** * The ARN of the member that you're removing from the channel. */ MemberArn: ChimeArn; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface DeleteChannelMessageRequest { /** * The ARN of the channel. */ ChannelArn: ChimeArn; /** * The ID of the message being deleted. */ MessageId: MessageId; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface DeleteChannelModeratorRequest { /** * The ARN of the channel. */ ChannelArn: ChimeArn; /** * The ARN of the moderator being deleted. */ ChannelModeratorArn: ChimeArn; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface DeleteChannelRequest { /** * The ARN of the channel being deleted. */ ChannelArn: ChimeArn; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface DescribeChannelBanRequest { /** * The ARN of the channel from which the user is banned. */ ChannelArn: ChimeArn; /** * The ARN of the member being banned. */ MemberArn: ChimeArn; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface DescribeChannelBanResponse { /** * The details of the ban. */ ChannelBan?: ChannelBan; } export interface DescribeChannelFlowRequest { /** * The ARN of the channel flow. */ ChannelFlowArn: ChimeArn; } export interface DescribeChannelFlowResponse { /** * The channel flow details. */ ChannelFlow?: ChannelFlow; } export interface DescribeChannelMembershipForAppInstanceUserRequest { /** * The ARN of the channel to which the user belongs. */ ChannelArn: ChimeArn; /** * The ARN of the user in a channel. */ AppInstanceUserArn: ChimeArn; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface DescribeChannelMembershipForAppInstanceUserResponse { /** * The channel to which a user belongs. */ ChannelMembership?: ChannelMembershipForAppInstanceUserSummary; } export interface DescribeChannelMembershipRequest { /** * The ARN of the channel. */ ChannelArn: ChimeArn; /** * The ARN of the member. */ MemberArn: ChimeArn; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface DescribeChannelMembershipResponse { /** * The details of the membership. */ ChannelMembership?: ChannelMembership; } export interface DescribeChannelModeratedByAppInstanceUserRequest { /** * The ARN of the moderated channel. */ ChannelArn: ChimeArn; /** * The ARN of the AppInstanceUser in the moderated channel. */ AppInstanceUserArn: ChimeArn; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface DescribeChannelModeratedByAppInstanceUserResponse { /** * The moderated channel. */ Channel?: ChannelModeratedByAppInstanceUserSummary; } export interface DescribeChannelModeratorRequest { /** * The ARN of the channel. */ ChannelArn: ChimeArn; /** * The ARN of the channel moderator. */ ChannelModeratorArn: ChimeArn; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface DescribeChannelModeratorResponse { /** * The details of the channel moderator. */ ChannelModerator?: ChannelModerator; } export interface DescribeChannelRequest { /** * The ARN of the channel. */ ChannelArn: ChimeArn; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface DescribeChannelResponse { /** * The channel details. */ Channel?: Channel; } export interface DisassociateChannelFlowRequest { /** * The ARN of the channel. */ ChannelArn: ChimeArn; /** * The ARN of the channel flow. */ ChannelFlowArn: ChimeArn; /** * The AppInstanceUserArn of the user making the API call. */ ChimeBearer: ChimeArn; } export type ErrorCode = "BadRequest"|"Conflict"|"Forbidden"|"NotFound"|"PreconditionFailed"|"ResourceLimitExceeded"|"ServiceFailure"|"AccessDenied"|"ServiceUnavailable"|"Throttled"|"Throttling"|"Unauthorized"|"Unprocessable"|"VoiceConnectorGroupAssociationsExist"|"PhoneNumberAssociationsExist"|string; export type FallbackAction = "CONTINUE"|"ABORT"|string; export interface GetChannelMessageRequest { /** * The ARN of the channel. */ ChannelArn: ChimeArn; /** * The ID of the message. */ MessageId: MessageId; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface GetChannelMessageResponse { /** * The details of and content in the message. */ ChannelMessage?: ChannelMessage; } export interface GetChannelMessageStatusRequest { /** * The ARN of the channel */ ChannelArn: ChimeArn; /** * The ID of the message. */ MessageId: MessageId; /** * The AppInstanceUserArn of the user making the API call. */ ChimeBearer: ChimeArn; } export interface GetChannelMessageStatusResponse { /** * The message status and details. */ Status?: ChannelMessageStatusStructure; } export interface GetMessagingSessionEndpointRequest { } export interface GetMessagingSessionEndpointResponse { /** * The endpoint returned in the response. */ Endpoint?: MessagingSessionEndpoint; } export interface Identity { /** * The ARN in an Identity. */ Arn?: ChimeArn; /** * The name in an Identity. */ Name?: ResourceName; } export type InvocationType = "ASYNC"|string; export interface LambdaConfiguration { /** * The ARN of the Lambda message processing function. */ ResourceArn: LambdaFunctionArn; /** * Controls how the Lambda function is invoked. */ InvocationType: InvocationType; } export type LambdaFunctionArn = string; export interface ListChannelBansRequest { /** * The ARN of the channel. */ ChannelArn: ChimeArn; /** * The maximum number of bans that you want returned. */ MaxResults?: MaxResults; /** * The token passed by previous API calls until all requested bans are returned. */ NextToken?: NextToken; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface ListChannelBansResponse { /** * The ARN of the channel. */ ChannelArn?: ChimeArn; /** * The token passed by previous API calls until all requested bans are returned. */ NextToken?: NextToken; /** * The information for each requested ban. */ ChannelBans?: ChannelBanSummaryList; } export interface ListChannelFlowsRequest { /** * The ARN of the app instance. */ AppInstanceArn: ChimeArn; /** * The maximum number of channel flows that you want to return. */ MaxResults?: MaxResults; /** * The token passed by previous API calls until all requested channel flows are returned. */ NextToken?: NextToken; } export interface ListChannelFlowsResponse { /** * The information about each channel flow. */ ChannelFlows?: ChannelFlowSummaryList; /** * The token passed by previous API calls until all requested channels are returned. */ NextToken?: NextToken; } export interface ListChannelMembershipsForAppInstanceUserRequest { /** * The ARN of the AppInstanceUsers */ AppInstanceUserArn?: ChimeArn; /** * The maximum number of users that you want returned. */ MaxResults?: MaxResults; /** * The token returned from previous API requests until the number of channel memberships is reached. */ NextToken?: NextToken; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface ListChannelMembershipsForAppInstanceUserResponse { /** * The token passed by previous API calls until all requested users are returned. */ ChannelMemberships?: ChannelMembershipForAppInstanceUserSummaryList; /** * The token passed by previous API calls until all requested users are returned. */ NextToken?: NextToken; } export interface ListChannelMembershipsRequest { /** * The maximum number of channel memberships that you want returned. */ ChannelArn: ChimeArn; /** * 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. */ Type?: ChannelMembershipType; /** * The maximum number of channel memberships that you want returned. */ MaxResults?: MaxResults; /** * The token passed by previous API calls until all requested channel memberships are returned. */ NextToken?: NextToken; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface ListChannelMembershipsResponse { /** * The ARN of the channel. */ ChannelArn?: ChimeArn; /** * The information for the requested channel memberships. */ ChannelMemberships?: ChannelMembershipSummaryList; /** * The token passed by previous API calls until all requested channel memberships are returned. */ NextToken?: NextToken; } export interface ListChannelMessagesRequest { /** * The ARN of the channel. */ ChannelArn: ChimeArn; /** * The order in which you want messages sorted. Default is Descending, based on time created. */ SortOrder?: SortOrder; /** * The initial or starting time stamp for your requested messages. */ NotBefore?: Timestamp; /** * The final or ending time stamp for your requested messages. */ NotAfter?: Timestamp; /** * The maximum number of messages that you want returned. */ MaxResults?: MaxResults; /** * The token passed by previous API calls until all requested messages are returned. */ NextToken?: NextToken; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface ListChannelMessagesResponse { /** * The ARN of the channel containing the requested messages. */ ChannelArn?: ChimeArn; /** * The token passed by previous API calls until all requested messages are returned. */ NextToken?: NextToken; /** * The information about, and content of, each requested message. */ ChannelMessages?: ChannelMessageSummaryList; } export interface ListChannelModeratorsRequest { /** * The ARN of the channel. */ ChannelArn: ChimeArn; /** * The maximum number of moderators that you want returned. */ MaxResults?: MaxResults; /** * The token passed by previous API calls until all requested moderators are returned. */ NextToken?: NextToken; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface ListChannelModeratorsResponse { /** * The ARN of the channel. */ ChannelArn?: ChimeArn; /** * The token passed by previous API calls until all requested moderators are returned. */ NextToken?: NextToken; /** * The information about and names of each moderator. */ ChannelModerators?: ChannelModeratorSummaryList; } export interface ListChannelsAssociatedWithChannelFlowRequest { /** * The ARN of the channel flow. */ ChannelFlowArn: ChimeArn; /** * The maximum number of channels that you want to return. */ MaxResults?: MaxResults; /** * The token passed by previous API calls until all requested channels are returned. */ NextToken?: NextToken; } export interface ListChannelsAssociatedWithChannelFlowResponse { /** * The information about each channel. */ Channels?: ChannelAssociatedWithFlowSummaryList; /** * The token passed by previous API calls until all requested channels are returned. */ NextToken?: NextToken; } export interface ListChannelsModeratedByAppInstanceUserRequest { /** * The ARN of the user in the moderated channel. */ AppInstanceUserArn?: ChimeArn; /** * The maximum number of channels in the request. */ MaxResults?: MaxResults; /** * The token returned from previous API requests until the number of channels moderated by the user is reached. */ NextToken?: NextToken; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface ListChannelsModeratedByAppInstanceUserResponse { /** * The moderated channels in the request. */ Channels?: ChannelModeratedByAppInstanceUserSummaryList; /** * The token returned from previous API requests until the number of channels moderated by the user is reached. */ NextToken?: NextToken; } export interface ListChannelsRequest { /** * The ARN of the AppInstance. */ AppInstanceArn: ChimeArn; /** * The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels. */ Privacy?: ChannelPrivacy; /** * The maximum number of channels that you want to return. */ MaxResults?: MaxResults; /** * The token passed by previous API calls until all requested channels are returned. */ NextToken?: NextToken; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface ListChannelsResponse { /** * The information about each channel. */ Channels?: ChannelSummaryList; /** * The token returned from previous API requests until the number of channels is reached. */ NextToken?: NextToken; } export interface ListTagsForResourceRequest { /** * The ARN of the resource. */ ResourceARN: ChimeArn; } export interface ListTagsForResourceResponse { /** * The tag key-value pairs. */ Tags?: TagList; } export type MaxResults = number; export type MemberArns = ChimeArn[]; export type Members = Identity[]; export type MessageId = string; export interface MessagingSessionEndpoint { /** * The endpoint to which you establish a websocket connection. */ Url?: UrlType; } export type Metadata = string; export type NextToken = string; export type NonEmptyContent = string; export type NonEmptyResourceName = string; export type NonNullableBoolean = boolean; export interface Processor { /** * The name of the channel flow. */ Name: NonEmptyResourceName; /** * The information about the type of processor and its identifier. */ Configuration: ProcessorConfiguration; /** * 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. */ ExecutionOrder: ChannelFlowExecutionOrder; /** * Determines whether to continue or stop processing if communication with processor fails. If the last processor in a channel flow sequence has a fallback action of CONTINUE, and communication with the processor fails, the message is considered processed and sent to the recipients in the channel. */ FallbackAction: FallbackAction; } export interface ProcessorConfiguration { /** * Indicates that the processor is of type Lambda. */ Lambda: LambdaConfiguration; } export type ProcessorList = Processor[]; export interface RedactChannelMessageRequest { /** * The ARN of the channel containing the messages that you want to redact. */ ChannelArn: ChimeArn; /** * The ID of the message being redacted. */ MessageId: MessageId; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface RedactChannelMessageResponse { /** * The ARN of the channel containing the messages that you want to redact. */ ChannelArn?: ChimeArn; /** * The ID of the message being redacted. */ MessageId?: MessageId; } export type ResourceName = string; export interface SendChannelMessageRequest { /** * The ARN of the channel. */ ChannelArn: ChimeArn; /** * The content of the message. */ Content: NonEmptyContent; /** * The type of message, STANDARD or CONTROL. */ Type: ChannelMessageType; /** * Boolean that controls whether the message is persisted on the back end. Required. */ Persistence: ChannelMessagePersistenceType; /** * The optional metadata for each message. */ Metadata?: Metadata; /** * The Idempotency token for each client request. */ ClientRequestToken: ClientRequestToken; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface SendChannelMessageResponse { /** * The ARN of the channel. */ ChannelArn?: ChimeArn; /** * The ID string assigned to each message. */ MessageId?: MessageId; /** * The status of the channel message. */ Status?: ChannelMessageStatusStructure; } export type SortOrder = "ASCENDING"|"DESCENDING"|string; export type StatusDetail = string; export type String = string; export interface Tag { /** * The key in a tag. */ Key: TagKey; /** * The value in a tag. */ Value: TagValue; } export type TagKey = string; export type TagKeyList = TagKey[]; export type TagList = Tag[]; export interface TagResourceRequest { /** * The resource ARN. */ ResourceARN: ChimeArn; /** * The tag key-value pairs. */ Tags: TagList; } export type TagValue = string; export type Timestamp = Date; export interface UntagResourceRequest { /** * The resource ARN. */ ResourceARN: ChimeArn; /** * The tag keys. */ TagKeys: TagKeyList; } export interface UpdateChannelFlowRequest { /** * The ARN of the channel flow. */ ChannelFlowArn: ChimeArn; /** * Information about the processor Lambda functions */ Processors: ProcessorList; /** * The name of the channel flow. */ Name: NonEmptyResourceName; } export interface UpdateChannelFlowResponse { /** * The ARN of the channel flow. */ ChannelFlowArn?: ChimeArn; } export interface UpdateChannelMessageRequest { /** * The ARN of the channel. */ ChannelArn: ChimeArn; /** * The ID string of the message being updated. */ MessageId: MessageId; /** * The content of the message being updated. */ Content?: Content; /** * The metadata of the message being updated. */ Metadata?: Metadata; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface UpdateChannelMessageResponse { /** * The ARN of the channel. */ ChannelArn?: ChimeArn; /** * The ID string of the message being updated. */ MessageId?: MessageId; /** * The status of the message update. */ Status?: ChannelMessageStatusStructure; } export interface UpdateChannelReadMarkerRequest { /** * The ARN of the channel. */ ChannelArn: ChimeArn; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface UpdateChannelReadMarkerResponse { /** * The ARN of the channel. */ ChannelArn?: ChimeArn; } export interface UpdateChannelRequest { /** * The ARN of the channel. */ ChannelArn: ChimeArn; /** * The name of the channel. */ Name: NonEmptyResourceName; /** * The mode of the update request. */ Mode: ChannelMode; /** * The metadata for the update request. */ Metadata?: Metadata; /** * The AppInstanceUserArn of the user that makes the API call. */ ChimeBearer: ChimeArn; } export interface UpdateChannelResponse { /** * The ARN of the channel. */ ChannelArn?: ChimeArn; } export type UrlType = string; /** * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. */ export type apiVersion = "2021-05-15"|"latest"|string; export interface ClientApiVersions { /** * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. */ apiVersion?: apiVersion; } export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; /** * Contains interfaces for use with the ChimeSDKMessaging client. */ export import Types = ChimeSDKMessaging; } export = ChimeSDKMessaging;