ChimeSDKMessaging ***************** Client ====== class ChimeSDKMessaging.Client A low-level client representing Amazon Chime SDK Messaging The Amazon Chime SDK messaging APIs in this section allow software developers to send and receive messages in custom messaging applications. These APIs depend on the frameworks provided by the Amazon Chime SDK identity APIs. For more information about the messaging APIs, see Amazon Chime SDK messaging. import boto3 client = boto3.client('chime-sdk-messaging') These are the available methods: * associate_channel_flow * batch_create_channel_membership * can_paginate * channel_flow_callback * close * create_channel * create_channel_ban * create_channel_flow * create_channel_membership * create_channel_moderator * delete_channel * delete_channel_ban * delete_channel_flow * delete_channel_membership * delete_channel_message * delete_channel_moderator * delete_messaging_streaming_configurations * describe_channel * describe_channel_ban * describe_channel_flow * describe_channel_membership * describe_channel_membership_for_app_instance_user * describe_channel_moderated_by_app_instance_user * describe_channel_moderator * disassociate_channel_flow * get_channel_membership_preferences * get_channel_message * get_channel_message_status * get_messaging_session_endpoint * get_messaging_streaming_configurations * get_paginator * get_waiter * list_channel_bans * list_channel_flows * list_channel_memberships * list_channel_memberships_for_app_instance_user * list_channel_messages * list_channel_moderators * list_channels * list_channels_associated_with_channel_flow * list_channels_moderated_by_app_instance_user * list_sub_channels * list_tags_for_resource * put_channel_expiration_settings * put_channel_membership_preferences * put_messaging_streaming_configurations * redact_channel_message * search_channels * send_channel_message * tag_resource * untag_resource * update_channel * update_channel_flow * update_channel_message * update_channel_read_marker ChimeSDKMessaging / Client / put_channel_membership_preferences put_channel_membership_preferences ********************************** ChimeSDKMessaging.Client.put_channel_membership_preferences(**kwargs) 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. Note: 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. See also: AWS API Documentation **Request Syntax** response = client.put_channel_membership_preferences( ChannelArn='string', MemberArn='string', ChimeBearer='string', Preferences={ 'PushNotifications': { 'AllowNotifications': 'ALL'|'NONE'|'FILTERED', 'FilterRule': 'string' } } ) Parameters: * **ChannelArn** (*string*) -- **[REQUIRED]** The ARN of the channel. * **MemberArn** (*string*) -- **[REQUIRED]** The ARN of the member setting the preferences. * **ChimeBearer** (*string*) -- **[REQUIRED]** The ARN of the "AppInstanceUser" or "AppInstanceBot" that makes the API call. * **Preferences** (*dict*) -- **[REQUIRED]** The channel membership preferences of an "AppInstanceUser" . * **PushNotifications** *(dict) --* The push notification configuration of a message. * **AllowNotifications** *(string) --* **[REQUIRED]** Enum value that indicates which push notifications to send to the requested member of a channel. "ALL" sends all push notifications, "NONE" sends no push notifications, "FILTERED" sends only filtered push notifications. * **FilterRule** *(string) --* The simple JSON object used to send a subset of a push notification to the requested member. Return type: dict Returns: **Response Syntax** { 'ChannelArn': 'string', 'Member': { 'Arn': 'string', 'Name': 'string' }, 'Preferences': { 'PushNotifications': { 'AllowNotifications': 'ALL'|'NONE'|'FILTERED', 'FilterRule': 'string' } } } **Response Structure** * *(dict) --* * **ChannelArn** *(string) --* The ARN of the channel. * **Member** *(dict) --* The details of a user. * **Arn** *(string) --* The ARN in an Identity. * **Name** *(string) --* The name in an Identity. * **Preferences** *(dict) --* The ARN and metadata of the member being added. * **PushNotifications** *(dict) --* The push notification configuration of a message. * **AllowNotifications** *(string) --* Enum value that indicates which push notifications to send to the requested member of a channel. "ALL" sends all push notifications, "NONE" sends no push notifications, "FILTERED" sends only filtered push notifications. * **FilterRule** *(string) --* The simple JSON object used to send a subset of a push notification to the requested member. **Exceptions** * "ChimeSDKMessaging.Client.exceptions.BadRequestException" * "ChimeSDKMessaging.Client.exceptions.ConflictException" * "ChimeSDKMessaging.Client.exceptions.UnauthorizedClientException" * "ChimeSDKMessaging.Client.exceptions.ForbiddenException" * "ChimeSDKMessaging.Client.exceptions.ThrottledClientException" * "ChimeSDKMessaging.Client.exceptions.ServiceUnavailableException" * "ChimeSDKMessaging.Client.exceptions.ServiceFailureException" ChimeSDKMessaging / Client / put_messaging_streaming_configurations put_messaging_streaming_configurations ************************************** ChimeSDKMessaging.Client.put_messaging_streaming_configurations(**kwargs) Sets the data streaming configuration for an "AppInstance". For more information, see Streaming messaging data in the *Amazon Chime SDK Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.put_messaging_streaming_configurations( AppInstanceArn='string', StreamingConfigurations=[ { 'DataType': 'Channel'|'ChannelMessage', 'ResourceArn': 'string' }, ] ) Parameters: * **AppInstanceArn** (*string*) -- **[REQUIRED]** The ARN of the streaming configuration. * **StreamingConfigurations** (*list*) -- **[REQUIRED]** The streaming configurations. * *(dict) --* The configuration for connecting a messaging stream to Amazon Kinesis. * **DataType** *(string) --* **[REQUIRED]** The data type of the configuration. * **ResourceArn** *(string) --* **[REQUIRED]** The ARN of the resource in the configuration. Return type: dict Returns: **Response Syntax** { 'StreamingConfigurations': [ { 'DataType': 'Channel'|'ChannelMessage', 'ResourceArn': 'string' }, ] } **Response Structure** * *(dict) --* * **StreamingConfigurations** *(list) --* The requested streaming configurations. * *(dict) --* The configuration for connecting a messaging stream to Amazon Kinesis. * **DataType** *(string) --* The data type of the configuration. * **ResourceArn** *(string) --* The ARN of the resource in the configuration. **Exceptions** * "ChimeSDKMessaging.Client.exceptions.NotFoundException" * "ChimeSDKMessaging.Client.exceptions.BadRequestException" * "ChimeSDKMessaging.Client.exceptions.ForbiddenException" * "ChimeSDKMessaging.Client.exceptions.UnauthorizedClientException" * "ChimeSDKMessaging.Client.exceptions.ThrottledClientException" * "ChimeSDKMessaging.Client.exceptions.ConflictException" * "ChimeSDKMessaging.Client.exceptions.ServiceUnavailableException" * "ChimeSDKMessaging.Client.exceptions.ServiceFailureException" ChimeSDKMessaging / Client / describe_channel_membership describe_channel_membership *************************** ChimeSDKMessaging.Client.describe_channel_membership(**kwargs) Returns the full details of a user's channel membership. Note: 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. See also: AWS API Documentation **Request Syntax** response = client.describe_channel_membership( ChannelArn='string', MemberArn='string', ChimeBearer='string', SubChannelId='string' ) Parameters: * **ChannelArn** (*string*) -- **[REQUIRED]** The ARN of the channel. * **MemberArn** (*string*) -- **[REQUIRED]** The "AppInstanceUserArn" of the member. * **ChimeBearer** (*string*) -- **[REQUIRED]** The ARN of the "AppInstanceUser" or "AppInstanceBot" that makes the API call. * **SubChannelId** (*string*) -- The ID of the SubChannel in the request. The response contains an "ElasticChannelConfiguration" object. Note: Only required to get a user’s SubChannel membership details. Return type: dict Returns: **Response Syntax** { 'ChannelMembership': { 'InvitedBy': { 'Arn': 'string', 'Name': 'string' }, 'Type': 'DEFAULT'|'HIDDEN', 'Member': { 'Arn': 'string', 'Name': 'string' }, 'ChannelArn': 'string', 'CreatedTimestamp': datetime(2015, 1, 1), 'LastUpdatedTimestamp': datetime(2015, 1, 1), 'SubChannelId': 'string' } } **Response Structure** * *(dict) --* * **ChannelMembership** *(dict) --* The details of the membership. * **InvitedBy** *(dict) --* The identifier of the member who invited another member. * **Arn** *(string) --* The ARN in an Identity. * **Name** *(string) --* The name in an Identity. * **Type** *(string) --* The membership type set for the channel member. * **Member** *(dict) --* The data of the channel member. * **Arn** *(string) --* The ARN in an Identity. * **Name** *(string) --* The name in an Identity. * **ChannelArn** *(string) --* The ARN of the member's channel. * **CreatedTimestamp** *(datetime) --* The time at which the channel membership was created. * **LastUpdatedTimestamp** *(datetime) --* The time at which a channel membership was last updated. * **SubChannelId** *(string) --* The ID of the SubChannel that a user belongs to. **Exceptions** * "ChimeSDKMessaging.Client.exceptions.BadRequestException" * "ChimeSDKMessaging.Client.exceptions.ForbiddenException" * "ChimeSDKMessaging.Client.exceptions.NotFoundException" * "ChimeSDKMessaging.Client.exceptions.UnauthorizedClientException" * "ChimeSDKMessaging.Client.exceptions.ThrottledClientException" * "ChimeSDKMessaging.Client.exceptions.ServiceUnavailableException" * "ChimeSDKMessaging.Client.exceptions.ServiceFailureException" ChimeSDKMessaging / Client / list_channel_memberships list_channel_memberships ************************ ChimeSDKMessaging.Client.list_channel_memberships(**kwargs) Lists all channel memberships in a channel. Note: 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. See also: AWS API Documentation **Request Syntax** response = client.list_channel_memberships( ChannelArn='string', Type='DEFAULT'|'HIDDEN', MaxResults=123, NextToken='string', ChimeBearer='string', SubChannelId='string' ) Parameters: * **ChannelArn** (*string*) -- **[REQUIRED]** The maximum number of channel memberships that you want returned. * **Type** (*string*) -- The membership type of a user, "DEFAULT" or "HIDDEN". Default members are returned as part of "ListChannelMemberships" if no type is specified. Hidden members are only returned if the type filter in "ListChannelMemberships" equals "HIDDEN". * **MaxResults** (*integer*) -- The maximum number of channel memberships that you want returned. * **NextToken** (*string*) -- The token passed by previous API calls until all requested channel memberships are returned. * **ChimeBearer** (*string*) -- **[REQUIRED]** The ARN of the "AppInstanceUser" or "AppInstanceBot" that makes the API call. * **SubChannelId** (*string*) -- The ID of the SubChannel in the request. Note: Only required when listing a user's memberships in a particular sub-channel of an elastic channel. Return type: dict Returns: **Response Syntax** { 'ChannelArn': 'string', 'ChannelMemberships': [ { 'Member': { 'Arn': 'string', 'Name': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ChannelArn** *(string) --* The ARN of the channel. * **ChannelMemberships** *(list) --* The information for the requested channel memberships. * *(dict) --* Summary of the details of a "ChannelMembership". * **Member** *(dict) --* A member's summary data. * **Arn** *(string) --* The ARN in an Identity. * **Name** *(string) --* The name in an Identity. * **NextToken** *(string) --* The token passed by previous API calls until all requested channel memberships are returned. **Exceptions** * "ChimeSDKMessaging.Client.exceptions.BadRequestException" * "ChimeSDKMessaging.Client.exceptions.ForbiddenException" * "ChimeSDKMessaging.Client.exceptions.UnauthorizedClientException" * "ChimeSDKMessaging.Client.exceptions.ThrottledClientException" * "ChimeSDKMessaging.Client.exceptions.ServiceUnavailableException" * "ChimeSDKMessaging.Client.exceptions.ServiceFailureException" ChimeSDKMessaging / Client / get_paginator get_paginator ************* ChimeSDKMessaging.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. ChimeSDKMessaging / Client / create_channel_moderator create_channel_moderator ************************ ChimeSDKMessaging.Client.create_channel_moderator(**kwargs) 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. Note: The "x-amz-chime-bearer" request header is mandatory. Use the ARN of the "AppInstanceUser" or >>``<