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 IdentityTypeDef

AppInstanceRetentionSettingsTypeDef#

# AppInstanceRetentionSettingsTypeDef definition

class AppInstanceRetentionSettingsTypeDef(TypedDict):
    ChannelRetentionSettings: NotRequired[ChannelRetentionSettingsTypeDef],  # (1)
  1. See ChannelRetentionSettingsTypeDef

AppInstanceUserEndpointSummaryTypeDef#

# AppInstanceUserEndpointSummaryTypeDef definition

class AppInstanceUserEndpointSummaryTypeDef(TypedDict):
    AppInstanceUserArn: NotRequired[str],
    EndpointId: NotRequired[str],
    Name: NotRequired[str],
    Type: NotRequired[AppInstanceUserEndpointTypeType],  # (1)
    AllowMessages: NotRequired[AllowMessagesType],  # (2)
    EndpointState: NotRequired[EndpointStateTypeDef],  # (3)
  1. See AppInstanceUserEndpointTypeType
  2. See AllowMessagesType
  3. See EndpointStateTypeDef

AppInstanceUserEndpointTypeDef#

# AppInstanceUserEndpointTypeDef definition

class AppInstanceUserEndpointTypeDef(TypedDict):
    AppInstanceUserArn: NotRequired[str],
    EndpointId: NotRequired[str],
    Name: NotRequired[str],
    Type: NotRequired[AppInstanceUserEndpointTypeType],  # (1)
    ResourceArn: NotRequired[str],
    EndpointAttributes: NotRequired[EndpointAttributesTypeDef],  # (2)
    CreatedTimestamp: NotRequired[datetime],
    LastUpdatedTimestamp: NotRequired[datetime],
    AllowMessages: NotRequired[AllowMessagesType],  # (3)
    EndpointState: NotRequired[EndpointStateTypeDef],  # (4)
  1. See AppInstanceUserEndpointTypeType
  2. See EndpointAttributesTypeDef
  3. See AllowMessagesType
  4. See EndpointStateTypeDef

RegisterAppInstanceUserEndpointRequestRequestTypeDef#

# RegisterAppInstanceUserEndpointRequestRequestTypeDef definition

class RegisterAppInstanceUserEndpointRequestRequestTypeDef(TypedDict):
    AppInstanceUserArn: str,
    Type: AppInstanceUserEndpointTypeType,  # (1)
    ResourceArn: str,
    EndpointAttributes: EndpointAttributesTypeDef,  # (2)
    ClientRequestToken: str,
    Name: NotRequired[str],
    AllowMessages: NotRequired[AllowMessagesType],  # (3)
  1. See AppInstanceUserEndpointTypeType
  2. See EndpointAttributesTypeDef
  3. See AllowMessagesType

AppInstanceUserTypeDef#

# AppInstanceUserTypeDef definition

class AppInstanceUserTypeDef(TypedDict):
    AppInstanceUserArn: NotRequired[str],
    Name: NotRequired[str],
    Metadata: NotRequired[str],
    CreatedTimestamp: NotRequired[datetime],
    LastUpdatedTimestamp: NotRequired[datetime],
    ExpirationSettings: NotRequired[ExpirationSettingsTypeDef],  # (1)
  1. See ExpirationSettingsTypeDef

PutAppInstanceUserExpirationSettingsRequestRequestTypeDef#

# PutAppInstanceUserExpirationSettingsRequestRequestTypeDef definition

class PutAppInstanceUserExpirationSettingsRequestRequestTypeDef(TypedDict):
    AppInstanceUserArn: str,
    ExpirationSettings: NotRequired[ExpirationSettingsTypeDef],  # (1)
  1. See ExpirationSettingsTypeDef

CreateAppInstanceAdminResponseTypeDef#

# CreateAppInstanceAdminResponseTypeDef definition

class CreateAppInstanceAdminResponseTypeDef(TypedDict):
    AppInstanceAdmin: IdentityTypeDef,  # (1)
    AppInstanceArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IdentityTypeDef
  2. See ResponseMetadataTypeDef

CreateAppInstanceBotResponseTypeDef#

# CreateAppInstanceBotResponseTypeDef definition

class CreateAppInstanceBotResponseTypeDef(TypedDict):
    AppInstanceBotArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateAppInstanceResponseTypeDef#

# CreateAppInstanceResponseTypeDef definition

class CreateAppInstanceResponseTypeDef(TypedDict):
    AppInstanceArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateAppInstanceUserResponseTypeDef#

# CreateAppInstanceUserResponseTypeDef definition

class CreateAppInstanceUserResponseTypeDef(TypedDict):
    AppInstanceUserArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeAppInstanceResponseTypeDef#

# DescribeAppInstanceResponseTypeDef definition

class DescribeAppInstanceResponseTypeDef(TypedDict):
    AppInstance: AppInstanceTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AppInstanceTypeDef
  2. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListAppInstanceBotsResponseTypeDef#

# ListAppInstanceBotsResponseTypeDef definition

class ListAppInstanceBotsResponseTypeDef(TypedDict):
    AppInstanceArn: str,
    AppInstanceBots: List[AppInstanceBotSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See AppInstanceBotSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListAppInstanceUsersResponseTypeDef#

# ListAppInstanceUsersResponseTypeDef definition

class ListAppInstanceUsersResponseTypeDef(TypedDict):
    AppInstanceArn: str,
    AppInstanceUsers: List[AppInstanceUserSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See AppInstanceUserSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListAppInstancesResponseTypeDef#

# ListAppInstancesResponseTypeDef definition

class ListAppInstancesResponseTypeDef(TypedDict):
    AppInstances: List[AppInstanceSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See AppInstanceSummaryTypeDef
  2. See ResponseMetadataTypeDef

PutAppInstanceUserExpirationSettingsResponseTypeDef#

# PutAppInstanceUserExpirationSettingsResponseTypeDef definition

class PutAppInstanceUserExpirationSettingsResponseTypeDef(TypedDict):
    AppInstanceUserArn: str,
    ExpirationSettings: ExpirationSettingsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ExpirationSettingsTypeDef
  2. See ResponseMetadataTypeDef

RegisterAppInstanceUserEndpointResponseTypeDef#

# RegisterAppInstanceUserEndpointResponseTypeDef definition

class RegisterAppInstanceUserEndpointResponseTypeDef(TypedDict):
    AppInstanceUserArn: str,
    EndpointId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateAppInstanceBotResponseTypeDef#

# UpdateAppInstanceBotResponseTypeDef definition

class UpdateAppInstanceBotResponseTypeDef(TypedDict):
    AppInstanceBotArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateAppInstanceResponseTypeDef#

# UpdateAppInstanceResponseTypeDef definition

class UpdateAppInstanceResponseTypeDef(TypedDict):
    AppInstanceArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateAppInstanceUserEndpointResponseTypeDef#