ChimeClient

Index > Chime > ChimeClient

Auto-generated documentation for Chime type annotations stubs module types-boto3-chime.

ChimeClient

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

# ChimeClient usage example

from boto3.session import Session
from types_boto3_chime.client import ChimeClient

def get_chime_client() -> ChimeClient:
    return Session().client("chime")

Exceptions

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

# Exceptions.exceptions usage example

client = boto3.client("chime")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    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,
    client.exceptions.UnprocessableEntityException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_chime.client import Exceptions

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

Methods

can_paginate

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

# can_paginate method definition

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

generate_presigned_url

Type annotations and code completion for boto3.client("chime").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:
    ...

associate_phone_number_with_user

Associates a phone number with the specified Amazon Chime user.

Type annotations and code completion for boto3.client("chime").associate_phone_number_with_user method. boto3 documentation

# associate_phone_number_with_user method definition

def associate_phone_number_with_user(
    self,
    *,
    AccountId: str,
    UserId: str,
    E164PhoneNumber: str,
) -> dict[str, Any]:
    ...

# associate_phone_number_with_user method usage example with argument unpacking

kwargs: AssociatePhoneNumberWithUserRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UserId": ...,
    "E164PhoneNumber": ...,
}

parent.associate_phone_number_with_user(**kwargs)

1. See AssociatePhoneNumberWithUserRequestRequestTypeDef

associate_phone_numbers_with_voice_connector

Associates phone numbers with the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").associate_phone_numbers_with_voice_connector method. boto3 documentation

# associate_phone_numbers_with_voice_connector method definition

def associate_phone_numbers_with_voice_connector(
    self,
    *,
    VoiceConnectorId: str,
    E164PhoneNumbers: Sequence[str],
    ForceAssociate: bool = ...,
) -> AssociatePhoneNumbersWithVoiceConnectorResponseTypeDef:  # (1)
    ...

1. See AssociatePhoneNumbersWithVoiceConnectorResponseTypeDef

# associate_phone_numbers_with_voice_connector method usage example with argument unpacking

kwargs: AssociatePhoneNumbersWithVoiceConnectorRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "E164PhoneNumbers": ...,
}

parent.associate_phone_numbers_with_voice_connector(**kwargs)

1. See AssociatePhoneNumbersWithVoiceConnectorRequestRequestTypeDef

associate_phone_numbers_with_voice_connector_group

Associates phone numbers with the specified Amazon Chime Voice Connector group.

Type annotations and code completion for boto3.client("chime").associate_phone_numbers_with_voice_connector_group method. boto3 documentation

# associate_phone_numbers_with_voice_connector_group method definition

def associate_phone_numbers_with_voice_connector_group(
    self,
    *,
    VoiceConnectorGroupId: str,
    E164PhoneNumbers: Sequence[str],
    ForceAssociate: bool = ...,
) -> AssociatePhoneNumbersWithVoiceConnectorGroupResponseTypeDef:  # (1)
    ...

1. See AssociatePhoneNumbersWithVoiceConnectorGroupResponseTypeDef

# associate_phone_numbers_with_voice_connector_group method usage example with argument unpacking

kwargs: AssociatePhoneNumbersWithVoiceConnectorGroupRequestRequestTypeDef = {  # (1)
    "VoiceConnectorGroupId": ...,
    "E164PhoneNumbers": ...,
}

parent.associate_phone_numbers_with_voice_connector_group(**kwargs)

1. See AssociatePhoneNumbersWithVoiceConnectorGroupRequestRequestTypeDef

associate_signin_delegate_groups_with_account

Associates the specified sign-in delegate groups with the specified Amazon Chime account.

Type annotations and code completion for boto3.client("chime").associate_signin_delegate_groups_with_account method. boto3 documentation

# associate_signin_delegate_groups_with_account method definition

def associate_signin_delegate_groups_with_account(
    self,
    *,
    AccountId: str,
    SigninDelegateGroups: Sequence[SigninDelegateGroupTypeDef],  # (1)
) -> dict[str, Any]:
    ...

1. See SigninDelegateGroupTypeDef

# associate_signin_delegate_groups_with_account method usage example with argument unpacking

kwargs: AssociateSigninDelegateGroupsWithAccountRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "SigninDelegateGroups": ...,
}

parent.associate_signin_delegate_groups_with_account(**kwargs)

1. See AssociateSigninDelegateGroupsWithAccountRequestRequestTypeDef

batch_create_attendee

Creates up to 100 new attendees for an active Amazon Chime SDK meeting.

Type annotations and code completion for boto3.client("chime").batch_create_attendee method. boto3 documentation

# batch_create_attendee method definition

def batch_create_attendee(
    self,
    *,
    MeetingId: str,
    Attendees: Sequence[CreateAttendeeRequestItemTypeDef],  # (1)
) -> BatchCreateAttendeeResponseTypeDef:  # (2)
    ...

1. See CreateAttendeeRequestItemTypeDef
2. See BatchCreateAttendeeResponseTypeDef

# batch_create_attendee method usage example with argument unpacking

kwargs: BatchCreateAttendeeRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
    "Attendees": ...,
}

parent.batch_create_attendee(**kwargs)

1. See BatchCreateAttendeeRequestRequestTypeDef

batch_create_channel_membership

Adds a specified number of users to a channel.

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

# batch_create_channel_membership method definition

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

1. See ChannelMembershipTypeType
2. See BatchCreateChannelMembershipResponseTypeDef

# batch_create_channel_membership method usage example with argument unpacking

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

parent.batch_create_channel_membership(**kwargs)

1. See BatchCreateChannelMembershipRequestRequestTypeDef

batch_create_room_membership

Adds up to 50 members to a chat room in an Amazon Chime Enterprise account.

Type annotations and code completion for boto3.client("chime").batch_create_room_membership method. boto3 documentation

# batch_create_room_membership method definition

def batch_create_room_membership(
    self,
    *,
    AccountId: str,
    RoomId: str,
    MembershipItemList: Sequence[MembershipItemTypeDef],  # (1)
) -> BatchCreateRoomMembershipResponseTypeDef:  # (2)
    ...

1. See MembershipItemTypeDef
2. See BatchCreateRoomMembershipResponseTypeDef

# batch_create_room_membership method usage example with argument unpacking

kwargs: BatchCreateRoomMembershipRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "RoomId": ...,
    "MembershipItemList": ...,
}

parent.batch_create_room_membership(**kwargs)

1. See BatchCreateRoomMembershipRequestRequestTypeDef

batch_delete_phone_number

Moves phone numbers into the Deletion queue.

Type annotations and code completion for boto3.client("chime").batch_delete_phone_number method. boto3 documentation

# batch_delete_phone_number method definition

def batch_delete_phone_number(
    self,
    *,
    PhoneNumberIds: Sequence[str],
) -> BatchDeletePhoneNumberResponseTypeDef:  # (1)
    ...

1. See BatchDeletePhoneNumberResponseTypeDef

# batch_delete_phone_number method usage example with argument unpacking

kwargs: BatchDeletePhoneNumberRequestRequestTypeDef = {  # (1)
    "PhoneNumberIds": ...,
}

parent.batch_delete_phone_number(**kwargs)

1. See BatchDeletePhoneNumberRequestRequestTypeDef

batch_suspend_user

Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account.

Type annotations and code completion for boto3.client("chime").batch_suspend_user method. boto3 documentation

# batch_suspend_user method definition

def batch_suspend_user(
    self,
    *,
    AccountId: str,
    UserIdList: Sequence[str],
) -> BatchSuspendUserResponseTypeDef:  # (1)
    ...

1. See BatchSuspendUserResponseTypeDef

# batch_suspend_user method usage example with argument unpacking

kwargs: BatchSuspendUserRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UserIdList": ...,
}

parent.batch_suspend_user(**kwargs)

1. See BatchSuspendUserRequestRequestTypeDef

batch_unsuspend_user

Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account.

Type annotations and code completion for boto3.client("chime").batch_unsuspend_user method. boto3 documentation

# batch_unsuspend_user method definition

def batch_unsuspend_user(
    self,
    *,
    AccountId: str,
    UserIdList: Sequence[str],
) -> BatchUnsuspendUserResponseTypeDef:  # (1)
    ...

1. See BatchUnsuspendUserResponseTypeDef

# batch_unsuspend_user method usage example with argument unpacking

kwargs: BatchUnsuspendUserRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UserIdList": ...,
}

parent.batch_unsuspend_user(**kwargs)

1. See BatchUnsuspendUserRequestRequestTypeDef

batch_update_phone_number

Updates phone number product types or calling names.

Type annotations and code completion for boto3.client("chime").batch_update_phone_number method. boto3 documentation

# batch_update_phone_number method definition

def batch_update_phone_number(
    self,
    *,
    UpdatePhoneNumberRequestItems: Sequence[UpdatePhoneNumberRequestItemTypeDef],  # (1)
) -> BatchUpdatePhoneNumberResponseTypeDef:  # (2)
    ...

1. See UpdatePhoneNumberRequestItemTypeDef
2. See BatchUpdatePhoneNumberResponseTypeDef

# batch_update_phone_number method usage example with argument unpacking

kwargs: BatchUpdatePhoneNumberRequestRequestTypeDef = {  # (1)
    "UpdatePhoneNumberRequestItems": ...,
}

parent.batch_update_phone_number(**kwargs)

1. See BatchUpdatePhoneNumberRequestRequestTypeDef

batch_update_user

Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account.

Type annotations and code completion for boto3.client("chime").batch_update_user method. boto3 documentation

# batch_update_user method definition

def batch_update_user(
    self,
    *,
    AccountId: str,
    UpdateUserRequestItems: Sequence[UpdateUserRequestItemTypeDef],  # (1)
) -> BatchUpdateUserResponseTypeDef:  # (2)
    ...

1. See UpdateUserRequestItemTypeDef
2. See BatchUpdateUserResponseTypeDef

# batch_update_user method usage example with argument unpacking

kwargs: BatchUpdateUserRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UpdateUserRequestItems": ...,
}

parent.batch_update_user(**kwargs)

1. See BatchUpdateUserRequestRequestTypeDef

create_account

Creates an Amazon Chime account under the administrator's AWS account.

Type annotations and code completion for boto3.client("chime").create_account method. boto3 documentation

# create_account method definition

def create_account(
    self,
    *,
    Name: str,
) -> CreateAccountResponseTypeDef:  # (1)
    ...

1. See CreateAccountResponseTypeDef

# create_account method usage example with argument unpacking

kwargs: CreateAccountRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_account(**kwargs)

1. See CreateAccountRequestRequestTypeDef

create_app_instance

Creates an Amazon Chime SDK messaging AppInstance under an AWS account.

Type annotations and code completion for boto3.client("chime").create_app_instance method. boto3 documentation

# create_app_instance method definition

def create_app_instance(
    self,
    *,
    Name: str,
    ClientRequestToken: str,
    Metadata: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateAppInstanceResponseTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateAppInstanceResponseTypeDef

# create_app_instance method usage example with argument unpacking

kwargs: CreateAppInstanceRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "ClientRequestToken": ...,
}

parent.create_app_instance(**kwargs)

1. See CreateAppInstanceRequestRequestTypeDef

create_app_instance_admin

Promotes an AppInstanceUser to an AppInstanceAdmin.

Type annotations and code completion for boto3.client("chime").create_app_instance_admin method. boto3 documentation

# create_app_instance_admin method definition

def create_app_instance_admin(
    self,
    *,
    AppInstanceAdminArn: str,
    AppInstanceArn: str,
) -> CreateAppInstanceAdminResponseTypeDef:  # (1)
    ...

1. See CreateAppInstanceAdminResponseTypeDef

# create_app_instance_admin method usage example with argument unpacking

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

parent.create_app_instance_admin(**kwargs)

1. See CreateAppInstanceAdminRequestRequestTypeDef

create_app_instance_user

Creates a user under an Amazon Chime AppInstance.

Type annotations and code completion for boto3.client("chime").create_app_instance_user method. boto3 documentation

# create_app_instance_user method definition

def create_app_instance_user(
    self,
    *,
    AppInstanceArn: str,
    AppInstanceUserId: str,
    Name: str,
    ClientRequestToken: str,
    Metadata: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateAppInstanceUserResponseTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateAppInstanceUserResponseTypeDef

# create_app_instance_user method usage example with argument unpacking

kwargs: CreateAppInstanceUserRequestRequestTypeDef = {  # (1)
    "AppInstanceArn": ...,
    "AppInstanceUserId": ...,
    "Name": ...,
    "ClientRequestToken": ...,
}

parent.create_app_instance_user(**kwargs)

1. See CreateAppInstanceUserRequestRequestTypeDef

create_attendee

Creates a new attendee for an active Amazon Chime SDK meeting.

Type annotations and code completion for boto3.client("chime").create_attendee method. boto3 documentation

# create_attendee method definition

def create_attendee(
    self,
    *,
    MeetingId: str,
    ExternalUserId: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateAttendeeResponseTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateAttendeeResponseTypeDef

# create_attendee method usage example with argument unpacking

kwargs: CreateAttendeeRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
    "ExternalUserId": ...,
}

parent.create_attendee(**kwargs)

1. See CreateAttendeeRequestRequestTypeDef

create_bot

Creates a bot for an Amazon Chime Enterprise account.

Type annotations and code completion for boto3.client("chime").create_bot method. boto3 documentation

# create_bot method definition

def create_bot(
    self,
    *,
    AccountId: str,
    DisplayName: str,
    Domain: str = ...,
) -> CreateBotResponseTypeDef:  # (1)
    ...

1. See CreateBotResponseTypeDef

# create_bot method usage example with argument unpacking

kwargs: CreateBotRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "DisplayName": ...,
}

parent.create_bot(**kwargs)

1. See CreateBotRequestRequestTypeDef

create_channel

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

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

# create_channel method definition

def create_channel(
    self,
    *,
    AppInstanceArn: str,
    Name: str,
    ClientRequestToken: str,
    Mode: ChannelModeType = ...,  # (1)
    Privacy: ChannelPrivacyType = ...,  # (2)
    Metadata: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    ChimeBearer: str = ...,
) -> CreateChannelResponseTypeDef:  # (4)
    ...

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

# create_channel method usage example with argument unpacking

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

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").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": ...,
}

