Classes Reference


                    
                    
                    AWSChimeSDKIdentityAppInstance

The details of an AppInstance, an instance of an Amazon Chime SDK messaging application.

Declaration

Objective-C

@interface AWSChimeSDKIdentityAppInstance

Swift

class AWSChimeSDKIdentityAppInstance


                    
                    
                    AWSChimeSDKIdentityAppInstanceAdmin

The name and ARN of the admin for the AppInstance.

Declaration

Objective-C

@interface AWSChimeSDKIdentityAppInstanceAdmin

Swift

class AWSChimeSDKIdentityAppInstanceAdmin


                    
                    
                    AWSChimeSDKIdentityAppInstanceAdminSummary

Summary of the details of an AppInstanceAdmin.

Declaration

Objective-C

@interface AWSChimeSDKIdentityAppInstanceAdminSummary

Swift

class AWSChimeSDKIdentityAppInstanceAdminSummary


                    
                    
                    AWSChimeSDKIdentityAppInstanceBot

An Amazon Lex V2 chat bot created under an AppInstance.

Declaration

Objective-C

@interface AWSChimeSDKIdentityAppInstanceBot

Swift

class AWSChimeSDKIdentityAppInstanceBot


                    
                    
                    AWSChimeSDKIdentityAppInstanceBotSummary

High-level information about an AppInstanceBot.

Declaration

Objective-C

@interface AWSChimeSDKIdentityAppInstanceBotSummary

Swift

class AWSChimeSDKIdentityAppInstanceBotSummary


                    
                    
                    AWSChimeSDKIdentityAppInstanceRetentionSettings

The details of the data-retention settings for an AppInstance.

Declaration

Objective-C

@interface AWSChimeSDKIdentityAppInstanceRetentionSettings

Swift

class AWSChimeSDKIdentityAppInstanceRetentionSettings


                    
                    
                    AWSChimeSDKIdentityAppInstanceSummary

Summary of the data for an AppInstance.

Declaration

Objective-C

@interface AWSChimeSDKIdentityAppInstanceSummary

Swift

class AWSChimeSDKIdentityAppInstanceSummary


                    
                    
                    AWSChimeSDKIdentityAppInstanceUser

The details of an AppInstanceUser.

Declaration

Objective-C

@interface AWSChimeSDKIdentityAppInstanceUser

Swift

class AWSChimeSDKIdentityAppInstanceUser


                    
                    
                    AWSChimeSDKIdentityAppInstanceUserEndpoint

An endpoint under an Amazon Chime AppInstanceUser that receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.

Declaration

Objective-C

@interface AWSChimeSDKIdentityAppInstanceUserEndpoint

Swift

class AWSChimeSDKIdentityAppInstanceUserEndpoint


                    
                    
                    AWSChimeSDKIdentityAppInstanceUserEndpointSummary

Summary of the details of an AppInstanceUserEndpoint.

Declaration

Objective-C

@interface AWSChimeSDKIdentityAppInstanceUserEndpointSummary

Swift

class AWSChimeSDKIdentityAppInstanceUserEndpointSummary


                    
                    
                    AWSChimeSDKIdentityAppInstanceUserSummary

Summary of the details of an AppInstanceUser.

Declaration

Objective-C

@interface AWSChimeSDKIdentityAppInstanceUserSummary

Swift

class AWSChimeSDKIdentityAppInstanceUserSummary


                    
                    
                    AWSChimeSDKIdentityChannelRetentionSettings

The details of the retention settings for a channel.

Declaration

Objective-C

@interface AWSChimeSDKIdentityChannelRetentionSettings

Swift

class AWSChimeSDKIdentityChannelRetentionSettings


                    
                    
                    AWSChimeSDKIdentityConfiguration

A structure that contains configuration data.

Required parameters: [Lex]

Declaration

Objective-C

@interface AWSChimeSDKIdentityConfiguration

Swift

class AWSChimeSDKIdentityConfiguration


                    
                    
                    AWSChimeSDKIdentityCreateAppInstanceAdminRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityCreateAppInstanceAdminRequest

Swift

class AWSChimeSDKIdentityCreateAppInstanceAdminRequest


                    
                    
                    AWSChimeSDKIdentityCreateAppInstanceAdminResponse

Declaration

Objective-C

@interface AWSChimeSDKIdentityCreateAppInstanceAdminResponse

Swift

class AWSChimeSDKIdentityCreateAppInstanceAdminResponse


                    
                    
                    AWSChimeSDKIdentityCreateAppInstanceBotRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityCreateAppInstanceBotRequest

Swift

class AWSChimeSDKIdentityCreateAppInstanceBotRequest


                    
                    
                    AWSChimeSDKIdentityCreateAppInstanceBotResponse

Declaration

Objective-C

@interface AWSChimeSDKIdentityCreateAppInstanceBotResponse

Swift

class AWSChimeSDKIdentityCreateAppInstanceBotResponse


                    
                    
                    AWSChimeSDKIdentityCreateAppInstanceRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityCreateAppInstanceRequest

Swift

class AWSChimeSDKIdentityCreateAppInstanceRequest


                    
                    
                    AWSChimeSDKIdentityCreateAppInstanceResponse

Declaration

Objective-C

@interface AWSChimeSDKIdentityCreateAppInstanceResponse

Swift

class AWSChimeSDKIdentityCreateAppInstanceResponse


                    
                    
                    AWSChimeSDKIdentityCreateAppInstanceUserRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityCreateAppInstanceUserRequest

Swift

class AWSChimeSDKIdentityCreateAppInstanceUserRequest


                    
                    
                    AWSChimeSDKIdentityCreateAppInstanceUserResponse

Declaration

Objective-C

@interface AWSChimeSDKIdentityCreateAppInstanceUserResponse

Swift

class AWSChimeSDKIdentityCreateAppInstanceUserResponse


                    
                    
                    AWSChimeSDKIdentityDeleteAppInstanceAdminRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityDeleteAppInstanceAdminRequest

Swift

class AWSChimeSDKIdentityDeleteAppInstanceAdminRequest


                    
                    
                    AWSChimeSDKIdentityDeleteAppInstanceBotRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityDeleteAppInstanceBotRequest

Swift

class AWSChimeSDKIdentityDeleteAppInstanceBotRequest


                    
                    
                    AWSChimeSDKIdentityDeleteAppInstanceRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityDeleteAppInstanceRequest

Swift

class AWSChimeSDKIdentityDeleteAppInstanceRequest


                    
                    
                    AWSChimeSDKIdentityDeleteAppInstanceUserRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityDeleteAppInstanceUserRequest

Swift

class AWSChimeSDKIdentityDeleteAppInstanceUserRequest


                    
                    
                    AWSChimeSDKIdentityDeregisterAppInstanceUserEndpointRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityDeregisterAppInstanceUserEndpointRequest

Swift

class AWSChimeSDKIdentityDeregisterAppInstanceUserEndpointRequest


                    
                    
                    AWSChimeSDKIdentityDescribeAppInstanceAdminRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityDescribeAppInstanceAdminRequest

Swift

class AWSChimeSDKIdentityDescribeAppInstanceAdminRequest


                    
                    
                    AWSChimeSDKIdentityDescribeAppInstanceAdminResponse

Declaration

Objective-C

@interface AWSChimeSDKIdentityDescribeAppInstanceAdminResponse

Swift

class AWSChimeSDKIdentityDescribeAppInstanceAdminResponse


                    
                    
                    AWSChimeSDKIdentityDescribeAppInstanceBotRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityDescribeAppInstanceBotRequest

Swift

class AWSChimeSDKIdentityDescribeAppInstanceBotRequest


                    
                    
                    AWSChimeSDKIdentityDescribeAppInstanceBotResponse

Declaration

Objective-C

@interface AWSChimeSDKIdentityDescribeAppInstanceBotResponse

Swift

class AWSChimeSDKIdentityDescribeAppInstanceBotResponse


                    
                    
                    AWSChimeSDKIdentityDescribeAppInstanceRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityDescribeAppInstanceRequest

