AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AppInstanceUserMembershipSummary

Summary of the membership details of an AppInstanceUser.

Class AssociateChannelFlowRequest

Container for the parameters to the AssociateChannelFlow operation. 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class AssociateChannelFlowResponse

This is the response object from the AssociateChannelFlow operation.

Class BadRequestException

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

Class BatchChannelMemberships

The membership information, including member ARNs, the channel ARN, and membership types.

Class BatchCreateChannelMembershipError

A list of failed member ARNs, error codes, and error messages.

Class BatchCreateChannelMembershipRequest

Container for the parameters to the BatchCreateChannelMembership operation. Adds a specified number of users and bots to a channel.

Class BatchCreateChannelMembershipResponse

This is the response object from the BatchCreateChannelMembership operation.

Class Channel

The details of a channel.

Class ChannelAssociatedWithFlowSummary

Summary of details of a channel associated with channel flow.

Class ChannelBan

The details of a channel ban.

Class ChannelBanSummary

Summary of the details of a ChannelBan.

Class ChannelFlow

The details of a channel flow.

Class ChannelFlowCallbackRequest

Container for the parameters to the ChannelFlowCallback operation. Calls back Amazon 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

Class ChannelFlowCallbackResponse

This is the response object from the ChannelFlowCallback operation.

Class ChannelFlowSummary

Summary of details of a channel flow.

Class ChannelMembership

The details of a channel member.

Class ChannelMembershipForAppInstanceUserSummary

Summary of the channel membership details of an AppInstanceUser.

Class ChannelMembershipPreferences

The channel membership preferences for an AppInstanceUser.

Class ChannelMembershipSummary

Summary of the details of a ChannelMembership.

Class ChannelMessage

The details of a message in a channel.

Class ChannelMessageCallback

Stores information about a callback.

Class ChannelMessageStatusStructure

Stores information about a message status.

Class ChannelMessageSummary

Summary of the messages in a Channel.

Class ChannelModeratedByAppInstanceUserSummary

Summary of the details of a moderated channel.

Class ChannelModerator

The details of a channel moderator.

Class ChannelModeratorSummary

Summary of the details of a ChannelModerator.

Class ChannelSummary

Summary of the details of a Channel.

Class ChimeSDKMessagingPaginatorFactory

Paginators for the ChimeSDKMessaging service

Class ConflictException

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

Class CreateChannelBanRequest

Container for the parameters to the CreateChannelBan operation. 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class CreateChannelBanResponse

This is the response object from the CreateChannelBan operation.

Class CreateChannelFlowRequest

Container for the parameters to the CreateChannelFlow operation. 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:

  1. New and updated messages

  2. Persistent and non-persistent messages

  3. 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.

Class CreateChannelFlowResponse

This is the response object from the CreateChannelFlow operation.

Class CreateChannelMembershipRequest

Container for the parameters to the CreateChannelMembership operation. Adds a member to a channel. The InvitedBy field in ChannelMembership 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 ARN of the AppInstanceUserArn or AppInstanceBot that makes the API call as the value in the header.

Class CreateChannelMembershipResponse

This is the response object from the CreateChannelMembership operation.

Class CreateChannelModeratorRequest

Container for the parameters to the CreateChannelModerator operation. 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 ARN of the AppInstanceUser or AppInstanceBotof the user that makes the API call as the value in the header.

Class CreateChannelModeratorResponse

This is the response object from the CreateChannelModerator operation.

Class CreateChannelRequest

Container for the parameters to the CreateChannel operation. 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class CreateChannelResponse

This is the response object from the CreateChannel operation.

Class DeleteChannelBanRequest

Container for the parameters to the DeleteChannelBan operation. Removes a member from a channel's ban list.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class DeleteChannelBanResponse

This is the response object from the DeleteChannelBan operation.

Class DeleteChannelFlowRequest

Container for the parameters to the DeleteChannelFlow operation. 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.

Class DeleteChannelFlowResponse

This is the response object from the DeleteChannelFlow operation.

Class DeleteChannelMembershipRequest

Container for the parameters to the DeleteChannelMembership operation. 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.