parent.create_channel_ban(**kwargs)

1. See CreateChannelBanRequestRequestTypeDef

create_channel_membership

Adds a user to a channel.

Type annotations and code completion for boto3.client("chime").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 = ...,
) -> CreateChannelMembershipResponseTypeDef:  # (2)
    ...

1. See ChannelMembershipTypeType
2. See CreateChannelMembershipResponseTypeDef

# create_channel_membership method usage example with argument unpacking

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

parent.create_channel_membership(**kwargs)

1. See CreateChannelMembershipRequestRequestTypeDef

create_channel_moderator

Creates a new ChannelModerator.

Type annotations and code completion for boto3.client("chime").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": ...,
}

parent.create_channel_moderator(**kwargs)

1. See CreateChannelModeratorRequestRequestTypeDef

create_media_capture_pipeline

Creates a media capture pipeline.

Type annotations and code completion for boto3.client("chime").create_media_capture_pipeline method. boto3 documentation

# create_media_capture_pipeline method definition

def create_media_capture_pipeline(
    self,
    *,
    SourceType: MediaPipelineSourceTypeType,  # (1)
    SourceArn: str,
    SinkType: MediaPipelineSinkTypeType,  # (2)
    SinkArn: str,
    ClientRequestToken: str = ...,
    ChimeSdkMeetingConfiguration: ChimeSdkMeetingConfigurationTypeDef = ...,  # (3)
) -> CreateMediaCapturePipelineResponseTypeDef:  # (4)
    ...

1. See MediaPipelineSourceTypeType
2. See MediaPipelineSinkTypeType
3. See ChimeSdkMeetingConfigurationTypeDef
4. See CreateMediaCapturePipelineResponseTypeDef

# create_media_capture_pipeline method usage example with argument unpacking

kwargs: CreateMediaCapturePipelineRequestRequestTypeDef = {  # (1)
    "SourceType": ...,
    "SourceArn": ...,
    "SinkType": ...,
    "SinkArn": ...,
}

parent.create_media_capture_pipeline(**kwargs)

1. See CreateMediaCapturePipelineRequestRequestTypeDef

create_meeting

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees.

Type annotations and code completion for boto3.client("chime").create_meeting method. boto3 documentation

# create_meeting method definition

def create_meeting(
    self,
    *,
    ClientRequestToken: str,
    ExternalMeetingId: str = ...,
    MeetingHostId: str = ...,
    MediaRegion: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    NotificationsConfiguration: MeetingNotificationConfigurationTypeDef = ...,  # (2)
) -> CreateMeetingResponseTypeDef:  # (3)
    ...

1. See TagTypeDef
2. See MeetingNotificationConfigurationTypeDef
3. See CreateMeetingResponseTypeDef

# create_meeting method usage example with argument unpacking

kwargs: CreateMeetingRequestRequestTypeDef = {  # (1)
    "ClientRequestToken": ...,
}

parent.create_meeting(**kwargs)

1. See CreateMeetingRequestRequestTypeDef

create_meeting_dial_out

Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting.

Type annotations and code completion for boto3.client("chime").create_meeting_dial_out method. boto3 documentation

# create_meeting_dial_out method definition

def create_meeting_dial_out(
    self,
    *,
    MeetingId: str,
    FromPhoneNumber: str,
    ToPhoneNumber: str,
    JoinToken: str,
) -> CreateMeetingDialOutResponseTypeDef:  # (1)
    ...

1. See CreateMeetingDialOutResponseTypeDef

# create_meeting_dial_out method usage example with argument unpacking

kwargs: CreateMeetingDialOutRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
    "FromPhoneNumber": ...,
    "ToPhoneNumber": ...,
    "JoinToken": ...,
}

parent.create_meeting_dial_out(**kwargs)

1. See CreateMeetingDialOutRequestRequestTypeDef

create_meeting_with_attendees

Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees.

Type annotations and code completion for boto3.client("chime").create_meeting_with_attendees method. boto3 documentation

# create_meeting_with_attendees method definition

def create_meeting_with_attendees(
    self,
    *,
    ClientRequestToken: str,
    ExternalMeetingId: str = ...,
    MeetingHostId: str = ...,
    MediaRegion: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    NotificationsConfiguration: MeetingNotificationConfigurationTypeDef = ...,  # (2)
    Attendees: Sequence[CreateAttendeeRequestItemTypeDef] = ...,  # (3)
) -> CreateMeetingWithAttendeesResponseTypeDef:  # (4)
    ...

1. See TagTypeDef
2. See MeetingNotificationConfigurationTypeDef
3. See CreateAttendeeRequestItemTypeDef
4. See CreateMeetingWithAttendeesResponseTypeDef

# create_meeting_with_attendees method usage example with argument unpacking

kwargs: CreateMeetingWithAttendeesRequestRequestTypeDef = {  # (1)
    "ClientRequestToken": ...,
}

parent.create_meeting_with_attendees(**kwargs)

1. See CreateMeetingWithAttendeesRequestRequestTypeDef

create_phone_number_order

Creates an order for phone numbers to be provisioned.

Type annotations and code completion for boto3.client("chime").create_phone_number_order method. boto3 documentation

# create_phone_number_order method definition

def create_phone_number_order(
    self,
    *,
    ProductType: PhoneNumberProductTypeType,  # (1)
    E164PhoneNumbers: Sequence[str],
) -> CreatePhoneNumberOrderResponseTypeDef:  # (2)
    ...

1. See PhoneNumberProductTypeType
2. See CreatePhoneNumberOrderResponseTypeDef

# create_phone_number_order method usage example with argument unpacking

kwargs: CreatePhoneNumberOrderRequestRequestTypeDef = {  # (1)
    "ProductType": ...,
    "E164PhoneNumbers": ...,
}

parent.create_phone_number_order(**kwargs)

1. See CreatePhoneNumberOrderRequestRequestTypeDef

create_proxy_session

Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.

Type annotations and code completion for boto3.client("chime").create_proxy_session method. boto3 documentation

# create_proxy_session method definition

def create_proxy_session(
    self,
    *,
    VoiceConnectorId: str,
    ParticipantPhoneNumbers: Sequence[str],
    Capabilities: Sequence[CapabilityType],  # (1)
    Name: str = ...,
    ExpiryMinutes: int = ...,
    NumberSelectionBehavior: NumberSelectionBehaviorType = ...,  # (2)
    GeoMatchLevel: GeoMatchLevelType = ...,  # (3)
    GeoMatchParams: GeoMatchParamsTypeDef = ...,  # (4)
) -> CreateProxySessionResponseTypeDef:  # (5)
    ...

1. See CapabilityType
2. See NumberSelectionBehaviorType
3. See GeoMatchLevelType
4. See GeoMatchParamsTypeDef
5. See CreateProxySessionResponseTypeDef

# create_proxy_session method usage example with argument unpacking

kwargs: CreateProxySessionRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "ParticipantPhoneNumbers": ...,
    "Capabilities": ...,
}

parent.create_proxy_session(**kwargs)

1. See CreateProxySessionRequestRequestTypeDef

create_room

Creates a chat room for the specified Amazon Chime Enterprise account.

Type annotations and code completion for boto3.client("chime").create_room method. boto3 documentation

# create_room method definition

def create_room(
    self,
    *,
    AccountId: str,
    Name: str,
    ClientRequestToken: str = ...,
) -> CreateRoomResponseTypeDef:  # (1)
    ...

1. See CreateRoomResponseTypeDef

# create_room method usage example with argument unpacking

kwargs: CreateRoomRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Name": ...,
}

parent.create_room(**kwargs)

1. See CreateRoomRequestRequestTypeDef

create_room_membership

Adds a member to a chat room in an Amazon Chime Enterprise account.

Type annotations and code completion for boto3.client("chime").create_room_membership method. boto3 documentation

# create_room_membership method definition

def create_room_membership(
    self,
    *,
    AccountId: str,
    RoomId: str,
    MemberId: str,
    Role: RoomMembershipRoleType = ...,  # (1)
) -> CreateRoomMembershipResponseTypeDef:  # (2)
    ...

1. See RoomMembershipRoleType
2. See CreateRoomMembershipResponseTypeDef

# create_room_membership method usage example with argument unpacking

kwargs: CreateRoomMembershipRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "RoomId": ...,
    "MemberId": ...,
}

parent.create_room_membership(**kwargs)

1. See CreateRoomMembershipRequestRequestTypeDef

create_sip_media_application

Creates a SIP media application.

Type annotations and code completion for boto3.client("chime").create_sip_media_application method. boto3 documentation

# create_sip_media_application method definition

def create_sip_media_application(
    self,
    *,
    AwsRegion: str,
    Name: str,
    Endpoints: Sequence[SipMediaApplicationEndpointTypeDef],  # (1)
) -> CreateSipMediaApplicationResponseTypeDef:  # (2)
    ...

1. See SipMediaApplicationEndpointTypeDef
2. See CreateSipMediaApplicationResponseTypeDef

# create_sip_media_application method usage example with argument unpacking

kwargs: CreateSipMediaApplicationRequestRequestTypeDef = {  # (1)
    "AwsRegion": ...,
    "Name": ...,
    "Endpoints": ...,
}

parent.create_sip_media_application(**kwargs)

1. See CreateSipMediaApplicationRequestRequestTypeDef

create_sip_media_application_call

Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId.

Type annotations and code completion for boto3.client("chime").create_sip_media_application_call method. boto3 documentation

# create_sip_media_application_call method definition

def create_sip_media_application_call(
    self,
    *,
    FromPhoneNumber: str,
    ToPhoneNumber: str,
    SipMediaApplicationId: str,
    SipHeaders: Mapping[str, str] = ...,
) -> CreateSipMediaApplicationCallResponseTypeDef:  # (1)
    ...

1. See CreateSipMediaApplicationCallResponseTypeDef

# create_sip_media_application_call method usage example with argument unpacking

kwargs: CreateSipMediaApplicationCallRequestRequestTypeDef = {  # (1)
    "FromPhoneNumber": ...,
    "ToPhoneNumber": ...,
    "SipMediaApplicationId": ...,
}

parent.create_sip_media_application_call(**kwargs)

1. See CreateSipMediaApplicationCallRequestRequestTypeDef

create_sip_rule

Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.

Type annotations and code completion for boto3.client("chime").create_sip_rule method. boto3 documentation

# create_sip_rule method definition

def create_sip_rule(
    self,
    *,
    Name: str,
    TriggerType: SipRuleTriggerTypeType,  # (1)
    TriggerValue: str,
    TargetApplications: Sequence[SipRuleTargetApplicationTypeDef],  # (2)
    Disabled: bool = ...,
) -> CreateSipRuleResponseTypeDef:  # (3)
    ...

1. See SipRuleTriggerTypeType
2. See SipRuleTargetApplicationTypeDef
3. See CreateSipRuleResponseTypeDef

# create_sip_rule method usage example with argument unpacking

kwargs: CreateSipRuleRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "TriggerType": ...,
    "TriggerValue": ...,
    "TargetApplications": ...,
}

parent.create_sip_rule(**kwargs)

1. See CreateSipRuleRequestRequestTypeDef

create_user

Creates a user under the specified Amazon Chime account.

Type annotations and code completion for boto3.client("chime").create_user method. boto3 documentation

# create_user method definition

def create_user(
    self,
    *,
    AccountId: str,
    Username: str = ...,
    Email: str = ...,
    UserType: UserTypeType = ...,  # (1)
) -> CreateUserResponseTypeDef:  # (2)
    ...

1. See UserTypeType
2. See CreateUserResponseTypeDef

# create_user method usage example with argument unpacking

kwargs: CreateUserRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.create_user(**kwargs)

1. See CreateUserRequestRequestTypeDef

create_voice_connector

Creates an Amazon Chime Voice Connector under the administrator's AWS account.

Type annotations and code completion for boto3.client("chime").create_voice_connector method. boto3 documentation

# create_voice_connector method definition

def create_voice_connector(
    self,
    *,
    Name: str,
    RequireEncryption: bool,
    AwsRegion: VoiceConnectorAwsRegionType = ...,  # (1)
) -> CreateVoiceConnectorResponseTypeDef:  # (2)
    ...

1. See VoiceConnectorAwsRegionType
2. See CreateVoiceConnectorResponseTypeDef

# create_voice_connector method usage example with argument unpacking

kwargs: CreateVoiceConnectorRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "RequireEncryption": ...,
}

parent.create_voice_connector(**kwargs)

1. See CreateVoiceConnectorRequestRequestTypeDef

create_voice_connector_group

Creates an Amazon Chime Voice Connector group under the administrator's AWS account.

Type annotations and code completion for boto3.client("chime").create_voice_connector_group method. boto3 documentation

# create_voice_connector_group method definition

def create_voice_connector_group(
    self,
    *,
    Name: str,
    VoiceConnectorItems: Sequence[VoiceConnectorItemTypeDef] = ...,  # (1)
) -> CreateVoiceConnectorGroupResponseTypeDef:  # (2)
    ...

1. See VoiceConnectorItemTypeDef
2. See CreateVoiceConnectorGroupResponseTypeDef

# create_voice_connector_group method usage example with argument unpacking

kwargs: CreateVoiceConnectorGroupRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_voice_connector_group(**kwargs)

1. See CreateVoiceConnectorGroupRequestRequestTypeDef

delete_account

Deletes the specified Amazon Chime account.

Type annotations and code completion for boto3.client("chime").delete_account method. boto3 documentation

# delete_account method definition

def delete_account(
    self,
    *,
    AccountId: str,
) -> dict[str, Any]:
    ...

# delete_account method usage example with argument unpacking

kwargs: DeleteAccountRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.delete_account(**kwargs)

1. See DeleteAccountRequestRequestTypeDef

delete_app_instance

Deletes an AppInstance and all associated data asynchronously.

Type annotations and code completion for boto3.client("chime").delete_app_instance method. boto3 documentation

# delete_app_instance method definition

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

1. See EmptyResponseMetadataTypeDef

# delete_app_instance method usage example with argument unpacking

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

parent.delete_app_instance(**kwargs)

1. See DeleteAppInstanceRequestRequestTypeDef

delete_app_instance_admin

Demotes an AppInstanceAdmin to an AppInstanceUser.

Type annotations and code completion for boto3.client("chime").delete_app_instance_admin method. boto3 documentation

