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)
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)
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)
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)
UpdateAppInstanceUserRequestRequestTypeDef#
# UpdateAppInstanceUserRequestRequestTypeDef definition
class UpdateAppInstanceUserRequestRequestTypeDef(TypedDict):
AppInstanceUserArn: str,
Name: str,
Metadata: str,
AppInstanceAdminSummaryTypeDef#
# AppInstanceAdminSummaryTypeDef definition
class AppInstanceAdminSummaryTypeDef(TypedDict):
Admin: NotRequired[IdentityTypeDef], # (1)
- See IdentityTypeDef
AppInstanceAdminTypeDef#
# AppInstanceAdminTypeDef definition
class AppInstanceAdminTypeDef(TypedDict):
Admin: NotRequired[IdentityTypeDef], # (1)
AppInstanceArn: NotRequired[str],
CreatedTimestamp: NotRequired[datetime],
- See IdentityTypeDef
AppInstanceRetentionSettingsTypeDef#
# AppInstanceRetentionSettingsTypeDef definition
class AppInstanceRetentionSettingsTypeDef(TypedDict):
ChannelRetentionSettings: NotRequired[ChannelRetentionSettingsTypeDef], # (1)
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)
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)
- See AppInstanceUserEndpointTypeType
- See EndpointAttributesTypeDef
- See AllowMessagesType
- 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)
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)
PutAppInstanceUserExpirationSettingsRequestRequestTypeDef#
# PutAppInstanceUserExpirationSettingsRequestRequestTypeDef definition
class PutAppInstanceUserExpirationSettingsRequestRequestTypeDef(TypedDict):
AppInstanceUserArn: str,
ExpirationSettings: NotRequired[ExpirationSettingsTypeDef], # (1)
CreateAppInstanceAdminResponseTypeDef#
# CreateAppInstanceAdminResponseTypeDef definition
class CreateAppInstanceAdminResponseTypeDef(TypedDict):
AppInstanceAdmin: IdentityTypeDef, # (1)
AppInstanceArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateAppInstanceBotResponseTypeDef#
# CreateAppInstanceBotResponseTypeDef definition
class CreateAppInstanceBotResponseTypeDef(TypedDict):
AppInstanceBotArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateAppInstanceResponseTypeDef#
# CreateAppInstanceResponseTypeDef definition
class CreateAppInstanceResponseTypeDef(TypedDict):
AppInstanceArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateAppInstanceUserResponseTypeDef#
# CreateAppInstanceUserResponseTypeDef definition
class CreateAppInstanceUserResponseTypeDef(TypedDict):
AppInstanceUserArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeAppInstanceResponseTypeDef#
# DescribeAppInstanceResponseTypeDef definition
class DescribeAppInstanceResponseTypeDef(TypedDict):
AppInstance: AppInstanceTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListAppInstanceBotsResponseTypeDef#
# ListAppInstanceBotsResponseTypeDef definition
class ListAppInstanceBotsResponseTypeDef(TypedDict):
AppInstanceArn: str,
AppInstanceBots: List[AppInstanceBotSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAppInstanceUsersResponseTypeDef#
# ListAppInstanceUsersResponseTypeDef definition
class ListAppInstanceUsersResponseTypeDef(TypedDict):
AppInstanceArn: str,
AppInstanceUsers: List[AppInstanceUserSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAppInstancesResponseTypeDef#
# ListAppInstancesResponseTypeDef definition
class ListAppInstancesResponseTypeDef(TypedDict):
AppInstances: List[AppInstanceSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutAppInstanceUserExpirationSettingsResponseTypeDef#
# PutAppInstanceUserExpirationSettingsResponseTypeDef definition
class PutAppInstanceUserExpirationSettingsResponseTypeDef(TypedDict):
AppInstanceUserArn: str,
ExpirationSettings: ExpirationSettingsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RegisterAppInstanceUserEndpointResponseTypeDef#
# RegisterAppInstanceUserEndpointResponseTypeDef definition
class RegisterAppInstanceUserEndpointResponseTypeDef(TypedDict):
AppInstanceUserArn: str,
EndpointId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateAppInstanceBotResponseTypeDef#
# UpdateAppInstanceBotResponseTypeDef definition
class UpdateAppInstanceBotResponseTypeDef(TypedDict):
AppInstanceBotArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateAppInstanceResponseTypeDef#
# UpdateAppInstanceResponseTypeDef definition
class UpdateAppInstanceResponseTypeDef(TypedDict):
AppInstanceArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateAppInstanceUserEndpointResponseTypeDef#
# UpdateAppInstanceUserEndpointResponseTypeDef definition
class UpdateAppInstanceUserEndpointResponseTypeDef(TypedDict):
AppInstanceUserArn: str,
EndpointId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateAppInstanceUserResponseTypeDef#
# UpdateAppInstanceUserResponseTypeDef definition
class UpdateAppInstanceUserResponseTypeDef(TypedDict):
AppInstanceUserArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateAppInstanceRequestRequestTypeDef#
# CreateAppInstanceRequestRequestTypeDef definition
class CreateAppInstanceRequestRequestTypeDef(TypedDict):
Name: str,
ClientRequestToken: str,
Metadata: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CreateAppInstanceUserRequestRequestTypeDef#
# CreateAppInstanceUserRequestRequestTypeDef definition
class CreateAppInstanceUserRequestRequestTypeDef(TypedDict):
AppInstanceArn: str,
AppInstanceUserId: str,
Name: str,
ClientRequestToken: str,
Metadata: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
ExpirationSettings: NotRequired[ExpirationSettingsTypeDef], # (2)
- See TagTypeDef
- See ExpirationSettingsTypeDef
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
LexConfigurationTypeDef#
# LexConfigurationTypeDef definition
class LexConfigurationTypeDef(TypedDict):
LexBotAliasArn: str,
LocaleId: str,
RespondsTo: NotRequired[RespondsToType], # (1)
InvokedBy: NotRequired[InvokedByTypeDef], # (2)
WelcomeIntent: NotRequired[str],
- See RespondsToType
- See InvokedByTypeDef
ListAppInstanceAdminsResponseTypeDef#
# ListAppInstanceAdminsResponseTypeDef definition
class ListAppInstanceAdminsResponseTypeDef(TypedDict):
AppInstanceArn: str,
AppInstanceAdmins: List[AppInstanceAdminSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeAppInstanceAdminResponseTypeDef#
# DescribeAppInstanceAdminResponseTypeDef definition
class DescribeAppInstanceAdminResponseTypeDef(TypedDict):
AppInstanceAdmin: AppInstanceAdminTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetAppInstanceRetentionSettingsResponseTypeDef#
# GetAppInstanceRetentionSettingsResponseTypeDef definition
class GetAppInstanceRetentionSettingsResponseTypeDef(TypedDict):
AppInstanceRetentionSettings: AppInstanceRetentionSettingsTypeDef, # (1)
InitiateDeletionTimestamp: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutAppInstanceRetentionSettingsRequestRequestTypeDef#
# PutAppInstanceRetentionSettingsRequestRequestTypeDef definition
class PutAppInstanceRetentionSettingsRequestRequestTypeDef(TypedDict):
AppInstanceArn: str,
AppInstanceRetentionSettings: AppInstanceRetentionSettingsTypeDef, # (1)
PutAppInstanceRetentionSettingsResponseTypeDef#
# PutAppInstanceRetentionSettingsResponseTypeDef definition
class PutAppInstanceRetentionSettingsResponseTypeDef(TypedDict):
AppInstanceRetentionSettings: AppInstanceRetentionSettingsTypeDef, # (1)
InitiateDeletionTimestamp: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAppInstanceUserEndpointsResponseTypeDef#
# ListAppInstanceUserEndpointsResponseTypeDef definition
class ListAppInstanceUserEndpointsResponseTypeDef(TypedDict):
AppInstanceUserEndpoints: List[AppInstanceUserEndpointSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeAppInstanceUserEndpointResponseTypeDef#
# DescribeAppInstanceUserEndpointResponseTypeDef definition
class DescribeAppInstanceUserEndpointResponseTypeDef(TypedDict):
AppInstanceUserEndpoint: AppInstanceUserEndpointTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeAppInstanceUserResponseTypeDef#
# DescribeAppInstanceUserResponseTypeDef definition
class DescribeAppInstanceUserResponseTypeDef(TypedDict):
AppInstanceUser: AppInstanceUserTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ConfigurationTypeDef#
# ConfigurationTypeDef definition
class ConfigurationTypeDef(TypedDict):
Lex: LexConfigurationTypeDef, # (1)
AppInstanceBotTypeDef#
# AppInstanceBotTypeDef definition
class AppInstanceBotTypeDef(TypedDict):
AppInstanceBotArn: NotRequired[str],
Name: NotRequired[str],
Configuration: NotRequired[ConfigurationTypeDef], # (1)
CreatedTimestamp: NotRequired[datetime],
LastUpdatedTimestamp: NotRequired[datetime],
Metadata: NotRequired[str],
CreateAppInstanceBotRequestRequestTypeDef#
# CreateAppInstanceBotRequestRequestTypeDef definition
class CreateAppInstanceBotRequestRequestTypeDef(TypedDict):
AppInstanceArn: str,
ClientRequestToken: str,
Configuration: ConfigurationTypeDef, # (1)
Name: NotRequired[str],
Metadata: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See ConfigurationTypeDef
- See TagTypeDef
UpdateAppInstanceBotRequestRequestTypeDef#
# UpdateAppInstanceBotRequestRequestTypeDef definition
class UpdateAppInstanceBotRequestRequestTypeDef(TypedDict):
AppInstanceBotArn: str,
Name: str,
Metadata: str,
Configuration: NotRequired[ConfigurationTypeDef], # (1)
DescribeAppInstanceBotResponseTypeDef#
# DescribeAppInstanceBotResponseTypeDef definition
class DescribeAppInstanceBotResponseTypeDef(TypedDict):
AppInstanceBot: AppInstanceBotTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)