ChimeSDKMessagingClient

Index > ChimeSDKMessaging > ChimeSDKMessagingClient

Auto-generated documentation for ChimeSDKMessaging type annotations stubs module mypy-boto3-chime-sdk-messaging.

ChimeSDKMessagingClient

Type annotations and code completion for boto3.client("chime-sdk-messaging"). boto3 documentation

# ChimeSDKMessagingClient usage example

from boto3.session import Session
from mypy_boto3_chime_sdk_messaging.client import ChimeSDKMessagingClient

def get_chime-sdk-messaging_client() -> ChimeSDKMessagingClient:
    return Session().client("chime-sdk-messaging")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("chime-sdk-messaging").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("chime-sdk-messaging")

try:
    do_something(client)
except (
    client.exceptions.BadRequestException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.ForbiddenException,
    client.exceptions.NotFoundException,
    client.exceptions.ResourceLimitExceededException,
    client.exceptions.ServiceFailureException,
    client.exceptions.ServiceUnavailableException,
    client.exceptions.ThrottledClientException,
    client.exceptions.UnauthorizedClientException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_chime_sdk_messaging.client import Exceptions

def handle_error(exc: Exceptions.BadRequestException) -> None:
    ...

Methods

associate_channel_flow

Associates a channel flow with a channel.

Type annotations and code completion for boto3.client("chime-sdk-messaging").associate_channel_flow method. boto3 documentation

# associate_channel_flow method definition

def associate_channel_flow(
    self,
    *,
    ChannelArn: str,
    ChannelFlowArn: str,
    ChimeBearer: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# associate_channel_flow method usage example with argument unpacking

kwargs: AssociateChannelFlowRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "ChannelFlowArn": ...,
    "ChimeBearer": ...,
}

parent.associate_channel_flow(**kwargs)

1. See AssociateChannelFlowRequestRequestTypeDef

batch_create_channel_membership

Adds a specified number of users and bots to a channel.

Type annotations and code completion for boto3.client("chime-sdk-messaging").batch_create_channel_membership method. boto3 documentation

# batch_create_channel_membership method definition

def batch_create_channel_membership(
    self,
    *,
    ChannelArn: str,
    MemberArns: Sequence[str],
    ChimeBearer: str,
    Type: ChannelMembershipTypeType = ...,  # (1)
    SubChannelId: str = ...,
) -> BatchCreateChannelMembershipResponseTypeDef:  # (2)
    ...

1. See ChannelMembershipTypeType
2. See BatchCreateChannelMembershipResponseTypeDef

# batch_create_channel_membership method usage example with argument unpacking

kwargs: BatchCreateChannelMembershipRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "MemberArns": ...,
    "ChimeBearer": ...,
}

parent.batch_create_channel_membership(**kwargs)

1. See BatchCreateChannelMembershipRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("chime-sdk-messaging").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

channel_flow_callback

Calls back Chime SDK Messaging with a processing response message.

Type annotations and code completion for boto3.client("chime-sdk-messaging").channel_flow_callback method. boto3 documentation

# channel_flow_callback method definition

def channel_flow_callback(
    self,
    *,
    CallbackId: str,
    ChannelArn: str,
    ChannelMessage: ChannelMessageCallbackTypeDef,  # (1)
    DeleteResource: bool = ...,
) -> ChannelFlowCallbackResponseTypeDef:  # (2)
    ...

1. See ChannelMessageCallbackTypeDef
2. See ChannelFlowCallbackResponseTypeDef

# channel_flow_callback method usage example with argument unpacking

kwargs: ChannelFlowCallbackRequestRequestTypeDef = {  # (1)
    "CallbackId": ...,
    "ChannelArn": ...,
    "ChannelMessage": ...,
}

parent.channel_flow_callback(**kwargs)

1. See ChannelFlowCallbackRequestRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("chime-sdk-messaging").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_channel

Creates a channel to which you can add users and send messages.

Type annotations and code completion for boto3.client("chime-sdk-messaging").create_channel method. boto3 documentation

# create_channel method definition

def create_channel(
    self,
    *,
    AppInstanceArn: str,
    Name: str,
    ClientRequestToken: str,
    ChimeBearer: str,
    Mode: ChannelModeType = ...,  # (1)
    Privacy: ChannelPrivacyType = ...,  # (2)
    Metadata: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    ChannelId: str = ...,
    MemberArns: Sequence[str] = ...,
    ModeratorArns: Sequence[str] = ...,
    ElasticChannelConfiguration: ElasticChannelConfigurationTypeDef = ...,  # (4)
    ExpirationSettings: ExpirationSettingsTypeDef = ...,  # (5)
) -> CreateChannelResponseTypeDef:  # (6)
    ...

1. See ChannelModeType
2. See ChannelPrivacyType
3. See TagTypeDef
4. See ElasticChannelConfigurationTypeDef
5. See ExpirationSettingsTypeDef
6. See CreateChannelResponseTypeDef

# create_channel method usage example with argument unpacking