# delete_app_instance_admin method definition

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

1. See EmptyResponseMetadataTypeDef

# delete_app_instance_admin method usage example with argument unpacking

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

parent.delete_app_instance_admin(**kwargs)

1. See DeleteAppInstanceAdminRequestRequestTypeDef

delete_app_instance_streaming_configurations

Deletes the streaming configurations of an AppInstance.

Type annotations and code completion for boto3.client("chime").delete_app_instance_streaming_configurations method. boto3 documentation

# delete_app_instance_streaming_configurations method definition

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

1. See EmptyResponseMetadataTypeDef

# delete_app_instance_streaming_configurations method usage example with argument unpacking

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

parent.delete_app_instance_streaming_configurations(**kwargs)

1. See DeleteAppInstanceStreamingConfigurationsRequestRequestTypeDef

delete_app_instance_user

Deletes an AppInstanceUser.

Type annotations and code completion for boto3.client("chime").delete_app_instance_user method. boto3 documentation

# delete_app_instance_user method definition

def delete_app_instance_user(
    self,
    *,
    AppInstanceUserArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_app_instance_user method usage example with argument unpacking

kwargs: DeleteAppInstanceUserRequestRequestTypeDef = {  # (1)
    "AppInstanceUserArn": ...,
}

parent.delete_app_instance_user(**kwargs)

1. See DeleteAppInstanceUserRequestRequestTypeDef

delete_attendee

Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken.

Type annotations and code completion for boto3.client("chime").delete_attendee method. boto3 documentation

# delete_attendee method definition

def delete_attendee(
    self,
    *,
    MeetingId: str,
    AttendeeId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_attendee method usage example with argument unpacking

kwargs: DeleteAttendeeRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
    "AttendeeId": ...,
}

parent.delete_attendee(**kwargs)

1. See DeleteAttendeeRequestRequestTypeDef

delete_channel

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

Type annotations and code completion for boto3.client("chime").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": ...,
}

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 boto3.client("chime").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": ...,
}

parent.delete_channel_ban(**kwargs)

1. See DeleteChannelBanRequestRequestTypeDef

delete_channel_membership

Removes a member from a channel.

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

# delete_channel_membership method definition

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

1. See EmptyResponseMetadataTypeDef

# delete_channel_membership method usage example with argument unpacking

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

parent.delete_channel_membership(**kwargs)

1. See DeleteChannelMembershipRequestRequestTypeDef

delete_channel_message

Deletes a channel message.

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

# delete_channel_message method definition

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

1. See EmptyResponseMetadataTypeDef

# delete_channel_message method usage example with argument unpacking

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

parent.delete_channel_message(**kwargs)

1. See DeleteChannelMessageRequestRequestTypeDef

delete_channel_moderator

Deletes a channel moderator.

Type annotations and code completion for boto3.client("chime").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": ...,
}

parent.delete_channel_moderator(**kwargs)

1. See DeleteChannelModeratorRequestRequestTypeDef

delete_events_configuration

Deletes the events configuration that allows a bot to receive outgoing events.

Type annotations and code completion for boto3.client("chime").delete_events_configuration method. boto3 documentation

# delete_events_configuration method definition

def delete_events_configuration(
    self,
    *,
    AccountId: str,
    BotId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_events_configuration method usage example with argument unpacking

kwargs: DeleteEventsConfigurationRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BotId": ...,
}

parent.delete_events_configuration(**kwargs)

1. See DeleteEventsConfigurationRequestRequestTypeDef

delete_media_capture_pipeline

Deletes the media capture pipeline.

Type annotations and code completion for boto3.client("chime").delete_media_capture_pipeline method. boto3 documentation

# delete_media_capture_pipeline method definition

def delete_media_capture_pipeline(
    self,
    *,
    MediaPipelineId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_media_capture_pipeline method usage example with argument unpacking

kwargs: DeleteMediaCapturePipelineRequestRequestTypeDef = {  # (1)
    "MediaPipelineId": ...,
}

parent.delete_media_capture_pipeline(**kwargs)

1. See DeleteMediaCapturePipelineRequestRequestTypeDef

delete_meeting

Deletes the specified Amazon Chime SDK meeting.

Type annotations and code completion for boto3.client("chime").delete_meeting method. boto3 documentation

# delete_meeting method definition

def delete_meeting(
    self,
    *,
    MeetingId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_meeting method usage example with argument unpacking

kwargs: DeleteMeetingRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
}

parent.delete_meeting(**kwargs)

1. See DeleteMeetingRequestRequestTypeDef

delete_phone_number

Moves the specified phone number into the Deletion queue.

Type annotations and code completion for boto3.client("chime").delete_phone_number method. boto3 documentation

# delete_phone_number method definition

def delete_phone_number(
    self,
    *,
    PhoneNumberId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_phone_number method usage example with argument unpacking

kwargs: DeletePhoneNumberRequestRequestTypeDef = {  # (1)
    "PhoneNumberId": ...,
}

parent.delete_phone_number(**kwargs)

1. See DeletePhoneNumberRequestRequestTypeDef

delete_proxy_session

Deletes the specified proxy session from the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").delete_proxy_session method. boto3 documentation

# delete_proxy_session method definition

def delete_proxy_session(
    self,
    *,
    VoiceConnectorId: str,
    ProxySessionId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_proxy_session method usage example with argument unpacking

kwargs: DeleteProxySessionRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "ProxySessionId": ...,
}

parent.delete_proxy_session(**kwargs)

1. See DeleteProxySessionRequestRequestTypeDef

delete_room

Deletes a chat room in an Amazon Chime Enterprise account.

Type annotations and code completion for boto3.client("chime").delete_room method. boto3 documentation

# delete_room method definition

def delete_room(
    self,
    *,
    AccountId: str,
    RoomId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_room method usage example with argument unpacking

kwargs: DeleteRoomRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "RoomId": ...,
}

parent.delete_room(**kwargs)

1. See DeleteRoomRequestRequestTypeDef

delete_room_membership

Removes a member from a chat room in an Amazon Chime Enterprise account.

Type annotations and code completion for boto3.client("chime").delete_room_membership method. boto3 documentation

# delete_room_membership method definition

def delete_room_membership(
    self,
    *,
    AccountId: str,
    RoomId: str,
    MemberId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_room_membership method usage example with argument unpacking

kwargs: DeleteRoomMembershipRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "RoomId": ...,
    "MemberId": ...,
}

parent.delete_room_membership(**kwargs)

1. See DeleteRoomMembershipRequestRequestTypeDef

delete_sip_media_application

Deletes a SIP media application.

Type annotations and code completion for boto3.client("chime").delete_sip_media_application method. boto3 documentation

# delete_sip_media_application method definition

def delete_sip_media_application(
    self,
    *,
    SipMediaApplicationId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_sip_media_application method usage example with argument unpacking

kwargs: DeleteSipMediaApplicationRequestRequestTypeDef = {  # (1)
    "SipMediaApplicationId": ...,
}

parent.delete_sip_media_application(**kwargs)

1. See DeleteSipMediaApplicationRequestRequestTypeDef

delete_sip_rule

Deletes a SIP rule.

Type annotations and code completion for boto3.client("chime").delete_sip_rule method. boto3 documentation

# delete_sip_rule method definition

def delete_sip_rule(
    self,
    *,
    SipRuleId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_sip_rule method usage example with argument unpacking

kwargs: DeleteSipRuleRequestRequestTypeDef = {  # (1)
    "SipRuleId": ...,
}

parent.delete_sip_rule(**kwargs)

1. See DeleteSipRuleRequestRequestTypeDef

delete_voice_connector

Deletes the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").delete_voice_connector method. boto3 documentation

# delete_voice_connector method definition

def delete_voice_connector(
    self,
    *,
    VoiceConnectorId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_voice_connector method usage example with argument unpacking

kwargs: DeleteVoiceConnectorRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.delete_voice_connector(**kwargs)

1. See DeleteVoiceConnectorRequestRequestTypeDef

delete_voice_connector_emergency_calling_configuration

Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").delete_voice_connector_emergency_calling_configuration method. boto3 documentation

# delete_voice_connector_emergency_calling_configuration method definition

def delete_voice_connector_emergency_calling_configuration(
    self,
    *,
    VoiceConnectorId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_voice_connector_emergency_calling_configuration method usage example with argument unpacking

kwargs: DeleteVoiceConnectorEmergencyCallingConfigurationRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.delete_voice_connector_emergency_calling_configuration(**kwargs)

1. See DeleteVoiceConnectorEmergencyCallingConfigurationRequestRequestTypeDef

delete_voice_connector_group

Deletes the specified Amazon Chime Voice Connector group.

Type annotations and code completion for boto3.client("chime").delete_voice_connector_group method. boto3 documentation

# delete_voice_connector_group method definition

def delete_voice_connector_group(
    self,
    *,
    VoiceConnectorGroupId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_voice_connector_group method usage example with argument unpacking

kwargs: DeleteVoiceConnectorGroupRequestRequestTypeDef = {  # (1)
    "VoiceConnectorGroupId": ...,
}

parent.delete_voice_connector_group(**kwargs)

1. See DeleteVoiceConnectorGroupRequestRequestTypeDef

delete_voice_connector_origination

Deletes the origination settings for the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").delete_voice_connector_origination method. boto3 documentation

# delete_voice_connector_origination method definition

def delete_voice_connector_origination(
    self,
    *,
    VoiceConnectorId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_voice_connector_origination method usage example with argument unpacking

kwargs: DeleteVoiceConnectorOriginationRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.delete_voice_connector_origination(**kwargs)

1. See DeleteVoiceConnectorOriginationRequestRequestTypeDef

delete_voice_connector_proxy

Deletes the proxy configuration from the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").delete_voice_connector_proxy method. boto3 documentation

# delete_voice_connector_proxy method definition

def delete_voice_connector_proxy(
    self,
    *,
    VoiceConnectorId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_voice_connector_proxy method usage example with argument unpacking

kwargs: DeleteVoiceConnectorProxyRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.delete_voice_connector_proxy(**kwargs)

1. See DeleteVoiceConnectorProxyRequestRequestTypeDef

delete_voice_connector_streaming_configuration

Deletes the streaming configuration for the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").delete_voice_connector_streaming_configuration method. boto3 documentation

# delete_voice_connector_streaming_configuration method definition

def delete_voice_connector_streaming_configuration(
    self,
    *,
    VoiceConnectorId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_voice_connector_streaming_configuration method usage example with argument unpacking

kwargs: DeleteVoiceConnectorStreamingConfigurationRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.delete_voice_connector_streaming_configuration(**kwargs)

1. See DeleteVoiceConnectorStreamingConfigurationRequestRequestTypeDef

delete_voice_connector_termination

Deletes the termination settings for the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").delete_voice_connector_termination method. boto3 documentation

# delete_voice_connector_termination method definition

def delete_voice_connector_termination(
    self,
    *,
    VoiceConnectorId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_voice_connector_termination method usage example with argument unpacking

kwargs: DeleteVoiceConnectorTerminationRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.delete_voice_connector_termination(**kwargs)

1. See DeleteVoiceConnectorTerminationRequestRequestTypeDef

delete_voice_connector_termination_credentials

Deletes the specified SIP credentials used by your equipment to authenticate during call termination.

Type annotations and code completion for boto3.client("chime").delete_voice_connector_termination_credentials method. boto3 documentation

# delete_voice_connector_termination_credentials method definition

def delete_voice_connector_termination_credentials(
    self,
    *,
    VoiceConnectorId: str,
    Usernames: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_voice_connector_termination_credentials method usage example with argument unpacking

kwargs: DeleteVoiceConnectorTerminationCredentialsRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "Usernames": ...,
}

parent.delete_voice_connector_termination_credentials(**kwargs)

1. See DeleteVoiceConnectorTerminationCredentialsRequestRequestTypeDef

describe_app_instance

Returns the full details of an AppInstance.

Type annotations and code completion for boto3.client("chime").describe_app_instance method. boto3 documentation

# describe_app_instance method definition

def describe_app_instance(
    self,
    *,
    AppInstanceArn: str,
) -> DescribeAppInstanceResponseTypeDef:  # (1)
    ...

1. See DescribeAppInstanceResponseTypeDef

# describe_app_instance method usage example with argument unpacking

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

parent.describe_app_instance(**kwargs)

1. See DescribeAppInstanceRequestRequestTypeDef

describe_app_instance_admin

Returns the full details of an AppInstanceAdmin.

Type annotations and code completion for boto3.client("chime").describe_app_instance_admin method. boto3 documentation

# describe_app_instance_admin method definition

def describe_app_instance_admin(
    self,
    *,
    AppInstanceAdminArn: str,
    AppInstanceArn: str,
) -> DescribeAppInstanceAdminResponseTypeDef:  # (1)
    ...

1. See DescribeAppInstanceAdminResponseTypeDef

# describe_app_instance_admin method usage example with argument unpacking

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

parent.describe_app_instance_admin(**kwargs)

1. See DescribeAppInstanceAdminRequestRequestTypeDef

describe_app_instance_user

Returns the full details of an AppInstanceUser.

Type annotations and code completion for boto3.client("chime").describe_app_instance_user method. boto3 documentation

# describe_app_instance_user method definition

def describe_app_instance_user(
    self,
    *,
    AppInstanceUserArn: str,
) -> DescribeAppInstanceUserResponseTypeDef:  # (1)
    ...

1. See DescribeAppInstanceUserResponseTypeDef

# describe_app_instance_user method usage example with argument unpacking

kwargs: DescribeAppInstanceUserRequestRequestTypeDef = {  # (1)
    "AppInstanceUserArn": ...,
}

parent.describe_app_instance_user(**kwargs)

1. See DescribeAppInstanceUserRequestRequestTypeDef

describe_channel

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

Type annotations and code completion for boto3.client("chime").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": ...,
}

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").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": ...,
}

parent.describe_channel_ban(**kwargs)

1. See DescribeChannelBanRequestRequestTypeDef

describe_channel_membership

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

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

# describe_channel_membership method definition

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

1. See DescribeChannelMembershipResponseTypeDef

# describe_channel_membership method usage example with argument unpacking

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

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 boto3.client("chime").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": ...,
}

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 boto3.client("chime").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": ...,
}

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").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": ...,
}

parent.describe_channel_moderator(**kwargs)

1. See DescribeChannelModeratorRequestRequestTypeDef

disassociate_phone_number_from_user

Disassociates the primary provisioned phone number from the specified Amazon Chime user.

Type annotations and code completion for boto3.client("chime").disassociate_phone_number_from_user method. boto3 documentation

# disassociate_phone_number_from_user method definition

def disassociate_phone_number_from_user(
    self,
    *,
    AccountId: str,
    UserId: str,
) -> dict[str, Any]:
    ...

# disassociate_phone_number_from_user method usage example with argument unpacking

kwargs: DisassociatePhoneNumberFromUserRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UserId": ...,
}

parent.disassociate_phone_number_from_user(**kwargs)

1. See DisassociatePhoneNumberFromUserRequestRequestTypeDef

disassociate_phone_numbers_from_voice_connector

Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").disassociate_phone_numbers_from_voice_connector method. boto3 documentation

# disassociate_phone_numbers_from_voice_connector method definition

def disassociate_phone_numbers_from_voice_connector(
    self,
    *,
    VoiceConnectorId: str,
    E164PhoneNumbers: Sequence[str],
) -> DisassociatePhoneNumbersFromVoiceConnectorResponseTypeDef:  # (1)
    ...

1. See DisassociatePhoneNumbersFromVoiceConnectorResponseTypeDef

# disassociate_phone_numbers_from_voice_connector method usage example with argument unpacking

kwargs: DisassociatePhoneNumbersFromVoiceConnectorRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "E164PhoneNumbers": ...,
}

parent.disassociate_phone_numbers_from_voice_connector(**kwargs)

1. See DisassociatePhoneNumbersFromVoiceConnectorRequestRequestTypeDef

disassociate_phone_numbers_from_voice_connector_group

Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.

Type annotations and code completion for boto3.client("chime").disassociate_phone_numbers_from_voice_connector_group method. boto3 documentation

# disassociate_phone_numbers_from_voice_connector_group method definition

def disassociate_phone_numbers_from_voice_connector_group(
    self,
    *,
    VoiceConnectorGroupId: str,
    E164PhoneNumbers: Sequence[str],
) -> DisassociatePhoneNumbersFromVoiceConnectorGroupResponseTypeDef:  # (1)
    ...

1. See DisassociatePhoneNumbersFromVoiceConnectorGroupResponseTypeDef

# disassociate_phone_numbers_from_voice_connector_group method usage example with argument unpacking

kwargs: DisassociatePhoneNumbersFromVoiceConnectorGroupRequestRequestTypeDef = {  # (1)
    "VoiceConnectorGroupId": ...,
    "E164PhoneNumbers": ...,
}

parent.disassociate_phone_numbers_from_voice_connector_group(**kwargs)

1. See DisassociatePhoneNumbersFromVoiceConnectorGroupRequestRequestTypeDef

disassociate_signin_delegate_groups_from_account

Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.

Type annotations and code completion for boto3.client("chime").disassociate_signin_delegate_groups_from_account method. boto3 documentation

# disassociate_signin_delegate_groups_from_account method definition

def disassociate_signin_delegate_groups_from_account(
    self,
    *,
    AccountId: str,
    GroupNames: Sequence[str],
) -> dict[str, Any]:
    ...

# disassociate_signin_delegate_groups_from_account method usage example with argument unpacking

kwargs: DisassociateSigninDelegateGroupsFromAccountRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "GroupNames": ...,
}

parent.disassociate_signin_delegate_groups_from_account(**kwargs)

1. See DisassociateSigninDelegateGroupsFromAccountRequestRequestTypeDef

get_account

Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.

Type annotations and code completion for boto3.client("chime").get_account method. boto3 documentation

# get_account method definition

def get_account(
    self,
    *,
    AccountId: str,
) -> GetAccountResponseTypeDef:  # (1)
    ...

1. See GetAccountResponseTypeDef

# get_account method usage example with argument unpacking

kwargs: GetAccountRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.get_account(**kwargs)

1. See GetAccountRequestRequestTypeDef

get_account_settings

Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings.

Type annotations and code completion for boto3.client("chime").get_account_settings method. boto3 documentation

# get_account_settings method definition

def get_account_settings(
    self,
    *,
    AccountId: str,
) -> GetAccountSettingsResponseTypeDef:  # (1)
    ...

1. See GetAccountSettingsResponseTypeDef

# get_account_settings method usage example with argument unpacking

kwargs: GetAccountSettingsRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.get_account_settings(**kwargs)

1. See GetAccountSettingsRequestRequestTypeDef

get_app_instance_retention_settings

Gets the retention settings for an AppInstance.

Type annotations and code completion for boto3.client("chime").get_app_instance_retention_settings method. boto3 documentation

# get_app_instance_retention_settings method definition

def get_app_instance_retention_settings(
    self,
    *,
    AppInstanceArn: str,
) -> GetAppInstanceRetentionSettingsResponseTypeDef:  # (1)
    ...

1. See GetAppInstanceRetentionSettingsResponseTypeDef

# get_app_instance_retention_settings method usage example with argument unpacking

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

parent.get_app_instance_retention_settings(**kwargs)

1. See GetAppInstanceRetentionSettingsRequestRequestTypeDef

get_app_instance_streaming_configurations

Gets the streaming settings for an AppInstance.

Type annotations and code completion for boto3.client("chime").get_app_instance_streaming_configurations method. boto3 documentation

# get_app_instance_streaming_configurations method definition

def get_app_instance_streaming_configurations(
    self,
    *,
    AppInstanceArn: str,
) -> GetAppInstanceStreamingConfigurationsResponseTypeDef:  # (1)
    ...

1. See GetAppInstanceStreamingConfigurationsResponseTypeDef

# get_app_instance_streaming_configurations method usage example with argument unpacking

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

parent.get_app_instance_streaming_configurations(**kwargs)

1. See GetAppInstanceStreamingConfigurationsRequestRequestTypeDef

get_attendee

Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID.

Type annotations and code completion for boto3.client("chime").get_attendee method. boto3 documentation

# get_attendee method definition

def get_attendee(
    self,
    *,
    MeetingId: str,
    AttendeeId: str,
) -> GetAttendeeResponseTypeDef:  # (1)
    ...

1. See GetAttendeeResponseTypeDef

# get_attendee method usage example with argument unpacking

kwargs: GetAttendeeRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
    "AttendeeId": ...,
}

parent.get_attendee(**kwargs)

1. See GetAttendeeRequestRequestTypeDef

get_bot

Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.

Type annotations and code completion for boto3.client("chime").get_bot method. boto3 documentation

# get_bot method definition

def get_bot(
    self,
    *,
    AccountId: str,
    BotId: str,
) -> GetBotResponseTypeDef:  # (1)
    ...

1. See GetBotResponseTypeDef

# get_bot method usage example with argument unpacking

kwargs: GetBotRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BotId": ...,
}

parent.get_bot(**kwargs)

1. See GetBotRequestRequestTypeDef

get_channel_message

Gets the full details of a channel message.

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

# get_channel_message method definition

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

1. See GetChannelMessageResponseTypeDef

# get_channel_message method usage example with argument unpacking

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

parent.get_channel_message(**kwargs)

1. See GetChannelMessageRequestRequestTypeDef

get_events_configuration

Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.

Type annotations and code completion for boto3.client("chime").get_events_configuration method. boto3 documentation

# get_events_configuration method definition

def get_events_configuration(
    self,
    *,
    AccountId: str,
    BotId: str,
) -> GetEventsConfigurationResponseTypeDef:  # (1)
    ...

1. See GetEventsConfigurationResponseTypeDef

# get_events_configuration method usage example with argument unpacking

kwargs: GetEventsConfigurationRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BotId": ...,
}

