AWSChimeSDKIdentity

Objective-C

@interface AWSChimeSDKIdentity

Swift

class 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.

  • The service configuration used to instantiate this service client.

    Warning

    Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration

  • Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with defaultServiceConfiguration from [AWSServiceManager defaultServiceManager]. The reference to this object is maintained by the SDK, and you do not need to retain it manually.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
   let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
   let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider)
   AWSServiceManager.default().defaultServiceConfiguration = configuration

   return true

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
     AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                     identityPoolId:@"YourIdentityPoolId"];
     AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1
                                                                          credentialsProvider:credentialsProvider];
     [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration;

     return YES;
 }

    Then call the following to get the default service client:

    Swift

    let ChimeSDKIdentity = AWSChimeSDKIdentity.default()

    Objective-C

    AWSChimeSDKIdentity *ChimeSDKIdentity = [AWSChimeSDKIdentity defaultChimeSDKIdentity];

    Declaration

    Objective-C

    + (nonnull instancetype)defaultChimeSDKIdentity;

    Swift

    class func `default`() -> Self

    Return Value

    The default service client.

  • Creates a service client with the given service configuration and registers it for the key.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
   let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
   let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
   AWSChimeSDKIdentity.register(with: configuration!, forKey: "USWest2ChimeSDKIdentity")

   return true

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                    identityPoolId:@"YourIdentityPoolId"];
    AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                         credentialsProvider:credentialsProvider];

    [AWSChimeSDKIdentity registerChimeSDKIdentityWithConfiguration:configuration forKey:@"USWest2ChimeSDKIdentity"];

    return YES;
}

    Then call the following to get the service client:

    Swift

    let ChimeSDKIdentity = AWSChimeSDKIdentity(forKey: "USWest2ChimeSDKIdentity")

    Objective-C

    AWSChimeSDKIdentity *ChimeSDKIdentity = [AWSChimeSDKIdentity ChimeSDKIdentityForKey:@"USWest2ChimeSDKIdentity"];

    Warning

    After calling this method, do not modify the configuration object. It may cause unspecified behaviors.

    Declaration

    Objective-C

    + (void)registerChimeSDKIdentityWithConfiguration:(id)configuration
                                           forKey:(nonnull NSString *)key;

    Swift

    class func register(withConfiguration configuration: Any!, forKey key: String)

    Parameters

    configuration

    A service configuration object.
    key

    A string to identify the service client.

  • Retrieves the service client associated with the key. You need to call + registerChimeSDKIdentityWithConfiguration:forKey: before invoking this method.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
   let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
   let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
   AWSChimeSDKIdentity.register(with: configuration!, forKey: "USWest2ChimeSDKIdentity")

   return true

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                    identityPoolId:@"YourIdentityPoolId"];
    AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                         credentialsProvider:credentialsProvider];

    [AWSChimeSDKIdentity registerChimeSDKIdentityWithConfiguration:configuration forKey:@"USWest2ChimeSDKIdentity"];

    return YES;
}

    Then call the following to get the service client:

    Swift

    let ChimeSDKIdentity = AWSChimeSDKIdentity(forKey: "USWest2ChimeSDKIdentity")

    Objective-C

    AWSChimeSDKIdentity *ChimeSDKIdentity = [AWSChimeSDKIdentity ChimeSDKIdentityForKey:@"USWest2ChimeSDKIdentity"];

    Declaration

    Objective-C

    + (nonnull instancetype)ChimeSDKIdentityForKey:(nonnull NSString *)key;

    Swift

    convenience init(forKey key: String)

    Parameters

    key

    A string to identify the service client.

    Return Value

    An instance of the service client.

  • Removes the service client associated with the key and release it.

    Warning

    Before calling this method, make sure no method is running on this client.

    Declaration

    Objective-C

    + (void)removeChimeSDKIdentityForKey:(nonnull NSString *)key;

    Swift

    class func remove(forKey key: String)

    Parameters

    key

    A string to identify the service client.

  • Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.

    identity

    See

    AWSChimeSDKIdentityCreateAppInstanceRequest

    See

    AWSChimeSDKIdentityCreateAppInstanceResponse

    Declaration

    Objective-C

    - (id)createAppInstance:
    (nonnull AWSChimeSDKIdentityCreateAppInstanceRequest *)request;

    Swift

    func createAppInstance(_ request: AWSChimeSDKIdentityCreateAppInstanceRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateAppInstance service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKIdentityCreateAppInstanceResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.

    identity

    See

    AWSChimeSDKIdentityCreateAppInstanceRequest

    See

    AWSChimeSDKIdentityCreateAppInstanceResponse

    Declaration

    Objective-C

    - (void)createAppInstance:
            (nonnull AWSChimeSDKIdentityCreateAppInstanceRequest *)request
        completionHandler:
            (void (^_Nullable)(
                AWSChimeSDKIdentityCreateAppInstanceResponse *_Nullable,
                NSError *_Nullable))completionHandler;

    Swift

    func createAppInstance(_ request: AWSChimeSDKIdentityCreateAppInstanceRequest) async throws -> AWSChimeSDKIdentityCreateAppInstanceResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateAppInstance service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Promotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin. The promoted entity can perform the following actions.

    • ChannelModerator actions across all channels in the AppInstance.

    • DeleteChannelMessage actions.

    Only an AppInstanceUser and AppInstanceBot can be promoted to an AppInstanceAdmin role.

    See

    AWSChimeSDKIdentityCreateAppInstanceAdminRequest

    See

    AWSChimeSDKIdentityCreateAppInstanceAdminResponse

    Declaration

    Objective-C

    - (id)createAppInstanceAdmin:
    (nonnull AWSChimeSDKIdentityCreateAppInstanceAdminRequest *)request;

    Swift

    func createAppInstanceAdmin(_ request: AWSChimeSDKIdentityCreateAppInstanceAdminRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateAppInstanceAdmin service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKIdentityCreateAppInstanceAdminResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Promotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin. The promoted entity can perform the following actions.

    • ChannelModerator actions across all channels in the AppInstance.

    • DeleteChannelMessage actions.

    Only an AppInstanceUser and AppInstanceBot can be promoted to an AppInstanceAdmin role.

    See

    AWSChimeSDKIdentityCreateAppInstanceAdminRequest

    See

    AWSChimeSDKIdentityCreateAppInstanceAdminResponse

    Declaration

    Objective-C

    - (void)
    createAppInstanceAdmin:
        (nonnull AWSChimeSDKIdentityCreateAppInstanceAdminRequest *)request
         completionHandler:
             (void (^_Nullable)(
                 AWSChimeSDKIdentityCreateAppInstanceAdminResponse *_Nullable,
                 NSError *_Nullable))completionHandler;

    Swift

    func createAppInstanceAdmin(_ request: AWSChimeSDKIdentityCreateAppInstanceAdminRequest) async throws -> AWSChimeSDKIdentityCreateAppInstanceAdminResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateAppInstanceAdmin service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Creates a bot under an Amazon Chime AppInstance. The request consists of a unique Configuration and Name for that bot.

    See

    AWSChimeSDKIdentityCreateAppInstanceBotRequest

    See

    AWSChimeSDKIdentityCreateAppInstanceBotResponse

    Declaration

    Objective-C

    - (id)createAppInstanceBot:
    (nonnull AWSChimeSDKIdentityCreateAppInstanceBotRequest *)request;

    Swift

    func createAppInstanceBot(_ request: AWSChimeSDKIdentityCreateAppInstanceBotRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateAppInstanceBot service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKIdentityCreateAppInstanceBotResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Creates a bot under an Amazon Chime AppInstance. The request consists of a unique Configuration and Name for that bot.

    See

    AWSChimeSDKIdentityCreateAppInstanceBotRequest

    See

    AWSChimeSDKIdentityCreateAppInstanceBotResponse

    Declaration

    Objective-C

    - (void)createAppInstanceBot:
            (nonnull AWSChimeSDKIdentityCreateAppInstanceBotRequest *)request
           completionHandler:
               (void (^_Nullable)(
                   AWSChimeSDKIdentityCreateAppInstanceBotResponse *_Nullable,
                   NSError *_Nullable))completionHandler;

    Swift

    func createAppInstanceBot(_ request: AWSChimeSDKIdentityCreateAppInstanceBotRequest) async throws -> AWSChimeSDKIdentityCreateAppInstanceBotResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateAppInstanceBot service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.

    See

    AWSChimeSDKIdentityCreateAppInstanceUserRequest

    See

    AWSChimeSDKIdentityCreateAppInstanceUserResponse

    Declaration

    Objective-C

    - (id)createAppInstanceUser:
    (nonnull AWSChimeSDKIdentityCreateAppInstanceUserRequest *)request;

    Swift

    func createAppInstanceUser(_ request: AWSChimeSDKIdentityCreateAppInstanceUserRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateAppInstanceUser service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKIdentityCreateAppInstanceUserResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.

    See

    AWSChimeSDKIdentityCreateAppInstanceUserRequest

    See

    AWSChimeSDKIdentityCreateAppInstanceUserResponse

    Declaration

    Objective-C

    - (void)createAppInstanceUser:
            (nonnull AWSChimeSDKIdentityCreateAppInstanceUserRequest *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSChimeSDKIdentityCreateAppInstanceUserResponse *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func createAppInstanceUser(_ request: AWSChimeSDKIdentityCreateAppInstanceUserRequest) async throws -> AWSChimeSDKIdentityCreateAppInstanceUserResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateAppInstanceUser service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Deletes an AppInstance and all associated data asynchronously.

    See

    AWSChimeSDKIdentityDeleteAppInstanceRequest

    Declaration

    Objective-C

    - (id)deleteAppInstance:
    (nonnull AWSChimeSDKIdentityDeleteAppInstanceRequest *)request;

    Swift

    func deleteAppInstance(_ request: AWSChimeSDKIdentityDeleteAppInstanceRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteAppInstance service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Deletes an AppInstance and all associated data asynchronously.

    See

    AWSChimeSDKIdentityDeleteAppInstanceRequest

    Declaration

    Objective-C

    - (void)deleteAppInstance:
            (nonnull AWSChimeSDKIdentityDeleteAppInstanceRequest *)request
        completionHandler:
            (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteAppInstance(_ request: AWSChimeSDKIdentityDeleteAppInstanceRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeleteAppInstance service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Demotes an AppInstanceAdmin to an AppInstanceUser or AppInstanceBot. This action does not delete the user.

    See

    AWSChimeSDKIdentityDeleteAppInstanceAdminRequest

    Declaration

    Objective-C

    - (id)deleteAppInstanceAdmin:
    (nonnull AWSChimeSDKIdentityDeleteAppInstanceAdminRequest *)request;

    Swift

    func deleteAppInstanceAdmin(_ request: AWSChimeSDKIdentityDeleteAppInstanceAdminRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteAppInstanceAdmin service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Demotes an AppInstanceAdmin to an AppInstanceUser or AppInstanceBot. This action does not delete the user.

    See

    AWSChimeSDKIdentityDeleteAppInstanceAdminRequest

    Declaration

    Objective-C

    - (void)deleteAppInstanceAdmin:
            (nonnull AWSChimeSDKIdentityDeleteAppInstanceAdminRequest *)request
             completionHandler:
                 (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteAppInstanceAdmin(_ request: AWSChimeSDKIdentityDeleteAppInstanceAdminRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeleteAppInstanceAdmin service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Deletes an AppInstanceBot.

    See

    AWSChimeSDKIdentityDeleteAppInstanceBotRequest

    Declaration

    Objective-C

    - (id)deleteAppInstanceBot:
    (nonnull AWSChimeSDKIdentityDeleteAppInstanceBotRequest *)request;

    Swift

    func deleteAppInstanceBot(_ request: AWSChimeSDKIdentityDeleteAppInstanceBotRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteAppInstanceBot service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Deletes an AppInstanceBot.

    See

    AWSChimeSDKIdentityDeleteAppInstanceBotRequest

    Declaration

    Objective-C

    - (void)deleteAppInstanceBot:
            (nonnull AWSChimeSDKIdentityDeleteAppInstanceBotRequest *)request
           completionHandler:
               (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteAppInstanceBot(_ request: AWSChimeSDKIdentityDeleteAppInstanceBotRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeleteAppInstanceBot service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Deletes an AppInstanceUser.

    See

    AWSChimeSDKIdentityDeleteAppInstanceUserRequest

    Declaration

    Objective-C

    - (id)deleteAppInstanceUser:
    (nonnull AWSChimeSDKIdentityDeleteAppInstanceUserRequest *)request;

    Swift

    func deleteAppInstanceUser(_ request: AWSChimeSDKIdentityDeleteAppInstanceUserRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteAppInstanceUser service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Deletes an AppInstanceUser.

    See

    AWSChimeSDKIdentityDeleteAppInstanceUserRequest

    Declaration

    Objective-C

    - (void)deleteAppInstanceUser:
            (nonnull AWSChimeSDKIdentityDeleteAppInstanceUserRequest *)request
            completionHandler:
                (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteAppInstanceUser(_ request: AWSChimeSDKIdentityDeleteAppInstanceUserRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeleteAppInstanceUser service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Deregisters an AppInstanceUserEndpoint.

    See

    AWSChimeSDKIdentityDeregisterAppInstanceUserEndpointRequest

    Declaration

    Objective-C

    - (id)deregisterAppInstanceUserEndpoint:
    (nonnull AWSChimeSDKIdentityDeregisterAppInstanceUserEndpointRequest *)
        request;

    Swift

    func deregisterAppInstanceUserEndpoint(_ request: AWSChimeSDKIdentityDeregisterAppInstanceUserEndpointRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeregisterAppInstanceUserEndpoint service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Deregisters an AppInstanceUserEndpoint.

    See

    AWSChimeSDKIdentityDeregisterAppInstanceUserEndpointRequest

    Declaration

    Objective-C

    - (void)
    deregisterAppInstanceUserEndpoint:
        (nonnull AWSChimeSDKIdentityDeregisterAppInstanceUserEndpointRequest *)
            request
                    completionHandler:(void (^_Nullable)(NSError *_Nullable))
                                          completionHandler;

    Swift

    func deregisterAppInstanceUserEndpoint(_ request: AWSChimeSDKIdentityDeregisterAppInstanceUserEndpointRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeregisterAppInstanceUserEndpoint service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Returns the full details of an AppInstance.

    See

    AWSChimeSDKIdentityDescribeAppInstanceRequest

    See

    AWSChimeSDKIdentityDescribeAppInstanceResponse

    Declaration

    Objective-C

    - (id)describeAppInstance:
    (nonnull AWSChimeSDKIdentityDescribeAppInstanceRequest *)request;

    Swift

    func describeAppInstance(_ request: AWSChimeSDKIdentityDescribeAppInstanceRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeAppInstance service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKIdentityDescribeAppInstanceResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Returns the full details of an AppInstance.

    See

    AWSChimeSDKIdentityDescribeAppInstanceRequest

    See

    AWSChimeSDKIdentityDescribeAppInstanceResponse

    Declaration

    Objective-C

    - (void)describeAppInstance:
            (nonnull AWSChimeSDKIdentityDescribeAppInstanceRequest *)request
          completionHandler:
              (void (^_Nullable)(
                  AWSChimeSDKIdentityDescribeAppInstanceResponse *_Nullable,
                  NSError *_Nullable))completionHandler;

    Swift

    func describeAppInstance(_ request: AWSChimeSDKIdentityDescribeAppInstanceRequest) async throws -> AWSChimeSDKIdentityDescribeAppInstanceResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeAppInstance service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Returns the full details of an AppInstanceAdmin.

    See

    AWSChimeSDKIdentityDescribeAppInstanceAdminRequest

    See

    AWSChimeSDKIdentityDescribeAppInstanceAdminResponse

    Declaration

    Objective-C

    - (id)describeAppInstanceAdmin:
    (nonnull AWSChimeSDKIdentityDescribeAppInstanceAdminRequest *)request;

    Swift

    func describeAppInstanceAdmin(_ request: AWSChimeSDKIdentityDescribeAppInstanceAdminRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeAppInstanceAdmin service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKIdentityDescribeAppInstanceAdminResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Returns the full details of an AppInstanceAdmin.

    See

    AWSChimeSDKIdentityDescribeAppInstanceAdminRequest

    See

    AWSChimeSDKIdentityDescribeAppInstanceAdminResponse

    Declaration

    Objective-C

    - (void)describeAppInstanceAdmin:
            (nonnull AWSChimeSDKIdentityDescribeAppInstanceAdminRequest *)
                request
               completionHandler:
                   (void (^_Nullable)(
                       AWSChimeSDKIdentityDescribeAppInstanceAdminResponse
                           *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func describeAppInstanceAdmin(_ request: AWSChimeSDKIdentityDescribeAppInstanceAdminRequest) async throws -> AWSChimeSDKIdentityDescribeAppInstanceAdminResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeAppInstanceAdmin service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • The AppInstanceBot's information.

    See

    AWSChimeSDKIdentityDescribeAppInstanceBotRequest

    See

    AWSChimeSDKIdentityDescribeAppInstanceBotResponse

    Declaration

    Objective-C

    - (id)describeAppInstanceBot:
    (nonnull AWSChimeSDKIdentityDescribeAppInstanceBotRequest *)request;

    Swift

    func describeAppInstanceBot(_ request: AWSChimeSDKIdentityDescribeAppInstanceBotRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeAppInstanceBot service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKIdentityDescribeAppInstanceBotResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorNotFound, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • The AppInstanceBot's information.

    See

    AWSChimeSDKIdentityDescribeAppInstanceBotRequest

    See

    AWSChimeSDKIdentityDescribeAppInstanceBotResponse

    Declaration

    Objective-C

    - (void)
    describeAppInstanceBot:
        (nonnull AWSChimeSDKIdentityDescribeAppInstanceBotRequest *)request
         completionHandler:
             (void (^_Nullable)(
                 AWSChimeSDKIdentityDescribeAppInstanceBotResponse *_Nullable,
                 NSError *_Nullable))completionHandler;

    Swift

    func describeAppInstanceBot(_ request: AWSChimeSDKIdentityDescribeAppInstanceBotRequest) async throws -> AWSChimeSDKIdentityDescribeAppInstanceBotResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeAppInstanceBot service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorNotFound, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Returns the full details of an AppInstanceUser.

    See

    AWSChimeSDKIdentityDescribeAppInstanceUserRequest

    See

    AWSChimeSDKIdentityDescribeAppInstanceUserResponse

    Declaration

    Objective-C

    - (id)describeAppInstanceUser:
    (nonnull AWSChimeSDKIdentityDescribeAppInstanceUserRequest *)request;

    Swift

    func describeAppInstanceUser(_ request: AWSChimeSDKIdentityDescribeAppInstanceUserRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeAppInstanceUser service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKIdentityDescribeAppInstanceUserResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Returns the full details of an AppInstanceUser.

    See

    AWSChimeSDKIdentityDescribeAppInstanceUserRequest

    See

    AWSChimeSDKIdentityDescribeAppInstanceUserResponse

    Declaration

    Objective-C

    - (void)
    describeAppInstanceUser:
        (nonnull AWSChimeSDKIdentityDescribeAppInstanceUserRequest *)request
          completionHandler:
              (void (^_Nullable)(
                  AWSChimeSDKIdentityDescribeAppInstanceUserResponse *_Nullable,
                  NSError *_Nullable))completionHandler;

    Swift

    func describeAppInstanceUser(_ request: AWSChimeSDKIdentityDescribeAppInstanceUserRequest) async throws -> AWSChimeSDKIdentityDescribeAppInstanceUserResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeAppInstanceUser service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Returns the full details of an AppInstanceUserEndpoint.

    See

    AWSChimeSDKIdentityDescribeAppInstanceUserEndpointRequest

    See

    AWSChimeSDKIdentityDescribeAppInstanceUserEndpointResponse

    Declaration

    Objective-C

    - (id)describeAppInstanceUserEndpoint:
    (nonnull AWSChimeSDKIdentityDescribeAppInstanceUserEndpointRequest *)
        request;

    Swift

    func describeAppInstanceUserEndpoint(_ request: AWSChimeSDKIdentityDescribeAppInstanceUserEndpointRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeAppInstanceUserEndpoint service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKIdentityDescribeAppInstanceUserEndpointResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Returns the full details of an AppInstanceUserEndpoint.

    See

    AWSChimeSDKIdentityDescribeAppInstanceUserEndpointRequest

    See

    AWSChimeSDKIdentityDescribeAppInstanceUserEndpointResponse

    Declaration

    Objective-C

    - (void)
    describeAppInstanceUserEndpoint:
        (nonnull AWSChimeSDKIdentityDescribeAppInstanceUserEndpointRequest *)
            request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSChimeSDKIdentityDescribeAppInstanceUserEndpointResponse
                              *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func describeAppInstanceUserEndpoint(_ request: AWSChimeSDKIdentityDescribeAppInstanceUserEndpointRequest) async throws -> AWSChimeSDKIdentityDescribeAppInstanceUserEndpointResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeAppInstanceUserEndpoint service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Gets the retention settings for an AppInstance.

    See

    AWSChimeSDKIdentityGetAppInstanceRetentionSettingsRequest

    See

    AWSChimeSDKIdentityGetAppInstanceRetentionSettingsResponse

    Declaration

    Objective-C

    - (id)getAppInstanceRetentionSettings:
    (nonnull AWSChimeSDKIdentityGetAppInstanceRetentionSettingsRequest *)
        request;

    Swift

    func getAppInstanceRetentionSettings(_ request: AWSChimeSDKIdentityGetAppInstanceRetentionSettingsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetAppInstanceRetentionSettings service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKIdentityGetAppInstanceRetentionSettingsResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Gets the retention settings for an AppInstance.

    See

    AWSChimeSDKIdentityGetAppInstanceRetentionSettingsRequest

    See

    AWSChimeSDKIdentityGetAppInstanceRetentionSettingsResponse

    Declaration

    Objective-C

    - (void)
    getAppInstanceRetentionSettings:
        (nonnull AWSChimeSDKIdentityGetAppInstanceRetentionSettingsRequest *)
            request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSChimeSDKIdentityGetAppInstanceRetentionSettingsResponse
                              *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func appInstanceRetentionSettings(_ request: AWSChimeSDKIdentityGetAppInstanceRetentionSettingsRequest) async throws -> AWSChimeSDKIdentityGetAppInstanceRetentionSettingsResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetAppInstanceRetentionSettings service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Returns a list of the administrators in the AppInstance.

    See

    AWSChimeSDKIdentityListAppInstanceAdminsRequest

    See

    AWSChimeSDKIdentityListAppInstanceAdminsResponse

    Declaration

    Objective-C

    - (id)listAppInstanceAdmins:
    (nonnull AWSChimeSDKIdentityListAppInstanceAdminsRequest *)request;

    Swift

    func listAppInstanceAdmins(_ request: AWSChimeSDKIdentityListAppInstanceAdminsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListAppInstanceAdmins service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKIdentityListAppInstanceAdminsResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Returns a list of the administrators in the AppInstance.

    See

    AWSChimeSDKIdentityListAppInstanceAdminsRequest

    See

    AWSChimeSDKIdentityListAppInstanceAdminsResponse

    Declaration

    Objective-C

    - (void)listAppInstanceAdmins:
            (nonnull AWSChimeSDKIdentityListAppInstanceAdminsRequest *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSChimeSDKIdentityListAppInstanceAdminsResponse *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func listAppInstanceAdmins(_ request: AWSChimeSDKIdentityListAppInstanceAdminsRequest) async throws -> AWSChimeSDKIdentityListAppInstanceAdminsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListAppInstanceAdmins service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Lists all AppInstanceBots created under a single AppInstance.

    See

    AWSChimeSDKIdentityListAppInstanceBotsRequest

    See

    AWSChimeSDKIdentityListAppInstanceBotsResponse

    Declaration

    Objective-C

    - (id)listAppInstanceBots:
    (nonnull AWSChimeSDKIdentityListAppInstanceBotsRequest *)request;

    Swift

    func listAppInstanceBots(_ request: AWSChimeSDKIdentityListAppInstanceBotsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListAppInstanceBots service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKIdentityListAppInstanceBotsResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Lists all AppInstanceBots created under a single AppInstance.

    See

    AWSChimeSDKIdentityListAppInstanceBotsRequest

    See

    AWSChimeSDKIdentityListAppInstanceBotsResponse

    Declaration

    Objective-C

    - (void)listAppInstanceBots:
            (nonnull AWSChimeSDKIdentityListAppInstanceBotsRequest *)request
          completionHandler:
              (void (^_Nullable)(
                  AWSChimeSDKIdentityListAppInstanceBotsResponse *_Nullable,
                  NSError *_Nullable))completionHandler;

    Swift

    func listAppInstanceBots(_ request: AWSChimeSDKIdentityListAppInstanceBotsRequest) async throws -> AWSChimeSDKIdentityListAppInstanceBotsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListAppInstanceBots service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.

    See

    AWSChimeSDKIdentityListAppInstanceUserEndpointsRequest

    See

    AWSChimeSDKIdentityListAppInstanceUserEndpointsResponse

    Declaration

    Objective-C

    - (id)listAppInstanceUserEndpoints:
    (nonnull AWSChimeSDKIdentityListAppInstanceUserEndpointsRequest *)request;

    Swift

    func listAppInstanceUserEndpoints(_ request: AWSChimeSDKIdentityListAppInstanceUserEndpointsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListAppInstanceUserEndpoints service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKIdentityListAppInstanceUserEndpointsResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.

    See

    AWSChimeSDKIdentityListAppInstanceUserEndpointsRequest

    See

    AWSChimeSDKIdentityListAppInstanceUserEndpointsResponse

    Declaration

    Objective-C

    - (void)
    listAppInstanceUserEndpoints:
        (nonnull AWSChimeSDKIdentityListAppInstanceUserEndpointsRequest *)
            request
               completionHandler:
                   (void (^_Nullable)(
                       AWSChimeSDKIdentityListAppInstanceUserEndpointsResponse
                           *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func listAppInstanceUserEndpoints(_ request: AWSChimeSDKIdentityListAppInstanceUserEndpointsRequest) async throws -> AWSChimeSDKIdentityListAppInstanceUserEndpointsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListAppInstanceUserEndpoints service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • List all AppInstanceUsers created under a single AppInstance.

    See

    AWSChimeSDKIdentityListAppInstanceUsersRequest

    See

    AWSChimeSDKIdentityListAppInstanceUsersResponse

    Declaration

    Objective-C

    - (id)listAppInstanceUsers:
    (nonnull AWSChimeSDKIdentityListAppInstanceUsersRequest *)request;

    Swift

    func listAppInstanceUsers(_ request: AWSChimeSDKIdentityListAppInstanceUsersRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListAppInstanceUsers service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKIdentityListAppInstanceUsersResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • List all AppInstanceUsers created under a single AppInstance.

    See

    AWSChimeSDKIdentityListAppInstanceUsersRequest

    See

    AWSChimeSDKIdentityListAppInstanceUsersResponse

    Declaration

    Objective-C

    - (void)listAppInstanceUsers:
            (nonnull AWSChimeSDKIdentityListAppInstanceUsersRequest *)request
           completionHandler:
               (void (^_Nullable)(
                   AWSChimeSDKIdentityListAppInstanceUsersResponse *_Nullable,
                   NSError *_Nullable))completionHandler;

    Swift

    func listAppInstanceUsers(_ request: AWSChimeSDKIdentityListAppInstanceUsersRequest) async throws -> AWSChimeSDKIdentityListAppInstanceUsersResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListAppInstanceUsers service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Lists all Amazon Chime AppInstances created under a single AWS account.

    See

    AWSChimeSDKIdentityListAppInstancesRequest

    See

    AWSChimeSDKIdentityListAppInstancesResponse

    Declaration

    Objective-C

    - (id)listAppInstances:
    (nonnull AWSChimeSDKIdentityListAppInstancesRequest *)request;

    Swift

    func listAppInstances(_ request: AWSChimeSDKIdentityListAppInstancesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListAppInstances service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKIdentityListAppInstancesResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Lists all Amazon Chime AppInstances created under a single AWS account.

    See

    AWSChimeSDKIdentityListAppInstancesRequest

    See

    AWSChimeSDKIdentityListAppInstancesResponse

    Declaration

    Objective-C

    - (void)listAppInstances:
            (nonnull AWSChimeSDKIdentityListAppInstancesRequest *)request
       completionHandler:
           (void (^_Nullable)(
               AWSChimeSDKIdentityListAppInstancesResponse *_Nullable,
               NSError *_Nullable))completionHandler;

    Swift

    func listAppInstances(_ request: AWSChimeSDKIdentityListAppInstancesRequest) async throws -> AWSChimeSDKIdentityListAppInstancesResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListAppInstances service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Lists the tags applied to an Amazon Chime SDK identity resource.

    See

    AWSChimeSDKIdentityListTagsForResourceRequest

    See

    AWSChimeSDKIdentityListTagsForResourceResponse

    Declaration

    Objective-C

    - (id)listTagsForResource:
    (nonnull AWSChimeSDKIdentityListTagsForResourceRequest *)request;

    Swift

    func listTags(forResource request: AWSChimeSDKIdentityListTagsForResourceRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListTagsForResource service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKIdentityListTagsForResourceResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Lists the tags applied to an Amazon Chime SDK identity resource.

    See

    AWSChimeSDKIdentityListTagsForResourceRequest

    See

    AWSChimeSDKIdentityListTagsForResourceResponse

    Declaration

    Objective-C

    - (void)listTagsForResource:
            (nonnull AWSChimeSDKIdentityListTagsForResourceRequest *)request
          completionHandler:
              (void (^_Nullable)(
                  AWSChimeSDKIdentityListTagsForResourceResponse *_Nullable,
                  NSError *_Nullable))completionHandler;

    Swift

    func listTags(forResource request: AWSChimeSDKIdentityListTagsForResourceRequest) async throws -> AWSChimeSDKIdentityListTagsForResourceResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListTagsForResource service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Sets the amount of time in days that a given AppInstance retains data.

    See

    AWSChimeSDKIdentityPutAppInstanceRetentionSettingsRequest

    See

    AWSChimeSDKIdentityPutAppInstanceRetentionSettingsResponse

    Declaration

    Objective-C

    - (id)putAppInstanceRetentionSettings:
    (nonnull AWSChimeSDKIdentityPutAppInstanceRetentionSettingsRequest *)
        request;

    Swift

    func putAppInstanceRetentionSettings(_ request: AWSChimeSDKIdentityPutAppInstanceRetentionSettingsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the PutAppInstanceRetentionSettings service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKIdentityPutAppInstanceRetentionSettingsResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Sets the amount of time in days that a given AppInstance retains data.

    See

    AWSChimeSDKIdentityPutAppInstanceRetentionSettingsRequest

    See

    AWSChimeSDKIdentityPutAppInstanceRetentionSettingsResponse

    Declaration

    Objective-C

    - (void)
    putAppInstanceRetentionSettings:
        (nonnull AWSChimeSDKIdentityPutAppInstanceRetentionSettingsRequest *)
            request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSChimeSDKIdentityPutAppInstanceRetentionSettingsResponse
                              *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func putAppInstanceRetentionSettings(_ request: AWSChimeSDKIdentityPutAppInstanceRetentionSettingsRequest) async throws -> AWSChimeSDKIdentityPutAppInstanceRetentionSettingsResponse

    Parameters

    request

    A container for the necessary parameters to execute the PutAppInstanceRetentionSettings service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Sets the number of days before the AppInstanceUser is automatically deleted.

    A background process deletes expired AppInstanceUsers within 6 hours of expiration. Actual deletion times may vary.

    Expired AppInstanceUsers that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.

    See

    AWSChimeSDKIdentityPutAppInstanceUserExpirationSettingsRequest

    See

    AWSChimeSDKIdentityPutAppInstanceUserExpirationSettingsResponse

    Declaration

    Objective-C

    - (id)putAppInstanceUserExpirationSettings:
    (nonnull AWSChimeSDKIdentityPutAppInstanceUserExpirationSettingsRequest *)
        request;

    Swift

    func putAppInstanceUserExpirationSettings(_ request: AWSChimeSDKIdentityPutAppInstanceUserExpirationSettingsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the PutAppInstanceUserExpirationSettings service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKIdentityPutAppInstanceUserExpirationSettingsResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Sets the number of days before the AppInstanceUser is automatically deleted.

    A background process deletes expired AppInstanceUsers within 6 hours of expiration. Actual deletion times may vary.

    Expired AppInstanceUsers that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.

    See

    AWSChimeSDKIdentityPutAppInstanceUserExpirationSettingsRequest

    See

    AWSChimeSDKIdentityPutAppInstanceUserExpirationSettingsResponse

    Declaration

    Objective-C

    - (void)
    putAppInstanceUserExpirationSettings:
        (nonnull AWSChimeSDKIdentityPutAppInstanceUserExpirationSettingsRequest
             *)request
                       completionHandler:
                           (void (^_Nullable)(
                               AWSChimeSDKIdentityPutAppInstanceUserExpirationSettingsResponse
                                   *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func putAppInstanceUserExpirationSettings(_ request: AWSChimeSDKIdentityPutAppInstanceUserExpirationSettingsRequest) async throws -> AWSChimeSDKIdentityPutAppInstanceUserExpirationSettingsResponse

    Parameters

    request

    A container for the necessary parameters to execute the PutAppInstanceUserExpirationSettings service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

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

    See

    AWSChimeSDKIdentityRegisterAppInstanceUserEndpointRequest

    See

    AWSChimeSDKIdentityRegisterAppInstanceUserEndpointResponse

    Declaration

    Objective-C

    - (id)registerAppInstanceUserEndpoint:
    (nonnull AWSChimeSDKIdentityRegisterAppInstanceUserEndpointRequest *)
        request;

    Swift

    func registerAppInstanceUserEndpoint(_ request: AWSChimeSDKIdentityRegisterAppInstanceUserEndpointRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the RegisterAppInstanceUserEndpoint service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKIdentityRegisterAppInstanceUserEndpointResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

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

    See

    AWSChimeSDKIdentityRegisterAppInstanceUserEndpointRequest

    See

    AWSChimeSDKIdentityRegisterAppInstanceUserEndpointResponse

    Declaration

    Objective-C

    - (void)
    registerAppInstanceUserEndpoint:
        (nonnull AWSChimeSDKIdentityRegisterAppInstanceUserEndpointRequest *)
            request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSChimeSDKIdentityRegisterAppInstanceUserEndpointResponse
                              *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func registerAppInstanceUserEndpoint(_ request: AWSChimeSDKIdentityRegisterAppInstanceUserEndpointRequest) async throws -> AWSChimeSDKIdentityRegisterAppInstanceUserEndpointResponse

    Parameters

    request

    A container for the necessary parameters to execute the RegisterAppInstanceUserEndpoint service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Applies the specified tags to the specified Amazon Chime SDK identity resource.

    See

    AWSChimeSDKIdentityTagResourceRequest

    Declaration

    Objective-C

    - (id)tagResource:(nonnull AWSChimeSDKIdentityTagResourceRequest *)request;

    Swift

    func tagResource(_ request: AWSChimeSDKIdentityTagResourceRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the TagResource service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Applies the specified tags to the specified Amazon Chime SDK identity resource.

    See

    AWSChimeSDKIdentityTagResourceRequest

    Declaration

    Objective-C

    - (void)tagResource:(nonnull AWSChimeSDKIdentityTagResourceRequest *)request
    completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func tagResource(_ request: AWSChimeSDKIdentityTagResourceRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the TagResource service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Removes the specified tags from the specified Amazon Chime SDK identity resource.

    See

    AWSChimeSDKIdentityUntagResourceRequest

    Declaration

    Objective-C

    - (id)untagResource:(nonnull AWSChimeSDKIdentityUntagResourceRequest *)request;

    Swift

    func untagResource(_ request: AWSChimeSDKIdentityUntagResourceRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UntagResource service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Removes the specified tags from the specified Amazon Chime SDK identity resource.

    See

    AWSChimeSDKIdentityUntagResourceRequest

    Declaration

    Objective-C

    - (void)untagResource:(nonnull AWSChimeSDKIdentityUntagResourceRequest *)request
    completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func untagResource(_ request: AWSChimeSDKIdentityUntagResourceRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the UntagResource service method.
    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Updates AppInstance metadata.

    See

    AWSChimeSDKIdentityUpdateAppInstanceRequest

    See

    AWSChimeSDKIdentityUpdateAppInstanceResponse

    Declaration

    Objective-C

    - (id)updateAppInstance:
    (nonnull AWSChimeSDKIdentityUpdateAppInstanceRequest *)request;

    Swift

    func updateAppInstance(_ request: AWSChimeSDKIdentityUpdateAppInstanceRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateAppInstance service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKIdentityUpdateAppInstanceResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Updates AppInstance metadata.

    See

    AWSChimeSDKIdentityUpdateAppInstanceRequest

    See

    AWSChimeSDKIdentityUpdateAppInstanceResponse

    Declaration

    Objective-C

    - (void)updateAppInstance:
            (nonnull AWSChimeSDKIdentityUpdateAppInstanceRequest *)request
        completionHandler:
            (void (^_Nullable)(
                AWSChimeSDKIdentityUpdateAppInstanceResponse *_Nullable,
                NSError *_Nullable))completionHandler;

    Swift

    func updateAppInstance(_ request: AWSChimeSDKIdentityUpdateAppInstanceRequest) async throws -> AWSChimeSDKIdentityUpdateAppInstanceResponse

    Parameters

    request

    A container for the necessary parameters to execute the UpdateAppInstance service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Updates the name and metadata of an AppInstanceBot.

    See

    AWSChimeSDKIdentityUpdateAppInstanceBotRequest

    See

    AWSChimeSDKIdentityUpdateAppInstanceBotResponse

    Declaration

    Objective-C

    - (id)updateAppInstanceBot:
    (nonnull AWSChimeSDKIdentityUpdateAppInstanceBotRequest *)request;

    Swift

    func updateAppInstanceBot(_ request: AWSChimeSDKIdentityUpdateAppInstanceBotRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateAppInstanceBot service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKIdentityUpdateAppInstanceBotResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Updates the name and metadata of an AppInstanceBot.

    See

    AWSChimeSDKIdentityUpdateAppInstanceBotRequest

    See

    AWSChimeSDKIdentityUpdateAppInstanceBotResponse

    Declaration

    Objective-C

    - (void)updateAppInstanceBot:
            (nonnull AWSChimeSDKIdentityUpdateAppInstanceBotRequest *)request
           completionHandler:
               (void (^_Nullable)(
                   AWSChimeSDKIdentityUpdateAppInstanceBotResponse *_Nullable,
                   NSError *_Nullable))completionHandler;

    Swift

    func updateAppInstanceBot(_ request: AWSChimeSDKIdentityUpdateAppInstanceBotRequest) async throws -> AWSChimeSDKIdentityUpdateAppInstanceBotResponse

    Parameters

    request

    A container for the necessary parameters to execute the UpdateAppInstanceBot service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Updates the details of an AppInstanceUser. You can update names and metadata.

    See

    AWSChimeSDKIdentityUpdateAppInstanceUserRequest

    See

    AWSChimeSDKIdentityUpdateAppInstanceUserResponse

    Declaration

    Objective-C

    - (id)updateAppInstanceUser:
    (nonnull AWSChimeSDKIdentityUpdateAppInstanceUserRequest *)request;

    Swift

    func updateAppInstanceUser(_ request: AWSChimeSDKIdentityUpdateAppInstanceUserRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateAppInstanceUser service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKIdentityUpdateAppInstanceUserResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Updates the details of an AppInstanceUser. You can update names and metadata.

    See

    AWSChimeSDKIdentityUpdateAppInstanceUserRequest

    See

    AWSChimeSDKIdentityUpdateAppInstanceUserResponse

    Declaration

    Objective-C

    - (void)updateAppInstanceUser:
            (nonnull AWSChimeSDKIdentityUpdateAppInstanceUserRequest *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSChimeSDKIdentityUpdateAppInstanceUserResponse *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func updateAppInstanceUser(_ request: AWSChimeSDKIdentityUpdateAppInstanceUserRequest) async throws -> AWSChimeSDKIdentityUpdateAppInstanceUserResponse

    Parameters

    request

    A container for the necessary parameters to execute the UpdateAppInstanceUser service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorResourceLimitExceeded, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Updates the details of an AppInstanceUserEndpoint. You can update the name and AllowMessage values.

    See

    AWSChimeSDKIdentityUpdateAppInstanceUserEndpointRequest

    See

    AWSChimeSDKIdentityUpdateAppInstanceUserEndpointResponse

    Declaration

    Objective-C

    - (id)updateAppInstanceUserEndpoint:
    (nonnull AWSChimeSDKIdentityUpdateAppInstanceUserEndpointRequest *)request;

    Swift

    func updateAppInstanceUserEndpoint(_ request: AWSChimeSDKIdentityUpdateAppInstanceUserEndpointRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateAppInstanceUserEndpoint service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSChimeSDKIdentityUpdateAppInstanceUserEndpointResponse. On failed execution, task.error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.

  • Updates the details of an AppInstanceUserEndpoint. You can update the name and AllowMessage values.

    See

    AWSChimeSDKIdentityUpdateAppInstanceUserEndpointRequest

    See

    AWSChimeSDKIdentityUpdateAppInstanceUserEndpointResponse

    Declaration

    Objective-C

    - (void)
    updateAppInstanceUserEndpoint:
        (nonnull AWSChimeSDKIdentityUpdateAppInstanceUserEndpointRequest *)
            request
                completionHandler:
                    (void (^_Nullable)(
                        AWSChimeSDKIdentityUpdateAppInstanceUserEndpointResponse
                            *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func updateAppInstanceUserEndpoint(_ request: AWSChimeSDKIdentityUpdateAppInstanceUserEndpointRequest) async throws -> AWSChimeSDKIdentityUpdateAppInstanceUserEndpointResponse

    Parameters

    request

    A container for the necessary parameters to execute the UpdateAppInstanceUserEndpoint service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSChimeSDKIdentityErrorDomain domain and the following error code: AWSChimeSDKIdentityErrorBadRequest, AWSChimeSDKIdentityErrorConflict, AWSChimeSDKIdentityErrorForbidden, AWSChimeSDKIdentityErrorThrottledClient, AWSChimeSDKIdentityErrorUnauthorizedClient, AWSChimeSDKIdentityErrorServiceUnavailable, AWSChimeSDKIdentityErrorServiceFailure.