kwargs: CreateChannelRequestRequestTypeDef = {  # (1)
    "AppInstanceArn": ...,
    "Name": ...,
    "ClientRequestToken": ...,
    "ChimeBearer": ...,
}

parent.create_channel(**kwargs)

1. See CreateChannelRequestRequestTypeDef

create_channel_ban

Permanently bans a member from a channel.

Type annotations and code completion for boto3.client("chime-sdk-messaging").create_channel_ban method. boto3 documentation

# create_channel_ban method definition

def create_channel_ban(
    self,
    *,
    ChannelArn: str,
    MemberArn: str,
    ChimeBearer: str,
) -> CreateChannelBanResponseTypeDef:  # (1)
    ...

1. See CreateChannelBanResponseTypeDef

# create_channel_ban method usage example with argument unpacking

kwargs: CreateChannelBanRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "MemberArn": ...,
    "ChimeBearer": ...,
}

parent.create_channel_ban(**kwargs)

1. See CreateChannelBanRequestRequestTypeDef

create_channel_flow

Creates a channel flow, a container for processors.

Type annotations and code completion for boto3.client("chime-sdk-messaging").create_channel_flow method. boto3 documentation

# create_channel_flow method definition

def create_channel_flow(
    self,
    *,
    AppInstanceArn: str,
    Processors: Sequence[ProcessorTypeDef],  # (1)
    Name: str,
    ClientRequestToken: str,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateChannelFlowResponseTypeDef:  # (3)
    ...

1. See ProcessorTypeDef
2. See TagTypeDef
3. See CreateChannelFlowResponseTypeDef

# create_channel_flow method usage example with argument unpacking

kwargs: CreateChannelFlowRequestRequestTypeDef = {  # (1)
    "AppInstanceArn": ...,
    "Processors": ...,
    "Name": ...,
    "ClientRequestToken": ...,
}

parent.create_channel_flow(**kwargs)

1. See CreateChannelFlowRequestRequestTypeDef

create_channel_membership

Adds a member to a channel.

Type annotations and code completion for boto3.client("chime-sdk-messaging").create_channel_membership method. boto3 documentation

# create_channel_membership method definition

def create_channel_membership(
    self,
    *,
    ChannelArn: str,
    MemberArn: str,
    Type: ChannelMembershipTypeType,  # (1)
    ChimeBearer: str,
    SubChannelId: str = ...,
) -> CreateChannelMembershipResponseTypeDef:  # (2)
    ...

1. See ChannelMembershipTypeType
2. See CreateChannelMembershipResponseTypeDef

# create_channel_membership method usage example with argument unpacking

kwargs: CreateChannelMembershipRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "MemberArn": ...,
    "Type": ...,
    "ChimeBearer": ...,
}

parent.create_channel_membership(**kwargs)

1. See CreateChannelMembershipRequestRequestTypeDef

create_channel_moderator

Creates a new ChannelModerator.

Type annotations and code completion for boto3.client("chime-sdk-messaging").create_channel_moderator method. boto3 documentation

# create_channel_moderator method definition

def create_channel_moderator(
    self,
    *,
    ChannelArn: str,
    ChannelModeratorArn: str,
    ChimeBearer: str,
) -> CreateChannelModeratorResponseTypeDef:  # (1)
    ...

1. See CreateChannelModeratorResponseTypeDef

# create_channel_moderator method usage example with argument unpacking

kwargs: CreateChannelModeratorRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "ChannelModeratorArn": ...,
    "ChimeBearer": ...,
}

parent.create_channel_moderator(**kwargs)

1. See CreateChannelModeratorRequestRequestTypeDef

delete_channel

Immediately makes a channel and its memberships inaccessible and marks them for deletion.

Type annotations and code completion for boto3.client("chime-sdk-messaging").delete_channel method. boto3 documentation

# delete_channel method definition

def delete_channel(
    self,
    *,
    ChannelArn: str,
    ChimeBearer: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_channel method usage example with argument unpacking

kwargs: DeleteChannelRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "ChimeBearer": ...,
}

parent.delete_channel(**kwargs)

1. See DeleteChannelRequestRequestTypeDef

delete_channel_ban

Removes a member from a channel's ban list.

Type annotations and code completion for boto3.client("chime-sdk-messaging").delete_channel_ban method. boto3 documentation

# delete_channel_ban method definition

def delete_channel_ban(
    self,
    *,
    ChannelArn: str,
    MemberArn: str,
    ChimeBearer: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_channel_ban method usage example with argument unpacking

kwargs: DeleteChannelBanRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "MemberArn": ...,
    "ChimeBearer": ...,
}

parent.delete_channel_ban(**kwargs)

1. See DeleteChannelBanRequestRequestTypeDef

delete_channel_flow

Deletes a channel flow, an irreversible process.

Type annotations and code completion for boto3.client("chime-sdk-messaging").delete_channel_flow method. boto3 documentation

# delete_channel_flow method definition