parent.get_events_configuration(**kwargs)

1. See GetEventsConfigurationRequestRequestTypeDef

get_global_settings

Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

Type annotations and code completion for boto3.client("chime").get_global_settings method. boto3 documentation

# get_global_settings method definition

def get_global_settings(
    self,
) -> GetGlobalSettingsResponseTypeDef:  # (1)
    ...

1. See GetGlobalSettingsResponseTypeDef

get_media_capture_pipeline

Gets an existing media capture pipeline.

Type annotations and code completion for boto3.client("chime").get_media_capture_pipeline method. boto3 documentation

# get_media_capture_pipeline method definition

def get_media_capture_pipeline(
    self,
    *,
    MediaPipelineId: str,
) -> GetMediaCapturePipelineResponseTypeDef:  # (1)
    ...

1. See GetMediaCapturePipelineResponseTypeDef

# get_media_capture_pipeline method usage example with argument unpacking

kwargs: GetMediaCapturePipelineRequestRequestTypeDef = {  # (1)
    "MediaPipelineId": ...,
}

parent.get_media_capture_pipeline(**kwargs)

1. See GetMediaCapturePipelineRequestRequestTypeDef

get_meeting

This API is is no longer supported and will not be updated. We recommend using the latest version, GetMeeting, in the Amazon Chime SDK.

Type annotations and code completion for boto3.client("chime").get_meeting method. boto3 documentation

# get_meeting method definition

def get_meeting(
    self,
    *,
    MeetingId: str,
) -> GetMeetingResponseTypeDef:  # (1)
    ...

1. See GetMeetingResponseTypeDef

# get_meeting method usage example with argument unpacking

kwargs: GetMeetingRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
}

parent.get_meeting(**kwargs)

1. See GetMeetingRequestRequestTypeDef

get_messaging_session_endpoint

The details of the endpoint for the messaging session.

Type annotations and code completion for boto3.client("chime").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_phone_number

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

Type annotations and code completion for boto3.client("chime").get_phone_number method. boto3 documentation

# get_phone_number method definition

def get_phone_number(
    self,
    *,
    PhoneNumberId: str,
) -> GetPhoneNumberResponseTypeDef:  # (1)
    ...

1. See GetPhoneNumberResponseTypeDef

# get_phone_number method usage example with argument unpacking

kwargs: GetPhoneNumberRequestRequestTypeDef = {  # (1)
    "PhoneNumberId": ...,
}

parent.get_phone_number(**kwargs)

1. See GetPhoneNumberRequestRequestTypeDef

get_phone_number_order

Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.

Type annotations and code completion for boto3.client("chime").get_phone_number_order method. boto3 documentation

# get_phone_number_order method definition

def get_phone_number_order(
    self,
    *,
    PhoneNumberOrderId: str,
) -> GetPhoneNumberOrderResponseTypeDef:  # (1)
    ...

1. See GetPhoneNumberOrderResponseTypeDef

# get_phone_number_order method usage example with argument unpacking

kwargs: GetPhoneNumberOrderRequestRequestTypeDef = {  # (1)
    "PhoneNumberOrderId": ...,
}

parent.get_phone_number_order(**kwargs)

1. See GetPhoneNumberOrderRequestRequestTypeDef

get_phone_number_settings

Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.

Type annotations and code completion for boto3.client("chime").get_phone_number_settings method. boto3 documentation

# get_phone_number_settings method definition

def get_phone_number_settings(
    self,
) -> GetPhoneNumberSettingsResponseTypeDef:  # (1)
    ...

1. See GetPhoneNumberSettingsResponseTypeDef

get_proxy_session

Gets the specified proxy session details for the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").get_proxy_session method. boto3 documentation

# get_proxy_session method definition

def get_proxy_session(
    self,
    *,
    VoiceConnectorId: str,
    ProxySessionId: str,
) -> GetProxySessionResponseTypeDef:  # (1)
    ...

1. See GetProxySessionResponseTypeDef

# get_proxy_session method usage example with argument unpacking

kwargs: GetProxySessionRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "ProxySessionId": ...,
}

parent.get_proxy_session(**kwargs)

1. See GetProxySessionRequestRequestTypeDef

get_retention_settings

Gets the retention settings for the specified Amazon Chime Enterprise account.

Type annotations and code completion for boto3.client("chime").get_retention_settings method. boto3 documentation

# get_retention_settings method definition

def get_retention_settings(
    self,
    *,
    AccountId: str,
) -> GetRetentionSettingsResponseTypeDef:  # (1)
    ...

1. See GetRetentionSettingsResponseTypeDef

# get_retention_settings method usage example with argument unpacking

kwargs: GetRetentionSettingsRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.get_retention_settings(**kwargs)

1. See GetRetentionSettingsRequestRequestTypeDef

get_room

Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.

Type annotations and code completion for boto3.client("chime").get_room method. boto3 documentation

# get_room method definition

def get_room(
    self,
    *,
    AccountId: str,
    RoomId: str,
) -> GetRoomResponseTypeDef:  # (1)
    ...

1. See GetRoomResponseTypeDef

# get_room method usage example with argument unpacking

kwargs: GetRoomRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "RoomId": ...,
}

parent.get_room(**kwargs)

1. See GetRoomRequestRequestTypeDef

get_sip_media_application

Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

Type annotations and code completion for boto3.client("chime").get_sip_media_application method. boto3 documentation

# get_sip_media_application method definition

def get_sip_media_application(
    self,
    *,
    SipMediaApplicationId: str,
) -> GetSipMediaApplicationResponseTypeDef:  # (1)
    ...

1. See GetSipMediaApplicationResponseTypeDef

# get_sip_media_application method usage example with argument unpacking

kwargs: GetSipMediaApplicationRequestRequestTypeDef = {  # (1)
    "SipMediaApplicationId": ...,
}

parent.get_sip_media_application(**kwargs)

1. See GetSipMediaApplicationRequestRequestTypeDef

get_sip_media_application_logging_configuration

Returns the logging configuration for the specified SIP media application.

Type annotations and code completion for boto3.client("chime").get_sip_media_application_logging_configuration method. boto3 documentation

# get_sip_media_application_logging_configuration method definition

def get_sip_media_application_logging_configuration(
    self,
    *,
    SipMediaApplicationId: str,
) -> GetSipMediaApplicationLoggingConfigurationResponseTypeDef:  # (1)
    ...

1. See GetSipMediaApplicationLoggingConfigurationResponseTypeDef

# get_sip_media_application_logging_configuration method usage example with argument unpacking

kwargs: GetSipMediaApplicationLoggingConfigurationRequestRequestTypeDef = {  # (1)
    "SipMediaApplicationId": ...,
}

parent.get_sip_media_application_logging_configuration(**kwargs)