Swift

class AWSChimeSDKIdentityDescribeAppInstanceRequest


                    
                    
                    AWSChimeSDKIdentityDescribeAppInstanceResponse

Declaration

Objective-C

@interface AWSChimeSDKIdentityDescribeAppInstanceResponse

Swift

class AWSChimeSDKIdentityDescribeAppInstanceResponse


                    
                    
                    AWSChimeSDKIdentityDescribeAppInstanceUserEndpointRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityDescribeAppInstanceUserEndpointRequest

Swift

class AWSChimeSDKIdentityDescribeAppInstanceUserEndpointRequest


                    
                    
                    AWSChimeSDKIdentityDescribeAppInstanceUserEndpointResponse

Declaration

Objective-C

@interface AWSChimeSDKIdentityDescribeAppInstanceUserEndpointResponse

Swift

class AWSChimeSDKIdentityDescribeAppInstanceUserEndpointResponse


                    
                    
                    AWSChimeSDKIdentityDescribeAppInstanceUserRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityDescribeAppInstanceUserRequest

Swift

class AWSChimeSDKIdentityDescribeAppInstanceUserRequest


                    
                    
                    AWSChimeSDKIdentityDescribeAppInstanceUserResponse

Declaration

Objective-C

@interface AWSChimeSDKIdentityDescribeAppInstanceUserResponse

Swift

class AWSChimeSDKIdentityDescribeAppInstanceUserResponse


                    
                    
                    AWSChimeSDKIdentityEndpointAttributes

The attributes of an Endpoint.

Required parameters: [DeviceToken]

Declaration

Objective-C

@interface AWSChimeSDKIdentityEndpointAttributes

Swift

class AWSChimeSDKIdentityEndpointAttributes


                    
                    
                    AWSChimeSDKIdentityEndpointState

A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values:

ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE, the EndpointStatusReason remains empty.
INACTIVE: The AppInstanceUserEndpoint is inactive and can’t receive message. When INACTIVE, the corresponding reason will be conveyed through EndpointStatusReason.
INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device token
INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input through the ResourceArn field.

Required parameters: [Status]

Declaration

Objective-C

@interface AWSChimeSDKIdentityEndpointState

Swift

class AWSChimeSDKIdentityEndpointState


                    
                    
                    AWSChimeSDKIdentityExpirationSettings

Determines the interval after which an AppInstanceUser is automatically deleted.

Required parameters: [ExpirationDays, ExpirationCriterion]

Declaration

Objective-C

@interface AWSChimeSDKIdentityExpirationSettings

Swift

class AWSChimeSDKIdentityExpirationSettings


                    
                    
                    AWSChimeSDKIdentityGetAppInstanceRetentionSettingsRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityGetAppInstanceRetentionSettingsRequest

Swift

class AWSChimeSDKIdentityGetAppInstanceRetentionSettingsRequest


                    
                    
                    AWSChimeSDKIdentityGetAppInstanceRetentionSettingsResponse

Declaration

Objective-C

@interface AWSChimeSDKIdentityGetAppInstanceRetentionSettingsResponse

Swift

class AWSChimeSDKIdentityGetAppInstanceRetentionSettingsResponse


                    
                    
                    AWSChimeSDKIdentityIdentity

The details of a user or bot.

Declaration

Objective-C

@interface AWSChimeSDKIdentityIdentity

Swift

class AWSChimeSDKIdentityIdentity


                    
                    
                    AWSChimeSDKIdentityInvokedBy

Specifies the type of message that triggers a bot.

Required parameters: [StandardMessages, TargetedMessages]

Declaration

Objective-C

@interface AWSChimeSDKIdentityInvokedBy

Swift

class AWSChimeSDKIdentityInvokedBy


                    
                    
                    AWSChimeSDKIdentityLexConfiguration

The configuration for an Amazon Lex V2 bot.

Required parameters: [LexBotAliasArn, LocaleId]

Declaration

Objective-C

@interface AWSChimeSDKIdentityLexConfiguration

