// // Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. // // Licensed under the Apache License, Version 2.0 (the "License"). // You may not use this file except in compliance with the License. // A copy of the License is located at // // http://aws.amazon.com/apache2.0 // // or in the "license" file accompanying this file. This file is distributed // on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either // express or implied. See the License for the specific language governing // permissions and limitations under the License. // #import #import #import NS_ASSUME_NONNULL_BEGIN FOUNDATION_EXPORT NSString *const AWSChimeSDKIdentityErrorDomain; typedef NS_ENUM(NSInteger, AWSChimeSDKIdentityErrorType) { AWSChimeSDKIdentityErrorUnknown, AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorNotFound, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorServiceFailure, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, }; typedef NS_ENUM(NSInteger, AWSChimeSDKIdentityAllowMessages) { AWSChimeSDKIdentityAllowMessagesUnknown, AWSChimeSDKIdentityAllowMessagesAll, AWSChimeSDKIdentityAllowMessagesNone, }; typedef NS_ENUM(NSInteger, AWSChimeSDKIdentityAppInstanceUserEndpointType) { AWSChimeSDKIdentityAppInstanceUserEndpointTypeUnknown, AWSChimeSDKIdentityAppInstanceUserEndpointTypeApns, AWSChimeSDKIdentityAppInstanceUserEndpointTypeApnsSandbox, AWSChimeSDKIdentityAppInstanceUserEndpointTypeGcm, }; typedef NS_ENUM(NSInteger, AWSChimeSDKIdentityEndpointStatus) { AWSChimeSDKIdentityEndpointStatusUnknown, AWSChimeSDKIdentityEndpointStatusActive, AWSChimeSDKIdentityEndpointStatusInactive, }; typedef NS_ENUM(NSInteger, AWSChimeSDKIdentityEndpointStatusReason) { AWSChimeSDKIdentityEndpointStatusReasonUnknown, AWSChimeSDKIdentityEndpointStatusReasonInvalidDeviceToken, AWSChimeSDKIdentityEndpointStatusReasonInvalidPinpointArn, }; typedef NS_ENUM(NSInteger, AWSChimeSDKIdentityErrorCode) { AWSChimeSDKIdentityErrorCodeUnknown, AWSChimeSDKIdentityErrorCodeBadRequest, AWSChimeSDKIdentityErrorCodeConflict, AWSChimeSDKIdentityErrorCodeForbidden, AWSChimeSDKIdentityErrorCodeNotFound, AWSChimeSDKIdentityErrorCodePreconditionFailed, AWSChimeSDKIdentityErrorCodeResourceLimitExceeded, AWSChimeSDKIdentityErrorCodeServiceFailure, AWSChimeSDKIdentityErrorCodeAccessDenied, AWSChimeSDKIdentityErrorCodeServiceUnavailable, AWSChimeSDKIdentityErrorCodeThrottled, AWSChimeSDKIdentityErrorCodeThrottling, AWSChimeSDKIdentityErrorCodeUnauthorized, AWSChimeSDKIdentityErrorCodeUnprocessable, AWSChimeSDKIdentityErrorCodeVoiceConnectorGroupAssociationsExist, AWSChimeSDKIdentityErrorCodePhoneNumberAssociationsExist, }; typedef NS_ENUM(NSInteger, AWSChimeSDKIdentityExpirationCriterion) { AWSChimeSDKIdentityExpirationCriterionUnknown, AWSChimeSDKIdentityExpirationCriterionCreatedTimestamp, }; typedef NS_ENUM(NSInteger, AWSChimeSDKIdentityRespondsTo) { AWSChimeSDKIdentityRespondsToUnknown, AWSChimeSDKIdentityRespondsToStandardMessages, }; typedef NS_ENUM(NSInteger, AWSChimeSDKIdentityStandardMessages) { AWSChimeSDKIdentityStandardMessagesUnknown, AWSChimeSDKIdentityStandardMessagesAuto, AWSChimeSDKIdentityStandardMessagesAll, AWSChimeSDKIdentityStandardMessagesMentions, AWSChimeSDKIdentityStandardMessagesNone, }; typedef NS_ENUM(NSInteger, AWSChimeSDKIdentityTargetedMessages) { AWSChimeSDKIdentityTargetedMessagesUnknown, AWSChimeSDKIdentityTargetedMessagesAll, AWSChimeSDKIdentityTargetedMessagesNone, }; @class AWSChimeSDKIdentityAppInstance; @class AWSChimeSDKIdentityAppInstanceAdmin; @class AWSChimeSDKIdentityAppInstanceAdminSummary; @class AWSChimeSDKIdentityAppInstanceBot; @class AWSChimeSDKIdentityAppInstanceBotSummary; @class AWSChimeSDKIdentityAppInstanceRetentionSettings; @class AWSChimeSDKIdentityAppInstanceSummary; @class AWSChimeSDKIdentityAppInstanceUser; @class AWSChimeSDKIdentityAppInstanceUserEndpoint; @class AWSChimeSDKIdentityAppInstanceUserEndpointSummary; @class AWSChimeSDKIdentityAppInstanceUserSummary; @class AWSChimeSDKIdentityChannelRetentionSettings; @class AWSChimeSDKIdentityConfiguration; @class AWSChimeSDKIdentityCreateAppInstanceAdminRequest; @class AWSChimeSDKIdentityCreateAppInstanceAdminResponse; @class AWSChimeSDKIdentityCreateAppInstanceBotRequest; @class AWSChimeSDKIdentityCreateAppInstanceBotResponse; @class AWSChimeSDKIdentityCreateAppInstanceRequest; @class AWSChimeSDKIdentityCreateAppInstanceResponse; @class AWSChimeSDKIdentityCreateAppInstanceUserRequest; @class AWSChimeSDKIdentityCreateAppInstanceUserResponse; @class AWSChimeSDKIdentityDeleteAppInstanceAdminRequest; @class AWSChimeSDKIdentityDeleteAppInstanceBotRequest; @class AWSChimeSDKIdentityDeleteAppInstanceRequest; @class AWSChimeSDKIdentityDeleteAppInstanceUserRequest; @class AWSChimeSDKIdentityDeregisterAppInstanceUserEndpointRequest; @class AWSChimeSDKIdentityDescribeAppInstanceAdminRequest; @class AWSChimeSDKIdentityDescribeAppInstanceAdminResponse; @class AWSChimeSDKIdentityDescribeAppInstanceBotRequest; @class AWSChimeSDKIdentityDescribeAppInstanceBotResponse; @class AWSChimeSDKIdentityDescribeAppInstanceRequest; @class AWSChimeSDKIdentityDescribeAppInstanceResponse; @class AWSChimeSDKIdentityDescribeAppInstanceUserEndpointRequest; @class AWSChimeSDKIdentityDescribeAppInstanceUserEndpointResponse; @class AWSChimeSDKIdentityDescribeAppInstanceUserRequest; @class AWSChimeSDKIdentityDescribeAppInstanceUserResponse; @class AWSChimeSDKIdentityEndpointAttributes; @class AWSChimeSDKIdentityEndpointState; @class AWSChimeSDKIdentityExpirationSettings; @class AWSChimeSDKIdentityGetAppInstanceRetentionSettingsRequest; @class AWSChimeSDKIdentityGetAppInstanceRetentionSettingsResponse; @class AWSChimeSDKIdentityIdentity; @class AWSChimeSDKIdentityInvokedBy; @class AWSChimeSDKIdentityLexConfiguration; @class AWSChimeSDKIdentityListAppInstanceAdminsRequest; @class AWSChimeSDKIdentityListAppInstanceAdminsResponse; @class AWSChimeSDKIdentityListAppInstanceBotsRequest; @class AWSChimeSDKIdentityListAppInstanceBotsResponse; @class AWSChimeSDKIdentityListAppInstanceUserEndpointsRequest; @class AWSChimeSDKIdentityListAppInstanceUserEndpointsResponse; @class AWSChimeSDKIdentityListAppInstanceUsersRequest; @class AWSChimeSDKIdentityListAppInstanceUsersResponse; @class AWSChimeSDKIdentityListAppInstancesRequest; @class AWSChimeSDKIdentityListAppInstancesResponse; @class AWSChimeSDKIdentityListTagsForResourceRequest; @class AWSChimeSDKIdentityListTagsForResourceResponse; @class AWSChimeSDKIdentityPutAppInstanceRetentionSettingsRequest; @class AWSChimeSDKIdentityPutAppInstanceRetentionSettingsResponse; @class AWSChimeSDKIdentityPutAppInstanceUserExpirationSettingsRequest; @class AWSChimeSDKIdentityPutAppInstanceUserExpirationSettingsResponse; @class AWSChimeSDKIdentityRegisterAppInstanceUserEndpointRequest; @class AWSChimeSDKIdentityRegisterAppInstanceUserEndpointResponse; @class AWSChimeSDKIdentityTag; @class AWSChimeSDKIdentityTagResourceRequest; @class AWSChimeSDKIdentityUntagResourceRequest; @class AWSChimeSDKIdentityUpdateAppInstanceBotRequest; @class AWSChimeSDKIdentityUpdateAppInstanceBotResponse; @class AWSChimeSDKIdentityUpdateAppInstanceRequest; @class AWSChimeSDKIdentityUpdateAppInstanceResponse; @class AWSChimeSDKIdentityUpdateAppInstanceUserEndpointRequest; @class AWSChimeSDKIdentityUpdateAppInstanceUserEndpointResponse; @class AWSChimeSDKIdentityUpdateAppInstanceUserRequest; @class AWSChimeSDKIdentityUpdateAppInstanceUserResponse; /**

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

