AWSIoT Class Reference

Inherits from AWSService : NSObject
Declared in AWSIoTService.h
AWSIoTService.m

Overview

AWS IoT

AWS IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.

For more information about how AWS IoT works, see the Developer Guide.

For information about how to use the credentials provider for AWS IoT, see Authorizing Direct Calls to AWS Services.

  configuration

The service configuration used to instantiate this service client.

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

Discussion

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

Declared In

AWSIoTService.h

+ defaultIoT

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.

+ (instancetype)defaultIoT

Return Value

The default service client.

Discussion

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 IoT = AWSIoT.default()

Objective-C

 AWSIoT *IoT = [AWSIoT defaultIoT];

Declared In

AWSIoTService.h

+ registerIoTWithConfiguration:forKey:

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

+ (void)registerIoTWithConfiguration:(AWSServiceConfiguration *)configuration forKey:(NSString *)key

Parameters

configuration

A service configuration object.

key

A string to identify the service client.

Discussion

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)
    AWSIoT.register(with: configuration!, forKey: "USWest2IoT")

    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];

     [AWSIoT registerIoTWithConfiguration:configuration forKey:@"USWest2IoT"];

     return YES;
 }

Then call the following to get the service client:

Swift

 let IoT = AWSIoT(forKey: "USWest2IoT")

Objective-C

 AWSIoT *IoT = [AWSIoT IoTForKey:@"USWest2IoT"];

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

Declared In

AWSIoTService.h

+ IoTForKey:

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

+ (instancetype)IoTForKey:(NSString *)key

Parameters

key

A string to identify the service client.

Return Value

An instance of the service client.

Discussion

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)
    AWSIoT.register(with: configuration!, forKey: "USWest2IoT")

    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];

     [AWSIoT registerIoTWithConfiguration:configuration forKey:@"USWest2IoT"];

     return YES;
 }

Then call the following to get the service client:

Swift

 let IoT = AWSIoT(forKey: "USWest2IoT")

Objective-C

 AWSIoT *IoT = [AWSIoT IoTForKey:@"USWest2IoT"];

Declared In

AWSIoTService.h

+ removeIoTForKey:

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

+ (void)removeIoTForKey:(NSString *)key

Parameters

key

A string to identify the service client.

Discussion

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

Declared In

AWSIoTService.h

– acceptCertificateTransfer:

Accepts a pending certificate transfer. The default state of the certificate is INACTIVE.

To check for pending certificate transfers, call ListCertificates to enumerate your certificates.

- (AWSTask *)acceptCertificateTransfer:(AWSIoTAcceptCertificateTransferRequest *)request

Parameters

request

A container for the necessary parameters to execute the AcceptCertificateTransfer 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorTransferAlreadyCompleted, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– acceptCertificateTransfer:completionHandler:

Accepts a pending certificate transfer. The default state of the certificate is INACTIVE.

To check for pending certificate transfers, call ListCertificates to enumerate your certificates.