1. See GetSipMediaApplicationLoggingConfigurationRequestRequestTypeDef

get_sip_rule

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

Type annotations and code completion for boto3.client("chime").get_sip_rule method. boto3 documentation

# get_sip_rule method definition

def get_sip_rule(
    self,
    *,
    SipRuleId: str,
) -> GetSipRuleResponseTypeDef:  # (1)
    ...

1. See GetSipRuleResponseTypeDef

# get_sip_rule method usage example with argument unpacking

kwargs: GetSipRuleRequestRequestTypeDef = {  # (1)
    "SipRuleId": ...,
}

parent.get_sip_rule(**kwargs)

1. See GetSipRuleRequestRequestTypeDef

get_user

Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.

Type annotations and code completion for boto3.client("chime").get_user method. boto3 documentation

# get_user method definition

def get_user(
    self,
    *,
    AccountId: str,
    UserId: str,
) -> GetUserResponseTypeDef:  # (1)
    ...

1. See GetUserResponseTypeDef

# get_user method usage example with argument unpacking

kwargs: GetUserRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UserId": ...,
}

parent.get_user(**kwargs)

1. See GetUserRequestRequestTypeDef

get_user_settings

Retrieves settings for the specified user ID, such as any associated phone number settings.

Type annotations and code completion for boto3.client("chime").get_user_settings method. boto3 documentation

# get_user_settings method definition

def get_user_settings(
    self,
    *,
    AccountId: str,
    UserId: str,
) -> GetUserSettingsResponseTypeDef:  # (1)
    ...

1. See GetUserSettingsResponseTypeDef

# get_user_settings method usage example with argument unpacking

kwargs: GetUserSettingsRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UserId": ...,
}

parent.get_user_settings(**kwargs)

1. See GetUserSettingsRequestRequestTypeDef

get_voice_connector

Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.

Type annotations and code completion for boto3.client("chime").get_voice_connector method. boto3 documentation

# get_voice_connector method definition

def get_voice_connector(
    self,
    *,
    VoiceConnectorId: str,
) -> GetVoiceConnectorResponseTypeDef:  # (1)
    ...

1. See GetVoiceConnectorResponseTypeDef

# get_voice_connector method usage example with argument unpacking

kwargs: GetVoiceConnectorRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.get_voice_connector(**kwargs)

1. See GetVoiceConnectorRequestRequestTypeDef

get_voice_connector_emergency_calling_configuration

Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").get_voice_connector_emergency_calling_configuration method. boto3 documentation

# get_voice_connector_emergency_calling_configuration method definition

def get_voice_connector_emergency_calling_configuration(
    self,
    *,
    VoiceConnectorId: str,
) -> GetVoiceConnectorEmergencyCallingConfigurationResponseTypeDef:  # (1)
    ...

1. See GetVoiceConnectorEmergencyCallingConfigurationResponseTypeDef

# get_voice_connector_emergency_calling_configuration method usage example with argument unpacking

kwargs: GetVoiceConnectorEmergencyCallingConfigurationRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.get_voice_connector_emergency_calling_configuration(**kwargs)

1. See GetVoiceConnectorEmergencyCallingConfigurationRequestRequestTypeDef

get_voice_connector_group

Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems.

Type annotations and code completion for boto3.client("chime").get_voice_connector_group method. boto3 documentation

# get_voice_connector_group method definition

def get_voice_connector_group(
    self,
    *,
    VoiceConnectorGroupId: str,
) -> GetVoiceConnectorGroupResponseTypeDef:  # (1)
    ...

1. See GetVoiceConnectorGroupResponseTypeDef

# get_voice_connector_group method usage example with argument unpacking

kwargs: GetVoiceConnectorGroupRequestRequestTypeDef = {  # (1)
    "VoiceConnectorGroupId": ...,
}

parent.get_voice_connector_group(**kwargs)

1. See GetVoiceConnectorGroupRequestRequestTypeDef

get_voice_connector_logging_configuration

Retrieves the logging configuration details for the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").get_voice_connector_logging_configuration method. boto3 documentation

# get_voice_connector_logging_configuration method definition

def get_voice_connector_logging_configuration(
    self,
    *,
    VoiceConnectorId: str,
) -> GetVoiceConnectorLoggingConfigurationResponseTypeDef:  # (1)
    ...

1. See GetVoiceConnectorLoggingConfigurationResponseTypeDef

# get_voice_connector_logging_configuration method usage example with argument unpacking

kwargs: GetVoiceConnectorLoggingConfigurationRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.get_voice_connector_logging_configuration(**kwargs)

1. See GetVoiceConnectorLoggingConfigurationRequestRequestTypeDef

get_voice_connector_origination

Retrieves origination setting details for the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").get_voice_connector_origination method. boto3 documentation

# get_voice_connector_origination method definition

def get_voice_connector_origination(
    self,
    *,
    VoiceConnectorId: str,
) -> GetVoiceConnectorOriginationResponseTypeDef:  # (1)
    ...

1. See GetVoiceConnectorOriginationResponseTypeDef

# get_voice_connector_origination method usage example with argument unpacking

kwargs: GetVoiceConnectorOriginationRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.get_voice_connector_origination(**kwargs)

1. See GetVoiceConnectorOriginationRequestRequestTypeDef

get_voice_connector_proxy

Gets the proxy configuration details for the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").get_voice_connector_proxy method. boto3 documentation

# get_voice_connector_proxy method definition

def get_voice_connector_proxy(
    self,
    *,
    VoiceConnectorId: str,
) -> GetVoiceConnectorProxyResponseTypeDef:  # (1)
    ...

1. See GetVoiceConnectorProxyResponseTypeDef

# get_voice_connector_proxy method usage example with argument unpacking

kwargs: GetVoiceConnectorProxyRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.get_voice_connector_proxy(**kwargs)

1. See GetVoiceConnectorProxyRequestRequestTypeDef

get_voice_connector_streaming_configuration

Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").get_voice_connector_streaming_configuration method. boto3 documentation

# get_voice_connector_streaming_configuration method definition

def get_voice_connector_streaming_configuration(
    self,
    *,
    VoiceConnectorId: str,
) -> GetVoiceConnectorStreamingConfigurationResponseTypeDef:  # (1)
    ...

1. See GetVoiceConnectorStreamingConfigurationResponseTypeDef

# get_voice_connector_streaming_configuration method usage example with argument unpacking

kwargs: GetVoiceConnectorStreamingConfigurationRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.get_voice_connector_streaming_configuration(**kwargs)

1. See GetVoiceConnectorStreamingConfigurationRequestRequestTypeDef

get_voice_connector_termination

Retrieves termination setting details for the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").get_voice_connector_termination method. boto3 documentation

# get_voice_connector_termination method definition

def get_voice_connector_termination(
    self,
    *,
    VoiceConnectorId: str,
) -> GetVoiceConnectorTerminationResponseTypeDef:  # (1)
    ...

1. See GetVoiceConnectorTerminationResponseTypeDef

# get_voice_connector_termination method usage example with argument unpacking

kwargs: GetVoiceConnectorTerminationRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.get_voice_connector_termination(**kwargs)

1. See GetVoiceConnectorTerminationRequestRequestTypeDef

get_voice_connector_termination_health

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorTerminationHealth, in the Amazon Chime SDK.

Type annotations and code completion for boto3.client("chime").get_voice_connector_termination_health method. boto3 documentation

# get_voice_connector_termination_health method definition

def get_voice_connector_termination_health(
    self,
    *,
    VoiceConnectorId: str,
) -> GetVoiceConnectorTerminationHealthResponseTypeDef:  # (1)
    ...

1. See GetVoiceConnectorTerminationHealthResponseTypeDef

# get_voice_connector_termination_health method usage example with argument unpacking

kwargs: GetVoiceConnectorTerminationHealthRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.get_voice_connector_termination_health(**kwargs)

1. See GetVoiceConnectorTerminationHealthRequestRequestTypeDef

invite_users

Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team account.

Type annotations and code completion for boto3.client("chime").invite_users method. boto3 documentation

# invite_users method definition

def invite_users(
    self,
    *,
    AccountId: str,
    UserEmailList: Sequence[str],
    UserType: UserTypeType = ...,  # (1)
) -> InviteUsersResponseTypeDef:  # (2)
    ...

1. See UserTypeType
2. See InviteUsersResponseTypeDef

# invite_users method usage example with argument unpacking

kwargs: InviteUsersRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UserEmailList": ...,
}

parent.invite_users(**kwargs)

1. See InviteUsersRequestRequestTypeDef

list_accounts

Lists the Amazon Chime accounts under the administrator's AWS account.

Type annotations and code completion for boto3.client("chime").list_accounts method. boto3 documentation

# list_accounts method definition

def list_accounts(
    self,
    *,
    Name: str = ...,
    UserEmail: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListAccountsResponseTypeDef:  # (1)
    ...

1. See ListAccountsResponseTypeDef

# list_accounts method usage example with argument unpacking

kwargs: ListAccountsRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.list_accounts(**kwargs)

1. See ListAccountsRequestRequestTypeDef

list_app_instance_admins

Returns a list of the administrators in the AppInstance.

Type annotations and code completion for boto3.client("chime").list_app_instance_admins method. boto3 documentation

# list_app_instance_admins method definition

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

1. See ListAppInstanceAdminsResponseTypeDef

# list_app_instance_admins method usage example with argument unpacking

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

parent.list_app_instance_admins(**kwargs)

1. See ListAppInstanceAdminsRequestRequestTypeDef

list_app_instance_users

List all AppInstanceUsers created under a single AppInstance.

Type annotations and code completion for boto3.client("chime").list_app_instance_users method. boto3 documentation

# list_app_instance_users method definition

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

1. See ListAppInstanceUsersResponseTypeDef

# list_app_instance_users method usage example with argument unpacking

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

parent.list_app_instance_users(**kwargs)

1. See ListAppInstanceUsersRequestRequestTypeDef

list_app_instances

Lists all Amazon Chime AppInstances created under a single AWS account.

Type annotations and code completion for boto3.client("chime").list_app_instances method. boto3 documentation

# list_app_instances method definition

def list_app_instances(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAppInstancesResponseTypeDef:  # (1)
    ...

1. See ListAppInstancesResponseTypeDef

# list_app_instances method usage example with argument unpacking

kwargs: ListAppInstancesRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_app_instances(**kwargs)

1. See ListAppInstancesRequestRequestTypeDef

list_attendee_tags

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

Type annotations and code completion for boto3.client("chime").list_attendee_tags method. boto3 documentation

# list_attendee_tags method definition

def list_attendee_tags(
    self,
    *,
    MeetingId: str,
    AttendeeId: str,
) -> ListAttendeeTagsResponseTypeDef:  # (1)
    ...

1. See ListAttendeeTagsResponseTypeDef

# list_attendee_tags method usage example with argument unpacking

kwargs: ListAttendeeTagsRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
    "AttendeeId": ...,
}

parent.list_attendee_tags(**kwargs)

1. See ListAttendeeTagsRequestRequestTypeDef

list_attendees

Lists the attendees for the specified Amazon Chime SDK meeting.

Type annotations and code completion for boto3.client("chime").list_attendees method. boto3 documentation

# list_attendees method definition

def list_attendees(
    self,
    *,
    MeetingId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListAttendeesResponseTypeDef:  # (1)
    ...

1. See ListAttendeesResponseTypeDef

# list_attendees method usage example with argument unpacking

kwargs: ListAttendeesRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
}

parent.list_attendees(**kwargs)

1. See ListAttendeesRequestRequestTypeDef

list_bots

Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.

Type annotations and code completion for boto3.client("chime").list_bots method. boto3 documentation

# list_bots method definition

def list_bots(
    self,
    *,
    AccountId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListBotsResponseTypeDef:  # (1)
    ...

1. See ListBotsResponseTypeDef

# list_bots method usage example with argument unpacking

kwargs: ListBotsRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.list_bots(**kwargs)

1. See ListBotsRequestRequestTypeDef

list_channel_bans

Lists all the users banned from a particular channel.

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

# list_channel_bans method definition

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

1. See ListChannelBansResponseTypeDef

# list_channel_bans method usage example with argument unpacking

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

parent.list_channel_bans(**kwargs)

1. See ListChannelBansRequestRequestTypeDef

list_channel_memberships

Lists all channel memberships in a channel.

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

# list_channel_memberships method definition

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

1. See ChannelMembershipTypeType
2. See ListChannelMembershipsResponseTypeDef

# list_channel_memberships method usage example with argument unpacking

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

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 boto3.client("chime").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,
    *,
    AppInstanceUserArn: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    ChimeBearer: str = ...,
) -> ListChannelMembershipsForAppInstanceUserResponseTypeDef:  # (1)
    ...

1. See ListChannelMembershipsForAppInstanceUserResponseTypeDef

# list_channel_memberships_for_app_instance_user method usage example with argument unpacking

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

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").list_channel_messages method. boto3 documentation

# list_channel_messages method definition

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

1. See SortOrderType
2. See ListChannelMessagesResponseTypeDef

# list_channel_messages method usage example with argument unpacking

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

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").list_channel_moderators method. boto3 documentation

# list_channel_moderators method definition

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

1. See ListChannelModeratorsResponseTypeDef

# list_channel_moderators method usage example with argument unpacking

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

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").list_channels method. boto3 documentation

# list_channels method definition

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

1. See ChannelPrivacyType
2. See ListChannelsResponseTypeDef

# list_channels method usage example with argument unpacking

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

parent.list_channels(**kwargs)

1. See ListChannelsRequestRequestTypeDef

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").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,
    *,
    AppInstanceUserArn: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    ChimeBearer: str = ...,
) -> ListChannelsModeratedByAppInstanceUserResponseTypeDef:  # (1)
    ...

1. See ListChannelsModeratedByAppInstanceUserResponseTypeDef

# list_channels_moderated_by_app_instance_user method usage example with argument unpacking

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

parent.list_channels_moderated_by_app_instance_user(**kwargs)

1. See ListChannelsModeratedByAppInstanceUserRequestRequestTypeDef

list_media_capture_pipelines

Returns a list of media capture pipelines.

Type annotations and code completion for boto3.client("chime").list_media_capture_pipelines method. boto3 documentation

# list_media_capture_pipelines method definition