def delete_channel_flow(
    self,
    *,
    ChannelFlowArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_channel_flow method usage example with argument unpacking

kwargs: DeleteChannelFlowRequestRequestTypeDef = {  # (1)
    "ChannelFlowArn": ...,
}

parent.delete_channel_flow(**kwargs)

1. See DeleteChannelFlowRequestRequestTypeDef

delete_channel_membership

Removes a member from a channel.

Type annotations and code completion for boto3.client("chime-sdk-messaging").delete_channel_membership method. boto3 documentation

# delete_channel_membership method definition

def delete_channel_membership(
    self,
    *,
    ChannelArn: str,
    MemberArn: str,
    ChimeBearer: str,
    SubChannelId: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_channel_membership method usage example with argument unpacking

kwargs: DeleteChannelMembershipRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "MemberArn": ...,
    "ChimeBearer": ...,
}

parent.delete_channel_membership(**kwargs)

1. See DeleteChannelMembershipRequestRequestTypeDef

delete_channel_message

Deletes a channel message.

Type annotations and code completion for boto3.client("chime-sdk-messaging").delete_channel_message method. boto3 documentation

# delete_channel_message method definition

def delete_channel_message(
    self,
    *,
    ChannelArn: str,
    MessageId: str,
    ChimeBearer: str,
    SubChannelId: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_channel_message method usage example with argument unpacking

kwargs: DeleteChannelMessageRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "MessageId": ...,
    "ChimeBearer": ...,
}

parent.delete_channel_message(**kwargs)

1. See DeleteChannelMessageRequestRequestTypeDef

delete_channel_moderator

Deletes a channel moderator.

Type annotations and code completion for boto3.client("chime-sdk-messaging").delete_channel_moderator method. boto3 documentation

# delete_channel_moderator method definition

def delete_channel_moderator(
    self,
    *,
    ChannelArn: str,
    ChannelModeratorArn: str,
    ChimeBearer: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_channel_moderator method usage example with argument unpacking

kwargs: DeleteChannelModeratorRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "ChannelModeratorArn": ...,
    "ChimeBearer": ...,
}

parent.delete_channel_moderator(**kwargs)

1. See DeleteChannelModeratorRequestRequestTypeDef

delete_messaging_streaming_configurations

Deletes the streaming configurations for an AppInstance.

Type annotations and code completion for boto3.client("chime-sdk-messaging").delete_messaging_streaming_configurations method. boto3 documentation

# delete_messaging_streaming_configurations method definition

def delete_messaging_streaming_configurations(
    self,
    *,
    AppInstanceArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_messaging_streaming_configurations method usage example with argument unpacking

kwargs: DeleteMessagingStreamingConfigurationsRequestRequestTypeDef = {  # (1)
    "AppInstanceArn": ...,
}

parent.delete_messaging_streaming_configurations(**kwargs)

1. See DeleteMessagingStreamingConfigurationsRequestRequestTypeDef

describe_channel

Returns the full details of a channel in an Amazon Chime AppInstance.

Type annotations and code completion for boto3.client("chime-sdk-messaging").describe_channel method. boto3 documentation

# describe_channel method definition

def describe_channel(
    self,
    *,
    ChannelArn: str,
    ChimeBearer: str,
) -> DescribeChannelResponseTypeDef:  # (1)
    ...

1. See DescribeChannelResponseTypeDef

# describe_channel method usage example with argument unpacking

kwargs: DescribeChannelRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "ChimeBearer": ...,
}

parent.describe_channel(**kwargs)

1. See DescribeChannelRequestRequestTypeDef

describe_channel_ban

Returns the full details of a channel ban.

Type annotations and code completion for boto3.client("chime-sdk-messaging").describe_channel_ban method. boto3 documentation

# describe_channel_ban method definition

def describe_channel_ban(
    self,
    *,
    ChannelArn: str,
    MemberArn: str,
    ChimeBearer: str,
) -> DescribeChannelBanResponseTypeDef:  # (1)
    ...

1. See DescribeChannelBanResponseTypeDef

# describe_channel_ban method usage example with argument unpacking

kwargs: DescribeChannelBanRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "MemberArn": ...,
    "ChimeBearer": ...,
}

parent.describe_channel_ban(**kwargs)

1. See DescribeChannelBanRequestRequestTypeDef

describe_channel_flow

Returns the full details of a channel flow in an Amazon Chime AppInstance.

Type annotations and code completion for boto3.client("chime-sdk-messaging").describe_channel_flow method. boto3 documentation

# describe_channel_flow method definition

def describe_channel_flow(
    self,
    *,
    ChannelFlowArn: str,
) -> DescribeChannelFlowResponseTypeDef:  # (1)
    ...

1. See DescribeChannelFlowResponseTypeDef

# describe_channel_flow method usage example with argument unpacking

kwargs: DescribeChannelFlowRequestRequestTypeDef = {  # (1)
    "ChannelFlowArn": ...,
}

parent.describe_channel_flow(**kwargs)

1. See DescribeChannelFlowRequestRequestTypeDef

describe_channel_membership

Returns the full details of a user's channel membership.

Type annotations and code completion for boto3.client("chime-sdk-messaging").describe_channel_membership method. boto3 documentation

# describe_channel_membership method definition