Swift

class AWSChimeSDKIdentityLexConfiguration


                    
                    
                    AWSChimeSDKIdentityListAppInstanceAdminsRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityListAppInstanceAdminsRequest

Swift

class AWSChimeSDKIdentityListAppInstanceAdminsRequest


                    
                    
                    AWSChimeSDKIdentityListAppInstanceAdminsResponse

Declaration

Objective-C

@interface AWSChimeSDKIdentityListAppInstanceAdminsResponse

Swift

class AWSChimeSDKIdentityListAppInstanceAdminsResponse


                    
                    
                    AWSChimeSDKIdentityListAppInstanceBotsRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityListAppInstanceBotsRequest

Swift

class AWSChimeSDKIdentityListAppInstanceBotsRequest


                    
                    
                    AWSChimeSDKIdentityListAppInstanceBotsResponse

Declaration

Objective-C

@interface AWSChimeSDKIdentityListAppInstanceBotsResponse

Swift

class AWSChimeSDKIdentityListAppInstanceBotsResponse


                    
                    
                    AWSChimeSDKIdentityListAppInstanceUserEndpointsRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityListAppInstanceUserEndpointsRequest

Swift

class AWSChimeSDKIdentityListAppInstanceUserEndpointsRequest


                    
                    
                    AWSChimeSDKIdentityListAppInstanceUserEndpointsResponse

Declaration

Objective-C

@interface AWSChimeSDKIdentityListAppInstanceUserEndpointsResponse

Swift

class AWSChimeSDKIdentityListAppInstanceUserEndpointsResponse


                    
                    
                    AWSChimeSDKIdentityListAppInstanceUsersRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityListAppInstanceUsersRequest

Swift

class AWSChimeSDKIdentityListAppInstanceUsersRequest


                    
                    
                    AWSChimeSDKIdentityListAppInstanceUsersResponse

Declaration

Objective-C

@interface AWSChimeSDKIdentityListAppInstanceUsersResponse

Swift

class AWSChimeSDKIdentityListAppInstanceUsersResponse


                    
                    
                    AWSChimeSDKIdentityListAppInstancesRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityListAppInstancesRequest

Swift

class AWSChimeSDKIdentityListAppInstancesRequest


                    
                    
                    AWSChimeSDKIdentityListAppInstancesResponse

Declaration

Objective-C

@interface AWSChimeSDKIdentityListAppInstancesResponse

Swift

class AWSChimeSDKIdentityListAppInstancesResponse


                    
                    
                    AWSChimeSDKIdentityListTagsForResourceRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityListTagsForResourceRequest

Swift

class AWSChimeSDKIdentityListTagsForResourceRequest


                    
                    
                    AWSChimeSDKIdentityListTagsForResourceResponse

Declaration

Objective-C

@interface AWSChimeSDKIdentityListTagsForResourceResponse

Swift

class AWSChimeSDKIdentityListTagsForResourceResponse


                    
                    
                    AWSChimeSDKIdentityPutAppInstanceRetentionSettingsRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityPutAppInstanceRetentionSettingsRequest

Swift

class AWSChimeSDKIdentityPutAppInstanceRetentionSettingsRequest


                    
                    
                    AWSChimeSDKIdentityPutAppInstanceRetentionSettingsResponse

Declaration

Objective-C

@interface AWSChimeSDKIdentityPutAppInstanceRetentionSettingsResponse

Swift

class AWSChimeSDKIdentityPutAppInstanceRetentionSettingsResponse


                    
                    
                    AWSChimeSDKIdentityPutAppInstanceUserExpirationSettingsRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityPutAppInstanceUserExpirationSettingsRequest

Swift

class AWSChimeSDKIdentityPutAppInstanceUserExpirationSettingsRequest


                    
                    
                    AWSChimeSDKIdentityPutAppInstanceUserExpirationSettingsResponse

Declaration

Objective-C

@interface AWSChimeSDKIdentityPutAppInstanceUserExpirationSettingsResponse

Swift

