ChimeClient

Index > Chime > ChimeClient

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

ChimeClient

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

# ChimeClient usage example

from boto3.session import Session
from mypy_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 mypy_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: AssociatePhoneNumberWithUserRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UserId": ...,
    "E164PhoneNumber": ...,
}

parent.associate_phone_number_with_user(**kwargs)

1. See AssociatePhoneNumberWithUserRequestTypeDef

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 Sequence[SigninDelegateGroupTypeDef]

# associate_signin_delegate_groups_with_account method usage example with argument unpacking

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

parent.associate_signin_delegate_groups_with_account(**kwargs)

1. See AssociateSigninDelegateGroupsWithAccountRequestTypeDef

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 Sequence[MembershipItemTypeDef]
2. See BatchCreateRoomMembershipResponseTypeDef

# batch_create_room_membership method usage example with argument unpacking

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

parent.batch_create_room_membership(**kwargs)

1. See BatchCreateRoomMembershipRequestTypeDef

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: BatchDeletePhoneNumberRequestTypeDef = {  # (1)
    "PhoneNumberIds": ...,
}

parent.batch_delete_phone_number(**kwargs)

1. See BatchDeletePhoneNumberRequestTypeDef

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: BatchSuspendUserRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UserIdList": ...,
}

parent.batch_suspend_user(**kwargs)

1. See BatchSuspendUserRequestTypeDef

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: BatchUnsuspendUserRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UserIdList": ...,
}

parent.batch_unsuspend_user(**kwargs)

1. See BatchUnsuspendUserRequestTypeDef

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 Sequence[UpdatePhoneNumberRequestItemTypeDef]
2. See BatchUpdatePhoneNumberResponseTypeDef

# batch_update_phone_number method usage example with argument unpacking

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

parent.batch_update_phone_number(**kwargs)

1. See BatchUpdatePhoneNumberRequestTypeDef

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 Sequence[UpdateUserRequestItemTypeDef]
2. See BatchUpdateUserResponseTypeDef

# batch_update_user method usage example with argument unpacking

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

parent.batch_update_user(**kwargs)

1. See BatchUpdateUserRequestTypeDef

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: CreateAccountRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_account(**kwargs)

1. See CreateAccountRequestTypeDef

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: CreateBotRequestTypeDef = {  # (1)
    "AccountId": ...,
    "DisplayName": ...,
}

parent.create_bot(**kwargs)

1. See CreateBotRequestTypeDef

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: CreateMeetingDialOutRequestTypeDef = {  # (1)
    "MeetingId": ...,
    "FromPhoneNumber": ...,
    "ToPhoneNumber": ...,
    "JoinToken": ...,
}

parent.create_meeting_dial_out(**kwargs)

1. See CreateMeetingDialOutRequestTypeDef

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: CreatePhoneNumberOrderRequestTypeDef = {  # (1)
    "ProductType": ...,
    "E164PhoneNumbers": ...,
}

parent.create_phone_number_order(**kwargs)

1. See CreatePhoneNumberOrderRequestTypeDef

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: CreateRoomRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Name": ...,
}

parent.create_room(**kwargs)

1. See CreateRoomRequestTypeDef

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: CreateRoomMembershipRequestTypeDef = {  # (1)
    "AccountId": ...,
    "RoomId": ...,
    "MemberId": ...,
}

parent.create_room_membership(**kwargs)

1. See CreateRoomMembershipRequestTypeDef

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: CreateUserRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.create_user(**kwargs)

1. See CreateUserRequestTypeDef

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: DeleteAccountRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.delete_account(**kwargs)

1. See DeleteAccountRequestTypeDef

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: DeleteEventsConfigurationRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BotId": ...,
}

parent.delete_events_configuration(**kwargs)

1. See DeleteEventsConfigurationRequestTypeDef

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: DeletePhoneNumberRequestTypeDef = {  # (1)
    "PhoneNumberId": ...,
}