def describe_channel_membership(
    self,
    *,
    ChannelArn: str,
    MemberArn: str,
    ChimeBearer: str,
    SubChannelId: str = ...,
) -> DescribeChannelMembershipResponseTypeDef:  # (1)
    ...

1. See DescribeChannelMembershipResponseTypeDef

# describe_channel_membership method usage example with argument unpacking

kwargs: DescribeChannelMembershipRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "MemberArn": ...,
    "ChimeBearer": ...,
}

parent.describe_channel_membership(**kwargs)

1. See DescribeChannelMembershipRequestRequestTypeDef

describe_channel_membership_for_app_instance_user

Returns the details of a channel based on the membership of the specified AppInstanceUser or AppInstanceBot.

Type annotations and code completion for boto3.client("chime-sdk-messaging").describe_channel_membership_for_app_instance_user method. boto3 documentation

# describe_channel_membership_for_app_instance_user method definition

def describe_channel_membership_for_app_instance_user(
    self,
    *,
    ChannelArn: str,
    AppInstanceUserArn: str,
    ChimeBearer: str,
) -> DescribeChannelMembershipForAppInstanceUserResponseTypeDef:  # (1)
    ...

1. See DescribeChannelMembershipForAppInstanceUserResponseTypeDef

# describe_channel_membership_for_app_instance_user method usage example with argument unpacking

kwargs: DescribeChannelMembershipForAppInstanceUserRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "AppInstanceUserArn": ...,
    "ChimeBearer": ...,
}

parent.describe_channel_membership_for_app_instance_user(**kwargs)

1. See DescribeChannelMembershipForAppInstanceUserRequestRequestTypeDef

describe_channel_moderated_by_app_instance_user

Returns the full details of a channel moderated by the specified AppInstanceUser or AppInstanceBot.

Type annotations and code completion for boto3.client("chime-sdk-messaging").describe_channel_moderated_by_app_instance_user method. boto3 documentation

# describe_channel_moderated_by_app_instance_user method definition

def describe_channel_moderated_by_app_instance_user(
    self,
    *,
    ChannelArn: str,
    AppInstanceUserArn: str,
    ChimeBearer: str,
) -> DescribeChannelModeratedByAppInstanceUserResponseTypeDef:  # (1)
    ...

1. See DescribeChannelModeratedByAppInstanceUserResponseTypeDef

# describe_channel_moderated_by_app_instance_user method usage example with argument unpacking

kwargs: DescribeChannelModeratedByAppInstanceUserRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "AppInstanceUserArn": ...,
    "ChimeBearer": ...,
}

parent.describe_channel_moderated_by_app_instance_user(**kwargs)

1. See DescribeChannelModeratedByAppInstanceUserRequestRequestTypeDef

describe_channel_moderator

Returns the full details of a single ChannelModerator.

Type annotations and code completion for boto3.client("chime-sdk-messaging").describe_channel_moderator method. boto3 documentation

# describe_channel_moderator method definition

def describe_channel_moderator(
    self,
    *,
    ChannelArn: str,
    ChannelModeratorArn: str,
    ChimeBearer: str,
) -> DescribeChannelModeratorResponseTypeDef:  # (1)
    ...

1. See DescribeChannelModeratorResponseTypeDef

# describe_channel_moderator method usage example with argument unpacking

kwargs: DescribeChannelModeratorRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "ChannelModeratorArn": ...,
    "ChimeBearer": ...,
}

parent.describe_channel_moderator(**kwargs)

1. See DescribeChannelModeratorRequestRequestTypeDef

disassociate_channel_flow

Disassociates a channel flow from all its channels.

Type annotations and code completion for boto3.client("chime-sdk-messaging").disassociate_channel_flow method. boto3 documentation

# disassociate_channel_flow method definition

def disassociate_channel_flow(
    self,
    *,
    ChannelArn: str,
    ChannelFlowArn: str,
    ChimeBearer: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# disassociate_channel_flow method usage example with argument unpacking

kwargs: DisassociateChannelFlowRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "ChannelFlowArn": ...,
    "ChimeBearer": ...,
}

parent.disassociate_channel_flow(**kwargs)

1. See DisassociateChannelFlowRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("chime-sdk-messaging").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_channel_membership_preferences

Gets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel.

Type annotations and code completion for boto3.client("chime-sdk-messaging").get_channel_membership_preferences method. boto3 documentation

# get_channel_membership_preferences method definition

def get_channel_membership_preferences(
    self,
    *,
    ChannelArn: str,
    MemberArn: str,
    ChimeBearer: str,
) -> GetChannelMembershipPreferencesResponseTypeDef:  # (1)
    ...

1. See GetChannelMembershipPreferencesResponseTypeDef

# get_channel_membership_preferences method usage example with argument unpacking

kwargs: GetChannelMembershipPreferencesRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "MemberArn": ...,
    "ChimeBearer": ...,
}

parent.get_channel_membership_preferences(**kwargs)

1. See GetChannelMembershipPreferencesRequestRequestTypeDef

get_channel_message

Gets the full details of a channel message.

