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