parent.delete_phone_number(**kwargs)

1. See DeletePhoneNumberRequestTypeDef

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: DeleteRoomRequestTypeDef = {  # (1)
    "AccountId": ...,
    "RoomId": ...,
}

parent.delete_room(**kwargs)

1. See DeleteRoomRequestTypeDef

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: DeleteRoomMembershipRequestTypeDef = {  # (1)
    "AccountId": ...,
    "RoomId": ...,
    "MemberId": ...,
}

parent.delete_room_membership(**kwargs)

1. See DeleteRoomMembershipRequestTypeDef

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: DisassociatePhoneNumberFromUserRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UserId": ...,
}

parent.disassociate_phone_number_from_user(**kwargs)

1. See DisassociatePhoneNumberFromUserRequestTypeDef

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: DisassociateSigninDelegateGroupsFromAccountRequestTypeDef = {  # (1)
    "AccountId": ...,
    "GroupNames": ...,
}

parent.disassociate_signin_delegate_groups_from_account(**kwargs)

1. See DisassociateSigninDelegateGroupsFromAccountRequestTypeDef

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: GetAccountRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.get_account(**kwargs)

1. See GetAccountRequestTypeDef

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: GetAccountSettingsRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.get_account_settings(**kwargs)

1. See GetAccountSettingsRequestTypeDef

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: GetBotRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BotId": ...,
}

parent.get_bot(**kwargs)

1. See GetBotRequestTypeDef

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: GetEventsConfigurationRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BotId": ...,
}

parent.get_events_configuration(**kwargs)

1. See GetEventsConfigurationRequestTypeDef

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_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: GetPhoneNumberRequestTypeDef = {  # (1)
    "PhoneNumberId": ...,
}

parent.get_phone_number(**kwargs)

1. See GetPhoneNumberRequestTypeDef

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: GetPhoneNumberOrderRequestTypeDef = {  # (1)
    "PhoneNumberOrderId": ...,
}

parent.get_phone_number_order(**kwargs)

1. See GetPhoneNumberOrderRequestTypeDef

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_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: GetRetentionSettingsRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.get_retention_settings(**kwargs)

1. See GetRetentionSettingsRequestTypeDef

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: GetRoomRequestTypeDef = {  # (1)
    "AccountId": ...,
    "RoomId": ...,
}

parent.get_room(**kwargs)

1. See GetRoomRequestTypeDef

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: GetUserRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UserId": ...,
}

parent.get_user(**kwargs)

1. See GetUserRequestTypeDef

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: GetUserSettingsRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UserId": ...,
}

parent.get_user_settings(**kwargs)

1. See GetUserSettingsRequestTypeDef

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: InviteUsersRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UserEmailList": ...,
}

parent.invite_users(**kwargs)

1. See InviteUsersRequestTypeDef

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: ListAccountsRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.list_accounts(**kwargs)

1. See ListAccountsRequestTypeDef

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: ListBotsRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.list_bots(**kwargs)

1. See ListBotsRequestTypeDef

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: ListPhoneNumberOrdersRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_phone_number_orders(**kwargs)

1. See ListPhoneNumberOrdersRequestTypeDef

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: ListPhoneNumbersRequestTypeDef = {  # (1)
    "Status": ...,
}

parent.list_phone_numbers(**kwargs)

1. See ListPhoneNumbersRequestTypeDef

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: ListRoomMembershipsRequestTypeDef = {  # (1)
    "AccountId": ...,
    "RoomId": ...,
}

parent.list_room_memberships(**kwargs)

1. See ListRoomMembershipsRequestTypeDef

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: ListRoomsRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.list_rooms(**kwargs)

1. See ListRoomsRequestTypeDef

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: ListSupportedPhoneNumberCountriesRequestTypeDef = {  # (1)
    "ProductType": ...,
}

parent.list_supported_phone_number_countries(**kwargs)

