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. 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_bot#

The AppInstanceBot's information.

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

# describe_app_instance_bot method definition

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

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

parent.describe_app_instance_bot(**kwargs)
  1. See DescribeAppInstanceBotRequestRequestTypeDef

describe_app_instance_user#

Returns the full details of an AppInstanceUser.

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

Returns the full details of an AppInstanceUserEndpoint.

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

# describe_app_instance_user_endpoint method definition

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

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

parent.describe_app_instance_user_endpoint(**kwargs)
  1. See DescribeAppInstanceUserEndpointRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

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

get_app_instance_retention_settings#

Gets the retention settings for an AppInstance.

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

list_app_instance_admins#

Returns a list of the administrators in the AppInstance.

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

Lists all AppInstanceBots created under a single AppInstance.

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

# list_app_instance_bots method definition

def list_app_instance_bots(
    self,
    *,
    AppInstanceArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAppInstanceBotsResponseTypeDef:  # (1)
    ...
  1. See ListAppInstanceBotsResponseTypeDef 
# list_app_instance_bots method usage example with argument unpacking

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

parent.list_app_instance_bots(**kwargs)
  1. See ListAppInstanceBotsRequestRequestTypeDef

list_app_instance_user_endpoints#

Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.

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

# list_app_instance_user_endpoints method definition

def list_app_instance_user_endpoints(
    self,
    *,
    AppInstanceUserArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAppInstanceUserEndpointsResponseTypeDef:  # (1)
    ...
  1. See ListAppInstanceUserEndpointsResponseTypeDef 
# list_app_instance_user_endpoints method usage example with argument unpacking

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

parent.list_app_instance_user_endpoints(**kwargs)
  1. See ListAppInstanceUserEndpointsRequestRequestTypeDef

list_app_instance_users#

List all AppInstanceUsers created under a single AppInstance.

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

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

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

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-sdk-identity").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_user_expiration_settings#

Sets the number of days before the AppInstanceUser is automatically deleted.

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

# put_app_instance_user_expiration_settings method definition

def put_app_instance_user_expiration_settings(
    self,
    *,
    AppInstanceUserArn: str,
    ExpirationSettings: ExpirationSettingsTypeDef = ...,  # (1)
) -> PutAppInstanceUserExpirationSettingsResponseTypeDef:  # (2)
    ...
  1. See ExpirationSettingsTypeDef
  2. See PutAppInstanceUserExpirationSettingsResponseTypeDef 
# put_app_instance_user_expiration_settings method usage example with argument unpacking

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

parent.put_app_instance_user_expiration_settings(**kwargs)
  1. See PutAppInstanceUserExpirationSettingsRequestRequestTypeDef

register_app_instance_user_endpoint#

Registers an endpoint under an Amazon Chime AppInstanceUser.

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

# register_app_instance_user_endpoint method definition

def register_app_instance_user_endpoint(
    self,
    *,
    AppInstanceUserArn: str,
    Type: AppInstanceUserEndpointTypeType,  # (1)
    ResourceArn: str,
    EndpointAttributes: EndpointAttributesTypeDef,  # (2)
    ClientRequestToken: str,
    Name: str = ...,
    AllowMessages: AllowMessagesType = ...,  # (3)
) -> RegisterAppInstanceUserEndpointResponseTypeDef:  # (4)
    ...
  1. See AppInstanceUserEndpointTypeType
  2. See EndpointAttributesTypeDef
  3. See AllowMessagesType
  4. See RegisterAppInstanceUserEndpointResponseTypeDef 
# register_app_instance_user_endpoint method usage example with argument unpacking

kwargs: RegisterAppInstanceUserEndpointRequestRequestTypeDef = {  # (1)
    "AppInstanceUserArn": ...,
    "Type": ...,
    "ResourceArn": ...,
    "EndpointAttributes": ...,
    "ClientRequestToken": ...,
}

parent.register_app_instance_user_endpoint(**kwargs)
  1. See RegisterAppInstanceUserEndpointRequestRequestTypeDef

tag_resource#

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

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

Removes the specified tags from the specified Amazon Chime SDK identity resource.

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

Updates AppInstance metadata.

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

parent.update_app_instance(**kwargs)
  1. See UpdateAppInstanceRequestRequestTypeDef

update_app_instance_bot#

Updates the name and metadata of an AppInstanceBot.

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

# update_app_instance_bot method definition

def update_app_instance_bot(
    self,
    *,
    AppInstanceBotArn: str,
    Name: str,
    Metadata: str,
    Configuration: ConfigurationTypeDef = ...,  # (1)
) -> UpdateAppInstanceBotResponseTypeDef:  # (2)
    ...
  1. See ConfigurationTypeDef
  2. See UpdateAppInstanceBotResponseTypeDef 
# update_app_instance_bot method usage example with argument unpacking

kwargs: UpdateAppInstanceBotRequestRequestTypeDef = {  # (1)
    "AppInstanceBotArn": ...,
    "Name": ...,
    "Metadata": ...,
}

parent.update_app_instance_bot(**kwargs)
  1. See UpdateAppInstanceBotRequestRequestTypeDef

update_app_instance_user#

Updates the details of an AppInstanceUser.

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

parent.update_app_instance_user(**kwargs)
  1. See UpdateAppInstanceUserRequestRequestTypeDef

update_app_instance_user_endpoint#

Updates the details of an AppInstanceUserEndpoint.

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

# update_app_instance_user_endpoint method definition

def update_app_instance_user_endpoint(
    self,
    *,
    AppInstanceUserArn: str,
    EndpointId: str,
    Name: str = ...,
    AllowMessages: AllowMessagesType = ...,  # (1)
) -> UpdateAppInstanceUserEndpointResponseTypeDef:  # (2)
    ...
  1. See AllowMessagesType
  2. See UpdateAppInstanceUserEndpointResponseTypeDef 
# update_app_instance_user_endpoint method usage example with argument unpacking

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

parent.update_app_instance_user_endpoint(**kwargs)
  1. See UpdateAppInstanceUserEndpointRequestRequestTypeDef