Type annotations and code completion for boto3.client("chime-sdk-messaging").get_channel_message method. boto3 documentation

# get_channel_message method definition

def get_channel_message(
    self,
    *,
    ChannelArn: str,
    MessageId: str,
    ChimeBearer: str,
    SubChannelId: str = ...,
) -> GetChannelMessageResponseTypeDef:  # (1)
    ...

1. See GetChannelMessageResponseTypeDef

# get_channel_message method usage example with argument unpacking

kwargs: GetChannelMessageRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "MessageId": ...,
    "ChimeBearer": ...,
}

parent.get_channel_message(**kwargs)

1. See GetChannelMessageRequestRequestTypeDef

get_channel_message_status

Gets message status for a specified messageId.

Type annotations and code completion for boto3.client("chime-sdk-messaging").get_channel_message_status method. boto3 documentation

# get_channel_message_status method definition

def get_channel_message_status(
    self,
    *,
    ChannelArn: str,
    MessageId: str,
    ChimeBearer: str,
    SubChannelId: str = ...,
) -> GetChannelMessageStatusResponseTypeDef:  # (1)
    ...

1. See GetChannelMessageStatusResponseTypeDef

# get_channel_message_status method usage example with argument unpacking

kwargs: GetChannelMessageStatusRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "MessageId": ...,
    "ChimeBearer": ...,
}

parent.get_channel_message_status(**kwargs)

1. See GetChannelMessageStatusRequestRequestTypeDef

get_messaging_session_endpoint

The details of the endpoint for the messaging session.

Type annotations and code completion for boto3.client("chime-sdk-messaging").get_messaging_session_endpoint method. boto3 documentation

# get_messaging_session_endpoint method definition

def get_messaging_session_endpoint(
    self,
) -> GetMessagingSessionEndpointResponseTypeDef:  # (1)
    ...

1. See GetMessagingSessionEndpointResponseTypeDef

get_messaging_streaming_configurations

Retrieves the data streaming configuration for an AppInstance.

Type annotations and code completion for boto3.client("chime-sdk-messaging").get_messaging_streaming_configurations method. boto3 documentation

# get_messaging_streaming_configurations method definition

def get_messaging_streaming_configurations(
    self,
    *,
    AppInstanceArn: str,
) -> GetMessagingStreamingConfigurationsResponseTypeDef:  # (1)
    ...

1. See GetMessagingStreamingConfigurationsResponseTypeDef

# get_messaging_streaming_configurations method usage example with argument unpacking

kwargs: GetMessagingStreamingConfigurationsRequestRequestTypeDef = {  # (1)
    "AppInstanceArn": ...,
}

parent.get_messaging_streaming_configurations(**kwargs)

1. See GetMessagingStreamingConfigurationsRequestRequestTypeDef

list_channel_bans

Lists all the users and bots banned from a particular channel.

Type annotations and code completion for boto3.client("chime-sdk-messaging").list_channel_bans method. boto3 documentation

# list_channel_bans method definition

def list_channel_bans(
    self,
    *,
    ChannelArn: str,
    ChimeBearer: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListChannelBansResponseTypeDef:  # (1)
    ...

1. See ListChannelBansResponseTypeDef

# list_channel_bans method usage example with argument unpacking

kwargs: ListChannelBansRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "ChimeBearer": ...,
}

parent.list_channel_bans(**kwargs)

1. See ListChannelBansRequestRequestTypeDef

list_channel_flows

Returns a paginated lists of all the channel flows created under a single Chime.

Type annotations and code completion for boto3.client("chime-sdk-messaging").list_channel_flows method. boto3 documentation

# list_channel_flows method definition

def list_channel_flows(
    self,
    *,
    AppInstanceArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListChannelFlowsResponseTypeDef:  # (1)
    ...

1. See ListChannelFlowsResponseTypeDef

# list_channel_flows method usage example with argument unpacking

kwargs: ListChannelFlowsRequestRequestTypeDef = {  # (1)
    "AppInstanceArn": ...,
}

parent.list_channel_flows(**kwargs)

1. See ListChannelFlowsRequestRequestTypeDef

list_channel_memberships

Lists all channel memberships in a channel.

Type annotations and code completion for boto3.client("chime-sdk-messaging").list_channel_memberships method. boto3 documentation

# list_channel_memberships method definition

def list_channel_memberships(
    self,
    *,
    ChannelArn: str,
    ChimeBearer: str,
    Type: ChannelMembershipTypeType = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
    SubChannelId: str = ...,
) -> ListChannelMembershipsResponseTypeDef:  # (2)
    ...

1. See ChannelMembershipTypeType
2. See ListChannelMembershipsResponseTypeDef

# list_channel_memberships method usage example with argument unpacking

kwargs: ListChannelMembershipsRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "ChimeBearer": ...,
}

parent.list_channel_memberships(**kwargs)

1. See ListChannelMembershipsRequestRequestTypeDef

list_channel_memberships_for_app_instance_user

Lists all channels that anr AppInstanceUser or AppInstanceBot is a part of.

Type annotations and code completion for boto3.client("chime-sdk-messaging").list_channel_memberships_for_app_instance_user method. boto3 documentation