Class DeleteChannelMembershipResponse

This is the response object from the DeleteChannelMembership operation.

Class DeleteChannelMessageRequest

Container for the parameters to the DeleteChannelMessage operation. 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class DeleteChannelMessageResponse

This is the response object from the DeleteChannelMessage operation.

Class DeleteChannelModeratorRequest

Container for the parameters to the DeleteChannelModerator operation. Deletes a channel moderator.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class DeleteChannelModeratorResponse

This is the response object from the DeleteChannelModerator operation.

Class DeleteChannelRequest

Container for the parameters to the DeleteChannel operation. 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 ARN of the AppInstanceUserArn or AppInstanceBot that makes the API call as the value in the header.

Class DeleteChannelResponse

This is the response object from the DeleteChannel operation.

Class DeleteMessagingStreamingConfigurationsRequest

Container for the parameters to the DeleteMessagingStreamingConfigurations operation. Deletes the streaming configurations for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.

Class DeleteMessagingStreamingConfigurationsResponse

This is the response object from the DeleteMessagingStreamingConfigurations operation.

Class DescribeChannelBanRequest

Container for the parameters to the DescribeChannelBan operation. Returns the full details of a channel ban.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class DescribeChannelBanResponse

This is the response object from the DescribeChannelBan operation.

Class DescribeChannelFlowRequest

Container for the parameters to the DescribeChannelFlow operation. Returns the full details of a channel flow in an Amazon Chime AppInstance. This is a developer API.

Class DescribeChannelFlowResponse

This is the response object from the DescribeChannelFlow operation.

Class DescribeChannelMembershipForAppInstanceUserRequest

Container for the parameters to the DescribeChannelMembershipForAppInstanceUser operation. Returns the details of a channel based on the membership of the specified AppInstanceUser or AppInstanceBot.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class DescribeChannelMembershipForAppInstanceUserResponse

This is the response object from the DescribeChannelMembershipForAppInstanceUser operation.

Class DescribeChannelMembershipRequest

Container for the parameters to the DescribeChannelMembership operation. Returns the full details of a user's channel membership.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class DescribeChannelMembershipResponse

This is the response object from the DescribeChannelMembership operation.

Class DescribeChannelModeratedByAppInstanceUserRequest

Container for the parameters to the DescribeChannelModeratedByAppInstanceUser operation. Returns the full details of a channel moderated by the specified AppInstanceUser or AppInstanceBot.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class DescribeChannelModeratedByAppInstanceUserResponse

This is the response object from the DescribeChannelModeratedByAppInstanceUser operation.

Class DescribeChannelModeratorRequest

Container for the parameters to the DescribeChannelModerator operation. 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.

Class DescribeChannelModeratorResponse

This is the response object from the DescribeChannelModerator operation.

Class DescribeChannelRequest

Container for the parameters to the DescribeChannel operation. Returns the full details of a channel in an Amazon Chime AppInstance.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class DescribeChannelResponse

This is the response object from the DescribeChannel operation.

Class DisassociateChannelFlowRequest

Container for the parameters to the DisassociateChannelFlow operation. 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class DisassociateChannelFlowResponse

This is the response object from the DisassociateChannelFlow operation.

Class ElasticChannelConfiguration

The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.

Class ExpirationSettings

Settings that control the interval after which a channel is deleted.

Class ForbiddenException

The client is permanently forbidden from making the request.

Class GetChannelMembershipPreferencesRequest

Container for the parameters to the GetChannelMembershipPreferences operation. Gets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel. A user or a bot must be a member of the channel and own the membership in order to retrieve membership preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't retrieve preferences for other users or bots. Banned users or bots can't retrieve membership preferences for the channel from which they are banned.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class GetChannelMembershipPreferencesResponse

This is the response object from the GetChannelMembershipPreferences operation.

Class GetChannelMessageRequest

Container for the parameters to the GetChannelMessage operation. Gets the full details of a channel message.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class GetChannelMessageResponse

This is the response object from the GetChannelMessage operation.

Class GetChannelMessageStatusRequest

Container for the parameters to the GetChannelMessageStatus operation. 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