- (void)acceptCertificateTransfer:(AWSIoTAcceptCertificateTransferRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the AcceptCertificateTransfer 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorTransferAlreadyCompleted, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– addThingToBillingGroup:

Adds a thing to a billing group.

- (AWSTask<AWSIoTAddThingToBillingGroupResponse*> *)addThingToBillingGroup:(AWSIoTAddThingToBillingGroupRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTAddThingToBillingGroupResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– addThingToBillingGroup:completionHandler:

Adds a thing to a billing group.

- (void)addThingToBillingGroup:(AWSIoTAddThingToBillingGroupRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTAddThingToBillingGroupResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the AddThingToBillingGroup 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– addThingToThingGroup:

Adds a thing to a thing group.

- (AWSTask<AWSIoTAddThingToThingGroupResponse*> *)addThingToThingGroup:(AWSIoTAddThingToThingGroupRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTAddThingToThingGroupResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– addThingToThingGroup:completionHandler:

Adds a thing to a thing group.

- (void)addThingToThingGroup:(AWSIoTAddThingToThingGroupRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTAddThingToThingGroupResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the AddThingToThingGroup 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– associateTargetsWithJob:

Associates a group with a continuous job. The following criteria must be met:

  • The job must have been created with the targetSelection field set to "CONTINUOUS".

  • The job status must currently be "IN_PROGRESS".

  • The total number of targets associated with a job must not exceed 100.

- (AWSTask<AWSIoTAssociateTargetsWithJobResponse*> *)associateTargetsWithJob:(AWSIoTAssociateTargetsWithJobRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTAssociateTargetsWithJobResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorLimitExceeded, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– associateTargetsWithJob:completionHandler:

Associates a group with a continuous job. The following criteria must be met:

  • The job must have been created with the targetSelection field set to "CONTINUOUS".

  • The job status must currently be "IN_PROGRESS".

  • The total number of targets associated with a job must not exceed 100.

- (void)associateTargetsWithJob:(AWSIoTAssociateTargetsWithJobRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTAssociateTargetsWithJobResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the AssociateTargetsWithJob 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorLimitExceeded, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– attachPolicy:

Attaches a policy to the specified target.

- (AWSTask *)attachPolicy:(AWSIoTAttachPolicyRequest *)request

Parameters

request

A container for the necessary parameters to execute the AttachPolicy 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorLimitExceeded.

Declared In

AWSIoTService.h

– attachPolicy:completionHandler:

Attaches a policy to the specified target.

- (void)attachPolicy:(AWSIoTAttachPolicyRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the AttachPolicy 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorLimitExceeded.

Declared In

AWSIoTService.h

– attachPrincipalPolicy:

Attaches the specified policy to the specified principal (certificate or other credential).

Note: This API is deprecated. Please use AttachPolicy instead.

- (AWSTask *)attachPrincipalPolicy:(AWSIoTAttachPrincipalPolicyRequest *)request

Parameters

request

A container for the necessary parameters to execute the AttachPrincipalPolicy 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorLimitExceeded.

Declared In

AWSIoTService.h

– attachPrincipalPolicy:completionHandler:

Attaches the specified policy to the specified principal (certificate or other credential).

Note: This API is deprecated. Please use AttachPolicy instead.

- (void)attachPrincipalPolicy:(AWSIoTAttachPrincipalPolicyRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the AttachPrincipalPolicy 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorLimitExceeded.

Declared In

AWSIoTService.h

– attachSecurityProfile:

Associates a Device Defender security profile with a thing group or with this account. Each thing group or account can have up to five security profiles associated with it.

- (AWSTask<AWSIoTAttachSecurityProfileResponse*> *)attachSecurityProfile:(AWSIoTAttachSecurityProfileRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTAttachSecurityProfileResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorLimitExceeded, AWSIoTErrorVersionConflict, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– attachSecurityProfile:completionHandler:

Associates a Device Defender security profile with a thing group or with this account. Each thing group or account can have up to five security profiles associated with it.

- (void)attachSecurityProfile:(AWSIoTAttachSecurityProfileRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTAttachSecurityProfileResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the AttachSecurityProfile 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorLimitExceeded, AWSIoTErrorVersionConflict, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– attachThingPrincipal:

Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

- (AWSTask<AWSIoTAttachThingPrincipalResponse*> *)attachThingPrincipal:(AWSIoTAttachThingPrincipalRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTAttachThingPrincipalResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– attachThingPrincipal:completionHandler:

Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

- (void)attachThingPrincipal:(AWSIoTAttachThingPrincipalRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTAttachThingPrincipalResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the AttachThingPrincipal 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– cancelAuditTask:

Cancels an audit that is in progress. The audit can be either scheduled or on-demand. If the audit is not in progress, an "InvalidRequestException" occurs.

- (AWSTask<AWSIoTCancelAuditTaskResponse*> *)cancelAuditTask:(AWSIoTCancelAuditTaskRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTCancelAuditTaskResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– cancelAuditTask:completionHandler:

Cancels an audit that is in progress. The audit can be either scheduled or on-demand. If the audit is not in progress, an "InvalidRequestException" occurs.

- (void)cancelAuditTask:(AWSIoTCancelAuditTaskRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTCancelAuditTaskResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CancelAuditTask 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– cancelCertificateTransfer:

Cancels a pending transfer for the specified certificate.

Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, AWS IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.

After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.

- (AWSTask *)cancelCertificateTransfer:(AWSIoTCancelCertificateTransferRequest *)request

Parameters

request

A container for the necessary parameters to execute the CancelCertificateTransfer 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorTransferAlreadyCompleted, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– cancelCertificateTransfer:completionHandler:

Cancels a pending transfer for the specified certificate.

Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, AWS IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.

After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.

- (void)cancelCertificateTransfer:(AWSIoTCancelCertificateTransferRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CancelCertificateTransfer 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorTransferAlreadyCompleted, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– cancelJob:

Cancels a job.

- (AWSTask<AWSIoTCancelJobResponse*> *)cancelJob:(AWSIoTCancelJobRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTCancelJobResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– cancelJob:completionHandler:

Cancels a job.

- (void)cancelJob:(AWSIoTCancelJobRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTCancelJobResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CancelJob 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– cancelJobExecution:

Cancels the execution of a job for a given thing.

- (AWSTask *)cancelJobExecution:(AWSIoTCancelJobExecutionRequest *)request

Parameters

request

A container for the necessary parameters to execute the CancelJobExecution 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInvalidStateTransition, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable, AWSIoTErrorVersionConflict.

Declared In

AWSIoTService.h

– cancelJobExecution:completionHandler:

Cancels the execution of a job for a given thing.

- (void)cancelJobExecution:(AWSIoTCancelJobExecutionRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CancelJobExecution 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInvalidStateTransition, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable, AWSIoTErrorVersionConflict.

Declared In

AWSIoTService.h

– clearDefaultAuthorizer:

Clears the default authorizer.

- (AWSTask<AWSIoTClearDefaultAuthorizerResponse*> *)clearDefaultAuthorizer:(AWSIoTClearDefaultAuthorizerRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTClearDefaultAuthorizerResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– clearDefaultAuthorizer:completionHandler:

Clears the default authorizer.

- (void)clearDefaultAuthorizer:(AWSIoTClearDefaultAuthorizerRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTClearDefaultAuthorizerResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ClearDefaultAuthorizer 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– createAuthorizer:

Creates an authorizer.

- (AWSTask<AWSIoTCreateAuthorizerResponse*> *)createAuthorizer:(AWSIoTCreateAuthorizerRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTCreateAuthorizerResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceAlreadyExists, AWSIoTErrorInvalidRequest, AWSIoTErrorLimitExceeded, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– createAuthorizer:completionHandler:

Creates an authorizer.

- (void)createAuthorizer:(AWSIoTCreateAuthorizerRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTCreateAuthorizerResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreateAuthorizer 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceAlreadyExists, AWSIoTErrorInvalidRequest, AWSIoTErrorLimitExceeded, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– createBillingGroup:

Creates a billing group.

- (AWSTask<AWSIoTCreateBillingGroupResponse*> *)createBillingGroup:(AWSIoTCreateBillingGroupRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTCreateBillingGroupResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceAlreadyExists, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– createBillingGroup:completionHandler:

Creates a billing group.

- (void)createBillingGroup:(AWSIoTCreateBillingGroupRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTCreateBillingGroupResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreateBillingGroup 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceAlreadyExists, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– createCertificateFromCsr:

Creates an X.509 certificate using the specified certificate signing request.

Note: The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves.

Note: Reusing the same certificate signing request (CSR) results in a distinct certificate.

You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs.

Assuming a set of CSRs are located inside of the directory my-csr-directory:

On Linux and OS X, the command is:

$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}

This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR.

The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process:

$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}

On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:

> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}

On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:

> forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"

- (AWSTask<AWSIoTCreateCertificateFromCsrResponse*> *)createCertificateFromCsr:(AWSIoTCreateCertificateFromCsrRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTCreateCertificateFromCsrResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– createCertificateFromCsr:completionHandler:

Creates an X.509 certificate using the specified certificate signing request.

Note: The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves.

Note: Reusing the same certificate signing request (CSR) results in a distinct certificate.

You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs.

Assuming a set of CSRs are located inside of the directory my-csr-directory:

On Linux and OS X, the command is:

$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}

This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR.

The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process:

$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}

On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:

> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}

On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:

> forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"

- (void)createCertificateFromCsr:(AWSIoTCreateCertificateFromCsrRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTCreateCertificateFromCsrResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreateCertificateFromCsr 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– createDynamicThingGroup:

Creates a dynamic thing group.

- (AWSTask<AWSIoTCreateDynamicThingGroupResponse*> *)createDynamicThingGroup:(AWSIoTCreateDynamicThingGroupRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTCreateDynamicThingGroupResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceAlreadyExists, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorInvalidQuery, AWSIoTErrorLimitExceeded.

Declared In

AWSIoTService.h

– createDynamicThingGroup:completionHandler:

Creates a dynamic thing group.

- (void)createDynamicThingGroup:(AWSIoTCreateDynamicThingGroupRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTCreateDynamicThingGroupResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreateDynamicThingGroup 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceAlreadyExists, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorInvalidQuery, AWSIoTErrorLimitExceeded.

Declared In

AWSIoTService.h

– createJob:

Creates a job.

- (AWSTask<AWSIoTCreateJobResponse*> *)createJob:(AWSIoTCreateJobRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTCreateJobResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorResourceAlreadyExists, AWSIoTErrorLimitExceeded, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– createJob:completionHandler:

Creates a job.

- (void)createJob:(AWSIoTCreateJobRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTCreateJobResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreateJob 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorResourceAlreadyExists, AWSIoTErrorLimitExceeded, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– createKeysAndCertificate:

Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.

Note This is the only time AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.

- (AWSTask<AWSIoTCreateKeysAndCertificateResponse*> *)createKeysAndCertificate:(AWSIoTCreateKeysAndCertificateRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTCreateKeysAndCertificateResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– createKeysAndCertificate:completionHandler:

Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.

Note This is the only time AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.

- (void)createKeysAndCertificate:(AWSIoTCreateKeysAndCertificateRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTCreateKeysAndCertificateResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreateKeysAndCertificate 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– createOTAUpdate:

Creates an AWS IoT OTAUpdate on a target group of things or groups.

- (AWSTask<AWSIoTCreateOTAUpdateResponse*> *)createOTAUpdate:(AWSIoTCreateOTAUpdateRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTCreateOTAUpdateResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorLimitExceeded, AWSIoTErrorResourceNotFound, AWSIoTErrorResourceAlreadyExists, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorInternalFailure, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– createOTAUpdate:completionHandler:

Creates an AWS IoT OTAUpdate on a target group of things or groups.

- (void)createOTAUpdate:(AWSIoTCreateOTAUpdateRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTCreateOTAUpdateResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreateOTAUpdate 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorLimitExceeded, AWSIoTErrorResourceNotFound, AWSIoTErrorResourceAlreadyExists, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorInternalFailure, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– createPolicy:

Creates an AWS IoT policy.

The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version.

- (AWSTask<AWSIoTCreatePolicyResponse*> *)createPolicy:(AWSIoTCreatePolicyRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTCreatePolicyResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceAlreadyExists, AWSIoTErrorMalformedPolicy, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– createPolicy:completionHandler:

Creates an AWS IoT policy.

The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version.

- (void)createPolicy:(AWSIoTCreatePolicyRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTCreatePolicyResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreatePolicy 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceAlreadyExists, AWSIoTErrorMalformedPolicy, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– createPolicyVersion:

Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.

Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

- (AWSTask<AWSIoTCreatePolicyVersionResponse*> *)createPolicyVersion:(AWSIoTCreatePolicyVersionRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTCreatePolicyVersionResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorMalformedPolicy, AWSIoTErrorVersionsLimitExceeded, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– createPolicyVersion:completionHandler:

Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.

Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

- (void)createPolicyVersion:(AWSIoTCreatePolicyVersionRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTCreatePolicyVersionResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreatePolicyVersion 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorMalformedPolicy, AWSIoTErrorVersionsLimitExceeded, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– createRoleAlias:

Creates a role alias.

- (AWSTask<AWSIoTCreateRoleAliasResponse*> *)createRoleAlias:(AWSIoTCreateRoleAliasRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTCreateRoleAliasResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceAlreadyExists, AWSIoTErrorInvalidRequest, AWSIoTErrorLimitExceeded, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– createRoleAlias:completionHandler:

Creates a role alias.

- (void)createRoleAlias:(AWSIoTCreateRoleAliasRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTCreateRoleAliasResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreateRoleAlias 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceAlreadyExists, AWSIoTErrorInvalidRequest, AWSIoTErrorLimitExceeded, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– createScheduledAudit:

Creates a scheduled audit that is run at a specified time interval.

- (AWSTask<AWSIoTCreateScheduledAuditResponse*> *)createScheduledAudit:(AWSIoTCreateScheduledAuditRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTCreateScheduledAuditResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorLimitExceeded.

Declared In

AWSIoTService.h

– createScheduledAudit:completionHandler:

Creates a scheduled audit that is run at a specified time interval.

- (void)createScheduledAudit:(AWSIoTCreateScheduledAuditRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTCreateScheduledAuditResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreateScheduledAudit 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorLimitExceeded.

Declared In

AWSIoTService.h

– createSecurityProfile:

Creates a Device Defender security profile.

- (AWSTask<AWSIoTCreateSecurityProfileResponse*> *)createSecurityProfile:(AWSIoTCreateSecurityProfileRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTCreateSecurityProfileResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceAlreadyExists, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– createSecurityProfile:completionHandler:

Creates a Device Defender security profile.

- (void)createSecurityProfile:(AWSIoTCreateSecurityProfileRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTCreateSecurityProfileResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreateSecurityProfile 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceAlreadyExists, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– createStream:

Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream. The total size of a file associated with the stream cannot exceed more than 2 MB. The stream will be created with version 0. If a stream is created with the same streamID as a stream that existed and was deleted within last 90 days, we will resurrect that old stream by incrementing the version by 1.

- (AWSTask<AWSIoTCreateStreamResponse*> *)createStream:(AWSIoTCreateStreamRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTCreateStreamResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorLimitExceeded, AWSIoTErrorResourceNotFound, AWSIoTErrorResourceAlreadyExists, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– createStream:completionHandler:

Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream. The total size of a file associated with the stream cannot exceed more than 2 MB. The stream will be created with version 0. If a stream is created with the same streamID as a stream that existed and was deleted within last 90 days, we will resurrect that old stream by incrementing the version by 1.

- (void)createStream:(AWSIoTCreateStreamRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTCreateStreamResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreateStream 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorLimitExceeded, AWSIoTErrorResourceNotFound, AWSIoTErrorResourceAlreadyExists, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– createThing:

Creates a thing record in the registry. If this call is made multiple times using the same thing name and configuration, the call will succeed. If this call is made with the same thing name but different configuration a ResourceAlreadyExistsException is thrown.

This is a control plane operation. See Authorization for information about authorizing control plane actions.

- (AWSTask<AWSIoTCreateThingResponse*> *)createThing:(AWSIoTCreateThingRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTCreateThingResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceAlreadyExists, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– createThing:completionHandler:

Creates a thing record in the registry. If this call is made multiple times using the same thing name and configuration, the call will succeed. If this call is made with the same thing name but different configuration a ResourceAlreadyExistsException is thrown.

This is a control plane operation. See Authorization for information about authorizing control plane actions.

- (void)createThing:(AWSIoTCreateThingRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTCreateThingResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreateThing 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceAlreadyExists, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– createThingGroup:

Create a thing group.

This is a control plane operation. See Authorization for information about authorizing control plane actions.

- (AWSTask<AWSIoTCreateThingGroupResponse*> *)createThingGroup:(AWSIoTCreateThingGroupRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTCreateThingGroupResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceAlreadyExists, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– createThingGroup:completionHandler:

Create a thing group.

This is a control plane operation. See Authorization for information about authorizing control plane actions.

- (void)createThingGroup:(AWSIoTCreateThingGroupRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTCreateThingGroupResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreateThingGroup 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceAlreadyExists, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– createThingType:

Creates a new thing type.

- (AWSTask<AWSIoTCreateThingTypeResponse*> *)createThingType:(AWSIoTCreateThingTypeRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTCreateThingTypeResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceAlreadyExists.

Declared In

AWSIoTService.h

– createThingType:completionHandler:

Creates a new thing type.

- (void)createThingType:(AWSIoTCreateThingTypeRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTCreateThingTypeResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreateThingType 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceAlreadyExists.

Declared In

AWSIoTService.h

– createTopicRule:

Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.

- (AWSTask *)createTopicRule:(AWSIoTCreateTopicRuleRequest *)request

Parameters

request

A container for the necessary parameters to execute the CreateTopicRule 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorSqlParse, AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorResourceAlreadyExists, AWSIoTErrorServiceUnavailable, AWSIoTErrorConflictingResourceUpdate.

Declared In

AWSIoTService.h

– createTopicRule:completionHandler:

Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.

- (void)createTopicRule:(AWSIoTCreateTopicRuleRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreateTopicRule 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorSqlParse, AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorResourceAlreadyExists, AWSIoTErrorServiceUnavailable, AWSIoTErrorConflictingResourceUpdate.

Declared In

AWSIoTService.h

– deleteAccountAuditConfiguration:

Restores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled.

- (AWSTask<AWSIoTDeleteAccountAuditConfigurationResponse*> *)deleteAccountAuditConfiguration:(AWSIoTDeleteAccountAuditConfigurationRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDeleteAccountAuditConfigurationResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– deleteAccountAuditConfiguration:completionHandler:

Restores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled.

- (void)deleteAccountAuditConfiguration:(AWSIoTDeleteAccountAuditConfigurationRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDeleteAccountAuditConfigurationResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteAccountAuditConfiguration 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– deleteAuthorizer:

Deletes an authorizer.

- (AWSTask<AWSIoTDeleteAuthorizerResponse*> *)deleteAuthorizer:(AWSIoTDeleteAuthorizerRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDeleteAuthorizerResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorDeleteConflict, AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– deleteAuthorizer:completionHandler:

Deletes an authorizer.

- (void)deleteAuthorizer:(AWSIoTDeleteAuthorizerRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDeleteAuthorizerResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteAuthorizer 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorDeleteConflict, AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– deleteBillingGroup:

Deletes the billing group.

- (AWSTask<AWSIoTDeleteBillingGroupResponse*> *)deleteBillingGroup:(AWSIoTDeleteBillingGroupRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDeleteBillingGroupResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorVersionConflict, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– deleteBillingGroup:completionHandler:

Deletes the billing group.

- (void)deleteBillingGroup:(AWSIoTDeleteBillingGroupRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDeleteBillingGroupResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteBillingGroup 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorVersionConflict, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– deleteCACertificate:

Deletes a registered CA certificate.

- (AWSTask<AWSIoTDeleteCACertificateResponse*> *)deleteCACertificate:(AWSIoTDeleteCACertificateRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDeleteCACertificateResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorCertificateState, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– deleteCACertificate:completionHandler:

Deletes a registered CA certificate.

- (void)deleteCACertificate:(AWSIoTDeleteCACertificateRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDeleteCACertificateResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteCACertificate 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorCertificateState, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– deleteCertificate:

Deletes the specified certificate.

A certificate cannot be deleted if it has a policy attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.

- (AWSTask *)deleteCertificate:(AWSIoTDeleteCertificateRequest *)request

Parameters

request

A container for the necessary parameters to execute the DeleteCertificate 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorCertificateState, AWSIoTErrorDeleteConflict, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– deleteCertificate:completionHandler:

Deletes the specified certificate.

A certificate cannot be deleted if it has a policy attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.

- (void)deleteCertificate:(AWSIoTDeleteCertificateRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteCertificate 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorCertificateState, AWSIoTErrorDeleteConflict, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– deleteDynamicThingGroup:

Deletes a dynamic thing group.

- (AWSTask<AWSIoTDeleteDynamicThingGroupResponse*> *)deleteDynamicThingGroup:(AWSIoTDeleteDynamicThingGroupRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDeleteDynamicThingGroupResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorVersionConflict, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– deleteDynamicThingGroup:completionHandler:

Deletes a dynamic thing group.

- (void)deleteDynamicThingGroup:(AWSIoTDeleteDynamicThingGroupRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDeleteDynamicThingGroupResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteDynamicThingGroup 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorVersionConflict, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– deleteJob:

Deletes a job and its related job executions.

Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". Attempting to delete or cancel a job whose status is already "DELETION_IN_PROGRESS" will result in an error.

Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException will occur.

- (AWSTask *)deleteJob:(AWSIoTDeleteJobRequest *)request

Parameters

request

A container for the necessary parameters to execute the DeleteJob 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInvalidStateTransition, AWSIoTErrorResourceNotFound, AWSIoTErrorLimitExceeded, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– deleteJob:completionHandler:

Deletes a job and its related job executions.

Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". Attempting to delete or cancel a job whose status is already "DELETION_IN_PROGRESS" will result in an error.

Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException will occur.

- (void)deleteJob:(AWSIoTDeleteJobRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteJob 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInvalidStateTransition, AWSIoTErrorResourceNotFound, AWSIoTErrorLimitExceeded, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– deleteJobExecution:

Deletes a job execution.

- (AWSTask *)deleteJobExecution:(AWSIoTDeleteJobExecutionRequest *)request

Parameters

request

A container for the necessary parameters to execute the DeleteJobExecution 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInvalidStateTransition, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– deleteJobExecution:completionHandler:

Deletes a job execution.

- (void)deleteJobExecution:(AWSIoTDeleteJobExecutionRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteJobExecution 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInvalidStateTransition, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– deleteOTAUpdate:

Delete an OTA update.

- (AWSTask<AWSIoTDeleteOTAUpdateResponse*> *)deleteOTAUpdate:(AWSIoTDeleteOTAUpdateRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDeleteOTAUpdateResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorInternalFailure, AWSIoTErrorServiceUnavailable, AWSIoTErrorVersionConflict.

Declared In

AWSIoTService.h

– deleteOTAUpdate:completionHandler:

Delete an OTA update.

- (void)deleteOTAUpdate:(AWSIoTDeleteOTAUpdateRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDeleteOTAUpdateResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteOTAUpdate 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorInternalFailure, AWSIoTErrorServiceUnavailable, AWSIoTErrorVersionConflict.

Declared In

AWSIoTService.h

– deletePolicy:

Deletes the specified policy.

A policy cannot be deleted if it has non-default versions or it is attached to any certificate.

To delete a policy, use the DeletePolicyVersion API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy.

When a policy is deleted using DeletePolicy, its default version is deleted with it.

- (AWSTask *)deletePolicy:(AWSIoTDeletePolicyRequest *)request

Parameters

request

A container for the necessary parameters to execute the DeletePolicy 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorDeleteConflict, AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– deletePolicy:completionHandler:

Deletes the specified policy.

A policy cannot be deleted if it has non-default versions or it is attached to any certificate.

To delete a policy, use the DeletePolicyVersion API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy.

When a policy is deleted using DeletePolicy, its default version is deleted with it.

- (void)deletePolicy:(AWSIoTDeletePolicyRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeletePolicy 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorDeleteConflict, AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– deletePolicyVersion:

Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.

- (AWSTask *)deletePolicyVersion:(AWSIoTDeletePolicyVersionRequest *)request

Parameters

request

A container for the necessary parameters to execute the DeletePolicyVersion 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorDeleteConflict, AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– deletePolicyVersion:completionHandler:

Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.

- (void)deletePolicyVersion:(AWSIoTDeletePolicyVersionRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeletePolicyVersion 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorDeleteConflict, AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– deleteRegistrationCode:

Deletes a CA certificate registration code.

- (AWSTask<AWSIoTDeleteRegistrationCodeResponse*> *)deleteRegistrationCode:(AWSIoTDeleteRegistrationCodeRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDeleteRegistrationCodeResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorThrottling, AWSIoTErrorResourceNotFound, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– deleteRegistrationCode:completionHandler:

Deletes a CA certificate registration code.

- (void)deleteRegistrationCode:(AWSIoTDeleteRegistrationCodeRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDeleteRegistrationCodeResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteRegistrationCode 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorThrottling, AWSIoTErrorResourceNotFound, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– deleteRoleAlias:

Deletes a role alias

- (AWSTask<AWSIoTDeleteRoleAliasResponse*> *)deleteRoleAlias:(AWSIoTDeleteRoleAliasRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDeleteRoleAliasResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorDeleteConflict, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– deleteRoleAlias:completionHandler:

Deletes a role alias

- (void)deleteRoleAlias:(AWSIoTDeleteRoleAliasRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDeleteRoleAliasResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteRoleAlias 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorDeleteConflict, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– deleteScheduledAudit:

Deletes a scheduled audit.

- (AWSTask<AWSIoTDeleteScheduledAuditResponse*> *)deleteScheduledAudit:(AWSIoTDeleteScheduledAuditRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDeleteScheduledAuditResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– deleteScheduledAudit:completionHandler:

Deletes a scheduled audit.

- (void)deleteScheduledAudit:(AWSIoTDeleteScheduledAuditRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDeleteScheduledAuditResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteScheduledAudit 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– deleteSecurityProfile:

Deletes a Device Defender security profile.

- (AWSTask<AWSIoTDeleteSecurityProfileResponse*> *)deleteSecurityProfile:(AWSIoTDeleteSecurityProfileRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDeleteSecurityProfileResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorVersionConflict.

Declared In

AWSIoTService.h

– deleteSecurityProfile:completionHandler:

Deletes a Device Defender security profile.

- (void)deleteSecurityProfile:(AWSIoTDeleteSecurityProfileRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDeleteSecurityProfileResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteSecurityProfile 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorVersionConflict.

Declared In

AWSIoTService.h

– deleteStream:

Deletes a stream.

- (AWSTask<AWSIoTDeleteStreamResponse*> *)deleteStream:(AWSIoTDeleteStreamRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDeleteStreamResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorDeleteConflict, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– deleteStream:completionHandler:

Deletes a stream.

- (void)deleteStream:(AWSIoTDeleteStreamRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDeleteStreamResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteStream 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorDeleteConflict, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– deleteThing:

Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.

- (AWSTask<AWSIoTDeleteThingResponse*> *)deleteThing:(AWSIoTDeleteThingRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDeleteThingResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorVersionConflict, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– deleteThing:completionHandler:

Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.

- (void)deleteThing:(AWSIoTDeleteThingRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDeleteThingResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteThing 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorVersionConflict, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– deleteThingGroup:

Deletes a thing group.

- (AWSTask<AWSIoTDeleteThingGroupResponse*> *)deleteThingGroup:(AWSIoTDeleteThingGroupRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDeleteThingGroupResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorVersionConflict, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– deleteThingGroup:completionHandler:

Deletes a thing group.

- (void)deleteThingGroup:(AWSIoTDeleteThingGroupRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDeleteThingGroupResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteThingGroup 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorVersionConflict, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– deleteThingType:

Deletes the specified thing type. You cannot delete a thing type if it has things associated with it. To delete a thing type, first mark it as deprecated by calling DeprecateThingType, then remove any associated things by calling UpdateThing to change the thing type on any associated thing, and finally use DeleteThingType to delete the thing type.

- (AWSTask<AWSIoTDeleteThingTypeResponse*> *)deleteThingType:(AWSIoTDeleteThingTypeRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDeleteThingTypeResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– deleteThingType:completionHandler:

Deletes the specified thing type. You cannot delete a thing type if it has things associated with it. To delete a thing type, first mark it as deprecated by calling DeprecateThingType, then remove any associated things by calling UpdateThing to change the thing type on any associated thing, and finally use DeleteThingType to delete the thing type.

- (void)deleteThingType:(AWSIoTDeleteThingTypeRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDeleteThingTypeResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteThingType 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– deleteTopicRule:

Deletes the rule.

- (AWSTask *)deleteTopicRule:(AWSIoTDeleteTopicRuleRequest *)request

Parameters

request

A container for the necessary parameters to execute the DeleteTopicRule 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable, AWSIoTErrorUnauthorized, AWSIoTErrorConflictingResourceUpdate.

Declared In

AWSIoTService.h

– deleteTopicRule:completionHandler:

Deletes the rule.

- (void)deleteTopicRule:(AWSIoTDeleteTopicRuleRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteTopicRule 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable, AWSIoTErrorUnauthorized, AWSIoTErrorConflictingResourceUpdate.

Declared In

AWSIoTService.h

– deleteV2LoggingLevel:

Deletes a logging level.

- (AWSTask *)deleteV2LoggingLevel:(AWSIoTDeleteV2LoggingLevelRequest *)request

Parameters

request

A container for the necessary parameters to execute the DeleteV2LoggingLevel 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– deleteV2LoggingLevel:completionHandler:

Deletes a logging level.

- (void)deleteV2LoggingLevel:(AWSIoTDeleteV2LoggingLevelRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteV2LoggingLevel 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– deprecateThingType:

Deprecates a thing type. You can not associate new things with deprecated thing type.

- (AWSTask<AWSIoTDeprecateThingTypeResponse*> *)deprecateThingType:(AWSIoTDeprecateThingTypeRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDeprecateThingTypeResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– deprecateThingType:completionHandler:

Deprecates a thing type. You can not associate new things with deprecated thing type.

- (void)deprecateThingType:(AWSIoTDeprecateThingTypeRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDeprecateThingTypeResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeprecateThingType 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– describeAccountAuditConfiguration:

Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.

- (AWSTask<AWSIoTDescribeAccountAuditConfigurationResponse*> *)describeAccountAuditConfiguration:(AWSIoTDescribeAccountAuditConfigurationRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDescribeAccountAuditConfigurationResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– describeAccountAuditConfiguration:completionHandler:

Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.

- (void)describeAccountAuditConfiguration:(AWSIoTDescribeAccountAuditConfigurationRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDescribeAccountAuditConfigurationResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeAccountAuditConfiguration 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– describeAuditTask:

Gets information about a Device Defender audit.

- (AWSTask<AWSIoTDescribeAuditTaskResponse*> *)describeAuditTask:(AWSIoTDescribeAuditTaskRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDescribeAuditTaskResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– describeAuditTask:completionHandler:

Gets information about a Device Defender audit.

- (void)describeAuditTask:(AWSIoTDescribeAuditTaskRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDescribeAuditTaskResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeAuditTask 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– describeAuthorizer:

Describes an authorizer.

- (AWSTask<AWSIoTDescribeAuthorizerResponse*> *)describeAuthorizer:(AWSIoTDescribeAuthorizerRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDescribeAuthorizerResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– describeAuthorizer:completionHandler:

Describes an authorizer.

- (void)describeAuthorizer:(AWSIoTDescribeAuthorizerRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDescribeAuthorizerResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeAuthorizer 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– describeBillingGroup:

Returns information about a billing group.

- (AWSTask<AWSIoTDescribeBillingGroupResponse*> *)describeBillingGroup:(AWSIoTDescribeBillingGroupRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDescribeBillingGroupResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– describeBillingGroup:completionHandler:

Returns information about a billing group.

- (void)describeBillingGroup:(AWSIoTDescribeBillingGroupRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDescribeBillingGroupResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeBillingGroup 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– describeCACertificate:

Describes a registered CA certificate.

- (AWSTask<AWSIoTDescribeCACertificateResponse*> *)describeCACertificate:(AWSIoTDescribeCACertificateRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDescribeCACertificateResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– describeCACertificate:completionHandler:

Describes a registered CA certificate.

- (void)describeCACertificate:(AWSIoTDescribeCACertificateRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDescribeCACertificateResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeCACertificate 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– describeCertificate:

Gets information about the specified certificate.

- (AWSTask<AWSIoTDescribeCertificateResponse*> *)describeCertificate:(AWSIoTDescribeCertificateRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDescribeCertificateResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– describeCertificate:completionHandler:

Gets information about the specified certificate.

- (void)describeCertificate:(AWSIoTDescribeCertificateRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDescribeCertificateResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeCertificate 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– describeDefaultAuthorizer:

Describes the default authorizer.

- (AWSTask<AWSIoTDescribeDefaultAuthorizerResponse*> *)describeDefaultAuthorizer:(AWSIoTDescribeDefaultAuthorizerRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDescribeDefaultAuthorizerResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– describeDefaultAuthorizer:completionHandler:

Describes the default authorizer.

- (void)describeDefaultAuthorizer:(AWSIoTDescribeDefaultAuthorizerRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDescribeDefaultAuthorizerResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeDefaultAuthorizer 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– describeEndpoint:

Returns a unique endpoint specific to the AWS account making the call.

- (AWSTask<AWSIoTDescribeEndpointResponse*> *)describeEndpoint:(AWSIoTDescribeEndpointRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDescribeEndpointResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternalFailure, AWSIoTErrorInvalidRequest, AWSIoTErrorUnauthorized, AWSIoTErrorThrottling.

Declared In

AWSIoTService.h

– describeEndpoint:completionHandler:

Returns a unique endpoint specific to the AWS account making the call.

- (void)describeEndpoint:(AWSIoTDescribeEndpointRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDescribeEndpointResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeEndpoint 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternalFailure, AWSIoTErrorInvalidRequest, AWSIoTErrorUnauthorized, AWSIoTErrorThrottling.

Declared In

AWSIoTService.h

– describeEventConfigurations:

Describes event configurations.

- (AWSTask<AWSIoTDescribeEventConfigurationsResponse*> *)describeEventConfigurations:(AWSIoTDescribeEventConfigurationsRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDescribeEventConfigurationsResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternalFailure, AWSIoTErrorThrottling.

Declared In

AWSIoTService.h

– describeEventConfigurations:completionHandler:

Describes event configurations.

- (void)describeEventConfigurations:(AWSIoTDescribeEventConfigurationsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDescribeEventConfigurationsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeEventConfigurations 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternalFailure, AWSIoTErrorThrottling.

Declared In

AWSIoTService.h

– describeIndex:

Describes a search index.

- (AWSTask<AWSIoTDescribeIndexResponse*> *)describeIndex:(AWSIoTDescribeIndexRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDescribeIndexResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– describeIndex:completionHandler:

Describes a search index.

- (void)describeIndex:(AWSIoTDescribeIndexRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDescribeIndexResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeIndex 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– describeJob:

Describes a job.

- (AWSTask<AWSIoTDescribeJobResponse*> *)describeJob:(AWSIoTDescribeJobRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDescribeJobResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– describeJob:completionHandler:

Describes a job.

- (void)describeJob:(AWSIoTDescribeJobRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDescribeJobResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeJob 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– describeJobExecution:

Describes a job execution.

- (AWSTask<AWSIoTDescribeJobExecutionResponse*> *)describeJobExecution:(AWSIoTDescribeJobExecutionRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDescribeJobExecutionResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– describeJobExecution:completionHandler:

Describes a job execution.

- (void)describeJobExecution:(AWSIoTDescribeJobExecutionRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDescribeJobExecutionResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeJobExecution 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– describeRoleAlias:

Describes a role alias.

- (AWSTask<AWSIoTDescribeRoleAliasResponse*> *)describeRoleAlias:(AWSIoTDescribeRoleAliasRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDescribeRoleAliasResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– describeRoleAlias:completionHandler:

Describes a role alias.

- (void)describeRoleAlias:(AWSIoTDescribeRoleAliasRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDescribeRoleAliasResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeRoleAlias 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– describeScheduledAudit:

Gets information about a scheduled audit.

- (AWSTask<AWSIoTDescribeScheduledAuditResponse*> *)describeScheduledAudit:(AWSIoTDescribeScheduledAuditRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDescribeScheduledAuditResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– describeScheduledAudit:completionHandler:

Gets information about a scheduled audit.

- (void)describeScheduledAudit:(AWSIoTDescribeScheduledAuditRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDescribeScheduledAuditResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeScheduledAudit 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– describeSecurityProfile:

Gets information about a Device Defender security profile.

- (AWSTask<AWSIoTDescribeSecurityProfileResponse*> *)describeSecurityProfile:(AWSIoTDescribeSecurityProfileRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDescribeSecurityProfileResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– describeSecurityProfile:completionHandler:

Gets information about a Device Defender security profile.

- (void)describeSecurityProfile:(AWSIoTDescribeSecurityProfileRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDescribeSecurityProfileResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeSecurityProfile 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– describeStream:

Gets information about a stream.

- (AWSTask<AWSIoTDescribeStreamResponse*> *)describeStream:(AWSIoTDescribeStreamRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDescribeStreamResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– describeStream:completionHandler:

Gets information about a stream.

- (void)describeStream:(AWSIoTDescribeStreamRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDescribeStreamResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeStream 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– describeThing:

Gets information about the specified thing.

- (AWSTask<AWSIoTDescribeThingResponse*> *)describeThing:(AWSIoTDescribeThingRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDescribeThingResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– describeThing:completionHandler:

Gets information about the specified thing.

- (void)describeThing:(AWSIoTDescribeThingRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDescribeThingResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeThing 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– describeThingGroup:

Describe a thing group.

- (AWSTask<AWSIoTDescribeThingGroupResponse*> *)describeThingGroup:(AWSIoTDescribeThingGroupRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDescribeThingGroupResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– describeThingGroup:completionHandler:

Describe a thing group.

- (void)describeThingGroup:(AWSIoTDescribeThingGroupRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDescribeThingGroupResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeThingGroup 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– describeThingRegistrationTask:

Describes a bulk thing provisioning task.

- (AWSTask<AWSIoTDescribeThingRegistrationTaskResponse*> *)describeThingRegistrationTask:(AWSIoTDescribeThingRegistrationTaskRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDescribeThingRegistrationTaskResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– describeThingRegistrationTask:completionHandler:

Describes a bulk thing provisioning task.

- (void)describeThingRegistrationTask:(AWSIoTDescribeThingRegistrationTaskRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDescribeThingRegistrationTaskResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeThingRegistrationTask 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– describeThingType:

Gets information about the specified thing type.

- (AWSTask<AWSIoTDescribeThingTypeResponse*> *)describeThingType:(AWSIoTDescribeThingTypeRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDescribeThingTypeResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– describeThingType:completionHandler:

Gets information about the specified thing type.

- (void)describeThingType:(AWSIoTDescribeThingTypeRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDescribeThingTypeResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeThingType 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– detachPolicy:

Detaches a policy from the specified target.

- (AWSTask *)detachPolicy:(AWSIoTDetachPolicyRequest *)request

Parameters

request

A container for the necessary parameters to execute the DetachPolicy 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorLimitExceeded.

Declared In

AWSIoTService.h

– detachPolicy:completionHandler:

Detaches a policy from the specified target.

- (void)detachPolicy:(AWSIoTDetachPolicyRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DetachPolicy 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorLimitExceeded.

Declared In

AWSIoTService.h

– detachPrincipalPolicy:

Removes the specified policy from the specified certificate.

Note: This API is deprecated. Please use DetachPolicy instead.

- (AWSTask *)detachPrincipalPolicy:(AWSIoTDetachPrincipalPolicyRequest *)request

Parameters

request

A container for the necessary parameters to execute the DetachPrincipalPolicy 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– detachPrincipalPolicy:completionHandler:

Removes the specified policy from the specified certificate.

Note: This API is deprecated. Please use DetachPolicy instead.

- (void)detachPrincipalPolicy:(AWSIoTDetachPrincipalPolicyRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DetachPrincipalPolicy 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– detachSecurityProfile:

Disassociates a Device Defender security profile from a thing group or from this account.

- (AWSTask<AWSIoTDetachSecurityProfileResponse*> *)detachSecurityProfile:(AWSIoTDetachSecurityProfileRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDetachSecurityProfileResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– detachSecurityProfile:completionHandler:

Disassociates a Device Defender security profile from a thing group or from this account.

- (void)detachSecurityProfile:(AWSIoTDetachSecurityProfileRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDetachSecurityProfileResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DetachSecurityProfile 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– detachThingPrincipal:

Detaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

This call is asynchronous. It might take several seconds for the detachment to propagate.

- (AWSTask<AWSIoTDetachThingPrincipalResponse*> *)detachThingPrincipal:(AWSIoTDetachThingPrincipalRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDetachThingPrincipalResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– detachThingPrincipal:completionHandler:

Detaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

This call is asynchronous. It might take several seconds for the detachment to propagate.

- (void)detachThingPrincipal:(AWSIoTDetachThingPrincipalRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTDetachThingPrincipalResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DetachThingPrincipal 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– disableTopicRule:

Disables the rule.

- (AWSTask *)disableTopicRule:(AWSIoTDisableTopicRuleRequest *)request

Parameters

request

A container for the necessary parameters to execute the DisableTopicRule 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable, AWSIoTErrorUnauthorized, AWSIoTErrorConflictingResourceUpdate.

Declared In

AWSIoTService.h

– disableTopicRule:completionHandler:

Disables the rule.

- (void)disableTopicRule:(AWSIoTDisableTopicRuleRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DisableTopicRule 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable, AWSIoTErrorUnauthorized, AWSIoTErrorConflictingResourceUpdate.

Declared In

AWSIoTService.h

– enableTopicRule:

Enables the rule.

- (AWSTask *)enableTopicRule:(AWSIoTEnableTopicRuleRequest *)request

Parameters

request

A container for the necessary parameters to execute the EnableTopicRule 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable, AWSIoTErrorUnauthorized, AWSIoTErrorConflictingResourceUpdate.

Declared In

AWSIoTService.h

– enableTopicRule:completionHandler:

Enables the rule.

- (void)enableTopicRule:(AWSIoTEnableTopicRuleRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the EnableTopicRule 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable, AWSIoTErrorUnauthorized, AWSIoTErrorConflictingResourceUpdate.

Declared In

AWSIoTService.h

– getEffectivePolicies:

Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the AWS IoT device gateway.

- (AWSTask<AWSIoTGetEffectivePoliciesResponse*> *)getEffectivePolicies:(AWSIoTGetEffectivePoliciesRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTGetEffectivePoliciesResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorLimitExceeded.

Declared In

AWSIoTService.h

– getEffectivePolicies:completionHandler:

Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the AWS IoT device gateway.

- (void)getEffectivePolicies:(AWSIoTGetEffectivePoliciesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTGetEffectivePoliciesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetEffectivePolicies 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorLimitExceeded.

Declared In

AWSIoTService.h

– getIndexingConfiguration:

Gets the search configuration.

- (AWSTask<AWSIoTGetIndexingConfigurationResponse*> *)getIndexingConfiguration:(AWSIoTGetIndexingConfigurationRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTGetIndexingConfigurationResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– getIndexingConfiguration:completionHandler:

Gets the search configuration.

- (void)getIndexingConfiguration:(AWSIoTGetIndexingConfigurationRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTGetIndexingConfigurationResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetIndexingConfiguration 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– getJobDocument:

Gets a job document.

- (AWSTask<AWSIoTGetJobDocumentResponse*> *)getJobDocument:(AWSIoTGetJobDocumentRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTGetJobDocumentResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– getJobDocument:completionHandler:

Gets a job document.

- (void)getJobDocument:(AWSIoTGetJobDocumentRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTGetJobDocumentResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetJobDocument 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– getLoggingOptions:

Gets the logging options.

NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead.

- (AWSTask<AWSIoTGetLoggingOptionsResponse*> *)getLoggingOptions:(AWSIoTGetLoggingOptionsRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTGetLoggingOptionsResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– getLoggingOptions:completionHandler:

Gets the logging options.

NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead.

- (void)getLoggingOptions:(AWSIoTGetLoggingOptionsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTGetLoggingOptionsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetLoggingOptions 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– getOTAUpdate:

Gets an OTA update.

- (AWSTask<AWSIoTGetOTAUpdateResponse*> *)getOTAUpdate:(AWSIoTGetOTAUpdateRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTGetOTAUpdateResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorInternalFailure, AWSIoTErrorServiceUnavailable, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– getOTAUpdate:completionHandler:

Gets an OTA update.

- (void)getOTAUpdate:(AWSIoTGetOTAUpdateRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTGetOTAUpdateResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetOTAUpdate 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorInternalFailure, AWSIoTErrorServiceUnavailable, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– getPolicy:

Gets information about the specified policy with the policy document of the default version.

- (AWSTask<AWSIoTGetPolicyResponse*> *)getPolicy:(AWSIoTGetPolicyRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTGetPolicyResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– getPolicy:completionHandler:

Gets information about the specified policy with the policy document of the default version.

- (void)getPolicy:(AWSIoTGetPolicyRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTGetPolicyResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetPolicy 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– getPolicyVersion:

Gets information about the specified policy version.

- (AWSTask<AWSIoTGetPolicyVersionResponse*> *)getPolicyVersion:(AWSIoTGetPolicyVersionRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTGetPolicyVersionResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– getPolicyVersion:completionHandler:

Gets information about the specified policy version.

- (void)getPolicyVersion:(AWSIoTGetPolicyVersionRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTGetPolicyVersionResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetPolicyVersion 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– getRegistrationCode:

Gets a registration code used to register a CA certificate with AWS IoT.

- (AWSTask<AWSIoTGetRegistrationCodeResponse*> *)getRegistrationCode:(AWSIoTGetRegistrationCodeRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTGetRegistrationCodeResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorInvalidRequest.

Declared In

AWSIoTService.h

– getRegistrationCode:completionHandler:

Gets a registration code used to register a CA certificate with AWS IoT.

- (void)getRegistrationCode:(AWSIoTGetRegistrationCodeRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTGetRegistrationCodeResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetRegistrationCode 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorInvalidRequest.

Declared In

AWSIoTService.h

– getStatistics:

Gets statistics about things that match the specified query.

- (AWSTask<AWSIoTGetStatisticsResponse*> *)getStatistics:(AWSIoTGetStatisticsRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTGetStatisticsResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidQuery, AWSIoTErrorInvalidAggregation, AWSIoTErrorIndexNotReady.

Declared In

AWSIoTService.h

– getStatistics:completionHandler:

Gets statistics about things that match the specified query.

- (void)getStatistics:(AWSIoTGetStatisticsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTGetStatisticsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetStatistics 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidQuery, AWSIoTErrorInvalidAggregation, AWSIoTErrorIndexNotReady.

Declared In

AWSIoTService.h

– getTopicRule:

Gets information about the rule.

- (AWSTask<AWSIoTGetTopicRuleResponse*> *)getTopicRule:(AWSIoTGetTopicRuleRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTGetTopicRuleResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable, AWSIoTErrorUnauthorized.

Declared In

AWSIoTService.h

– getTopicRule:completionHandler:

Gets information about the rule.

- (void)getTopicRule:(AWSIoTGetTopicRuleRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTGetTopicRuleResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetTopicRule 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable, AWSIoTErrorUnauthorized.

Declared In

AWSIoTService.h

– getV2LoggingOptions:

Gets the fine grained logging options.

- (AWSTask<AWSIoTGetV2LoggingOptionsResponse*> *)getV2LoggingOptions:(AWSIoTGetV2LoggingOptionsRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTGetV2LoggingOptionsResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorNotConfigured, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– getV2LoggingOptions:completionHandler:

Gets the fine grained logging options.

- (void)getV2LoggingOptions:(AWSIoTGetV2LoggingOptionsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTGetV2LoggingOptionsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetV2LoggingOptions 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorNotConfigured, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– listActiveViolations:

Lists the active violations for a given Device Defender security profile.

- (AWSTask<AWSIoTListActiveViolationsResponse*> *)listActiveViolations:(AWSIoTListActiveViolationsRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListActiveViolationsResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listActiveViolations:completionHandler:

Lists the active violations for a given Device Defender security profile.

- (void)listActiveViolations:(AWSIoTListActiveViolationsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListActiveViolationsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListActiveViolations 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listAttachedPolicies:

Lists the policies attached to the specified thing group.

- (AWSTask<AWSIoTListAttachedPoliciesResponse*> *)listAttachedPolicies:(AWSIoTListAttachedPoliciesRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListAttachedPoliciesResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorLimitExceeded.

Declared In

AWSIoTService.h

– listAttachedPolicies:completionHandler:

Lists the policies attached to the specified thing group.

- (void)listAttachedPolicies:(AWSIoTListAttachedPoliciesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListAttachedPoliciesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListAttachedPolicies 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorLimitExceeded.

Declared In

AWSIoTService.h

– listAuditFindings:

Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 180 days.)

- (AWSTask<AWSIoTListAuditFindingsResponse*> *)listAuditFindings:(AWSIoTListAuditFindingsRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListAuditFindingsResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listAuditFindings:completionHandler:

Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 180 days.)

- (void)listAuditFindings:(AWSIoTListAuditFindingsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListAuditFindingsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListAuditFindings 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listAuditTasks:

Lists the Device Defender audits that have been performed during a given time period.

- (AWSTask<AWSIoTListAuditTasksResponse*> *)listAuditTasks:(AWSIoTListAuditTasksRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListAuditTasksResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listAuditTasks:completionHandler:

Lists the Device Defender audits that have been performed during a given time period.

- (void)listAuditTasks:(AWSIoTListAuditTasksRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListAuditTasksResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListAuditTasks 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listAuthorizers:

Lists the authorizers registered in your account.

- (AWSTask<AWSIoTListAuthorizersResponse*> *)listAuthorizers:(AWSIoTListAuthorizersRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListAuthorizersResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listAuthorizers:completionHandler:

Lists the authorizers registered in your account.

- (void)listAuthorizers:(AWSIoTListAuthorizersRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListAuthorizersResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListAuthorizers 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listBillingGroups:

Lists the billing groups you have created.

- (AWSTask<AWSIoTListBillingGroupsResponse*> *)listBillingGroups:(AWSIoTListBillingGroupsRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListBillingGroupsResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling.

Declared In

AWSIoTService.h

– listBillingGroups:completionHandler:

Lists the billing groups you have created.

- (void)listBillingGroups:(AWSIoTListBillingGroupsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListBillingGroupsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListBillingGroups 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling.

Declared In

AWSIoTService.h

– listCACertificates:

Lists the CA certificates registered for your AWS account.

The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.

- (AWSTask<AWSIoTListCACertificatesResponse*> *)listCACertificates:(AWSIoTListCACertificatesRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListCACertificatesResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listCACertificates:completionHandler:

Lists the CA certificates registered for your AWS account.

The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.

- (void)listCACertificates:(AWSIoTListCACertificatesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListCACertificatesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListCACertificates 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listCertificates:

Lists the certificates registered in your AWS account.

The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.

- (AWSTask<AWSIoTListCertificatesResponse*> *)listCertificates:(AWSIoTListCertificatesRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListCertificatesResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listCertificates:completionHandler:

Lists the certificates registered in your AWS account.

The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.

- (void)listCertificates:(AWSIoTListCertificatesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListCertificatesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListCertificates 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listCertificatesByCA:

List the device certificates signed by the specified CA certificate.

- (AWSTask<AWSIoTListCertificatesByCAResponse*> *)listCertificatesByCA:(AWSIoTListCertificatesByCARequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListCertificatesByCAResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listCertificatesByCA:completionHandler:

List the device certificates signed by the specified CA certificate.

- (void)listCertificatesByCA:(AWSIoTListCertificatesByCARequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListCertificatesByCAResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListCertificatesByCA 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listIndices:

Lists the search indices.

- (AWSTask<AWSIoTListIndicesResponse*> *)listIndices:(AWSIoTListIndicesRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListIndicesResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listIndices:completionHandler:

Lists the search indices.

- (void)listIndices:(AWSIoTListIndicesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListIndicesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListIndices 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listJobExecutionsForJob:

Lists the job executions for a job.

- (AWSTask<AWSIoTListJobExecutionsForJobResponse*> *)listJobExecutionsForJob:(AWSIoTListJobExecutionsForJobRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListJobExecutionsForJobResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– listJobExecutionsForJob:completionHandler:

Lists the job executions for a job.

- (void)listJobExecutionsForJob:(AWSIoTListJobExecutionsForJobRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListJobExecutionsForJobResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListJobExecutionsForJob 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– listJobExecutionsForThing:

Lists the job executions for the specified thing.

- (AWSTask<AWSIoTListJobExecutionsForThingResponse*> *)listJobExecutionsForThing:(AWSIoTListJobExecutionsForThingRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListJobExecutionsForThingResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– listJobExecutionsForThing:completionHandler:

Lists the job executions for the specified thing.

- (void)listJobExecutionsForThing:(AWSIoTListJobExecutionsForThingRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListJobExecutionsForThingResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListJobExecutionsForThing 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– listJobs:

Lists jobs.

- (AWSTask<AWSIoTListJobsResponse*> *)listJobs:(AWSIoTListJobsRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListJobsResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– listJobs:completionHandler:

Lists jobs.

- (void)listJobs:(AWSIoTListJobsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListJobsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListJobs 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– listOTAUpdates:

Lists OTA updates.

- (AWSTask<AWSIoTListOTAUpdatesResponse*> *)listOTAUpdates:(AWSIoTListOTAUpdatesRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListOTAUpdatesResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorInternalFailure, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– listOTAUpdates:completionHandler:

Lists OTA updates.

- (void)listOTAUpdates:(AWSIoTListOTAUpdatesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListOTAUpdatesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListOTAUpdates 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorInternalFailure, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– listOutgoingCertificates:

Lists certificates that are being transferred but not yet accepted.

- (AWSTask<AWSIoTListOutgoingCertificatesResponse*> *)listOutgoingCertificates:(AWSIoTListOutgoingCertificatesRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListOutgoingCertificatesResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listOutgoingCertificates:completionHandler:

Lists certificates that are being transferred but not yet accepted.

- (void)listOutgoingCertificates:(AWSIoTListOutgoingCertificatesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListOutgoingCertificatesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListOutgoingCertificates 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listPolicies:

Lists your policies.

- (AWSTask<AWSIoTListPoliciesResponse*> *)listPolicies:(AWSIoTListPoliciesRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListPoliciesResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listPolicies:completionHandler:

Lists your policies.

- (void)listPolicies:(AWSIoTListPoliciesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListPoliciesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListPolicies 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listPolicyPrincipals:

Lists the principals associated with the specified policy.

Note: This API is deprecated. Please use ListTargetsForPolicy instead.

- (AWSTask<AWSIoTListPolicyPrincipalsResponse*> *)listPolicyPrincipals:(AWSIoTListPolicyPrincipalsRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListPolicyPrincipalsResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listPolicyPrincipals:completionHandler:

Lists the principals associated with the specified policy.

Note: This API is deprecated. Please use ListTargetsForPolicy instead.

- (void)listPolicyPrincipals:(AWSIoTListPolicyPrincipalsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListPolicyPrincipalsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListPolicyPrincipals 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listPolicyVersions:

Lists the versions of the specified policy and identifies the default version.

- (AWSTask<AWSIoTListPolicyVersionsResponse*> *)listPolicyVersions:(AWSIoTListPolicyVersionsRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListPolicyVersionsResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listPolicyVersions:completionHandler:

Lists the versions of the specified policy and identifies the default version.

- (void)listPolicyVersions:(AWSIoTListPolicyVersionsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListPolicyVersionsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListPolicyVersions 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listPrincipalPolicies:

Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format.

Note: This API is deprecated. Please use ListAttachedPolicies instead.

- (AWSTask<AWSIoTListPrincipalPoliciesResponse*> *)listPrincipalPolicies:(AWSIoTListPrincipalPoliciesRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListPrincipalPoliciesResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listPrincipalPolicies:completionHandler:

Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format.

Note: This API is deprecated. Please use ListAttachedPolicies instead.

- (void)listPrincipalPolicies:(AWSIoTListPrincipalPoliciesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListPrincipalPoliciesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListPrincipalPolicies 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listPrincipalThings:

Lists the things associated with the specified principal. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

- (AWSTask<AWSIoTListPrincipalThingsResponse*> *)listPrincipalThings:(AWSIoTListPrincipalThingsRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListPrincipalThingsResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– listPrincipalThings:completionHandler:

Lists the things associated with the specified principal. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

- (void)listPrincipalThings:(AWSIoTListPrincipalThingsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListPrincipalThingsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListPrincipalThings 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– listRoleAliases:

Lists the role aliases registered in your account.

- (AWSTask<AWSIoTListRoleAliasesResponse*> *)listRoleAliases:(AWSIoTListRoleAliasesRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListRoleAliasesResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listRoleAliases:completionHandler:

Lists the role aliases registered in your account.

- (void)listRoleAliases:(AWSIoTListRoleAliasesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListRoleAliasesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListRoleAliases 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listScheduledAudits:

Lists all of your scheduled audits.

- (AWSTask<AWSIoTListScheduledAuditsResponse*> *)listScheduledAudits:(AWSIoTListScheduledAuditsRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListScheduledAuditsResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listScheduledAudits:completionHandler:

Lists all of your scheduled audits.

- (void)listScheduledAudits:(AWSIoTListScheduledAuditsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListScheduledAuditsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListScheduledAudits 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listSecurityProfiles:

Lists the Device Defender security profiles you have created. You can use filters to list only those security profiles associated with a thing group or only those associated with your account.

- (AWSTask<AWSIoTListSecurityProfilesResponse*> *)listSecurityProfiles:(AWSIoTListSecurityProfilesRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListSecurityProfilesResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listSecurityProfiles:completionHandler:

Lists the Device Defender security profiles you have created. You can use filters to list only those security profiles associated with a thing group or only those associated with your account.

- (void)listSecurityProfiles:(AWSIoTListSecurityProfilesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListSecurityProfilesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListSecurityProfiles 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listSecurityProfilesForTarget:

Lists the Device Defender security profiles attached to a target (thing group).

- (AWSTask<AWSIoTListSecurityProfilesForTargetResponse*> *)listSecurityProfilesForTarget:(AWSIoTListSecurityProfilesForTargetRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListSecurityProfilesForTargetResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– listSecurityProfilesForTarget:completionHandler:

Lists the Device Defender security profiles attached to a target (thing group).

- (void)listSecurityProfilesForTarget:(AWSIoTListSecurityProfilesForTargetRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListSecurityProfilesForTargetResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListSecurityProfilesForTarget 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– listStreams:

Lists all of the streams in your AWS account.

- (AWSTask<AWSIoTListStreamsResponse*> *)listStreams:(AWSIoTListStreamsRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListStreamsResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listStreams:completionHandler:

Lists all of the streams in your AWS account.

- (void)listStreams:(AWSIoTListStreamsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListStreamsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListStreams 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listTagsForResource:

Lists the tags (metadata) you have assigned to the resource.

- (AWSTask<AWSIoTListTagsForResourceResponse*> *)listTagsForResource:(AWSIoTListTagsForResourceRequest *)request

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 AWSIoTListTagsForResourceResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling.

Declared In

AWSIoTService.h

– listTagsForResource:completionHandler:

Lists the tags (metadata) you have assigned to the resource.

- (void)listTagsForResource:(AWSIoTListTagsForResourceRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListTagsForResourceResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling.

Declared In

AWSIoTService.h

– listTargetsForPolicy:

List targets for the specified policy.

- (AWSTask<AWSIoTListTargetsForPolicyResponse*> *)listTargetsForPolicy:(AWSIoTListTargetsForPolicyRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListTargetsForPolicyResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorLimitExceeded.

Declared In

AWSIoTService.h

– listTargetsForPolicy:completionHandler:

List targets for the specified policy.

- (void)listTargetsForPolicy:(AWSIoTListTargetsForPolicyRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListTargetsForPolicyResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListTargetsForPolicy 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorLimitExceeded.

Declared In

AWSIoTService.h

– listTargetsForSecurityProfile:

Lists the targets (thing groups) associated with a given Device Defender security profile.

- (AWSTask<AWSIoTListTargetsForSecurityProfileResponse*> *)listTargetsForSecurityProfile:(AWSIoTListTargetsForSecurityProfileRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListTargetsForSecurityProfileResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listTargetsForSecurityProfile:completionHandler:

Lists the targets (thing groups) associated with a given Device Defender security profile.

- (void)listTargetsForSecurityProfile:(AWSIoTListTargetsForSecurityProfileRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListTargetsForSecurityProfileResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListTargetsForSecurityProfile 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listThingGroups:

List the thing groups in your account.

- (AWSTask<AWSIoTListThingGroupsResponse*> *)listThingGroups:(AWSIoTListThingGroupsRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListThingGroupsResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– listThingGroups:completionHandler:

List the thing groups in your account.

- (void)listThingGroups:(AWSIoTListThingGroupsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListThingGroupsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListThingGroups 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– listThingGroupsForThing:

List the thing groups to which the specified thing belongs.

- (AWSTask<AWSIoTListThingGroupsForThingResponse*> *)listThingGroupsForThing:(AWSIoTListThingGroupsForThingRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListThingGroupsForThingResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– listThingGroupsForThing:completionHandler:

List the thing groups to which the specified thing belongs.

- (void)listThingGroupsForThing:(AWSIoTListThingGroupsForThingRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListThingGroupsForThingResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListThingGroupsForThing 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– listThingPrincipals:

Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

- (AWSTask<AWSIoTListThingPrincipalsResponse*> *)listThingPrincipals:(AWSIoTListThingPrincipalsRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListThingPrincipalsResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– listThingPrincipals:completionHandler:

Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

- (void)listThingPrincipals:(AWSIoTListThingPrincipalsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListThingPrincipalsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListThingPrincipals 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– listThingRegistrationTaskReports:

Information about the thing registration tasks.

- (AWSTask<AWSIoTListThingRegistrationTaskReportsResponse*> *)listThingRegistrationTaskReports:(AWSIoTListThingRegistrationTaskReportsRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListThingRegistrationTaskReportsResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listThingRegistrationTaskReports:completionHandler:

Information about the thing registration tasks.

- (void)listThingRegistrationTaskReports:(AWSIoTListThingRegistrationTaskReportsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListThingRegistrationTaskReportsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListThingRegistrationTaskReports 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listThingRegistrationTasks:

List bulk thing provisioning tasks.

- (AWSTask<AWSIoTListThingRegistrationTasksResponse*> *)listThingRegistrationTasks:(AWSIoTListThingRegistrationTasksRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListThingRegistrationTasksResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listThingRegistrationTasks:completionHandler:

List bulk thing provisioning tasks.

- (void)listThingRegistrationTasks:(AWSIoTListThingRegistrationTasksRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListThingRegistrationTasksResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListThingRegistrationTasks 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listThingTypes:

Lists the existing thing types.

- (AWSTask<AWSIoTListThingTypesResponse*> *)listThingTypes:(AWSIoTListThingTypesRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListThingTypesResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listThingTypes:completionHandler:

Lists the existing thing types.

- (void)listThingTypes:(AWSIoTListThingTypesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListThingTypesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListThingTypes 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listThings:

Lists your things. Use the attributeName and attributeValue parameters to filter your things. For example, calling ListThings with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute Color with the value Red.

- (AWSTask<AWSIoTListThingsResponse*> *)listThings:(AWSIoTListThingsRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListThingsResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listThings:completionHandler:

Lists your things. Use the attributeName and attributeValue parameters to filter your things. For example, calling ListThings with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute Color with the value Red.

- (void)listThings:(AWSIoTListThingsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListThingsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListThings 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listThingsInBillingGroup:

Lists the things you have added to the given billing group.

- (AWSTask<AWSIoTListThingsInBillingGroupResponse*> *)listThingsInBillingGroup:(AWSIoTListThingsInBillingGroupRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListThingsInBillingGroupResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling.

Declared In

AWSIoTService.h

– listThingsInBillingGroup:completionHandler:

Lists the things you have added to the given billing group.

- (void)listThingsInBillingGroup:(AWSIoTListThingsInBillingGroupRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListThingsInBillingGroupResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListThingsInBillingGroup 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling.

Declared In

AWSIoTService.h

– listThingsInThingGroup:

Lists the things in the specified group.

- (AWSTask<AWSIoTListThingsInThingGroupResponse*> *)listThingsInThingGroup:(AWSIoTListThingsInThingGroupRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListThingsInThingGroupResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– listThingsInThingGroup:completionHandler:

Lists the things in the specified group.

- (void)listThingsInThingGroup:(AWSIoTListThingsInThingGroupRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListThingsInThingGroupResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListThingsInThingGroup 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– listTopicRules:

Lists the rules for the specific topic.

- (AWSTask<AWSIoTListTopicRulesResponse*> *)listTopicRules:(AWSIoTListTopicRulesRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListTopicRulesResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– listTopicRules:completionHandler:

Lists the rules for the specific topic.

- (void)listTopicRules:(AWSIoTListTopicRulesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListTopicRulesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListTopicRules 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– listV2LoggingLevels:

Lists logging levels.

- (AWSTask<AWSIoTListV2LoggingLevelsResponse*> *)listV2LoggingLevels:(AWSIoTListV2LoggingLevelsRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListV2LoggingLevelsResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorNotConfigured, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– listV2LoggingLevels:completionHandler:

Lists logging levels.

- (void)listV2LoggingLevels:(AWSIoTListV2LoggingLevelsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListV2LoggingLevelsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListV2LoggingLevels 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorNotConfigured, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– listViolationEvents:

Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior or thing (device).

- (AWSTask<AWSIoTListViolationEventsResponse*> *)listViolationEvents:(AWSIoTListViolationEventsRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTListViolationEventsResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– listViolationEvents:completionHandler:

Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior or thing (device).

- (void)listViolationEvents:(AWSIoTListViolationEventsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTListViolationEventsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListViolationEvents 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– registerCACertificate:

Registers a CA certificate with AWS IoT. This CA certificate can then be used to sign device certificates, which can be then registered with AWS IoT. You can register up to 10 CA certificates per AWS account that have the same subject field. This enables you to have up to 10 certificate authorities sign your device certificates. If you have more than one CA certificate registered, make sure you pass the CA certificate when you register your device certificates with the RegisterCertificate API.

- (AWSTask<AWSIoTRegisterCACertificateResponse*> *)registerCACertificate:(AWSIoTRegisterCACertificateRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTRegisterCACertificateResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceAlreadyExists, AWSIoTErrorRegistrationCodeValidation, AWSIoTErrorInvalidRequest, AWSIoTErrorCertificateValidation, AWSIoTErrorThrottling, AWSIoTErrorLimitExceeded, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– registerCACertificate:completionHandler:

Registers a CA certificate with AWS IoT. This CA certificate can then be used to sign device certificates, which can be then registered with AWS IoT. You can register up to 10 CA certificates per AWS account that have the same subject field. This enables you to have up to 10 certificate authorities sign your device certificates. If you have more than one CA certificate registered, make sure you pass the CA certificate when you register your device certificates with the RegisterCertificate API.

- (void)registerCACertificate:(AWSIoTRegisterCACertificateRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTRegisterCACertificateResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the RegisterCACertificate 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceAlreadyExists, AWSIoTErrorRegistrationCodeValidation, AWSIoTErrorInvalidRequest, AWSIoTErrorCertificateValidation, AWSIoTErrorThrottling, AWSIoTErrorLimitExceeded, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– registerCertificate:

Registers a device certificate with AWS IoT. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered.

- (AWSTask<AWSIoTRegisterCertificateResponse*> *)registerCertificate:(AWSIoTRegisterCertificateRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTRegisterCertificateResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceAlreadyExists, AWSIoTErrorInvalidRequest, AWSIoTErrorCertificateValidation, AWSIoTErrorCertificateState, AWSIoTErrorCertificateConflict, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– registerCertificate:completionHandler:

Registers a device certificate with AWS IoT. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered.

- (void)registerCertificate:(AWSIoTRegisterCertificateRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTRegisterCertificateResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the RegisterCertificate 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceAlreadyExists, AWSIoTErrorInvalidRequest, AWSIoTErrorCertificateValidation, AWSIoTErrorCertificateState, AWSIoTErrorCertificateConflict, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– registerThing:

Provisions a thing.

- (AWSTask<AWSIoTRegisterThingResponse*> *)registerThing:(AWSIoTRegisterThingRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTRegisterThingResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternalFailure, AWSIoTErrorServiceUnavailable, AWSIoTErrorInvalidRequest, AWSIoTErrorUnauthorized, AWSIoTErrorThrottling, AWSIoTErrorConflictingResourceUpdate, AWSIoTErrorResourceRegistrationFailure.

Declared In

AWSIoTService.h

– registerThing:completionHandler:

Provisions a thing.

- (void)registerThing:(AWSIoTRegisterThingRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTRegisterThingResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the RegisterThing 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternalFailure, AWSIoTErrorServiceUnavailable, AWSIoTErrorInvalidRequest, AWSIoTErrorUnauthorized, AWSIoTErrorThrottling, AWSIoTErrorConflictingResourceUpdate, AWSIoTErrorResourceRegistrationFailure.

Declared In

AWSIoTService.h

– rejectCertificateTransfer:

Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE.

To check for pending certificate transfers, call ListCertificates to enumerate your certificates.

This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state.

- (AWSTask *)rejectCertificateTransfer:(AWSIoTRejectCertificateTransferRequest *)request

Parameters

request

A container for the necessary parameters to execute the RejectCertificateTransfer 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorTransferAlreadyCompleted, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– rejectCertificateTransfer:completionHandler:

Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE.

To check for pending certificate transfers, call ListCertificates to enumerate your certificates.

This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state.

- (void)rejectCertificateTransfer:(AWSIoTRejectCertificateTransferRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the RejectCertificateTransfer 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorTransferAlreadyCompleted, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– removeThingFromBillingGroup:

Removes the given thing from the billing group.

- (AWSTask<AWSIoTRemoveThingFromBillingGroupResponse*> *)removeThingFromBillingGroup:(AWSIoTRemoveThingFromBillingGroupRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTRemoveThingFromBillingGroupResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– removeThingFromBillingGroup:completionHandler:

Removes the given thing from the billing group.

- (void)removeThingFromBillingGroup:(AWSIoTRemoveThingFromBillingGroupRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTRemoveThingFromBillingGroupResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the RemoveThingFromBillingGroup 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– removeThingFromThingGroup:

Remove the specified thing from the specified group.

- (AWSTask<AWSIoTRemoveThingFromThingGroupResponse*> *)removeThingFromThingGroup:(AWSIoTRemoveThingFromThingGroupRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTRemoveThingFromThingGroupResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– removeThingFromThingGroup:completionHandler:

Remove the specified thing from the specified group.

- (void)removeThingFromThingGroup:(AWSIoTRemoveThingFromThingGroupRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTRemoveThingFromThingGroupResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the RemoveThingFromThingGroup 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– replaceTopicRule:

Replaces the rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.

- (AWSTask *)replaceTopicRule:(AWSIoTReplaceTopicRuleRequest *)request

Parameters

request

A container for the necessary parameters to execute the ReplaceTopicRule 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorSqlParse, AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable, AWSIoTErrorUnauthorized, AWSIoTErrorConflictingResourceUpdate.

Declared In

AWSIoTService.h

– replaceTopicRule:completionHandler:

Replaces the rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.

- (void)replaceTopicRule:(AWSIoTReplaceTopicRuleRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ReplaceTopicRule 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorSqlParse, AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable, AWSIoTErrorUnauthorized, AWSIoTErrorConflictingResourceUpdate.

Declared In

AWSIoTService.h

– searchIndex:

The query search index.

- (AWSTask<AWSIoTSearchIndexResponse*> *)searchIndex:(AWSIoTSearchIndexRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTSearchIndexResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidQuery, AWSIoTErrorIndexNotReady.

Declared In

AWSIoTService.h

– searchIndex:completionHandler:

The query search index.

- (void)searchIndex:(AWSIoTSearchIndexRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTSearchIndexResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the SearchIndex 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidQuery, AWSIoTErrorIndexNotReady.

Declared In

AWSIoTService.h

– setDefaultAuthorizer:

Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.

- (AWSTask<AWSIoTSetDefaultAuthorizerResponse*> *)setDefaultAuthorizer:(AWSIoTSetDefaultAuthorizerRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTSetDefaultAuthorizerResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceAlreadyExists.

Declared In

AWSIoTService.h

– setDefaultAuthorizer:completionHandler:

Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.

- (void)setDefaultAuthorizer:(AWSIoTSetDefaultAuthorizerRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTSetDefaultAuthorizerResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the SetDefaultAuthorizer 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceAlreadyExists.

Declared In

AWSIoTService.h

– setDefaultPolicyVersion:

Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicy API.

- (AWSTask *)setDefaultPolicyVersion:(AWSIoTSetDefaultPolicyVersionRequest *)request

Parameters

request

A container for the necessary parameters to execute the SetDefaultPolicyVersion 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– setDefaultPolicyVersion:completionHandler:

Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicy API.

- (void)setDefaultPolicyVersion:(AWSIoTSetDefaultPolicyVersionRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the SetDefaultPolicyVersion 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– setLoggingOptions:

Sets the logging options.

NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead.

- (AWSTask *)setLoggingOptions:(AWSIoTSetLoggingOptionsRequest *)request

Parameters

request

A container for the necessary parameters to execute the SetLoggingOptions 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– setLoggingOptions:completionHandler:

Sets the logging options.

NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead.

- (void)setLoggingOptions:(AWSIoTSetLoggingOptionsRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the SetLoggingOptions 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– setV2LoggingLevel:

Sets the logging level.

- (AWSTask *)setV2LoggingLevel:(AWSIoTSetV2LoggingLevelRequest *)request

Parameters

request

A container for the necessary parameters to execute the SetV2LoggingLevel 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorNotConfigured, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– setV2LoggingLevel:completionHandler:

Sets the logging level.

- (void)setV2LoggingLevel:(AWSIoTSetV2LoggingLevelRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the SetV2LoggingLevel 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorNotConfigured, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– setV2LoggingOptions:

Sets the logging options for the V2 logging service.

- (AWSTask *)setV2LoggingOptions:(AWSIoTSetV2LoggingOptionsRequest *)request

Parameters

request

A container for the necessary parameters to execute the SetV2LoggingOptions 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– setV2LoggingOptions:completionHandler:

Sets the logging options for the V2 logging service.

- (void)setV2LoggingOptions:(AWSIoTSetV2LoggingOptionsRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the SetV2LoggingOptions 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– startOnDemandAuditTask:

Starts an on-demand Device Defender audit.

- (AWSTask<AWSIoTStartOnDemandAuditTaskResponse*> *)startOnDemandAuditTask:(AWSIoTStartOnDemandAuditTaskRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTStartOnDemandAuditTaskResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorLimitExceeded.

Declared In

AWSIoTService.h

– startOnDemandAuditTask:completionHandler:

Starts an on-demand Device Defender audit.

- (void)startOnDemandAuditTask:(AWSIoTStartOnDemandAuditTaskRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTStartOnDemandAuditTaskResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the StartOnDemandAuditTask 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorLimitExceeded.

Declared In

AWSIoTService.h

– startThingRegistrationTask:

Creates a bulk thing provisioning task.

- (AWSTask<AWSIoTStartThingRegistrationTaskResponse*> *)startThingRegistrationTask:(AWSIoTStartThingRegistrationTaskRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTStartThingRegistrationTaskResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– startThingRegistrationTask:completionHandler:

Creates a bulk thing provisioning task.

- (void)startThingRegistrationTask:(AWSIoTStartThingRegistrationTaskRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTStartThingRegistrationTaskResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the StartThingRegistrationTask 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– stopThingRegistrationTask:

Cancels a bulk thing provisioning task.

- (AWSTask<AWSIoTStopThingRegistrationTaskResponse*> *)stopThingRegistrationTask:(AWSIoTStopThingRegistrationTaskRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTStopThingRegistrationTaskResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– stopThingRegistrationTask:completionHandler:

Cancels a bulk thing provisioning task.

- (void)stopThingRegistrationTask:(AWSIoTStopThingRegistrationTaskRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTStopThingRegistrationTaskResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the StopThingRegistrationTask 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– tagResource:

Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.

- (AWSTask<AWSIoTTagResourceResponse*> *)tagResource:(AWSIoTTagResourceRequest *)request

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 contain an instance of AWSIoTTagResourceResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorLimitExceeded.

Declared In

AWSIoTService.h

– tagResource:completionHandler:

Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.

- (void)tagResource:(AWSIoTTagResourceRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTTagResourceResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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. 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorLimitExceeded.

Declared In

AWSIoTService.h

– testAuthorization:

Tests if a specified principal is authorized to perform an AWS IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the AWS IoT device gateway.

- (AWSTask<AWSIoTTestAuthorizationResponse*> *)testAuthorization:(AWSIoTTestAuthorizationRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTTestAuthorizationResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorLimitExceeded.

Declared In

AWSIoTService.h

– testAuthorization:completionHandler:

Tests if a specified principal is authorized to perform an AWS IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the AWS IoT device gateway.

- (void)testAuthorization:(AWSIoTTestAuthorizationRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTTestAuthorizationResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the TestAuthorization 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorLimitExceeded.

Declared In

AWSIoTService.h

– testInvokeAuthorizer:

Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the AWS IoT device gateway.

- (AWSTask<AWSIoTTestInvokeAuthorizerResponse*> *)testInvokeAuthorizer:(AWSIoTTestInvokeAuthorizerRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTTestInvokeAuthorizerResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorInvalidResponse.

Declared In

AWSIoTService.h

– testInvokeAuthorizer:completionHandler:

Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the AWS IoT device gateway.

- (void)testInvokeAuthorizer:(AWSIoTTestInvokeAuthorizerRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTTestInvokeAuthorizerResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the TestInvokeAuthorizer 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorInvalidResponse.

Declared In

AWSIoTService.h

– transferCertificate:

Transfers the specified certificate to the specified AWS account.

You can cancel the transfer until it is acknowledged by the recipient.

No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target.

The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate API to deactivate it.

The certificate must not have any policies attached to it. You can use the DetachPrincipalPolicy API to detach them.

- (AWSTask<AWSIoTTransferCertificateResponse*> *)transferCertificate:(AWSIoTTransferCertificateRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTTransferCertificateResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorCertificateState, AWSIoTErrorTransferConflict, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– transferCertificate:completionHandler:

Transfers the specified certificate to the specified AWS account.

You can cancel the transfer until it is acknowledged by the recipient.

No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target.

The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate API to deactivate it.

The certificate must not have any policies attached to it. You can use the DetachPrincipalPolicy API to detach them.

- (void)transferCertificate:(AWSIoTTransferCertificateRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTTransferCertificateResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the TransferCertificate 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorCertificateState, AWSIoTErrorTransferConflict, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– untagResource:

Removes the given tags (metadata) from the resource.

- (AWSTask<AWSIoTUntagResourceResponse*> *)untagResource:(AWSIoTUntagResourceRequest *)request

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 contain an instance of AWSIoTUntagResourceResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling.

Declared In

AWSIoTService.h

– untagResource:completionHandler:

Removes the given tags (metadata) from the resource.

- (void)untagResource:(AWSIoTUntagResourceRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTUntagResourceResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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. 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling.

Declared In

AWSIoTService.h

– updateAccountAuditConfiguration:

Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.

- (AWSTask<AWSIoTUpdateAccountAuditConfigurationResponse*> *)updateAccountAuditConfiguration:(AWSIoTUpdateAccountAuditConfigurationRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTUpdateAccountAuditConfigurationResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– updateAccountAuditConfiguration:completionHandler:

Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.

- (void)updateAccountAuditConfiguration:(AWSIoTUpdateAccountAuditConfigurationRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTUpdateAccountAuditConfigurationResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the UpdateAccountAuditConfiguration 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– updateAuthorizer:

Updates an authorizer.

- (AWSTask<AWSIoTUpdateAuthorizerResponse*> *)updateAuthorizer:(AWSIoTUpdateAuthorizerRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTUpdateAuthorizerResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorLimitExceeded, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– updateAuthorizer:completionHandler:

Updates an authorizer.

- (void)updateAuthorizer:(AWSIoTUpdateAuthorizerRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTUpdateAuthorizerResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the UpdateAuthorizer 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorLimitExceeded, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– updateBillingGroup:

Updates information about the billing group.

- (AWSTask<AWSIoTUpdateBillingGroupResponse*> *)updateBillingGroup:(AWSIoTUpdateBillingGroupRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTUpdateBillingGroupResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorVersionConflict, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– updateBillingGroup:completionHandler:

Updates information about the billing group.

- (void)updateBillingGroup:(AWSIoTUpdateBillingGroupRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTUpdateBillingGroupResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the UpdateBillingGroup 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorVersionConflict, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– updateCACertificate:

Updates a registered CA certificate.

- (AWSTask *)updateCACertificate:(AWSIoTUpdateCACertificateRequest *)request

Parameters

request

A container for the necessary parameters to execute the UpdateCACertificate 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– updateCACertificate:completionHandler:

Updates a registered CA certificate.

- (void)updateCACertificate:(AWSIoTUpdateCACertificateRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the UpdateCACertificate 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– updateCertificate:

Updates the status of the specified certificate. This operation is idempotent.

Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect.

The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.

- (AWSTask *)updateCertificate:(AWSIoTUpdateCertificateRequest *)request

Parameters

request

A container for the necessary parameters to execute the UpdateCertificate 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorCertificateState, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– updateCertificate:completionHandler:

Updates the status of the specified certificate. This operation is idempotent.

Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect.

The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.

- (void)updateCertificate:(AWSIoTUpdateCertificateRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the UpdateCertificate 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorCertificateState, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– updateDynamicThingGroup:

Updates a dynamic thing group.

- (AWSTask<AWSIoTUpdateDynamicThingGroupResponse*> *)updateDynamicThingGroup:(AWSIoTUpdateDynamicThingGroupRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTUpdateDynamicThingGroupResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorVersionConflict, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidQuery.

Declared In

AWSIoTService.h

– updateDynamicThingGroup:completionHandler:

Updates a dynamic thing group.

- (void)updateDynamicThingGroup:(AWSIoTUpdateDynamicThingGroupRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTUpdateDynamicThingGroupResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the UpdateDynamicThingGroup 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorVersionConflict, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidQuery.

Declared In

AWSIoTService.h

– updateEventConfigurations:

Updates the event configurations.

- (AWSTask<AWSIoTUpdateEventConfigurationsResponse*> *)updateEventConfigurations:(AWSIoTUpdateEventConfigurationsRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTUpdateEventConfigurationsResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorThrottling.

Declared In

AWSIoTService.h

– updateEventConfigurations:completionHandler:

Updates the event configurations.

- (void)updateEventConfigurations:(AWSIoTUpdateEventConfigurationsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTUpdateEventConfigurationsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the UpdateEventConfigurations 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorThrottling.

Declared In

AWSIoTService.h

– updateIndexingConfiguration:

Updates the search configuration.

- (AWSTask<AWSIoTUpdateIndexingConfigurationResponse*> *)updateIndexingConfiguration:(AWSIoTUpdateIndexingConfigurationRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTUpdateIndexingConfigurationResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– updateIndexingConfiguration:completionHandler:

Updates the search configuration.

- (void)updateIndexingConfiguration:(AWSIoTUpdateIndexingConfigurationRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTUpdateIndexingConfigurationResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the UpdateIndexingConfiguration 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– updateJob:

Updates supported fields of the specified job.

- (AWSTask *)updateJob:(AWSIoTUpdateJobRequest *)request

Parameters

request

A container for the necessary parameters to execute the UpdateJob 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– updateJob:completionHandler:

Updates supported fields of the specified job.

- (void)updateJob:(AWSIoTUpdateJobRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the UpdateJob 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

Declared In

AWSIoTService.h

– updateRoleAlias:

Updates a role alias.

- (AWSTask<AWSIoTUpdateRoleAliasResponse*> *)updateRoleAlias:(AWSIoTUpdateRoleAliasRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTUpdateRoleAliasResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– updateRoleAlias:completionHandler:

Updates a role alias.

- (void)updateRoleAlias:(AWSIoTUpdateRoleAliasRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTUpdateRoleAliasResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the UpdateRoleAlias 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– updateScheduledAudit:

Updates a scheduled audit, including what checks are performed and how often the audit takes place.

- (AWSTask<AWSIoTUpdateScheduledAuditResponse*> *)updateScheduledAudit:(AWSIoTUpdateScheduledAuditRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTUpdateScheduledAuditResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– updateScheduledAudit:completionHandler:

Updates a scheduled audit, including what checks are performed and how often the audit takes place.

- (void)updateScheduledAudit:(AWSIoTUpdateScheduledAuditRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTUpdateScheduledAuditResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the UpdateScheduledAudit 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– updateSecurityProfile:

Updates a Device Defender security profile.

- (AWSTask<AWSIoTUpdateSecurityProfileResponse*> *)updateSecurityProfile:(AWSIoTUpdateSecurityProfileRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTUpdateSecurityProfileResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorVersionConflict, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– updateSecurityProfile:completionHandler:

Updates a Device Defender security profile.

- (void)updateSecurityProfile:(AWSIoTUpdateSecurityProfileRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTUpdateSecurityProfileResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the UpdateSecurityProfile 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorVersionConflict, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– updateStream:

Updates an existing stream. The stream version will be incremented by one.

- (AWSTask<AWSIoTUpdateStreamResponse*> *)updateStream:(AWSIoTUpdateStreamRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTUpdateStreamResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– updateStream:completionHandler:

Updates an existing stream. The stream version will be incremented by one.

- (void)updateStream:(AWSIoTUpdateStreamRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTUpdateStreamResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the UpdateStream 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– updateThing:

Updates the data for a thing.

- (AWSTask<AWSIoTUpdateThingResponse*> *)updateThing:(AWSIoTUpdateThingRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTUpdateThingResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorVersionConflict, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– updateThing:completionHandler:

Updates the data for a thing.

- (void)updateThing:(AWSIoTUpdateThingRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTUpdateThingResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the UpdateThing 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorVersionConflict, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– updateThingGroup:

Update a thing group.

- (AWSTask<AWSIoTUpdateThingGroupResponse*> *)updateThingGroup:(AWSIoTUpdateThingGroupRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTUpdateThingGroupResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorVersionConflict, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– updateThingGroup:completionHandler:

Update a thing group.

- (void)updateThingGroup:(AWSIoTUpdateThingGroupRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTUpdateThingGroupResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the UpdateThingGroup 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorVersionConflict, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– updateThingGroupsForThing:

Updates the groups to which the thing belongs.

- (AWSTask<AWSIoTUpdateThingGroupsForThingResponse*> *)updateThingGroupsForThing:(AWSIoTUpdateThingGroupsForThingRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTUpdateThingGroupsForThingResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– updateThingGroupsForThing:completionHandler:

Updates the groups to which the thing belongs.

- (void)updateThingGroupsForThing:(AWSIoTUpdateThingGroupsForThingRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTUpdateThingGroupsForThingResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the UpdateThingGroupsForThing 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

Declared In

AWSIoTService.h

– validateSecurityProfileBehaviors:

Validates a Device Defender security profile behaviors specification.

- (AWSTask<AWSIoTValidateSecurityProfileBehaviorsResponse*> *)validateSecurityProfileBehaviors:(AWSIoTValidateSecurityProfileBehaviorsRequest *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTValidateSecurityProfileBehaviorsResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h

– validateSecurityProfileBehaviors:completionHandler:

Validates a Device Defender security profile behaviors specification.

- (void)validateSecurityProfileBehaviors:(AWSIoTValidateSecurityProfileBehaviorsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSIoTValidateSecurityProfileBehaviorsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ValidateSecurityProfileBehaviors 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 AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

Declared In

AWSIoTService.h