*/ @interface AWSChimeSDKIdentityAppInstance : AWSModel /**

The ARN of the messaging instance.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceArn; /**

The time at which an AppInstance was created. In epoch milliseconds.

*/ @property (nonatomic, strong) NSDate * _Nullable createdTimestamp; /**

The time an AppInstance was last updated. In epoch milliseconds.

*/ @property (nonatomic, strong) NSDate * _Nullable lastUpdatedTimestamp; /**

The metadata of an AppInstance.

*/ @property (nonatomic, strong) NSString * _Nullable metadata; /**

The name of an AppInstance.

*/ @property (nonatomic, strong) NSString * _Nullable name; @end /**

The name and ARN of the admin for the AppInstance.

*/ @interface AWSChimeSDKIdentityAppInstanceAdmin : AWSModel /**

The AppInstanceAdmin data.

*/ @property (nonatomic, strong) AWSChimeSDKIdentityIdentity * _Nullable admin; /**

The ARN of the AppInstance for which the user is an administrator.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceArn; /**

The time at which an administrator was created.

*/ @property (nonatomic, strong) NSDate * _Nullable createdTimestamp; @end /**

Summary of the details of an AppInstanceAdmin.

*/ @interface AWSChimeSDKIdentityAppInstanceAdminSummary : AWSModel /**

The details of the AppInstanceAdmin.

*/ @property (nonatomic, strong) AWSChimeSDKIdentityIdentity * _Nullable admin; @end /**

An Amazon Lex V2 chat bot created under an AppInstance.

*/ @interface AWSChimeSDKIdentityAppInstanceBot : AWSModel /**

The ARN of the AppInstanceBot.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceBotArn; /**

The data processing instructions for an AppInstanceBot.

*/ @property (nonatomic, strong) AWSChimeSDKIdentityConfiguration * _Nullable configuration; /**

The time at which the AppInstanceBot was created.

*/ @property (nonatomic, strong) NSDate * _Nullable createdTimestamp; /**

The time at which the AppInstanceBot was last updated.

*/ @property (nonatomic, strong) NSDate * _Nullable lastUpdatedTimestamp; /**

The metadata for an AppInstanceBot.

*/ @property (nonatomic, strong) NSString * _Nullable metadata; /**

The name of the AppInstanceBot.

*/ @property (nonatomic, strong) NSString * _Nullable name; @end /**

High-level information about an AppInstanceBot.

*/ @interface AWSChimeSDKIdentityAppInstanceBotSummary : AWSModel /**

The ARN of the AppInstanceBot.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceBotArn; /**

The metadata of the AppInstanceBot.

*/ @property (nonatomic, strong) NSString * _Nullable metadata; /**

The name of the AppInstanceBox.

*/ @property (nonatomic, strong) NSString * _Nullable name; @end /**

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

*/ @interface AWSChimeSDKIdentityAppInstanceRetentionSettings : AWSModel /**

The length of time in days to retain the messages in a channel.

*/ @property (nonatomic, strong) AWSChimeSDKIdentityChannelRetentionSettings * _Nullable channelRetentionSettings; @end /**

Summary of the data for an AppInstance.

*/ @interface AWSChimeSDKIdentityAppInstanceSummary : AWSModel /**

The AppInstance ARN.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceArn; /**

The metadata of the AppInstance.

*/ @property (nonatomic, strong) NSString * _Nullable metadata; /**

The name of the AppInstance.

*/ @property (nonatomic, strong) NSString * _Nullable name; @end /**

The details of an AppInstanceUser.

*/ @interface AWSChimeSDKIdentityAppInstanceUser : AWSModel /**

The ARN of the AppInstanceUser.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceUserArn; /**

The time at which the AppInstanceUser was created.

*/ @property (nonatomic, strong) NSDate * _Nullable createdTimestamp; /**

The interval after which an AppInstanceUser is automatically deleted.

*/ @property (nonatomic, strong) AWSChimeSDKIdentityExpirationSettings * _Nullable expirationSettings; /**

The time at which the AppInstanceUser was last updated.

*/ @property (nonatomic, strong) NSDate * _Nullable lastUpdatedTimestamp; /**

The metadata of the AppInstanceUser.

*/ @property (nonatomic, strong) NSString * _Nullable metadata; /**

The name of the AppInstanceUser.

*/ @property (nonatomic, strong) NSString * _Nullable name; @end /**

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.

*/ @interface AWSChimeSDKIdentityAppInstanceUserEndpoint : AWSModel /**

Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.

*/ @property (nonatomic, assign) AWSChimeSDKIdentityAllowMessages allowMessages; /**

The ARN of the AppInstanceUser.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceUserArn; /**

The time at which an AppInstanceUserEndpoint was created.

*/ @property (nonatomic, strong) NSDate * _Nullable createdTimestamp; /**

The attributes of an Endpoint.

*/ @property (nonatomic, strong) AWSChimeSDKIdentityEndpointAttributes * _Nullable endpointAttributes; /**

The unique identifier of the AppInstanceUserEndpoint.

*/ @property (nonatomic, strong) NSString * _Nullable endpointId; /**

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.

*/ @property (nonatomic, strong) AWSChimeSDKIdentityEndpointState * _Nullable endpointState; /**

The time at which an AppInstanceUserEndpoint was last updated.

*/ @property (nonatomic, strong) NSDate * _Nullable lastUpdatedTimestamp; /**

The name of the AppInstanceUserEndpoint.

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

The ARN of the resource to which the endpoint belongs.

*/ @property (nonatomic, strong) NSString * _Nullable resourceArn; /**

The type of the AppInstanceUserEndpoint.

*/ @property (nonatomic, assign) AWSChimeSDKIdentityAppInstanceUserEndpointType types; @end /**

Summary of the details of an AppInstanceUserEndpoint.

*/ @interface AWSChimeSDKIdentityAppInstanceUserEndpointSummary : AWSModel /**

BBoolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.

*/ @property (nonatomic, assign) AWSChimeSDKIdentityAllowMessages allowMessages; /**

The ARN of the AppInstanceUser.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceUserArn; /**

The unique identifier of the AppInstanceUserEndpoint.

*/ @property (nonatomic, strong) NSString * _Nullable endpointId; /**

A read-only field that represent the state of an AppInstanceUserEndpoint.

*/ @property (nonatomic, strong) AWSChimeSDKIdentityEndpointState * _Nullable endpointState; /**

The name of the AppInstanceUserEndpoint.

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

The type of the AppInstanceUserEndpoint.

*/ @property (nonatomic, assign) AWSChimeSDKIdentityAppInstanceUserEndpointType types; @end /**

Summary of the details of an AppInstanceUser.

*/ @interface AWSChimeSDKIdentityAppInstanceUserSummary : AWSModel /**

The ARN of the AppInstanceUser.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceUserArn; /**

The metadata of the AppInstanceUser.

*/ @property (nonatomic, strong) NSString * _Nullable metadata; /**

The name of an AppInstanceUser.

*/ @property (nonatomic, strong) NSString * _Nullable name; @end /**

The details of the retention settings for a channel.

*/ @interface AWSChimeSDKIdentityChannelRetentionSettings : AWSModel /**

The time in days to retain the messages in a channel.

*/ @property (nonatomic, strong) NSNumber * _Nullable retentionDays; @end /**

A structure that contains configuration data.

Required parameters: [Lex] */ @interface AWSChimeSDKIdentityConfiguration : AWSModel /**

The configuration for an Amazon Lex V2 bot.

*/ @property (nonatomic, strong) AWSChimeSDKIdentityLexConfiguration * _Nullable lex; @end /** */ @interface AWSChimeSDKIdentityCreateAppInstanceAdminRequest : AWSRequest /**

The ARN of the administrator of the current AppInstance.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceAdminArn; /**

The ARN of the AppInstance.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceArn; @end /** */ @interface AWSChimeSDKIdentityCreateAppInstanceAdminResponse : AWSModel /**

The ARN and name of the administrator, the ARN of the AppInstance, and the created and last-updated timestamps. All timestamps use epoch milliseconds.

*/ @property (nonatomic, strong) AWSChimeSDKIdentityIdentity * _Nullable appInstanceAdmin; /**

The ARN of the of the admin for the AppInstance.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceArn; @end /** */ @interface AWSChimeSDKIdentityCreateAppInstanceBotRequest : AWSRequest /**

The ARN of the AppInstance request.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceArn; /**

The unique ID for the client making the request. Use different tokens for different AppInstanceBots.

*/ @property (nonatomic, strong) NSString * _Nullable clientRequestToken; /**

Configuration information about the Amazon Lex V2 V2 bot.

*/ @property (nonatomic, strong) AWSChimeSDKIdentityConfiguration * _Nullable configuration; /**

The request metadata. Limited to a 1KB string in UTF-8.

*/ @property (nonatomic, strong) NSString * _Nullable metadata; /**

The user's name.

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

The tags assigned to the AppInstanceBot.

*/ @property (nonatomic, strong) NSArray * _Nullable tags; @end /** */ @interface AWSChimeSDKIdentityCreateAppInstanceBotResponse : AWSModel /**

The ARN of the AppinstanceBot.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceBotArn; @end /** */ @interface AWSChimeSDKIdentityCreateAppInstanceRequest : AWSRequest /**

The unique ID of the request. Use different tokens to create different AppInstances.

*/ @property (nonatomic, strong) NSString * _Nullable clientRequestToken; /**

The metadata of the AppInstance. Limited to a 1KB string in UTF-8.

*/ @property (nonatomic, strong) NSString * _Nullable metadata; /**

The name of the AppInstance.

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

Tags assigned to the AppInstance.

*/ @property (nonatomic, strong) NSArray * _Nullable tags; @end /** */ @interface AWSChimeSDKIdentityCreateAppInstanceResponse : AWSModel /**

The Amazon Resource Number (ARN) of the AppInstance.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceArn; @end /** */ @interface AWSChimeSDKIdentityCreateAppInstanceUserRequest : AWSRequest /**

The ARN of the AppInstance request.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceArn; /**

The user ID of the AppInstance.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceUserId; /**

The unique ID of the request. Use different tokens to request additional AppInstances.

*/ @property (nonatomic, strong) NSString * _Nullable clientRequestToken; /**

Settings that control the interval after which the AppInstanceUser is automatically deleted.

*/ @property (nonatomic, strong) AWSChimeSDKIdentityExpirationSettings * _Nullable expirationSettings; /**

The request's metadata. Limited to a 1KB string in UTF-8.

*/ @property (nonatomic, strong) NSString * _Nullable metadata; /**

The user's name.

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

Tags assigned to the AppInstanceUser.

*/ @property (nonatomic, strong) NSArray * _Nullable tags; @end /** */ @interface AWSChimeSDKIdentityCreateAppInstanceUserResponse : AWSModel /**

The user's ARN.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceUserArn; @end /** */ @interface AWSChimeSDKIdentityDeleteAppInstanceAdminRequest : AWSRequest /**

The ARN of the AppInstance's administrator.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceAdminArn; /**

The ARN of the AppInstance.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceArn; @end /** */ @interface AWSChimeSDKIdentityDeleteAppInstanceBotRequest : AWSRequest /**

The ARN of the AppInstanceBot being deleted.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceBotArn; @end /** */ @interface AWSChimeSDKIdentityDeleteAppInstanceRequest : AWSRequest /**

The ARN of the AppInstance.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceArn; @end /** */ @interface AWSChimeSDKIdentityDeleteAppInstanceUserRequest : AWSRequest /**

The ARN of the user request being deleted.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceUserArn; @end /** */ @interface AWSChimeSDKIdentityDeregisterAppInstanceUserEndpointRequest : AWSRequest /**

The ARN of the AppInstanceUser.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceUserArn; /**

The unique identifier of the AppInstanceUserEndpoint.

*/ @property (nonatomic, strong) NSString * _Nullable endpointId; @end /** */ @interface AWSChimeSDKIdentityDescribeAppInstanceAdminRequest : AWSRequest /**

The ARN of the AppInstanceAdmin.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceAdminArn; /**

The ARN of the AppInstance.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceArn; @end /** */ @interface AWSChimeSDKIdentityDescribeAppInstanceAdminResponse : AWSModel /**

The ARN and name of the AppInstanceUser, the ARN of the AppInstance, and the created and last-updated timestamps. All timestamps use epoch milliseconds.

*/ @property (nonatomic, strong) AWSChimeSDKIdentityAppInstanceAdmin * _Nullable appInstanceAdmin; @end /** */ @interface AWSChimeSDKIdentityDescribeAppInstanceBotRequest : AWSRequest /**

The ARN of the AppInstanceBot.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceBotArn; @end /** */ @interface AWSChimeSDKIdentityDescribeAppInstanceBotResponse : AWSModel /**

The detials of the AppInstanceBot.

*/ @property (nonatomic, strong) AWSChimeSDKIdentityAppInstanceBot * _Nullable appInstanceBot; @end /** */ @interface AWSChimeSDKIdentityDescribeAppInstanceRequest : AWSRequest /**

The ARN of the AppInstance.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceArn; @end /** */ @interface AWSChimeSDKIdentityDescribeAppInstanceResponse : AWSModel /**

The ARN, metadata, created and last-updated timestamps, and the name of the AppInstance. All timestamps use epoch milliseconds.

*/ @property (nonatomic, strong) AWSChimeSDKIdentityAppInstance * _Nullable appInstance; @end /** */ @interface AWSChimeSDKIdentityDescribeAppInstanceUserEndpointRequest : AWSRequest /**

The ARN of the AppInstanceUser.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceUserArn; /**

The unique identifier of the AppInstanceUserEndpoint.

*/ @property (nonatomic, strong) NSString * _Nullable endpointId; @end /** */ @interface AWSChimeSDKIdentityDescribeAppInstanceUserEndpointResponse : AWSModel /**

The full details of an AppInstanceUserEndpoint: the AppInstanceUserArn, ID, name, type, resource ARN, attributes, allow messages, state, and created and last updated timestamps. All timestamps use epoch milliseconds.

*/ @property (nonatomic, strong) AWSChimeSDKIdentityAppInstanceUserEndpoint * _Nullable appInstanceUserEndpoint; @end /** */ @interface AWSChimeSDKIdentityDescribeAppInstanceUserRequest : AWSRequest /**

The ARN of the AppInstanceUser.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceUserArn; @end /** */ @interface AWSChimeSDKIdentityDescribeAppInstanceUserResponse : AWSModel /**

The name of the AppInstanceUser.

*/ @property (nonatomic, strong) AWSChimeSDKIdentityAppInstanceUser * _Nullable appInstanceUser; @end /**

The attributes of an Endpoint.

Required parameters: [DeviceToken] */ @interface AWSChimeSDKIdentityEndpointAttributes : AWSModel /**

The device token for the GCM, APNS, and APNS_SANDBOX endpoint types.

*/ @property (nonatomic, strong) NSString * _Nullable deviceToken; /**

The VOIP device token for the APNS and APNS_SANDBOX endpoint types.

*/ @property (nonatomic, strong) NSString * _Nullable voipDeviceToken; @end /**

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] */ @interface AWSChimeSDKIdentityEndpointState : AWSModel /**

Enum that indicates the Status of an AppInstanceUserEndpoint.

*/ @property (nonatomic, assign) AWSChimeSDKIdentityEndpointStatus status; /**

The reason for the EndpointStatus.

*/ @property (nonatomic, assign) AWSChimeSDKIdentityEndpointStatusReason statusReason; @end /**

Determines the interval after which an AppInstanceUser is automatically deleted.

Required parameters: [ExpirationDays, ExpirationCriterion] */ @interface AWSChimeSDKIdentityExpirationSettings : AWSModel /**

Specifies the conditions under which an AppInstanceUser will expire.

*/ @property (nonatomic, assign) AWSChimeSDKIdentityExpirationCriterion expirationCriterion; /**

The period in days after which an AppInstanceUser will be automatically deleted.

*/ @property (nonatomic, strong) NSNumber * _Nullable expirationDays; @end /** */ @interface AWSChimeSDKIdentityGetAppInstanceRetentionSettingsRequest : AWSRequest /**

The ARN of the AppInstance.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceArn; @end /** */ @interface AWSChimeSDKIdentityGetAppInstanceRetentionSettingsResponse : AWSModel /**

The retention settings for the AppInstance.

*/ @property (nonatomic, strong) AWSChimeSDKIdentityAppInstanceRetentionSettings * _Nullable appInstanceRetentionSettings; /**

The timestamp representing the time at which the specified items are retained, in Epoch Seconds.

*/ @property (nonatomic, strong) NSDate * _Nullable initiateDeletionTimestamp; @end /**

The details of a user or bot.

*/ @interface AWSChimeSDKIdentityIdentity : AWSModel /**

The ARN in an Identity.

*/ @property (nonatomic, strong) NSString * _Nullable arn; /**

The name in an Identity.

*/ @property (nonatomic, strong) NSString * _Nullable name; @end /**

Specifies the type of message that triggers a bot.

Required parameters: [StandardMessages, TargetedMessages] */ @interface AWSChimeSDKIdentityInvokedBy : AWSModel /**

Sets standard messages as the bot trigger. For standard messages:

  • ALL: The bot processes all standard messages.

  • AUTO: The bot responds to ALL messages when the channel has one other non-hidden member, and responds to MENTIONS when the channel has more than one other non-hidden member.

  • MENTIONS: The bot processes all standard messages that have a message attribute with CHIME.mentions and a value of the bot ARN.

  • NONE: The bot processes no standard messages.

*/ @property (nonatomic, assign) AWSChimeSDKIdentityStandardMessages standardMessages; /**

Sets targeted messages as the bot trigger. For targeted messages:

  • ALL: The bot processes all TargetedMessages sent to it. The bot then responds with a targeted message back to the sender.

  • NONE: The bot processes no targeted messages.

*/ @property (nonatomic, assign) AWSChimeSDKIdentityTargetedMessages targetedMessages; @end /**

The configuration for an Amazon Lex V2 bot.

Required parameters: [LexBotAliasArn, LocaleId] */ @interface AWSChimeSDKIdentityLexConfiguration : AWSModel /**

Specifies the type of message that triggers a bot.

*/ @property (nonatomic, strong) AWSChimeSDKIdentityInvokedBy * _Nullable invokedBy; /**

The ARN of the Amazon Lex V2 bot's alias. The ARN uses this format: arn:aws:lex:REGION:ACCOUNT:bot-alias/MYBOTID/MYBOTALIAS

*/ @property (nonatomic, strong) NSString * _Nullable lexBotAliasArn; /**

Identifies the Amazon Lex V2 bot's language and locale. The string must match one of the supported locales in Amazon Lex V2. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages in the Amazon Lex V2 Developer Guide.

*/ @property (nonatomic, strong) NSString * _Nullable localeId; /**

Deprecated. Use InvokedBy instead.

Determines whether the Amazon Lex V2 bot responds to all standard messages. Control messages are not supported.

*/ @property (nonatomic, assign) AWSChimeSDKIdentityRespondsTo respondsTo; /**

The name of the welcome intent configured in the Amazon Lex V2 bot.

*/ @property (nonatomic, strong) NSString * _Nullable welcomeIntent; @end /** */ @interface AWSChimeSDKIdentityListAppInstanceAdminsRequest : AWSRequest /**

The ARN of the AppInstance.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceArn; /**

The maximum number of administrators that you want to return.

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

The token returned from previous API requests until the number of administrators is reached.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSChimeSDKIdentityListAppInstanceAdminsResponse : AWSModel /**

The information for each administrator.

*/ @property (nonatomic, strong) NSArray * _Nullable appInstanceAdmins; /**

The ARN of the AppInstance.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceArn; /**

The token returned from previous API requests until the number of administrators is reached.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSChimeSDKIdentityListAppInstanceBotsRequest : AWSRequest /**

The ARN of the AppInstance.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceArn; /**

The maximum number of requests to return.

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

The token passed by previous API calls until all requested bots are returned.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSChimeSDKIdentityListAppInstanceBotsResponse : AWSModel /**

The ARN of the AppInstance.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceArn; /**

The information for each requested AppInstanceBot.

*/ @property (nonatomic, strong) NSArray * _Nullable appInstanceBots; /**

The token passed by previous API calls until all requested bots are returned.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSChimeSDKIdentityListAppInstanceUserEndpointsRequest : AWSRequest /**

The ARN of the AppInstanceUser.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceUserArn; /**

The maximum number of endpoints that you want to return.

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

The token passed by previous API calls until all requested endpoints are returned.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSChimeSDKIdentityListAppInstanceUserEndpointsResponse : AWSModel /**

The information for each requested AppInstanceUserEndpoint.

*/ @property (nonatomic, strong) NSArray * _Nullable appInstanceUserEndpoints; /**

The token passed by previous API calls until all requested endpoints are returned.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSChimeSDKIdentityListAppInstanceUsersRequest : AWSRequest /**

The ARN of the AppInstance.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceArn; /**

The maximum number of requests that you want returned.

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

The token passed by previous API calls until all requested users are returned.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSChimeSDKIdentityListAppInstanceUsersResponse : AWSModel /**

The ARN of the AppInstance.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceArn; /**

The information for each requested AppInstanceUser.

*/ @property (nonatomic, strong) NSArray * _Nullable appInstanceUsers; /**

The token passed by previous API calls until all requested users are returned.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSChimeSDKIdentityListAppInstancesRequest : AWSRequest /**

The maximum number of AppInstances that you want to return.

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

The token passed by previous API requests until you reach the maximum number of AppInstances.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSChimeSDKIdentityListAppInstancesResponse : AWSModel /**

The information for each AppInstance.

*/ @property (nonatomic, strong) NSArray * _Nullable appInstances; /**

The token passed by previous API requests until the maximum number of AppInstances is reached.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSChimeSDKIdentityListTagsForResourceRequest : AWSRequest /**

The ARN of the resource.

*/ @property (nonatomic, strong) NSString * _Nullable resourceARN; @end /** */ @interface AWSChimeSDKIdentityListTagsForResourceResponse : AWSModel /**

The tag key-value pairs.

*/ @property (nonatomic, strong) NSArray * _Nullable tags; @end /** */ @interface AWSChimeSDKIdentityPutAppInstanceRetentionSettingsRequest : AWSRequest /**

The ARN of the AppInstance.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceArn; /**

The time in days to retain data. Data type: number.

*/ @property (nonatomic, strong) AWSChimeSDKIdentityAppInstanceRetentionSettings * _Nullable appInstanceRetentionSettings; @end /** */ @interface AWSChimeSDKIdentityPutAppInstanceRetentionSettingsResponse : AWSModel /**

The time in days to retain data. Data type: number.

*/ @property (nonatomic, strong) AWSChimeSDKIdentityAppInstanceRetentionSettings * _Nullable appInstanceRetentionSettings; /**

The time at which the API deletes data.

*/ @property (nonatomic, strong) NSDate * _Nullable initiateDeletionTimestamp; @end /** */ @interface AWSChimeSDKIdentityPutAppInstanceUserExpirationSettingsRequest : AWSRequest /**

The ARN of the AppInstanceUser.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceUserArn; /**

Settings that control the interval after which an AppInstanceUser is automatically deleted.

*/ @property (nonatomic, strong) AWSChimeSDKIdentityExpirationSettings * _Nullable expirationSettings; @end /** */ @interface AWSChimeSDKIdentityPutAppInstanceUserExpirationSettingsResponse : AWSModel /**

The ARN of the AppInstanceUser.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceUserArn; /**

Settings that control the interval after which an AppInstanceUser is automatically deleted.

*/ @property (nonatomic, strong) AWSChimeSDKIdentityExpirationSettings * _Nullable expirationSettings; @end /** */ @interface AWSChimeSDKIdentityRegisterAppInstanceUserEndpointRequest : AWSRequest /**

Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint receives all messages. NONE indicates the endpoint receives no messages.

*/ @property (nonatomic, assign) AWSChimeSDKIdentityAllowMessages allowMessages; /**

The ARN of the AppInstanceUser.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceUserArn; /**

The unique ID assigned to the request. Use different tokens to register other endpoints.

*/ @property (nonatomic, strong) NSString * _Nullable clientRequestToken; /**

The attributes of an Endpoint.

*/ @property (nonatomic, strong) AWSChimeSDKIdentityEndpointAttributes * _Nullable endpointAttributes; /**

The name of the AppInstanceUserEndpoint.

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

The ARN of the resource to which the endpoint belongs.

*/ @property (nonatomic, strong) NSString * _Nullable resourceArn; /**

The type of the AppInstanceUserEndpoint. Supported types:

  • APNS: The mobile notification service for an Apple device.

  • APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.

  • GCM: The mobile notification service for an Android device.

Populate the ResourceArn value of each type as PinpointAppArn.

*/ @property (nonatomic, assign) AWSChimeSDKIdentityAppInstanceUserEndpointType types; @end /** */ @interface AWSChimeSDKIdentityRegisterAppInstanceUserEndpointResponse : AWSModel /**

The ARN of the AppInstanceUser.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceUserArn; /**

The unique identifier of the AppInstanceUserEndpoint.

*/ @property (nonatomic, strong) NSString * _Nullable endpointId; @end /**

A tag object containing a key-value pair.

Required parameters: [Key, Value] */ @interface AWSChimeSDKIdentityTag : AWSModel /**

The key in a tag.

*/ @property (nonatomic, strong) NSString * _Nullable key; /**

The value in a tag.

*/ @property (nonatomic, strong) NSString * _Nullable value; @end /** */ @interface AWSChimeSDKIdentityTagResourceRequest : AWSRequest /**

The resource ARN.

*/ @property (nonatomic, strong) NSString * _Nullable resourceARN; /**

The tag key-value pairs.

*/ @property (nonatomic, strong) NSArray * _Nullable tags; @end /** */ @interface AWSChimeSDKIdentityUntagResourceRequest : AWSRequest /**

The resource ARN.

*/ @property (nonatomic, strong) NSString * _Nullable resourceARN; /**

The tag keys.

*/ @property (nonatomic, strong) NSArray * _Nullable tagKeys; @end /** */ @interface AWSChimeSDKIdentityUpdateAppInstanceBotRequest : AWSRequest /**

The ARN of the AppInstanceBot.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceBotArn; /**

The configuration for the bot update.

*/ @property (nonatomic, strong) AWSChimeSDKIdentityConfiguration * _Nullable configuration; /**

The metadata of the AppInstanceBot.

*/ @property (nonatomic, strong) NSString * _Nullable metadata; /**

The name of the AppInstanceBot.

*/ @property (nonatomic, strong) NSString * _Nullable name; @end /** */ @interface AWSChimeSDKIdentityUpdateAppInstanceBotResponse : AWSModel /**

The ARN of the AppInstanceBot.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceBotArn; @end /** */ @interface AWSChimeSDKIdentityUpdateAppInstanceRequest : AWSRequest /**

The ARN of the AppInstance.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceArn; /**

The metadata that you want to change.

*/ @property (nonatomic, strong) NSString * _Nullable metadata; /**

The name that you want to change.

*/ @property (nonatomic, strong) NSString * _Nullable name; @end /** */ @interface AWSChimeSDKIdentityUpdateAppInstanceResponse : AWSModel /**

The ARN of the AppInstance.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceArn; @end /** */ @interface AWSChimeSDKIdentityUpdateAppInstanceUserEndpointRequest : AWSRequest /**

Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.

*/ @property (nonatomic, assign) AWSChimeSDKIdentityAllowMessages allowMessages; /**

The ARN of the AppInstanceUser.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceUserArn; /**

The unique identifier of the AppInstanceUserEndpoint.

*/ @property (nonatomic, strong) NSString * _Nullable endpointId; /**

The name of the AppInstanceUserEndpoint.

*/ @property (nonatomic, strong) NSString * _Nullable name; @end /** */ @interface AWSChimeSDKIdentityUpdateAppInstanceUserEndpointResponse : AWSModel /**

The ARN of the AppInstanceUser.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceUserArn; /**

The unique identifier of the AppInstanceUserEndpoint.

*/ @property (nonatomic, strong) NSString * _Nullable endpointId; @end /** */ @interface AWSChimeSDKIdentityUpdateAppInstanceUserRequest : AWSRequest /**

The ARN of the AppInstanceUser.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceUserArn; /**

The metadata of the AppInstanceUser.

*/ @property (nonatomic, strong) NSString * _Nullable metadata; /**

The name of the AppInstanceUser.

*/ @property (nonatomic, strong) NSString * _Nullable name; @end /** */ @interface AWSChimeSDKIdentityUpdateAppInstanceUserResponse : AWSModel /**

The ARN of the AppInstanceUser.

*/ @property (nonatomic, strong) NSString * _Nullable appInstanceUserArn; @end NS_ASSUME_NONNULL_END