def list_media_capture_pipelines(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListMediaCapturePipelinesResponseTypeDef:  # (1)
    ...

1. See ListMediaCapturePipelinesResponseTypeDef

# list_media_capture_pipelines method usage example with argument unpacking

kwargs: ListMediaCapturePipelinesRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_media_capture_pipelines(**kwargs)

1. See ListMediaCapturePipelinesRequestRequestTypeDef

list_meeting_tags

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

Type annotations and code completion for boto3.client("chime").list_meeting_tags method. boto3 documentation

# list_meeting_tags method definition

def list_meeting_tags(
    self,
    *,
    MeetingId: str,
) -> ListMeetingTagsResponseTypeDef:  # (1)
    ...

1. See ListMeetingTagsResponseTypeDef

# list_meeting_tags method usage example with argument unpacking

kwargs: ListMeetingTagsRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
}

parent.list_meeting_tags(**kwargs)

1. See ListMeetingTagsRequestRequestTypeDef

list_meetings

Lists up to 100 active Amazon Chime SDK meetings.

Type annotations and code completion for boto3.client("chime").list_meetings method. boto3 documentation

# list_meetings method definition

def list_meetings(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListMeetingsResponseTypeDef:  # (1)
    ...

1. See ListMeetingsResponseTypeDef

# list_meetings method usage example with argument unpacking

kwargs: ListMeetingsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_meetings(**kwargs)

1. See ListMeetingsRequestRequestTypeDef

list_phone_number_orders

Lists the phone number orders for the administrator's Amazon Chime account.

Type annotations and code completion for boto3.client("chime").list_phone_number_orders method. boto3 documentation

# list_phone_number_orders method definition

def list_phone_number_orders(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPhoneNumberOrdersResponseTypeDef:  # (1)
    ...

1. See ListPhoneNumberOrdersResponseTypeDef

# list_phone_number_orders method usage example with argument unpacking

kwargs: ListPhoneNumberOrdersRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_phone_number_orders(**kwargs)

1. See ListPhoneNumberOrdersRequestRequestTypeDef

list_phone_numbers

Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.

Type annotations and code completion for boto3.client("chime").list_phone_numbers method. boto3 documentation

# list_phone_numbers method definition

def list_phone_numbers(
    self,
    *,
    Status: PhoneNumberStatusType = ...,  # (1)
    ProductType: PhoneNumberProductTypeType = ...,  # (2)
    FilterName: PhoneNumberAssociationNameType = ...,  # (3)
    FilterValue: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListPhoneNumbersResponseTypeDef:  # (4)
    ...

1. See PhoneNumberStatusType
2. See PhoneNumberProductTypeType
3. See PhoneNumberAssociationNameType
4. See ListPhoneNumbersResponseTypeDef

# list_phone_numbers method usage example with argument unpacking

kwargs: ListPhoneNumbersRequestRequestTypeDef = {  # (1)
    "Status": ...,
}

parent.list_phone_numbers(**kwargs)

1. See ListPhoneNumbersRequestRequestTypeDef

list_proxy_sessions

Lists the proxy sessions for the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").list_proxy_sessions method. boto3 documentation

# list_proxy_sessions method definition

def list_proxy_sessions(
    self,
    *,
    VoiceConnectorId: str,
    Status: ProxySessionStatusType = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListProxySessionsResponseTypeDef:  # (2)
    ...

1. See ProxySessionStatusType
2. See ListProxySessionsResponseTypeDef

# list_proxy_sessions method usage example with argument unpacking

kwargs: ListProxySessionsRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.list_proxy_sessions(**kwargs)

1. See ListProxySessionsRequestRequestTypeDef

list_room_memberships

Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.

Type annotations and code completion for boto3.client("chime").list_room_memberships method. boto3 documentation

# list_room_memberships method definition

def list_room_memberships(
    self,
    *,
    AccountId: str,
    RoomId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListRoomMembershipsResponseTypeDef:  # (1)
    ...

1. See ListRoomMembershipsResponseTypeDef

# list_room_memberships method usage example with argument unpacking

kwargs: ListRoomMembershipsRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "RoomId": ...,
}

parent.list_room_memberships(**kwargs)

1. See ListRoomMembershipsRequestRequestTypeDef

list_rooms

Lists the room details for the specified Amazon Chime Enterprise account.

Type annotations and code completion for boto3.client("chime").list_rooms method. boto3 documentation

# list_rooms method definition

def list_rooms(
    self,
    *,
    AccountId: str,
    MemberId: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListRoomsResponseTypeDef:  # (1)
    ...

1. See ListRoomsResponseTypeDef

# list_rooms method usage example with argument unpacking

kwargs: ListRoomsRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.list_rooms(**kwargs)

1. See ListRoomsRequestRequestTypeDef

list_sip_media_applications

Lists the SIP media applications under the administrator's AWS account.

Type annotations and code completion for boto3.client("chime").list_sip_media_applications method. boto3 documentation

# list_sip_media_applications method definition

def list_sip_media_applications(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListSipMediaApplicationsResponseTypeDef:  # (1)
    ...

1. See ListSipMediaApplicationsResponseTypeDef

# list_sip_media_applications method usage example with argument unpacking

kwargs: ListSipMediaApplicationsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_sip_media_applications(**kwargs)

1. See ListSipMediaApplicationsRequestRequestTypeDef

list_sip_rules

Lists the SIP rules under the administrator's AWS account.

Type annotations and code completion for boto3.client("chime").list_sip_rules method. boto3 documentation

# list_sip_rules method definition

def list_sip_rules(
    self,
    *,
    SipMediaApplicationId: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListSipRulesResponseTypeDef:  # (1)
    ...

1. See ListSipRulesResponseTypeDef

# list_sip_rules method usage example with argument unpacking

kwargs: ListSipRulesRequestRequestTypeDef = {  # (1)
    "SipMediaApplicationId": ...,
}

parent.list_sip_rules(**kwargs)

1. See ListSipRulesRequestRequestTypeDef

list_supported_phone_number_countries

Lists supported phone number countries.

Type annotations and code completion for boto3.client("chime").list_supported_phone_number_countries method. boto3 documentation

# list_supported_phone_number_countries method definition

def list_supported_phone_number_countries(
    self,
    *,
    ProductType: PhoneNumberProductTypeType,  # (1)
) -> ListSupportedPhoneNumberCountriesResponseTypeDef:  # (2)
    ...

1. See PhoneNumberProductTypeType
2. See ListSupportedPhoneNumberCountriesResponseTypeDef

# list_supported_phone_number_countries method usage example with argument unpacking

kwargs: ListSupportedPhoneNumberCountriesRequestRequestTypeDef = {  # (1)
    "ProductType": ...,
}

parent.list_supported_phone_number_countries(**kwargs)

1. See ListSupportedPhoneNumberCountriesRequestRequestTypeDef

list_tags_for_resource

Lists the tags applied to an Amazon Chime SDK meeting and messaging resources.

Type annotations and code completion for boto3.client("chime").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

list_users

Lists the users that belong to the specified Amazon Chime account.

Type annotations and code completion for boto3.client("chime").list_users method. boto3 documentation

# list_users method definition

def list_users(
    self,
    *,
    AccountId: str,
    UserEmail: str = ...,
    UserType: UserTypeType = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListUsersResponseTypeDef:  # (2)
    ...

1. See UserTypeType
2. See ListUsersResponseTypeDef

# list_users method usage example with argument unpacking

kwargs: ListUsersRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.list_users(**kwargs)

1. See ListUsersRequestRequestTypeDef

list_voice_connector_groups

Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.

Type annotations and code completion for boto3.client("chime").list_voice_connector_groups method. boto3 documentation

# list_voice_connector_groups method definition

def list_voice_connector_groups(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListVoiceConnectorGroupsResponseTypeDef:  # (1)
    ...

1. See ListVoiceConnectorGroupsResponseTypeDef

# list_voice_connector_groups method usage example with argument unpacking

kwargs: ListVoiceConnectorGroupsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_voice_connector_groups(**kwargs)

1. See ListVoiceConnectorGroupsRequestRequestTypeDef

list_voice_connector_termination_credentials

Lists the SIP credentials for the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").list_voice_connector_termination_credentials method. boto3 documentation

# list_voice_connector_termination_credentials method definition

def list_voice_connector_termination_credentials(
    self,
    *,
    VoiceConnectorId: str,
) -> ListVoiceConnectorTerminationCredentialsResponseTypeDef:  # (1)
    ...

1. See ListVoiceConnectorTerminationCredentialsResponseTypeDef

# list_voice_connector_termination_credentials method usage example with argument unpacking

kwargs: ListVoiceConnectorTerminationCredentialsRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.list_voice_connector_termination_credentials(**kwargs)

1. See ListVoiceConnectorTerminationCredentialsRequestRequestTypeDef

list_voice_connectors

Lists the Amazon Chime Voice Connectors for the administrator's AWS account.

Type annotations and code completion for boto3.client("chime").list_voice_connectors method. boto3 documentation

# list_voice_connectors method definition

def list_voice_connectors(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListVoiceConnectorsResponseTypeDef:  # (1)
    ...

1. See ListVoiceConnectorsResponseTypeDef

# list_voice_connectors method usage example with argument unpacking

kwargs: ListVoiceConnectorsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_voice_connectors(**kwargs)

1. See ListVoiceConnectorsRequestRequestTypeDef

logout_user

Logs out the specified user from all of the devices they are currently logged into.

Type annotations and code completion for boto3.client("chime").logout_user method. boto3 documentation

# logout_user method definition

def logout_user(
    self,
    *,
    AccountId: str,
    UserId: str,
) -> dict[str, Any]:
    ...

# logout_user method usage example with argument unpacking

kwargs: LogoutUserRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UserId": ...,
}

parent.logout_user(**kwargs)

1. See LogoutUserRequestRequestTypeDef

put_app_instance_retention_settings

Sets the amount of time in days that a given AppInstance retains data.

Type annotations and code completion for boto3.client("chime").put_app_instance_retention_settings method. boto3 documentation

# put_app_instance_retention_settings method definition

def put_app_instance_retention_settings(
    self,
    *,
    AppInstanceArn: str,
    AppInstanceRetentionSettings: AppInstanceRetentionSettingsTypeDef,  # (1)
) -> PutAppInstanceRetentionSettingsResponseTypeDef:  # (2)
    ...

1. See AppInstanceRetentionSettingsTypeDef
2. See PutAppInstanceRetentionSettingsResponseTypeDef

# put_app_instance_retention_settings method usage example with argument unpacking

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

parent.put_app_instance_retention_settings(**kwargs)

1. See PutAppInstanceRetentionSettingsRequestRequestTypeDef

put_app_instance_streaming_configurations

The data streaming configurations of an AppInstance.

Type annotations and code completion for boto3.client("chime").put_app_instance_streaming_configurations method. boto3 documentation

# put_app_instance_streaming_configurations method definition

def put_app_instance_streaming_configurations(
    self,
    *,
    AppInstanceArn: str,
    AppInstanceStreamingConfigurations: Sequence[AppInstanceStreamingConfigurationTypeDef],  # (1)
) -> PutAppInstanceStreamingConfigurationsResponseTypeDef:  # (2)
    ...

1. See AppInstanceStreamingConfigurationTypeDef
2. See PutAppInstanceStreamingConfigurationsResponseTypeDef

# put_app_instance_streaming_configurations method usage example with argument unpacking

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

parent.put_app_instance_streaming_configurations(**kwargs)

1. See PutAppInstanceStreamingConfigurationsRequestRequestTypeDef

put_events_configuration

Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime.

Type annotations and code completion for boto3.client("chime").put_events_configuration method. boto3 documentation

# put_events_configuration method definition

def put_events_configuration(
    self,
    *,
    AccountId: str,
    BotId: str,
    OutboundEventsHTTPSEndpoint: str = ...,
    LambdaFunctionArn: str = ...,
) -> PutEventsConfigurationResponseTypeDef:  # (1)
    ...

1. See PutEventsConfigurationResponseTypeDef

# put_events_configuration method usage example with argument unpacking

kwargs: PutEventsConfigurationRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BotId": ...,
}

parent.put_events_configuration(**kwargs)

1. See PutEventsConfigurationRequestRequestTypeDef

put_retention_settings

Puts retention settings for the specified Amazon Chime Enterprise account.

Type annotations and code completion for boto3.client("chime").put_retention_settings method. boto3 documentation

# put_retention_settings method definition

def put_retention_settings(
    self,
    *,
    AccountId: str,
    RetentionSettings: RetentionSettingsTypeDef,  # (1)
) -> PutRetentionSettingsResponseTypeDef:  # (2)
    ...

1. See RetentionSettingsTypeDef
2. See PutRetentionSettingsResponseTypeDef

# put_retention_settings method usage example with argument unpacking

kwargs: PutRetentionSettingsRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "RetentionSettings": ...,
}

parent.put_retention_settings(**kwargs)

1. See PutRetentionSettingsRequestRequestTypeDef

put_sip_media_application_logging_configuration

Updates the logging configuration for the specified SIP media application.

Type annotations and code completion for boto3.client("chime").put_sip_media_application_logging_configuration method. boto3 documentation

# put_sip_media_application_logging_configuration method definition

def put_sip_media_application_logging_configuration(
    self,
    *,
    SipMediaApplicationId: str,
    SipMediaApplicationLoggingConfiguration: SipMediaApplicationLoggingConfigurationTypeDef = ...,  # (1)
) -> PutSipMediaApplicationLoggingConfigurationResponseTypeDef:  # (2)
    ...

1. See SipMediaApplicationLoggingConfigurationTypeDef
2. See PutSipMediaApplicationLoggingConfigurationResponseTypeDef

# put_sip_media_application_logging_configuration method usage example with argument unpacking

kwargs: PutSipMediaApplicationLoggingConfigurationRequestRequestTypeDef = {  # (1)
    "SipMediaApplicationId": ...,
}

parent.put_sip_media_application_logging_configuration(**kwargs)

1. See PutSipMediaApplicationLoggingConfigurationRequestRequestTypeDef

put_voice_connector_emergency_calling_configuration

Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries.

Type annotations and code completion for boto3.client("chime").put_voice_connector_emergency_calling_configuration method. boto3 documentation

# put_voice_connector_emergency_calling_configuration method definition

def put_voice_connector_emergency_calling_configuration(
    self,
    *,
    VoiceConnectorId: str,
    EmergencyCallingConfiguration: EmergencyCallingConfigurationTypeDef,  # (1)
) -> PutVoiceConnectorEmergencyCallingConfigurationResponseTypeDef:  # (2)
    ...

1. See EmergencyCallingConfigurationTypeDef
2. See PutVoiceConnectorEmergencyCallingConfigurationResponseTypeDef

# put_voice_connector_emergency_calling_configuration method usage example with argument unpacking

kwargs: PutVoiceConnectorEmergencyCallingConfigurationRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "EmergencyCallingConfiguration": ...,
}

parent.put_voice_connector_emergency_calling_configuration(**kwargs)

1. See PutVoiceConnectorEmergencyCallingConfigurationRequestRequestTypeDef

put_voice_connector_logging_configuration

Adds a logging configuration for the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").put_voice_connector_logging_configuration method. boto3 documentation

# put_voice_connector_logging_configuration method definition

def put_voice_connector_logging_configuration(
    self,
    *,
    VoiceConnectorId: str,
    LoggingConfiguration: LoggingConfigurationTypeDef,  # (1)
) -> PutVoiceConnectorLoggingConfigurationResponseTypeDef:  # (2)
    ...

1. See LoggingConfigurationTypeDef
2. See PutVoiceConnectorLoggingConfigurationResponseTypeDef

# put_voice_connector_logging_configuration method usage example with argument unpacking

kwargs: PutVoiceConnectorLoggingConfigurationRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "LoggingConfiguration": ...,
}

parent.put_voice_connector_logging_configuration(**kwargs)

1. See PutVoiceConnectorLoggingConfigurationRequestRequestTypeDef

put_voice_connector_origination

Adds origination settings for the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").put_voice_connector_origination method. boto3 documentation

# put_voice_connector_origination method definition

def put_voice_connector_origination(
    self,
    *,
    VoiceConnectorId: str,
    Origination: OriginationTypeDef,  # (1)
) -> PutVoiceConnectorOriginationResponseTypeDef:  # (2)
    ...

1. See OriginationTypeDef
2. See PutVoiceConnectorOriginationResponseTypeDef

# put_voice_connector_origination method usage example with argument unpacking

kwargs: PutVoiceConnectorOriginationRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "Origination": ...,
}

parent.put_voice_connector_origination(**kwargs)

1. See PutVoiceConnectorOriginationRequestRequestTypeDef

put_voice_connector_proxy

Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").put_voice_connector_proxy method. boto3 documentation

# put_voice_connector_proxy method definition

def put_voice_connector_proxy(
    self,
    *,
    VoiceConnectorId: str,
    DefaultSessionExpiryMinutes: int,
    PhoneNumberPoolCountries: Sequence[str],
    FallBackPhoneNumber: str = ...,
    Disabled: bool = ...,
) -> PutVoiceConnectorProxyResponseTypeDef:  # (1)
    ...

1. See PutVoiceConnectorProxyResponseTypeDef

# put_voice_connector_proxy method usage example with argument unpacking

kwargs: PutVoiceConnectorProxyRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "DefaultSessionExpiryMinutes": ...,
    "PhoneNumberPoolCountries": ...,
}

parent.put_voice_connector_proxy(**kwargs)

1. See PutVoiceConnectorProxyRequestRequestTypeDef

put_voice_connector_streaming_configuration

Adds a streaming configuration for the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").put_voice_connector_streaming_configuration method. boto3 documentation

# put_voice_connector_streaming_configuration method definition

def put_voice_connector_streaming_configuration(
    self,
    *,
    VoiceConnectorId: str,
    StreamingConfiguration: StreamingConfigurationTypeDef,  # (1)
) -> PutVoiceConnectorStreamingConfigurationResponseTypeDef:  # (2)
    ...

1. See StreamingConfigurationTypeDef
2. See PutVoiceConnectorStreamingConfigurationResponseTypeDef

# put_voice_connector_streaming_configuration method usage example with argument unpacking

kwargs: PutVoiceConnectorStreamingConfigurationRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "StreamingConfiguration": ...,
}

parent.put_voice_connector_streaming_configuration(**kwargs)

1. See PutVoiceConnectorStreamingConfigurationRequestRequestTypeDef

put_voice_connector_termination

Adds termination settings for the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").put_voice_connector_termination method. boto3 documentation

# put_voice_connector_termination method definition

def put_voice_connector_termination(
    self,
    *,
    VoiceConnectorId: str,
    Termination: TerminationTypeDef,  # (1)
) -> PutVoiceConnectorTerminationResponseTypeDef:  # (2)
    ...

1. See TerminationTypeDef
2. See PutVoiceConnectorTerminationResponseTypeDef

# put_voice_connector_termination method usage example with argument unpacking

kwargs: PutVoiceConnectorTerminationRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "Termination": ...,
}

parent.put_voice_connector_termination(**kwargs)

1. See PutVoiceConnectorTerminationRequestRequestTypeDef

put_voice_connector_termination_credentials

Adds termination SIP credentials for the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").put_voice_connector_termination_credentials method. boto3 documentation

# put_voice_connector_termination_credentials method definition

def put_voice_connector_termination_credentials(
    self,
    *,
    VoiceConnectorId: str,
    Credentials: Sequence[CredentialTypeDef] = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See CredentialTypeDef
2. See EmptyResponseMetadataTypeDef

# put_voice_connector_termination_credentials method usage example with argument unpacking

kwargs: PutVoiceConnectorTerminationCredentialsRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
}

parent.put_voice_connector_termination_credentials(**kwargs)

1. See PutVoiceConnectorTerminationCredentialsRequestRequestTypeDef

redact_channel_message

Redacts message content, but not metadata.

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

# redact_channel_message method definition

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

1. See RedactChannelMessageResponseTypeDef

# redact_channel_message method usage example with argument unpacking

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

parent.redact_channel_message(**kwargs)

1. See RedactChannelMessageRequestRequestTypeDef

redact_conversation_message

Redacts the specified message from the specified Amazon Chime conversation.

Type annotations and code completion for boto3.client("chime").redact_conversation_message method. boto3 documentation

# redact_conversation_message method definition

def redact_conversation_message(
    self,
    *,
    AccountId: str,
    ConversationId: str,
    MessageId: str,
) -> dict[str, Any]:
    ...

# redact_conversation_message method usage example with argument unpacking

kwargs: RedactConversationMessageRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "ConversationId": ...,
    "MessageId": ...,
}

