ChimeSDKIdentityClient
Index > ChimeSDKIdentity > ChimeSDKIdentityClient
Auto-generated documentation for ChimeSDKIdentity type annotations stubs module types-aiobotocore-chime-sdk-identity.
ChimeSDKIdentityClient
Type annotations and code completion for session.client("chime-sdk-identity")
boto3 documentation
from aioboto3.session import Session
from types_aiobotocore_chime_sdk_identity.client import ChimeSDKIdentityClient
session = Session()
async with session.client("chime-sdk-identity") as client:
client: ChimeSDKIdentityClient
Exceptions
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("chime-sdk-identity").exceptions
structure.
async with session.client("chime-sdk-identity") as client:
try:
do_something(client)
except (
client.BadRequestException,
client.ClientError,
client.ConflictException,
client.ForbiddenException,
client.ResourceLimitExceededException,
client.ServiceFailureException,
client.ServiceUnavailableException,
client.ThrottledClientException,
client.UnauthorizedClientException,
) as e:
print(e)
from types_aiobotocore_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 session.client("chime-sdk-identity").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for session.client("chime-sdk-identity").close
method.
boto3 documentation
create_app_instance
Creates an Amazon Chime SDK messaging AppInstance
under an AWS account.
Type annotations and code completion for session.client("chime-sdk-identity").create_app_instance
method.
boto3 documentation
await def create_app_instance(
self,
*,
Name: str,
ClientRequestToken: str,
Metadata: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateAppInstanceResponseTypeDef: # (2)
...
kwargs: CreateAppInstanceRequestRequestTypeDef = { # (1)
"Name": ...,
"ClientRequestToken": ...,
}
parent.create_app_instance(**kwargs)
create_app_instance_admin
Promotes an AppInstanceUser
to an AppInstanceAdmin
.
Type annotations and code completion for session.client("chime-sdk-identity").create_app_instance_admin
method.
boto3 documentation
await def create_app_instance_admin(
self,
*,
AppInstanceAdminArn: str,
AppInstanceArn: str,
) -> CreateAppInstanceAdminResponseTypeDef: # (1)
...
kwargs: CreateAppInstanceAdminRequestRequestTypeDef = { # (1)
"AppInstanceAdminArn": ...,
"AppInstanceArn": ...,
}
parent.create_app_instance_admin(**kwargs)
create_app_instance_user
Creates a user under an Amazon Chime AppInstance
.
Type annotations and code completion for session.client("chime-sdk-identity").create_app_instance_user
method.
boto3 documentation
await def create_app_instance_user(
self,
*,
AppInstanceArn: str,
AppInstanceUserId: str,
Name: str,
ClientRequestToken: str,
Metadata: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateAppInstanceUserResponseTypeDef: # (2)
...
kwargs: CreateAppInstanceUserRequestRequestTypeDef = { # (1)
"AppInstanceArn": ...,
"AppInstanceUserId": ...,
"Name": ...,
"ClientRequestToken": ...,
}
parent.create_app_instance_user(**kwargs)
delete_app_instance
Deletes an AppInstance
and all associated data asynchronously.
Type annotations and code completion for session.client("chime-sdk-identity").delete_app_instance
method.
boto3 documentation
await def delete_app_instance(
self,
*,
AppInstanceArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteAppInstanceRequestRequestTypeDef = { # (1)
"AppInstanceArn": ...,
}
parent.delete_app_instance(**kwargs)
delete_app_instance_admin
Demotes an AppInstanceAdmin
to an AppInstanceUser
.
Type annotations and code completion for session.client("chime-sdk-identity").delete_app_instance_admin
method.
boto3 documentation
await def delete_app_instance_admin(
self,
*,
AppInstanceAdminArn: str,
AppInstanceArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteAppInstanceAdminRequestRequestTypeDef = { # (1)
"AppInstanceAdminArn": ...,
"AppInstanceArn": ...,
}
parent.delete_app_instance_admin(**kwargs)
delete_app_instance_user
Deletes an AppInstanceUser
.
Type annotations and code completion for session.client("chime-sdk-identity").delete_app_instance_user
method.
boto3 documentation
await def delete_app_instance_user(
self,
*,
AppInstanceUserArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteAppInstanceUserRequestRequestTypeDef = { # (1)
"AppInstanceUserArn": ...,
}
parent.delete_app_instance_user(**kwargs)
deregister_app_instance_user_endpoint
Deregisters an AppInstanceUserEndpoint
.
Type annotations and code completion for session.client("chime-sdk-identity").deregister_app_instance_user_endpoint
method.
boto3 documentation
await def deregister_app_instance_user_endpoint(
self,
*,
AppInstanceUserArn: str,
EndpointId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeregisterAppInstanceUserEndpointRequestRequestTypeDef = { # (1)
"AppInstanceUserArn": ...,
"EndpointId": ...,
}
parent.deregister_app_instance_user_endpoint(**kwargs)
describe_app_instance
Returns the full details of an AppInstance
.
Type annotations and code completion for session.client("chime-sdk-identity").describe_app_instance
method.
boto3 documentation
await def describe_app_instance(
self,
*,
AppInstanceArn: str,
) -> DescribeAppInstanceResponseTypeDef: # (1)
...
kwargs: DescribeAppInstanceRequestRequestTypeDef = { # (1)
"AppInstanceArn": ...,
}
parent.describe_app_instance(**kwargs)
describe_app_instance_admin
Returns the full details of an AppInstanceAdmin
.
Type annotations and code completion for session.client("chime-sdk-identity").describe_app_instance_admin
method.
boto3 documentation
await def describe_app_instance_admin(
self,
*,
AppInstanceAdminArn: str,
AppInstanceArn: str,
) -> DescribeAppInstanceAdminResponseTypeDef: # (1)
...
kwargs: DescribeAppInstanceAdminRequestRequestTypeDef = { # (1)
"AppInstanceAdminArn": ...,
"AppInstanceArn": ...,
}
parent.describe_app_instance_admin(**kwargs)
describe_app_instance_user
Returns the full details of an AppInstanceUser
.
Type annotations and code completion for session.client("chime-sdk-identity").describe_app_instance_user
method.
boto3 documentation
await def describe_app_instance_user(
self,
*,
AppInstanceUserArn: str,
) -> DescribeAppInstanceUserResponseTypeDef: # (1)
...
kwargs: DescribeAppInstanceUserRequestRequestTypeDef = { # (1)
"AppInstanceUserArn": ...,
}
parent.describe_app_instance_user(**kwargs)
describe_app_instance_user_endpoint
Returns the full details of an AppInstanceUserEndpoint
.
Type annotations and code completion for session.client("chime-sdk-identity").describe_app_instance_user_endpoint
method.
boto3 documentation
await def describe_app_instance_user_endpoint(
self,
*,
AppInstanceUserArn: str,
EndpointId: str,
) -> DescribeAppInstanceUserEndpointResponseTypeDef: # (1)
...
kwargs: DescribeAppInstanceUserEndpointRequestRequestTypeDef = { # (1)
"AppInstanceUserArn": ...,
"EndpointId": ...,
}
parent.describe_app_instance_user_endpoint(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.client("chime-sdk-identity").generate_presigned_url
method.
boto3 documentation
await 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 session.client("chime-sdk-identity").get_app_instance_retention_settings
method.
boto3 documentation
await def get_app_instance_retention_settings(
self,
*,
AppInstanceArn: str,
) -> GetAppInstanceRetentionSettingsResponseTypeDef: # (1)
...
kwargs: GetAppInstanceRetentionSettingsRequestRequestTypeDef = { # (1)
"AppInstanceArn": ...,
}
parent.get_app_instance_retention_settings(**kwargs)
list_app_instance_admins
Returns a list of the administrators in the AppInstance
.
Type annotations and code completion for session.client("chime-sdk-identity").list_app_instance_admins
method.
boto3 documentation
await def list_app_instance_admins(
self,
*,
AppInstanceArn: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAppInstanceAdminsResponseTypeDef: # (1)
...
kwargs: ListAppInstanceAdminsRequestRequestTypeDef = { # (1)
"AppInstanceArn": ...,
}
parent.list_app_instance_admins(**kwargs)
list_app_instance_user_endpoints
Lists all the AppInstanceUserEndpoints
created under a single
AppInstanceUser
.
Type annotations and code completion for session.client("chime-sdk-identity").list_app_instance_user_endpoints
method.
boto3 documentation
await def list_app_instance_user_endpoints(
self,
*,
AppInstanceUserArn: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAppInstanceUserEndpointsResponseTypeDef: # (1)
...
kwargs: ListAppInstanceUserEndpointsRequestRequestTypeDef = { # (1)
"AppInstanceUserArn": ...,
}
parent.list_app_instance_user_endpoints(**kwargs)
list_app_instance_users
List all AppInstanceUsers
created under a single AppInstance
.
Type annotations and code completion for session.client("chime-sdk-identity").list_app_instance_users
method.
boto3 documentation
await def list_app_instance_users(
self,
*,
AppInstanceArn: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAppInstanceUsersResponseTypeDef: # (1)
...
kwargs: ListAppInstanceUsersRequestRequestTypeDef = { # (1)
"AppInstanceArn": ...,
}
parent.list_app_instance_users(**kwargs)
list_app_instances
Lists all Amazon Chime AppInstance
s created under a single AWS account.
Type annotations and code completion for session.client("chime-sdk-identity").list_app_instances
method.
boto3 documentation
await def list_app_instances(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAppInstancesResponseTypeDef: # (1)
...
kwargs: ListAppInstancesRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_app_instances(**kwargs)
list_tags_for_resource
Lists the tags applied to an Amazon Chime SDK identity resource.
Type annotations and code completion for session.client("chime-sdk-identity").list_tags_for_resource
method.
boto3 documentation
await def list_tags_for_resource(
self,
*,
ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
}
parent.list_tags_for_resource(**kwargs)
put_app_instance_retention_settings
Sets the amount of time in days that a given AppInstance
retains data.
Type annotations and code completion for session.client("chime-sdk-identity").put_app_instance_retention_settings
method.
boto3 documentation
await def put_app_instance_retention_settings(
self,
*,
AppInstanceArn: str,
AppInstanceRetentionSettings: AppInstanceRetentionSettingsTypeDef, # (1)
) -> PutAppInstanceRetentionSettingsResponseTypeDef: # (2)
...
kwargs: PutAppInstanceRetentionSettingsRequestRequestTypeDef = { # (1)
"AppInstanceArn": ...,
"AppInstanceRetentionSettings": ...,
}
parent.put_app_instance_retention_settings(**kwargs)
register_app_instance_user_endpoint
Registers an endpoint under an Amazon Chime AppInstanceUser
.
Type annotations and code completion for session.client("chime-sdk-identity").register_app_instance_user_endpoint
method.
boto3 documentation
await 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)
...
- See AppInstanceUserEndpointTypeType
- See EndpointAttributesTypeDef
- See AllowMessagesType
- See RegisterAppInstanceUserEndpointResponseTypeDef
kwargs: RegisterAppInstanceUserEndpointRequestRequestTypeDef = { # (1)
"AppInstanceUserArn": ...,
"Type": ...,
"ResourceArn": ...,
"EndpointAttributes": ...,
"ClientRequestToken": ...,
}
parent.register_app_instance_user_endpoint(**kwargs)
tag_resource
Applies the specified tags to the specified Amazon Chime SDK identity resource.
Type annotations and code completion for session.client("chime-sdk-identity").tag_resource
method.
boto3 documentation
await def tag_resource(
self,
*,
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes the specified tags from the specified Amazon Chime SDK identity resource.
Type annotations and code completion for session.client("chime-sdk-identity").untag_resource
method.
boto3 documentation
await def untag_resource(
self,
*,
ResourceARN: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_app_instance
Updates AppInstance
metadata.
Type annotations and code completion for session.client("chime-sdk-identity").update_app_instance
method.
boto3 documentation
await def update_app_instance(
self,
*,
AppInstanceArn: str,
Name: str,
Metadata: str,
) -> UpdateAppInstanceResponseTypeDef: # (1)
...
kwargs: UpdateAppInstanceRequestRequestTypeDef = { # (1)
"AppInstanceArn": ...,
"Name": ...,
"Metadata": ...,
}
parent.update_app_instance(**kwargs)
update_app_instance_user
Updates the details of an AppInstanceUser
.
Type annotations and code completion for session.client("chime-sdk-identity").update_app_instance_user
method.
boto3 documentation
await def update_app_instance_user(
self,
*,
AppInstanceUserArn: str,
Name: str,
Metadata: str,
) -> UpdateAppInstanceUserResponseTypeDef: # (1)
...
kwargs: UpdateAppInstanceUserRequestRequestTypeDef = { # (1)
"AppInstanceUserArn": ...,
"Name": ...,
"Metadata": ...,
}
parent.update_app_instance_user(**kwargs)
update_app_instance_user_endpoint
Updates the details of an AppInstanceUserEndpoint
.
Type annotations and code completion for session.client("chime-sdk-identity").update_app_instance_user_endpoint
method.
boto3 documentation
await def update_app_instance_user_endpoint(
self,
*,
AppInstanceUserArn: str,
EndpointId: str,
Name: str = ...,
AllowMessages: AllowMessagesType = ..., # (1)
) -> UpdateAppInstanceUserEndpointResponseTypeDef: # (2)
...
kwargs: UpdateAppInstanceUserEndpointRequestRequestTypeDef = { # (1)
"AppInstanceUserArn": ...,
"EndpointId": ...,
}
parent.update_app_instance_user_endpoint(**kwargs)
__aenter__
Type annotations and code completion for session.client("chime-sdk-identity").__aenter__
method.
boto3 documentation
__aexit__
Type annotations and code completion for session.client("chime-sdk-identity").__aexit__
method.
boto3 documentation