Skip to content

Type definitions#

Index > ChimeSDKIdentity > Type definitions

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

IdentityTypeDef#

# IdentityTypeDef definition

class IdentityTypeDef(TypedDict):
    Arn: NotRequired[str],
    Name: NotRequired[str],

AppInstanceBotSummaryTypeDef#

# AppInstanceBotSummaryTypeDef definition

class AppInstanceBotSummaryTypeDef(TypedDict):
    AppInstanceBotArn: NotRequired[str],
    Name: NotRequired[str],
    Metadata: NotRequired[str],

ChannelRetentionSettingsTypeDef#

# ChannelRetentionSettingsTypeDef definition

class ChannelRetentionSettingsTypeDef(TypedDict):
    RetentionDays: NotRequired[int],

AppInstanceSummaryTypeDef#

# AppInstanceSummaryTypeDef definition

class AppInstanceSummaryTypeDef(TypedDict):
    AppInstanceArn: NotRequired[str],
    Name: NotRequired[str],
    Metadata: NotRequired[str],

AppInstanceTypeDef#

# AppInstanceTypeDef definition

class AppInstanceTypeDef(TypedDict):
    AppInstanceArn: NotRequired[str],
    Name: NotRequired[str],
    CreatedTimestamp: NotRequired[datetime],
    LastUpdatedTimestamp: NotRequired[datetime],
    Metadata: NotRequired[str],

EndpointStateTypeDef#

# EndpointStateTypeDef definition

class EndpointStateTypeDef(TypedDict):
    Status: EndpointStatusType,  # (1)
    StatusReason: NotRequired[EndpointStatusReasonType],  # (2)
  1. See EndpointStatusType
  2. See EndpointStatusReasonType

EndpointAttributesTypeDef#

# EndpointAttributesTypeDef definition

class EndpointAttributesTypeDef(TypedDict):
    DeviceToken: str,
    VoipDeviceToken: NotRequired[str],

AppInstanceUserSummaryTypeDef#

# AppInstanceUserSummaryTypeDef definition

class AppInstanceUserSummaryTypeDef(TypedDict):
    AppInstanceUserArn: NotRequired[str],
    Name: NotRequired[str],
    Metadata: NotRequired[str],

ExpirationSettingsTypeDef#

# ExpirationSettingsTypeDef definition

class ExpirationSettingsTypeDef(TypedDict):
    ExpirationDays: int,
    ExpirationCriterion: ExpirationCriterionType,  # (1)
  1. See ExpirationCriterionType

CreateAppInstanceAdminRequestRequestTypeDef#

# CreateAppInstanceAdminRequestRequestTypeDef definition

class CreateAppInstanceAdminRequestRequestTypeDef(TypedDict):
    AppInstanceAdminArn: str,
    AppInstanceArn: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

DeleteAppInstanceAdminRequestRequestTypeDef#

# DeleteAppInstanceAdminRequestRequestTypeDef definition

class DeleteAppInstanceAdminRequestRequestTypeDef(TypedDict):
    AppInstanceAdminArn: str,
    AppInstanceArn: str,

DeleteAppInstanceBotRequestRequestTypeDef#

# DeleteAppInstanceBotRequestRequestTypeDef definition

class DeleteAppInstanceBotRequestRequestTypeDef(TypedDict):
    AppInstanceBotArn: str,

DeleteAppInstanceRequestRequestTypeDef#

# DeleteAppInstanceRequestRequestTypeDef definition

class DeleteAppInstanceRequestRequestTypeDef(TypedDict):
    AppInstanceArn: str,

DeleteAppInstanceUserRequestRequestTypeDef#

# DeleteAppInstanceUserRequestRequestTypeDef definition

class DeleteAppInstanceUserRequestRequestTypeDef(TypedDict):
    AppInstanceUserArn: str,

DeregisterAppInstanceUserEndpointRequestRequestTypeDef#

# DeregisterAppInstanceUserEndpointRequestRequestTypeDef definition

class DeregisterAppInstanceUserEndpointRequestRequestTypeDef(TypedDict):
    AppInstanceUserArn: str,
    EndpointId: str,

DescribeAppInstanceAdminRequestRequestTypeDef#

# DescribeAppInstanceAdminRequestRequestTypeDef definition

class DescribeAppInstanceAdminRequestRequestTypeDef(TypedDict):
    AppInstanceAdminArn: str,
    AppInstanceArn: str,

