Skip to content

ChimeSDKIdentityClient#

Index > ChimeSDKIdentity > ChimeSDKIdentityClient

Auto-generated documentation for ChimeSDKIdentity type annotations stubs module mypy-boto3-chime-sdk-identity.

ChimeSDKIdentityClient#

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

# ChimeSDKIdentityClient usage example

from boto3.session import Session
from mypy_boto3_chime_sdk_identity.client import ChimeSDKIdentityClient

def get_chime-sdk-identity_client() -> ChimeSDKIdentityClient:
    return Session().client("chime-sdk-identity")

Exceptions#

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

# Exceptions.exceptions usage example

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

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

from mypy_boto3_chime_sdk_identity.client import Exceptions

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

Methods#

can_paginate#

Check if an operation can be paginated.

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

# can_paginate method definition

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

close#

Closes underlying endpoint connections.

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

# close method definition

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

create_app_instance#

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

Type annotations and code completion for boto3.client("chime-sdk-identity").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 or AppInstanceBot to an AppInstanceAdmin.

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

Creates a bot under an Amazon Chime AppInstance.

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

# create_app_instance_bot method definition

def create_app_instance_bot(
    self,
    *,
    AppInstanceArn: str,
    ClientRequestToken: str,
    Configuration: ConfigurationTypeDef,  # (1)
    Name: str = ...,
    Metadata: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateAppInstanceBotResponseTypeDef:  # (3)
    ...
  1. See ConfigurationTypeDef
  2. See TagTypeDef
  3. See CreateAppInstanceBotResponseTypeDef
# create_app_instance_bot method usage example with argument unpacking

kwargs: CreateAppInstanceBotRequestRequestTypeDef = {  # (1)
    "AppInstanceArn": ...,
    "ClientRequestToken": ...,
    "Configuration": ...,
}

parent.create_app_instance_bot(**kwargs)
  1. See CreateAppInstanceBotRequestRequestTypeDef

create_app_instance_user#

Creates a user under an Amazon Chime AppInstance.

Type annotations and code completion for boto3.client("chime-sdk-identity").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)
    ExpirationSettings: ExpirationSettingsTypeDef = ...,  # (2)
) -> CreateAppInstanceUserResponseTypeDef:  # (3)
    ...
  1. See TagTypeDef
  2. See ExpirationSettingsTypeDef
  3. 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

delete_app_instance#

Deletes an AppInstance and all associated data asynchronously.

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

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

Deletes an AppInstanceBot.

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

# delete_app_instance_bot method definition

def delete_app_instance_bot(
    self,
    *,
    AppInstanceBotArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_app_instance_bot method usage example with argument unpacking

kwargs: DeleteAppInstanceBotRequestRequestTypeDef = {  # (1)
    "AppInstanceBotArn": ...,
}

parent.delete_app_instance_bot(**kwargs)
  1. See DeleteAppInstanceBotRequestRequestTypeDef

delete_app_instance_user#

Deletes an AppInstanceUser.

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

deregister_app_instance_user_endpoint#

Deregisters an AppInstanceUserEndpoint.

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

# deregister_app_instance_user_endpoint method definition

def deregister_app_instance_user_endpoint(
    self,
    *,
    AppInstanceUserArn: str,
    EndpointId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# deregister_app_instance_user_endpoint method usage example with argument unpacking

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

parent.deregister_app_instance_user_endpoint(**kwargs)
  1. See DeregisterAppInstanceUserEndpointRequestRequestTypeDef

describe_app_instance#

Returns the full details of an AppInstance.

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