class AWSChimeSDKIdentityPutAppInstanceUserExpirationSettingsResponse


                    
                    
                    AWSChimeSDKIdentityRegisterAppInstanceUserEndpointRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityRegisterAppInstanceUserEndpointRequest

Swift

class AWSChimeSDKIdentityRegisterAppInstanceUserEndpointRequest


                    
                    
                    AWSChimeSDKIdentityRegisterAppInstanceUserEndpointResponse

Declaration

Objective-C

@interface AWSChimeSDKIdentityRegisterAppInstanceUserEndpointResponse

Swift

class AWSChimeSDKIdentityRegisterAppInstanceUserEndpointResponse


                    
                    
                    AWSChimeSDKIdentityTag

A tag object containing a key-value pair.

Required parameters: [Key, Value]

Declaration

Objective-C

@interface AWSChimeSDKIdentityTag

Swift

class AWSChimeSDKIdentityTag


                    
                    
                    AWSChimeSDKIdentityTagResourceRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityTagResourceRequest

Swift

class AWSChimeSDKIdentityTagResourceRequest


                    
                    
                    AWSChimeSDKIdentityUntagResourceRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityUntagResourceRequest

Swift

class AWSChimeSDKIdentityUntagResourceRequest


                    
                    
                    AWSChimeSDKIdentityUpdateAppInstanceBotRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityUpdateAppInstanceBotRequest

Swift

class AWSChimeSDKIdentityUpdateAppInstanceBotRequest


                    
                    
                    AWSChimeSDKIdentityUpdateAppInstanceBotResponse

Declaration

Objective-C

@interface AWSChimeSDKIdentityUpdateAppInstanceBotResponse

Swift

class AWSChimeSDKIdentityUpdateAppInstanceBotResponse


                    
                    
                    AWSChimeSDKIdentityUpdateAppInstanceRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityUpdateAppInstanceRequest

Swift

class AWSChimeSDKIdentityUpdateAppInstanceRequest


                    
                    
                    AWSChimeSDKIdentityUpdateAppInstanceResponse

Declaration

Objective-C

@interface AWSChimeSDKIdentityUpdateAppInstanceResponse

Swift

class AWSChimeSDKIdentityUpdateAppInstanceResponse


                    
                    
                    AWSChimeSDKIdentityUpdateAppInstanceUserEndpointRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityUpdateAppInstanceUserEndpointRequest

Swift

class AWSChimeSDKIdentityUpdateAppInstanceUserEndpointRequest


                    
                    
                    AWSChimeSDKIdentityUpdateAppInstanceUserEndpointResponse

Declaration

Objective-C

@interface AWSChimeSDKIdentityUpdateAppInstanceUserEndpointResponse

Swift

class AWSChimeSDKIdentityUpdateAppInstanceUserEndpointResponse


                    
                    
                    AWSChimeSDKIdentityUpdateAppInstanceUserRequest

Declaration

Objective-C

@interface AWSChimeSDKIdentityUpdateAppInstanceUserRequest

Swift

class AWSChimeSDKIdentityUpdateAppInstanceUserRequest


                    
                    
                    AWSChimeSDKIdentityUpdateAppInstanceUserResponse

Declaration

Objective-C

@interface AWSChimeSDKIdentityUpdateAppInstanceUserResponse

Swift

class AWSChimeSDKIdentityUpdateAppInstanceUserResponse


                    
                    
                    AWSChimeSDKIdentityResources

Undocumented

Declaration

Objective-C

@interface AWSChimeSDKIdentityResources : NSObject

+ (instancetype)sharedInstance;

- (NSDictionary *)JSONObject;

@end

Swift

class AWSChimeSDKIdentityResources : NSObject


                    
                    
                    AWSChimeSDKIdentity

The Amazon Chime SDK Identity APIs in this section allow software developers to create and manage unique instances of their messaging applications. These APIs provide the overarching framework for creating and sending messages. For more information about the identity APIs, refer to Amazon Chime SDK identity.

Declaration

Objective-C

@interface AWSChimeSDKIdentity

Swift

class AWSChimeSDKIdentity