DescribeAppInstanceBotRequestRequestTypeDef#

# DescribeAppInstanceBotRequestRequestTypeDef definition

class DescribeAppInstanceBotRequestRequestTypeDef(TypedDict):
    AppInstanceBotArn: str,

DescribeAppInstanceRequestRequestTypeDef#

# DescribeAppInstanceRequestRequestTypeDef definition

class DescribeAppInstanceRequestRequestTypeDef(TypedDict):
    AppInstanceArn: str,

DescribeAppInstanceUserEndpointRequestRequestTypeDef#

# DescribeAppInstanceUserEndpointRequestRequestTypeDef definition

class DescribeAppInstanceUserEndpointRequestRequestTypeDef(TypedDict):
    AppInstanceUserArn: str,
    EndpointId: str,

DescribeAppInstanceUserRequestRequestTypeDef#

# DescribeAppInstanceUserRequestRequestTypeDef definition

class DescribeAppInstanceUserRequestRequestTypeDef(TypedDict):
    AppInstanceUserArn: str,

GetAppInstanceRetentionSettingsRequestRequestTypeDef#

# GetAppInstanceRetentionSettingsRequestRequestTypeDef definition

class GetAppInstanceRetentionSettingsRequestRequestTypeDef(TypedDict):
    AppInstanceArn: str,

InvokedByTypeDef#

# InvokedByTypeDef definition

class InvokedByTypeDef(TypedDict):
    StandardMessages: StandardMessagesType,  # (1)
    TargetedMessages: TargetedMessagesType,  # (2)
  1. See StandardMessagesType
  2. See TargetedMessagesType

ListAppInstanceAdminsRequestRequestTypeDef#

# ListAppInstanceAdminsRequestRequestTypeDef definition

class ListAppInstanceAdminsRequestRequestTypeDef(TypedDict):
    AppInstanceArn: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListAppInstanceBotsRequestRequestTypeDef#

# ListAppInstanceBotsRequestRequestTypeDef definition

class ListAppInstanceBotsRequestRequestTypeDef(TypedDict):
    AppInstanceArn: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListAppInstanceUserEndpointsRequestRequestTypeDef#

# ListAppInstanceUserEndpointsRequestRequestTypeDef definition

class ListAppInstanceUserEndpointsRequestRequestTypeDef(TypedDict):
    AppInstanceUserArn: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListAppInstanceUsersRequestRequestTypeDef#

# ListAppInstanceUsersRequestRequestTypeDef definition

class ListAppInstanceUsersRequestRequestTypeDef(TypedDict):
    AppInstanceArn: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListAppInstancesRequestRequestTypeDef#

# ListAppInstancesRequestRequestTypeDef definition

class ListAppInstancesRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    TagKeys: Sequence[str],

UpdateAppInstanceRequestRequestTypeDef#

# UpdateAppInstanceRequestRequestTypeDef definition

class UpdateAppInstanceRequestRequestTypeDef(TypedDict):
    AppInstanceArn: str,
    Name: str,
    Metadata: str,

UpdateAppInstanceUserEndpointRequestRequestTypeDef#

# UpdateAppInstanceUserEndpointRequestRequestTypeDef definition

class UpdateAppInstanceUserEndpointRequestRequestTypeDef(TypedDict):
    AppInstanceUserArn: str,
    EndpointId: str,
    Name: NotRequired[str],
    AllowMessages: NotRequired[AllowMessagesType],  # (1)
  1. See AllowMessagesType

UpdateAppInstanceUserRequestRequestTypeDef#

# UpdateAppInstanceUserRequestRequestTypeDef definition

class UpdateAppInstanceUserRequestRequestTypeDef(TypedDict):
    AppInstanceUserArn: str,
    Name: str,
    Metadata: str,

AppInstanceAdminSummaryTypeDef#

# AppInstanceAdminSummaryTypeDef definition

class AppInstanceAdminSummaryTypeDef(TypedDict):
    Admin: NotRequired[IdentityTypeDef],  # (1)
  1. See IdentityTypeDef

AppInstanceAdminTypeDef#

# AppInstanceAdminTypeDef definition

class AppInstanceAdminTypeDef(TypedDict):
    Admin: NotRequired[IdentityTypeDef],  # (1)
    AppInstanceArn: NotRequired[str],
    CreatedTimestamp: NotRequired[datetime],
  1. See