# list_channel_memberships_for_app_instance_user method definition

def list_channel_memberships_for_app_instance_user(
    self,
    *,
    ChimeBearer: str,
    AppInstanceUserArn: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListChannelMembershipsForAppInstanceUserResponseTypeDef:  # (1)
    ...

1. See ListChannelMembershipsForAppInstanceUserResponseTypeDef

# list_channel_memberships_for_app_instance_user method usage example with argument unpacking

kwargs: ListChannelMembershipsForAppInstanceUserRequestRequestTypeDef = {  # (1)
    "ChimeBearer": ...,
}

parent.list_channel_memberships_for_app_instance_user(**kwargs)

1. See ListChannelMembershipsForAppInstanceUserRequestRequestTypeDef

list_channel_messages

List all the messages in a channel.

Type annotations and code completion for boto3.client("chime-sdk-messaging").list_channel_messages method. boto3 documentation

# list_channel_messages method definition

def list_channel_messages(
    self,
    *,
    ChannelArn: str,
    ChimeBearer: str,
    SortOrder: SortOrderType = ...,  # (1)
    NotBefore: Union[datetime, str] = ...,
    NotAfter: Union[datetime, str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    SubChannelId: str = ...,
) -> ListChannelMessagesResponseTypeDef:  # (2)
    ...

1. See SortOrderType
2. See ListChannelMessagesResponseTypeDef

# list_channel_messages method usage example with argument unpacking

kwargs: ListChannelMessagesRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "ChimeBearer": ...,
}

parent.list_channel_messages(**kwargs)

1. See ListChannelMessagesRequestRequestTypeDef

list_channel_moderators

Lists all the moderators for a channel.

Type annotations and code completion for boto3.client("chime-sdk-messaging").list_channel_moderators method. boto3 documentation

# list_channel_moderators method definition

def list_channel_moderators(
    self,
    *,
    ChannelArn: str,
    ChimeBearer: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListChannelModeratorsResponseTypeDef:  # (1)
    ...

1. See ListChannelModeratorsResponseTypeDef

# list_channel_moderators method usage example with argument unpacking

kwargs: ListChannelModeratorsRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "ChimeBearer": ...,
}

parent.list_channel_moderators(**kwargs)

1. See ListChannelModeratorsRequestRequestTypeDef

list_channels

Lists all Channels created under a single Chime App as a paginated list.

Type annotations and code completion for boto3.client("chime-sdk-messaging").list_channels method. boto3 documentation

# list_channels method definition

def list_channels(
    self,
    *,
    AppInstanceArn: str,
    ChimeBearer: str,
    Privacy: ChannelPrivacyType = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListChannelsResponseTypeDef:  # (2)
    ...

1. See ChannelPrivacyType
2. See ListChannelsResponseTypeDef

# list_channels method usage example with argument unpacking

kwargs: ListChannelsRequestRequestTypeDef = {  # (1)
    "AppInstanceArn": ...,
    "ChimeBearer": ...,
}

parent.list_channels(**kwargs)

1. See ListChannelsRequestRequestTypeDef

list_channels_associated_with_channel_flow

Lists all channels associated with a specified channel flow.

Type annotations and code completion for boto3.client("chime-sdk-messaging").list_channels_associated_with_channel_flow method. boto3 documentation

# list_channels_associated_with_channel_flow method definition

def list_channels_associated_with_channel_flow(
    self,
    *,
    ChannelFlowArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListChannelsAssociatedWithChannelFlowResponseTypeDef:  # (1)
    ...

1. See ListChannelsAssociatedWithChannelFlowResponseTypeDef

# list_channels_associated_with_channel_flow method usage example with argument unpacking

kwargs: ListChannelsAssociatedWithChannelFlowRequestRequestTypeDef = {  # (1)
    "ChannelFlowArn": ...,
}

parent.list_channels_associated_with_channel_flow(**kwargs)

1. See ListChannelsAssociatedWithChannelFlowRequestRequestTypeDef

list_channels_moderated_by_app_instance_user

A list of the channels moderated by an AppInstanceUser.

Type annotations and code completion for boto3.client("chime-sdk-messaging").list_channels_moderated_by_app_instance_user method. boto3 documentation

# list_channels_moderated_by_app_instance_user method definition

def list_channels_moderated_by_app_instance_user(
    self,
    *,
    ChimeBearer: str,
    AppInstanceUserArn: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListChannelsModeratedByAppInstanceUserResponseTypeDef:  # (1)
    ...

1. See ListChannelsModeratedByAppInstanceUserResponseTypeDef

# list_channels_moderated_by_app_instance_user method usage example with argument unpacking

kwargs: ListChannelsModeratedByAppInstanceUserRequestRequestTypeDef = {  # (1)
    "ChimeBearer": ...,
}

parent.list_channels_moderated_by_app_instance_user(**kwargs)

1. See ListChannelsModeratedByAppInstanceUserRequestRequestTypeDef

list_sub_channels

Lists all the SubChannels in an elastic channel when given a channel ID.

Type annotations and code completion for boto3.client("chime-sdk-messaging").list_sub_channels method. boto3 documentation

# list_sub_channels method definition

def list_sub_channels(
    self,
    *,
    ChannelArn: str,
    ChimeBearer: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListSubChannelsResponseTypeDef:  # (1)
    ...

1. See ListSubChannelsResponseTypeDef

# list_sub_channels method usage example with argument unpacking

kwargs: ListSubChannelsRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "ChimeBearer": ...,
}

parent.list_sub_channels(**kwargs)

1. See ListSubChannelsRequestRequestTypeDef

list_tags_for_resource

Lists the tags applied to an Amazon Chime SDK messaging resource.

Type annotations and code completion for boto3.client("chime-sdk-messaging").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

put_channel_expiration_settings

Sets the number of days before the channel is automatically deleted.

Type annotations and code completion for boto3.client("chime-sdk-messaging").put_channel_expiration_settings method. boto3 documentation

# put_channel_expiration_settings method definition

def put_channel_expiration_settings(
    self,
    *,
    ChannelArn: str,
    ChimeBearer: str = ...,
    ExpirationSettings: ExpirationSettingsTypeDef = ...,  # (1)
) -> PutChannelExpirationSettingsResponseTypeDef:  # (2)
    ...

1. See ExpirationSettingsTypeDef
2. See PutChannelExpirationSettingsResponseTypeDef

# put_channel_expiration_settings method usage example with argument unpacking

kwargs: PutChannelExpirationSettingsRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
}

parent.put_channel_expiration_settings(**kwargs)

1. See PutChannelExpirationSettingsRequestRequestTypeDef

put_channel_membership_preferences

Sets the membership preferences of an AppInstanceUser or AppIntanceBot for the specified channel.

Type annotations and code completion for boto3.client("chime-sdk-messaging").put_channel_membership_preferences method. boto3 documentation

# put_channel_membership_preferences method definition

def put_channel_membership_preferences(
    self,
    *,
    ChannelArn: str,
    MemberArn: str,
    ChimeBearer: str,
    Preferences: ChannelMembershipPreferencesTypeDef,  # (1)
) -> PutChannelMembershipPreferencesResponseTypeDef:  # (2)
    ...

1. See ChannelMembershipPreferencesTypeDef
2. See PutChannelMembershipPreferencesResponseTypeDef

# put_channel_membership_preferences method usage example with argument unpacking

kwargs: PutChannelMembershipPreferencesRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "MemberArn": ...,
    "ChimeBearer": ...,
    "Preferences": ...,
}

parent.put_channel_membership_preferences(**kwargs)

1. See PutChannelMembershipPreferencesRequestRequestTypeDef

put_messaging_streaming_configurations

Sets the data streaming configuration for an AppInstance.

Type annotations and code completion for boto3.client("chime-sdk-messaging").put_messaging_streaming_configurations method. boto3 documentation

# put_messaging_streaming_configurations method definition

def put_messaging_streaming_configurations(
    self,
    *,
    AppInstanceArn: str,
    StreamingConfigurations: Sequence[StreamingConfigurationTypeDef],  # (1)
) -> PutMessagingStreamingConfigurationsResponseTypeDef:  # (2)
    ...

1. See StreamingConfigurationTypeDef
2. See PutMessagingStreamingConfigurationsResponseTypeDef

# put_messaging_streaming_configurations method usage example with argument unpacking

kwargs: PutMessagingStreamingConfigurationsRequestRequestTypeDef = {  # (1)
    "AppInstanceArn": ...,
    "StreamingConfigurations": ...,
}

parent.put_messaging_streaming_configurations(**kwargs)

1. See PutMessagingStreamingConfigurationsRequestRequestTypeDef

redact_channel_message

Redacts message content, but not metadata.

Type annotations and code completion for boto3.client("chime-sdk-messaging").redact_channel_message method. boto3 documentation

# redact_channel_message method definition

def redact_channel_message(
    self,
    *,
    ChannelArn: str,
    MessageId: str,
    ChimeBearer: str,
    SubChannelId: str = ...,
) -> RedactChannelMessageResponseTypeDef:  # (1)
    ...

1. See RedactChannelMessageResponseTypeDef

# redact_channel_message method usage example with argument unpacking

kwargs: RedactChannelMessageRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "MessageId": ...,
    "ChimeBearer": ...,
}

parent.redact_channel_message(**kwargs)

1. See RedactChannelMessageRequestRequestTypeDef

search_channels

Allows the ChimeBearer to search channels by channel members.

Type annotations and code completion for boto3.client("chime-sdk-messaging").search_channels method. boto3 documentation

# search_channels method definition

def search_channels(
    self,
    *,
    Fields: Sequence[SearchFieldTypeDef],  # (1)
    ChimeBearer: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> SearchChannelsResponseTypeDef:  # (2)
    ...

1. See SearchFieldTypeDef
2. See SearchChannelsResponseTypeDef

# search_channels method usage example with argument unpacking

kwargs: SearchChannelsRequestRequestTypeDef = {  # (1)
    "Fields": ...,
}

parent.search_channels(**kwargs)

1. See SearchChannelsRequestRequestTypeDef

send_channel_message

Sends a message to a particular channel that the member is a part of.

Type annotations and code completion for boto3.client("chime-sdk-messaging").send_channel_message method. boto3 documentation

# send_channel_message method definition

def send_channel_message(
    self,
    *,
    ChannelArn: str,
    Content: str,
    Type: ChannelMessageTypeType,  # (1)
    Persistence: ChannelMessagePersistenceTypeType,  # (2)
    ClientRequestToken: str,
    ChimeBearer: str,
    Metadata: str = ...,
    PushNotification: PushNotificationConfigurationTypeDef = ...,  # (3)
    MessageAttributes: Mapping[str, MessageAttributeValueTypeDef] = ...,  # (4)
    SubChannelId: str = ...,
    ContentType: str = ...,
) -> SendChannelMessageResponseTypeDef:  # (5)
    ...

1. See ChannelMessageTypeType
2. See ChannelMessagePersistenceTypeType
3. See PushNotificationConfigurationTypeDef
4. See MessageAttributeValueTypeDef
5. See SendChannelMessageResponseTypeDef

# send_channel_message method usage example with argument unpacking

kwargs: SendChannelMessageRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "Content": ...,
    "Type": ...,
    "Persistence": ...,
    "ClientRequestToken": ...,
    "ChimeBearer": ...,
}

parent.send_channel_message(**kwargs)

1. See SendChannelMessageRequestRequestTypeDef

tag_resource

Applies the specified tags to the specified Amazon Chime SDK messaging resource.

Type annotations and code completion for boto3.client("chime-sdk-messaging").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See EmptyResponseMetadataTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes the specified tags from the specified Amazon Chime SDK messaging resource.

Type annotations and code completion for boto3.client("chime-sdk-messaging").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceARN: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_channel

Update a channel's attributes.

Type annotations and code completion for boto3.client("chime-sdk-messaging").update_channel method. boto3 documentation

# update_channel method definition

def update_channel(
    self,
    *,
    ChannelArn: str,
    ChimeBearer: str,
    Name: str = ...,
    Mode: ChannelModeType = ...,  # (1)
    Metadata: str = ...,
) -> UpdateChannelResponseTypeDef:  # (2)
    ...

1. See ChannelModeType
2. See UpdateChannelResponseTypeDef

# update_channel method usage example with argument unpacking

kwargs: UpdateChannelRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "ChimeBearer": ...,
}