parent.redact_conversation_message(**kwargs)

1. See RedactConversationMessageRequestRequestTypeDef

redact_room_message

Redacts the specified message from the specified Amazon Chime channel.

Type annotations and code completion for boto3.client("chime").redact_room_message method. boto3 documentation

# redact_room_message method definition

def redact_room_message(
    self,
    *,
    AccountId: str,
    RoomId: str,
    MessageId: str,
) -> dict[str, Any]:
    ...

# redact_room_message method usage example with argument unpacking

kwargs: RedactRoomMessageRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "RoomId": ...,
    "MessageId": ...,
}

parent.redact_room_message(**kwargs)

1. See RedactRoomMessageRequestRequestTypeDef

regenerate_security_token

Regenerates the security token for a bot.

Type annotations and code completion for boto3.client("chime").regenerate_security_token method. boto3 documentation

# regenerate_security_token method definition

def regenerate_security_token(
    self,
    *,
    AccountId: str,
    BotId: str,
) -> RegenerateSecurityTokenResponseTypeDef:  # (1)
    ...

1. See RegenerateSecurityTokenResponseTypeDef

# regenerate_security_token method usage example with argument unpacking

kwargs: RegenerateSecurityTokenRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BotId": ...,
}

parent.regenerate_security_token(**kwargs)

1. See RegenerateSecurityTokenRequestRequestTypeDef

reset_personal_pin

Resets the personal meeting PIN for the specified user on an Amazon Chime account.

Type annotations and code completion for boto3.client("chime").reset_personal_pin method. boto3 documentation

# reset_personal_pin method definition

def reset_personal_pin(
    self,
    *,
    AccountId: str,
    UserId: str,
) -> ResetPersonalPINResponseTypeDef:  # (1)
    ...

1. See ResetPersonalPINResponseTypeDef

# reset_personal_pin method usage example with argument unpacking

kwargs: ResetPersonalPINRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UserId": ...,
}

parent.reset_personal_pin(**kwargs)

1. See ResetPersonalPINRequestRequestTypeDef

restore_phone_number

Moves a phone number from the Deletion queue back into the phone number Inventory.

Type annotations and code completion for boto3.client("chime").restore_phone_number method. boto3 documentation

# restore_phone_number method definition

def restore_phone_number(
    self,
    *,
    PhoneNumberId: str,
) -> RestorePhoneNumberResponseTypeDef:  # (1)
    ...

1. See RestorePhoneNumberResponseTypeDef

# restore_phone_number method usage example with argument unpacking

kwargs: RestorePhoneNumberRequestRequestTypeDef = {  # (1)
    "PhoneNumberId": ...,
}

parent.restore_phone_number(**kwargs)

1. See RestorePhoneNumberRequestRequestTypeDef

search_available_phone_numbers

Searches for phone numbers that can be ordered.

Type annotations and code completion for boto3.client("chime").search_available_phone_numbers method. boto3 documentation

# search_available_phone_numbers method definition

def search_available_phone_numbers(
    self,
    *,
    AreaCode: str = ...,
    City: str = ...,
    Country: str = ...,
    State: str = ...,
    TollFreePrefix: str = ...,
    PhoneNumberType: PhoneNumberTypeType = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> SearchAvailablePhoneNumbersResponseTypeDef:  # (2)
    ...

1. See PhoneNumberTypeType
2. See SearchAvailablePhoneNumbersResponseTypeDef

# search_available_phone_numbers method usage example with argument unpacking

kwargs: SearchAvailablePhoneNumbersRequestRequestTypeDef = {  # (1)
    "AreaCode": ...,
}

parent.search_available_phone_numbers(**kwargs)

1. See SearchAvailablePhoneNumbersRequestRequestTypeDef

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").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,
    Metadata: str = ...,
    ChimeBearer: str = ...,
) -> SendChannelMessageResponseTypeDef:  # (3)
    ...

1. See ChannelMessageTypeType
2. See ChannelMessagePersistenceTypeType
3. See SendChannelMessageResponseTypeDef

# send_channel_message method usage example with argument unpacking

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

parent.send_channel_message(**kwargs)

1. See SendChannelMessageRequestRequestTypeDef

start_meeting_transcription

Starts transcription for the specified meetingId.

Type annotations and code completion for boto3.client("chime").start_meeting_transcription method. boto3 documentation

# start_meeting_transcription method definition

def start_meeting_transcription(
    self,
    *,
    MeetingId: str,
    TranscriptionConfiguration: TranscriptionConfigurationTypeDef,  # (1)
) -> dict[str, Any]:
    ...

1. See TranscriptionConfigurationTypeDef

# start_meeting_transcription method usage example with argument unpacking

kwargs: StartMeetingTranscriptionRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
    "TranscriptionConfiguration": ...,
}

parent.start_meeting_transcription(**kwargs)

1. See StartMeetingTranscriptionRequestRequestTypeDef

stop_meeting_transcription

Stops transcription for the specified meetingId.

Type annotations and code completion for boto3.client("chime").stop_meeting_transcription method. boto3 documentation

# stop_meeting_transcription method definition

def stop_meeting_transcription(
    self,
    *,
    MeetingId: str,
) -> dict[str, Any]:
    ...

# stop_meeting_transcription method usage example with argument unpacking

kwargs: StopMeetingTranscriptionRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
}

parent.stop_meeting_transcription(**kwargs)

1. See StopMeetingTranscriptionRequestRequestTypeDef

tag_attendee

Applies the specified tags to the specified Amazon Chime attendee.

Type annotations and code completion for boto3.client("chime").tag_attendee method. boto3 documentation

# tag_attendee method definition

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

1. See TagTypeDef
2. See EmptyResponseMetadataTypeDef

# tag_attendee method usage example with argument unpacking

kwargs: TagAttendeeRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
    "AttendeeId": ...,
    "Tags": ...,
}

parent.tag_attendee(**kwargs)

1. See TagAttendeeRequestRequestTypeDef

tag_meeting

Applies the specified tags to the specified Amazon Chime SDK meeting.

Type annotations and code completion for boto3.client("chime").tag_meeting method. boto3 documentation

# tag_meeting method definition

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

1. See TagTypeDef
2. See EmptyResponseMetadataTypeDef

# tag_meeting method usage example with argument unpacking

kwargs: TagMeetingRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
    "Tags": ...,
}

parent.tag_meeting(**kwargs)

1. See TagMeetingRequestRequestTypeDef

tag_resource

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

Type annotations and code completion for boto3.client("chime").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_attendee

Untags the specified tags from the specified Amazon Chime SDK attendee.

Type annotations and code completion for boto3.client("chime").untag_attendee method. boto3 documentation

# untag_attendee method definition

def untag_attendee(
    self,
    *,
    MeetingId: str,
    AttendeeId: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# untag_attendee method usage example with argument unpacking

kwargs: UntagAttendeeRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
    "AttendeeId": ...,
    "TagKeys": ...,
}

parent.untag_attendee(**kwargs)

1. See UntagAttendeeRequestRequestTypeDef

untag_meeting

Untags the specified tags from the specified Amazon Chime SDK meeting.

Type annotations and code completion for boto3.client("chime").untag_meeting method. boto3 documentation

# untag_meeting method definition

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

1. See EmptyResponseMetadataTypeDef

# untag_meeting method usage example with argument unpacking

kwargs: UntagMeetingRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
    "TagKeys": ...,
}

parent.untag_meeting(**kwargs)

1. See UntagMeetingRequestRequestTypeDef

untag_resource

Untags the specified tags from the specified Amazon Chime SDK meeting resource.

Type annotations and code completion for boto3.client("chime").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_account

Updates account details for the specified Amazon Chime account.

Type annotations and code completion for boto3.client("chime").update_account method. boto3 documentation

# update_account method definition

def update_account(
    self,
    *,
    AccountId: str,
    Name: str = ...,
    DefaultLicense: LicenseType = ...,  # (1)
) -> UpdateAccountResponseTypeDef:  # (2)
    ...

1. See LicenseType
2. See UpdateAccountResponseTypeDef