1. See ListSupportedPhoneNumberCountriesRequestTypeDef

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: ListUsersRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.list_users(**kwargs)

1. See ListUsersRequestTypeDef

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: LogoutUserRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UserId": ...,
}

parent.logout_user(**kwargs)

1. See LogoutUserRequestTypeDef

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: PutEventsConfigurationRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BotId": ...,
}

parent.put_events_configuration(**kwargs)

1. See PutEventsConfigurationRequestTypeDef

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: PutRetentionSettingsRequestTypeDef = {  # (1)
    "AccountId": ...,
    "RetentionSettings": ...,
}

parent.put_retention_settings(**kwargs)

1. See PutRetentionSettingsRequestTypeDef

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: RedactConversationMessageRequestTypeDef = {  # (1)
    "AccountId": ...,
    "ConversationId": ...,
    "MessageId": ...,
}

parent.redact_conversation_message(**kwargs)

1. See RedactConversationMessageRequestTypeDef

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: RedactRoomMessageRequestTypeDef = {  # (1)
    "AccountId": ...,
    "RoomId": ...,
    "MessageId": ...,
}

parent.redact_room_message(**kwargs)

1. See RedactRoomMessageRequestTypeDef

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: RegenerateSecurityTokenRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BotId": ...,
}

parent.regenerate_security_token(**kwargs)

1. See RegenerateSecurityTokenRequestTypeDef

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: ResetPersonalPINRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UserId": ...,
}

parent.reset_personal_pin(**kwargs)

1. See ResetPersonalPINRequestTypeDef

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: RestorePhoneNumberRequestTypeDef = {  # (1)
    "PhoneNumberId": ...,
}

parent.restore_phone_number(**kwargs)

1. See RestorePhoneNumberRequestTypeDef

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: SearchAvailablePhoneNumbersRequestTypeDef = {  # (1)
    "AreaCode": ...,
}

parent.search_available_phone_numbers(**kwargs)

1. See SearchAvailablePhoneNumbersRequestTypeDef

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: UpdateAccountRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.update_account(**kwargs)

1. See UpdateAccountRequestTypeDef

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: UpdateAccountSettingsRequestTypeDef = {  # (1)
    "AccountId": ...,
    "AccountSettings": ...,
}

parent.update_account_settings(**kwargs)

1. See UpdateAccountSettingsRequestTypeDef

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: UpdateBotRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BotId": ...,
}

parent.update_bot(**kwargs)

1. See UpdateBotRequestTypeDef

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: UpdateGlobalSettingsRequestTypeDef = {  # (1)
    "BusinessCalling": ...,
}

parent.update_global_settings(**kwargs)

1. See UpdateGlobalSettingsRequestTypeDef

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: UpdatePhoneNumberRequestTypeDef = {  # (1)
    "PhoneNumberId": ...,
}

parent.update_phone_number(**kwargs)

1. See UpdatePhoneNumberRequestTypeDef

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: UpdatePhoneNumberSettingsRequestTypeDef = {  # (1)
    "CallingName": ...,
}

parent.update_phone_number_settings(**kwargs)

1. See UpdatePhoneNumberSettingsRequestTypeDef

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: UpdateRoomRequestTypeDef = {  # (1)
    "AccountId": ...,
    "RoomId": ...,
}

parent.update_room(**kwargs)

1. See UpdateRoomRequestTypeDef

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: UpdateRoomMembershipRequestTypeDef = {  # (1)
    "AccountId": ...,
    "RoomId": ...,
    "MemberId": ...,
}

parent.update_room_membership(**kwargs)

1. See UpdateRoomMembershipRequestTypeDef

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: UpdateUserRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UserId": ...,
}

parent.update_user(**kwargs)

1. See UpdateUserRequestTypeDef

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: UpdateUserSettingsRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UserId": ...,
    "UserSettings": ...,
}

parent.update_user_settings(**kwargs)

1. See UpdateUserSettingsRequestTypeDef

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