Message 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class GetChannelMessageStatusResponse

This is the response object from the GetChannelMessageStatus operation.

Class GetMessagingSessionEndpointRequest

Container for the parameters to the GetMessagingSessionEndpoint operation. The details of the endpoint for the messaging session.

Class GetMessagingSessionEndpointResponse

This is the response object from the GetMessagingSessionEndpoint operation.

Class GetMessagingStreamingConfigurationsRequest

Container for the parameters to the GetMessagingStreamingConfigurations operation. Retrieves the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.

Class GetMessagingStreamingConfigurationsResponse

This is the response object from the GetMessagingStreamingConfigurations operation.

Class Identity

The details of a user or bot.

Class LambdaConfiguration

Stores metadata about a Lambda processor.

Class ListChannelBansRequest

Container for the parameters to the ListChannelBans operation. Lists all the users and bots banned from a particular channel.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class ListChannelBansResponse

This is the response object from the ListChannelBans operation.

Class ListChannelFlowsRequest

Container for the parameters to the ListChannelFlows operation. Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.

Class ListChannelFlowsResponse

This is the response object from the ListChannelFlows operation.

Class ListChannelMembershipsForAppInstanceUserRequest

Container for the parameters to the ListChannelMembershipsForAppInstanceUser operation. Lists all channels that an AppInstanceUser or AppInstanceBot 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class ListChannelMembershipsForAppInstanceUserResponse

This is the response object from the ListChannelMembershipsForAppInstanceUser operation.

Class ListChannelMembershipsRequest

Container for the parameters to the ListChannelMemberships operation. Lists all channel memberships in a channel.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API.

Class ListChannelMembershipsResponse

This is the response object from the ListChannelMemberships operation.

Class ListChannelMessagesRequest

Container for the parameters to the ListChannelMessages operation. 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class ListChannelMessagesResponse

This is the response object from the ListChannelMessages operation.

Class ListChannelModeratorsRequest

Container for the parameters to the ListChannelModerators operation. Lists all the moderators for a channel.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class ListChannelModeratorsResponse

This is the response object from the ListChannelModerators operation.

Class ListChannelsAssociatedWithChannelFlowRequest

Container for the parameters to the ListChannelsAssociatedWithChannelFlow operation. 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.

Class ListChannelsAssociatedWithChannelFlowResponse

This is the response object from the ListChannelsAssociatedWithChannelFlow operation.

Class ListChannelsModeratedByAppInstanceUserRequest

Container for the parameters to the ListChannelsModeratedByAppInstanceUser operation. A list of the channels moderated by an AppInstanceUser.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class ListChannelsModeratedByAppInstanceUserResponse

This is the response object from the ListChannelsModeratedByAppInstanceUser operation.

Class ListChannelsRequest

Container for the parameters to the ListChannels operation. 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class ListChannelsResponse

This is the response object from the ListChannels operation.

Class ListSubChannelsRequest

Container for the parameters to the ListSubChannels operation. Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.

Class ListSubChannelsResponse

This is the response object from the ListSubChannels operation.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Lists the tags applied to an Amazon Chime SDK messaging resource.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class MessageAttributeValue

A list of message attribute values.

Class MessagingSessionEndpoint

The websocket endpoint used to connect to Amazon Chime SDK messaging.

Class NotFoundException

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

Class Processor

The information about a processor in a channel flow.

Class ProcessorConfiguration

A processor's metadata.

Class PushNotificationConfiguration

The push notification configuration of the message.

Class PushNotificationPreferences

The channel membership preferences for push notification.

Class PutChannelExpirationSettingsRequest

Container for the parameters to the PutChannelExpirationSettings operation. Sets the number of days before the channel is automatically deleted.

  • A background process deletes expired channels within 6 hours of expiration. Actual deletion times may vary.

  • Expired channels that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.

  • The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class PutChannelExpirationSettingsResponse

This is the response object from the PutChannelExpirationSettings operation.

Class PutChannelMembershipPreferencesRequest

Container for the parameters to the PutChannelMembershipPreferences operation. Sets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the membership can set preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't set preferences for other users. Banned users or bots can't set membership preferences for the channel from which they are banned.

