ChimeSDKMessagingClient

Index > ChimeSDKMessaging > ChimeSDKMessagingClient

Auto-generated documentation for ChimeSDKMessaging type annotations stubs module types-aiobotocore-chime-sdk-messaging.

ChimeSDKMessagingClient

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

Usage example

from aioboto3.session import Session
from types_aiobotocore_chime_sdk_messaging.client import ChimeSDKMessagingClient

session = Session()
async with session.client("chime-sdk-messaging") as client:
    client: ChimeSDKMessagingClient

Exceptions

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

Usage example

async with session.client("chime-sdk-messaging") as client:
    try:
        do_something(client)
    except (
            client.BadRequestException,
        client.ClientError,
        client.ConflictException,
        client.ForbiddenException,
        client.NotFoundException,
        client.ResourceLimitExceededException,
        client.ServiceFailureException,
        client.ServiceUnavailableException,
        client.ThrottledClientException,
        client.UnauthorizedClientException,
    ) as e:
        print(e)

Type checking example

from types_aiobotocore_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 session.client("chime-sdk-messaging").associate_channel_flow method. boto3 documentation

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.associate_channel_flow(**kwargs)

1. See AssociateChannelFlowRequestRequestTypeDef

batch_create_channel_membership

Adds a specified number of users to a channel.

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

Method definition

await 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

Usage example with kwargs

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 session.client("chime-sdk-messaging").can_paginate method. boto3 documentation

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 session.client("chime-sdk-messaging").channel_flow_callback method. boto3 documentation

Method definition

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

1. See ChannelMessageCallbackTypeDef
2. See ChannelFlowCallbackResponseTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").close method. boto3 documentation

Method definition

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

create_channel

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

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

Method definition

await 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)
) -> CreateChannelResponseTypeDef:  # (5)
    ...

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

Usage example with kwargs

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 session.client("chime-sdk-messaging").create_channel_ban method. boto3 documentation

Method definition

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

1. See CreateChannelBanResponseTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").create_channel_flow method. boto3 documentation

Method definition

await 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

Usage example with kwargs

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

parent.create_channel_flow(**kwargs)

1. See CreateChannelFlowRequestRequestTypeDef

create_channel_membership

Adds a user to a channel.

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

Method definition

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

1. See ChannelMembershipTypeType
2. See CreateChannelMembershipResponseTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").create_channel_moderator method. boto3 documentation

Method definition

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

1. See CreateChannelModeratorResponseTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").delete_channel method. boto3 documentation

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_channel(**kwargs)

1. See DeleteChannelRequestRequestTypeDef

delete_channel_ban

Removes a user from a channel's ban list.

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").delete_channel_flow method. boto3 documentation

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").delete_channel_membership method. boto3 documentation

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").delete_channel_message method. boto3 documentation

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").delete_channel_moderator method. boto3 documentation

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_channel_moderator(**kwargs)

1. See DeleteChannelModeratorRequestRequestTypeDef

describe_channel

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

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

Method definition

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

1. See DescribeChannelResponseTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").describe_channel_ban method. boto3 documentation

Method definition

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

1. See DescribeChannelBanResponseTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").describe_channel_flow method. boto3 documentation

Method definition

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

1. See DescribeChannelFlowResponseTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").describe_channel_membership method. boto3 documentation

Method definition

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

1. See DescribeChannelMembershipResponseTypeDef

Usage example with kwargs

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 .

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

Method definition

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

1. See DescribeChannelMembershipForAppInstanceUserResponseTypeDef

Usage example with kwargs

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 .

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

Method definition

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

1. See DescribeChannelModeratedByAppInstanceUserResponseTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").describe_channel_moderator method. boto3 documentation

Method definition

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

1. See DescribeChannelModeratorResponseTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").disassociate_channel_flow method. boto3 documentation

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").generate_presigned_url method. boto3 documentation

Method definition

await 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 for the specified channel.

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

Method definition

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

1. See GetChannelMembershipPreferencesResponseTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").get_channel_message method. boto3 documentation