parent.update_channel(**kwargs)

1. See UpdateChannelRequestRequestTypeDef

update_channel_flow

Updates channel flow attributes.

Type annotations and code completion for boto3.client("chime-sdk-messaging").update_channel_flow method. boto3 documentation

# update_channel_flow method definition

def update_channel_flow(
    self,
    *,
    ChannelFlowArn: str,
    Processors: Sequence[ProcessorTypeDef],  # (1)
    Name: str,
) -> UpdateChannelFlowResponseTypeDef:  # (2)
    ...

1. See ProcessorTypeDef
2. See UpdateChannelFlowResponseTypeDef

# update_channel_flow method usage example with argument unpacking

kwargs: UpdateChannelFlowRequestRequestTypeDef = {  # (1)
    "ChannelFlowArn": ...,
    "Processors": ...,
    "Name": ...,
}

parent.update_channel_flow(**kwargs)

1. See UpdateChannelFlowRequestRequestTypeDef

update_channel_message

Updates the content of a message.

Type annotations and code completion for boto3.client("chime-sdk-messaging").update_channel_message method. boto3 documentation

# update_channel_message method definition

def update_channel_message(
    self,
    *,
    ChannelArn: str,
    MessageId: str,
    Content: str,
    ChimeBearer: str,
    Metadata: str = ...,
    SubChannelId: str = ...,
    ContentType: str = ...,
) -> UpdateChannelMessageResponseTypeDef:  # (1)
    ...

1. See UpdateChannelMessageResponseTypeDef

# update_channel_message method usage example with argument unpacking

kwargs: UpdateChannelMessageRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "MessageId": ...,
    "Content": ...,
    "ChimeBearer": ...,
}

parent.update_channel_message(**kwargs)

1. See UpdateChannelMessageRequestRequestTypeDef

update_channel_read_marker

The details of the time when a user last read messages in a channel.

Type annotations and code completion for boto3.client("chime-sdk-messaging").update_channel_read_marker method. boto3 documentation

# update_channel_read_marker method definition

def update_channel_read_marker(
    self,
    *,
    ChannelArn: str,
    ChimeBearer: str,
) -> UpdateChannelReadMarkerResponseTypeDef:  # (1)
    ...

1. See UpdateChannelReadMarkerResponseTypeDef

# update_channel_read_marker method usage example with argument unpacking

kwargs: UpdateChannelReadMarkerRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "ChimeBearer": ...,
}

parent.update_channel_read_marker(**kwargs)

1. See UpdateChannelReadMarkerRequestRequestTypeDef