# update_account method usage example with argument unpacking

kwargs: UpdateAccountRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.update_account(**kwargs)

1. See UpdateAccountRequestRequestTypeDef

update_account_settings

Updates the settings for the specified Amazon Chime account.

Type annotations and code completion for boto3.client("chime").update_account_settings method. boto3 documentation

# update_account_settings method definition

def update_account_settings(
    self,
    *,
    AccountId: str,
    AccountSettings: AccountSettingsTypeDef,  # (1)
) -> dict[str, Any]:
    ...

1. See AccountSettingsTypeDef

# update_account_settings method usage example with argument unpacking

kwargs: UpdateAccountSettingsRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "AccountSettings": ...,
}

parent.update_account_settings(**kwargs)

1. See UpdateAccountSettingsRequestRequestTypeDef

update_app_instance

Updates AppInstance metadata.

Type annotations and code completion for boto3.client("chime").update_app_instance method. boto3 documentation

# update_app_instance method definition

def update_app_instance(
    self,
    *,
    AppInstanceArn: str,
    Name: str,
    Metadata: str = ...,
) -> UpdateAppInstanceResponseTypeDef:  # (1)
    ...

1. See UpdateAppInstanceResponseTypeDef

# update_app_instance method usage example with argument unpacking

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

parent.update_app_instance(**kwargs)

1. See UpdateAppInstanceRequestRequestTypeDef

update_app_instance_user

Updates the details of an AppInstanceUser.

Type annotations and code completion for boto3.client("chime").update_app_instance_user method. boto3 documentation

# update_app_instance_user method definition

def update_app_instance_user(
    self,
    *,
    AppInstanceUserArn: str,
    Name: str,
    Metadata: str = ...,
) -> UpdateAppInstanceUserResponseTypeDef:  # (1)
    ...

1. See UpdateAppInstanceUserResponseTypeDef

# update_app_instance_user method usage example with argument unpacking

kwargs: UpdateAppInstanceUserRequestRequestTypeDef = {  # (1)
    "AppInstanceUserArn": ...,
    "Name": ...,
}

parent.update_app_instance_user(**kwargs)

1. See UpdateAppInstanceUserRequestRequestTypeDef

update_bot

Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.

Type annotations and code completion for boto3.client("chime").update_bot method. boto3 documentation

# update_bot method definition

def update_bot(
    self,
    *,
    AccountId: str,
    BotId: str,
    Disabled: bool = ...,
) -> UpdateBotResponseTypeDef:  # (1)
    ...

1. See UpdateBotResponseTypeDef

# update_bot method usage example with argument unpacking

kwargs: UpdateBotRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BotId": ...,
}

parent.update_bot(**kwargs)

1. See UpdateBotRequestRequestTypeDef

update_channel

Update a channel's attributes.

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

# update_channel method definition

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

1. See ChannelModeType
2. See UpdateChannelResponseTypeDef

# update_channel method usage example with argument unpacking

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

parent.update_channel(**kwargs)

1. See UpdateChannelRequestRequestTypeDef

update_channel_message

Updates the content of a message.

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

# update_channel_message method definition

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

1. See UpdateChannelMessageResponseTypeDef

# update_channel_message method usage example with argument unpacking

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

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").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": ...,
}

parent.update_channel_read_marker(**kwargs)

1. See UpdateChannelReadMarkerRequestRequestTypeDef

update_global_settings

Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

Type annotations and code completion for boto3.client("chime").update_global_settings method. boto3 documentation

# update_global_settings method definition

def update_global_settings(
    self,
    *,
    BusinessCalling: BusinessCallingSettingsTypeDef = ...,  # (1)
    VoiceConnector: VoiceConnectorSettingsTypeDef = ...,  # (2)
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...

1. See BusinessCallingSettingsTypeDef
2. See VoiceConnectorSettingsTypeDef
3. See EmptyResponseMetadataTypeDef

# update_global_settings method usage example with argument unpacking

kwargs: UpdateGlobalSettingsRequestRequestTypeDef = {  # (1)
    "BusinessCalling": ...,
}

parent.update_global_settings(**kwargs)

1. See UpdateGlobalSettingsRequestRequestTypeDef

update_phone_number

Updates phone number details, such as product type or calling name, for the specified phone number ID.

Type annotations and code completion for boto3.client("chime").update_phone_number method. boto3 documentation

# update_phone_number method definition

def update_phone_number(
    self,
    *,
    PhoneNumberId: str,
    ProductType: PhoneNumberProductTypeType = ...,  # (1)
    CallingName: str = ...,
) -> UpdatePhoneNumberResponseTypeDef:  # (2)
    ...

1. See PhoneNumberProductTypeType
2. See UpdatePhoneNumberResponseTypeDef

# update_phone_number method usage example with argument unpacking

kwargs: UpdatePhoneNumberRequestRequestTypeDef = {  # (1)
    "PhoneNumberId": ...,
}

parent.update_phone_number(**kwargs)

1. See UpdatePhoneNumberRequestRequestTypeDef

update_phone_number_settings

Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name.

Type annotations and code completion for boto3.client("chime").update_phone_number_settings method. boto3 documentation

# update_phone_number_settings method definition

def update_phone_number_settings(
    self,
    *,
    CallingName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# update_phone_number_settings method usage example with argument unpacking

kwargs: UpdatePhoneNumberSettingsRequestRequestTypeDef = {  # (1)
    "CallingName": ...,
}

parent.update_phone_number_settings(**kwargs)

1. See UpdatePhoneNumberSettingsRequestRequestTypeDef

update_proxy_session

Updates the specified proxy session details, such as voice or SMS capabilities.

Type annotations and code completion for boto3.client("chime").update_proxy_session method. boto3 documentation

# update_proxy_session method definition

def update_proxy_session(
    self,
    *,
    VoiceConnectorId: str,
    ProxySessionId: str,
    Capabilities: Sequence[CapabilityType],  # (1)
    ExpiryMinutes: int = ...,
) -> UpdateProxySessionResponseTypeDef:  # (2)
    ...

1. See CapabilityType
2. See UpdateProxySessionResponseTypeDef

# update_proxy_session method usage example with argument unpacking

kwargs: UpdateProxySessionRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "ProxySessionId": ...,
    "Capabilities": ...,
}

parent.update_proxy_session(**kwargs)

1. See UpdateProxySessionRequestRequestTypeDef

update_room

Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.

Type annotations and code completion for boto3.client("chime").update_room method. boto3 documentation

# update_room method definition

def update_room(
    self,
    *,
    AccountId: str,
    RoomId: str,
    Name: str = ...,
) -> UpdateRoomResponseTypeDef:  # (1)
    ...

1. See UpdateRoomResponseTypeDef

# update_room method usage example with argument unpacking

kwargs: UpdateRoomRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "RoomId": ...,
}

parent.update_room(**kwargs)

1. See UpdateRoomRequestRequestTypeDef

update_room_membership

Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account.

Type annotations and code completion for boto3.client("chime").update_room_membership method. boto3 documentation

# update_room_membership method definition

def update_room_membership(
    self,
    *,
    AccountId: str,
    RoomId: str,
    MemberId: str,
    Role: RoomMembershipRoleType = ...,  # (1)
) -> UpdateRoomMembershipResponseTypeDef:  # (2)
    ...

1. See RoomMembershipRoleType
2. See UpdateRoomMembershipResponseTypeDef

# update_room_membership method usage example with argument unpacking

kwargs: UpdateRoomMembershipRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "RoomId": ...,
    "MemberId": ...,
}

parent.update_room_membership(**kwargs)

1. See UpdateRoomMembershipRequestRequestTypeDef

update_sip_media_application

Updates the details of the specified SIP media application.

Type annotations and code completion for boto3.client("chime").update_sip_media_application method. boto3 documentation

# update_sip_media_application method definition

def update_sip_media_application(
    self,
    *,
    SipMediaApplicationId: str,
    Name: str = ...,
    Endpoints: Sequence[SipMediaApplicationEndpointTypeDef] = ...,  # (1)
) -> UpdateSipMediaApplicationResponseTypeDef:  # (2)
    ...

1. See SipMediaApplicationEndpointTypeDef
2. See UpdateSipMediaApplicationResponseTypeDef

# update_sip_media_application method usage example with argument unpacking

kwargs: UpdateSipMediaApplicationRequestRequestTypeDef = {  # (1)
    "SipMediaApplicationId": ...,
}

parent.update_sip_media_application(**kwargs)

1. See UpdateSipMediaApplicationRequestRequestTypeDef

update_sip_media_application_call

Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request.

Type annotations and code completion for boto3.client("chime").update_sip_media_application_call method. boto3 documentation

# update_sip_media_application_call method definition

def update_sip_media_application_call(
    self,
    *,
    SipMediaApplicationId: str,
    TransactionId: str,
    Arguments: Mapping[str, str],
) -> UpdateSipMediaApplicationCallResponseTypeDef:  # (1)
    ...

1. See UpdateSipMediaApplicationCallResponseTypeDef

# update_sip_media_application_call method usage example with argument unpacking

kwargs: UpdateSipMediaApplicationCallRequestRequestTypeDef = {  # (1)
    "SipMediaApplicationId": ...,
    "TransactionId": ...,
    "Arguments": ...,
}

parent.update_sip_media_application_call(**kwargs)

1. See UpdateSipMediaApplicationCallRequestRequestTypeDef

update_sip_rule

Updates the details of the specified SIP rule.

Type annotations and code completion for boto3.client("chime").update_sip_rule method. boto3 documentation

# update_sip_rule method definition

def update_sip_rule(
    self,
    *,
    SipRuleId: str,
    Name: str,
    Disabled: bool = ...,
    TargetApplications: Sequence[SipRuleTargetApplicationTypeDef] = ...,  # (1)
) -> UpdateSipRuleResponseTypeDef:  # (2)
    ...

1. See SipRuleTargetApplicationTypeDef
2. See UpdateSipRuleResponseTypeDef

# update_sip_rule method usage example with argument unpacking

kwargs: UpdateSipRuleRequestRequestTypeDef = {  # (1)
    "SipRuleId": ...,
    "Name": ...,
}

parent.update_sip_rule(**kwargs)

1. See UpdateSipRuleRequestRequestTypeDef

update_user

Updates user details for a specified user ID.

Type annotations and code completion for boto3.client("chime").update_user method. boto3 documentation

# update_user method definition

def update_user(
    self,
    *,
    AccountId: str,
    UserId: str,
    LicenseType: LicenseType = ...,  # (1)
    UserType: UserTypeType = ...,  # (2)
    AlexaForBusinessMetadata: AlexaForBusinessMetadataTypeDef = ...,  # (3)
) -> UpdateUserResponseTypeDef:  # (4)
    ...

1. See LicenseType
2. See UserTypeType
3. See AlexaForBusinessMetadataTypeDef
4. See UpdateUserResponseTypeDef

# update_user method usage example with argument unpacking

kwargs: UpdateUserRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UserId": ...,
}

parent.update_user(**kwargs)

1. See UpdateUserRequestRequestTypeDef

update_user_settings

Updates the settings for the specified user, such as phone number settings.

Type annotations and code completion for boto3.client("chime").update_user_settings method. boto3 documentation

# update_user_settings method definition

def update_user_settings(
    self,
    *,
    AccountId: str,
    UserId: str,
    UserSettings: UserSettingsTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See UserSettingsTypeDef
2. See EmptyResponseMetadataTypeDef

# update_user_settings method usage example with argument unpacking

kwargs: UpdateUserSettingsRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UserId": ...,
    "UserSettings": ...,
}

parent.update_user_settings(**kwargs)

1. See UpdateUserSettingsRequestRequestTypeDef

update_voice_connector

Updates details for the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").update_voice_connector method. boto3 documentation

# update_voice_connector method definition

def update_voice_connector(
    self,
    *,
    VoiceConnectorId: str,
    Name: str,
    RequireEncryption: bool,
) -> UpdateVoiceConnectorResponseTypeDef:  # (1)
    ...

1. See UpdateVoiceConnectorResponseTypeDef

# update_voice_connector method usage example with argument unpacking

kwargs: UpdateVoiceConnectorRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "Name": ...,
    "RequireEncryption": ...,
}

parent.update_voice_connector(**kwargs)

1. See UpdateVoiceConnectorRequestRequestTypeDef

update_voice_connector_group

Updates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.

Type annotations and code completion for boto3.client("chime").update_voice_connector_group method. boto3 documentation

# update_voice_connector_group method definition

def update_voice_connector_group(
    self,
    *,
    VoiceConnectorGroupId: str,
    Name: str,
    VoiceConnectorItems: Sequence[VoiceConnectorItemTypeDef],  # (1)
) -> UpdateVoiceConnectorGroupResponseTypeDef:  # (2)
    ...

1. See VoiceConnectorItemTypeDef
2. See UpdateVoiceConnectorGroupResponseTypeDef

# update_voice_connector_group method usage example with argument unpacking

kwargs: UpdateVoiceConnectorGroupRequestRequestTypeDef = {  # (1)
    "VoiceConnectorGroupId": ...,
    "Name": ...,
    "VoiceConnectorItems": ...,
}

parent.update_voice_connector_group(**kwargs)

1. See UpdateVoiceConnectorGroupRequestRequestTypeDef

validate_e911_address

Validates an address to be used for 911 calls made with Amazon Chime Voice Connectors.

Type annotations and code completion for boto3.client("chime").validate_e911_address method. boto3 documentation

# validate_e911_address method definition

def validate_e911_address(
    self,
    *,
    AwsAccountId: str,
    StreetNumber: str,
    StreetInfo: str,
    City: str,
    State: str,
    Country: str,
    PostalCode: str,
) -> ValidateE911AddressResponseTypeDef:  # (1)
    ...

1. See ValidateE911AddressResponseTypeDef

# validate_e911_address method usage example with argument unpacking

kwargs: ValidateE911AddressRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "StreetNumber": ...,
    "StreetInfo": ...,
    "City": ...,
    "State": ...,
    "Country": ...,
    "PostalCode": ...,
}

parent.validate_e911_address(**kwargs)

1. See ValidateE911AddressRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("chime").get_paginator method with overloads.

• client.get_paginator("list_accounts") -> ListAccountsPaginator
• client.get_paginator("list_users") -> ListUsersPaginator