The x-amz-chime-bearer request header is mandatory. Use the ARN of an AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class PutChannelMembershipPreferencesResponse

This is the response object from the PutChannelMembershipPreferences operation.

Class PutMessagingStreamingConfigurationsRequest

Container for the parameters to the PutMessagingStreamingConfigurations operation. Sets the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.

Class PutMessagingStreamingConfigurationsResponse

This is the response object from the PutMessagingStreamingConfigurations operation.

Class RedactChannelMessageRequest

Container for the parameters to the RedactChannelMessage operation. 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class RedactChannelMessageResponse

This is the response object from the RedactChannelMessage operation.

Class ResourceLimitExceededException

The request exceeds the resource limit.

Class SearchChannelsRequest

Container for the parameters to the SearchChannels operation. Allows the ChimeBearer to search channels by channel members. Users or bots can search across the channels that they belong to. Users in the AppInstanceAdmin role can search across all channels.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class SearchChannelsResponse

This is the response object from the SearchChannels operation.

Class SearchField

A Field of the channel that you want to search.

Class SendChannelMessageRequest

Container for the parameters to the SendChannelMessage operation. 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Also, 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.

Class SendChannelMessageResponse

This is the response object from the SendChannelMessage operation.

Class ServiceFailureException

The service encountered an unexpected error.

Class ServiceUnavailableException

The service is currently unavailable.

Class StreamingConfiguration

The configuration for connecting a messaging stream to Amazon Kinesis.

Class SubChannelSummary

Summary of the sub-channels associated with the elastic channel.

Class Tag

A tag object containing a key-value pair.

Class TagResourceRequest

Container for the parameters to the TagResource operation. Applies the specified tags to the specified Amazon Chime SDK messaging resource.

Class TagResourceResponse

This is the response object from the TagResource operation.

Class 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.

Class ThrottledClientException

The client exceeded its request rate limit.

Class UnauthorizedClientException

The client is not currently authorized to make the request.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Removes the specified tags from the specified Amazon Chime SDK messaging resource.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class UpdateChannelFlowRequest

Container for the parameters to the UpdateChannelFlow operation. Updates channel flow attributes. This is a developer API.

Class UpdateChannelFlowResponse

This is the response object from the UpdateChannelFlow operation.

Class UpdateChannelMessageRequest

Container for the parameters to the UpdateChannelMessage operation. Updates the content of a message.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class UpdateChannelMessageResponse

This is the response object from the UpdateChannelMessage operation.

Class UpdateChannelReadMarkerRequest

Container for the parameters to the UpdateChannelReadMarker operation. 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class UpdateChannelReadMarkerResponse

This is the response object from the UpdateChannelReadMarker operation.

Class UpdateChannelRequest

Container for the parameters to the UpdateChannel operation. 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Class UpdateChannelResponse

This is the response object from the UpdateChannel operation.

Interfaces

NameDescription
Interface IChimeSDKMessagingPaginatorFactory

Paginators for the ChimeSDKMessaging service

Interface IListChannelBansPaginator

Paginator for the ListChannelBans operation

Interface IListChannelFlowsPaginator

Paginator for the ListChannelFlows operation

Interface IListChannelMembershipsForAppInstanceUserPaginator

Paginator for the ListChannelMembershipsForAppInstanceUser operation

Interface IListChannelMembershipsPaginator

Paginator for the ListChannelMemberships operation

Interface IListChannelMessagesPaginator

Paginator for the ListChannelMessages operation

Interface IListChannelModeratorsPaginator

Paginator for the ListChannelModerators operation

Interface IListChannelsAssociatedWithChannelFlowPaginator

Paginator for the ListChannelsAssociatedWithChannelFlow operation

Interface IListChannelsModeratedByAppInstanceUserPaginator

Paginator for the ListChannelsModeratedByAppInstanceUser operation

Interface IListChannelsPaginator

Paginator for the ListChannels operation

Interface IListSubChannelsPaginator

Paginator for the ListSubChannels operation

Interface ISearchChannelsPaginator

Paginator for the SearchChannels operation