Method definition

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

1. See GetChannelMessageResponseTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").get_channel_message_status method. boto3 documentation

Method definition

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

1. See GetChannelMessageStatusResponseTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").get_messaging_session_endpoint method. boto3 documentation

Method definition

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

1. See GetMessagingSessionEndpointResponseTypeDef

list_channel_bans

Lists all the users banned from a particular channel.

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

Method definition

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

1. See ListChannelBansResponseTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").list_channel_flows method. boto3 documentation

Method definition

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

1. See ListChannelFlowsResponseTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").list_channel_memberships method. boto3 documentation

Method definition

await 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

Usage example with kwargs

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

parent.list_channel_memberships(**kwargs)

1. See ListChannelMembershipsRequestRequestTypeDef

list_channel_memberships_for_app_instance_user

Lists all channels that a particular AppInstanceUser is a part of.

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

Method definition

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

1. See ListChannelMembershipsForAppInstanceUserResponseTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").list_channel_messages method. boto3 documentation

Method definition

await 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

Usage example with kwargs

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 session.client("chime-sdk-messaging").list_channel_moderators method. boto3 documentation

Method definition

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

1. See ListChannelModeratorsResponseTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").list_channels method. boto3 documentation

Method definition

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

1. See ChannelPrivacyType
2. See ListChannelsResponseTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").list_channels_associated_with_channel_flow method. boto3 documentation

Method definition

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

1. See ListChannelsAssociatedWithChannelFlowResponseTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").list_channels_moderated_by_app_instance_user method. boto3 documentation

Method definition

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

1. See ListChannelsModeratedByAppInstanceUserResponseTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").list_sub_channels method. boto3 documentation

Method definition

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

1. See ListSubChannelsResponseTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").list_tags_for_resource method. boto3 documentation

Method definition

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

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

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

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

put_channel_membership_preferences

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

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

Method definition

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

1. See ChannelMembershipPreferencesTypeDef
2. See PutChannelMembershipPreferencesResponseTypeDef

Usage example with kwargs

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

parent.put_channel_membership_preferences(**kwargs)

1. See PutChannelMembershipPreferencesRequestRequestTypeDef

redact_channel_message

Redacts message content, but not metadata.

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

Method definition

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

1. See RedactChannelMessageResponseTypeDef

Usage example with kwargs

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

parent.redact_channel_message(**kwargs)

1. See RedactChannelMessageRequestRequestTypeDef

search_channels

Allows an AppInstanceUser to search the channels that they belong to.

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

Method definition

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

1. See SearchFieldTypeDef
2. See SearchChannelsResponseTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").send_channel_message method. boto3 documentation

Method definition

await 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 = ...,
) -> SendChannelMessageResponseTypeDef:  # (5)
    ...

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

Usage example with kwargs

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 session.client("chime-sdk-messaging").tag_resource method. boto3 documentation

Method definition

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

1. See TagTypeDef
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").untag_resource method. boto3 documentation

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").update_channel method. boto3 documentation

Method definition

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

1. See ChannelModeType
2. See UpdateChannelResponseTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").update_channel_flow method. boto3 documentation

Method definition

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

1. See ProcessorTypeDef
2. See UpdateChannelFlowResponseTypeDef

Usage example with kwargs

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 session.client("chime-sdk-messaging").update_channel_message method. boto3 documentation

Method definition

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

1. See UpdateChannelMessageResponseTypeDef

Usage example with kwargs

kwargs: UpdateChannelMessageRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "MessageId": ...,
    "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 session.client("chime-sdk-messaging").update_channel_read_marker method. boto3 documentation

Method definition

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

1. See UpdateChannelReadMarkerResponseTypeDef

Usage example with kwargs

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

parent.update_channel_read_marker(**kwargs)

1. See UpdateChannelReadMarkerRequestRequestTypeDef

__aenter__

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

Method definition

await def __aenter__(
    self,
) -> ChimeSDKMessagingClient:
    ...

__aexit__

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

Method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...