AWSIoT

Objective-C

@interface AWSIoT

Swift

class AWSIoT

IoT

IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services 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.

The service endpoints that expose this API are listed in Amazon Web Services IoT Core Endpoints and Quotas. You must use the endpoint for the region that has the resources you want to access.

The service name used by Amazon Web Services Signature Version 4 to sign the request is: execute-api.

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

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

  • The service configuration used to instantiate this service client.

    Warning

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

    Declaration

    Objective-C

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

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

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

    Swift

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

   return true

    }

    Objective-C

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

     return YES;
 }

    Then call the following to get the default service client:

    Swift

    let IoT = AWSIoT.default()

    Objective-C

    AWSIoT *IoT = [AWSIoT defaultIoT];

    Declaration

    Objective-C

    + (nonnull instancetype)defaultIoT;

    Swift

    class func `default`() -> Self

    Return Value

    The default service client.

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

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

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
   let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
   let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
   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.

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    configuration

    A service configuration object.
    key

    A string to identify the service client.

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

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

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
   let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
   let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
   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"];

    Declaration

    Objective-C

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

    Swift

    convenience init(forKey key: String)

    Parameters

    key

    A string to identify the service client.

    Return Value

    An instance of the service client.

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

    Warning

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

    Declaration

    Objective-C

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

    Swift

    class func remove(forKey key: String)

    Parameters

    key

    A string to identify the service client.

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

    Requires permission to access the AcceptCertificateTransfer action.

    See

    AWSIoTAcceptCertificateTransferRequest

    Declaration

    Objective-C

    - (id)acceptCertificateTransfer:
    (nonnull AWSIoTAcceptCertificateTransferRequest *)request;

    Swift

    func acceptCertificateTransfer(_ request: AWSIoTAcceptCertificateTransferRequest) -> Any!

    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.

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

    Requires permission to access the AcceptCertificateTransfer action.

    See

    AWSIoTAcceptCertificateTransferRequest

    Declaration

    Objective-C

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

    Swift

    func acceptCertificateTransfer(_ request: AWSIoTAcceptCertificateTransferRequest) async throws

    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.

  • Adds a thing to a billing group.

    Requires permission to access the AddThingToBillingGroup action.

    See

    AWSIoTAddThingToBillingGroupRequest

    See

    AWSIoTAddThingToBillingGroupResponse

    Declaration

    Objective-C

    - (id)addThingToBillingGroup:
    (nonnull AWSIoTAddThingToBillingGroupRequest *)request;

    Swift

    func addThing(toBillingGroup request: AWSIoTAddThingToBillingGroupRequest) -> Any!

    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.

  • Adds a thing to a billing group.

    Requires permission to access the AddThingToBillingGroup action.

    See

    AWSIoTAddThingToBillingGroupRequest

    See

    AWSIoTAddThingToBillingGroupResponse

    Declaration

    Objective-C

    - (void)
    addThingToBillingGroup:
        (nonnull AWSIoTAddThingToBillingGroupRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSIoTAddThingToBillingGroupResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func addThing(toBillingGroup request: AWSIoTAddThingToBillingGroupRequest) async throws -> AWSIoTAddThingToBillingGroupResponse

    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.

  • Adds a thing to a thing group.

    Requires permission to access the AddThingToThingGroup action.

    See

    AWSIoTAddThingToThingGroupRequest

    See

    AWSIoTAddThingToThingGroupResponse

    Declaration

    Objective-C

    - (id)addThingToThingGroup:(nonnull AWSIoTAddThingToThingGroupRequest *)request;

    Swift

    func addThing(toThingGroup request: AWSIoTAddThingToThingGroupRequest) -> Any!

    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.

  • Adds a thing to a thing group.

    Requires permission to access the AddThingToThingGroup action.

    See

    AWSIoTAddThingToThingGroupRequest

    See

    AWSIoTAddThingToThingGroupResponse

    Declaration

    Objective-C

    - (void)addThingToThingGroup:
            (nonnull AWSIoTAddThingToThingGroupRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSIoTAddThingToThingGroupResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func addThing(toThingGroup request: AWSIoTAddThingToThingGroupRequest) async throws -> AWSIoTAddThingToThingGroupResponse

    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.

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

    Requires permission to access the AssociateTargetsWithJob action.

    See

    AWSIoTAssociateTargetsWithJobRequest

    See

    AWSIoTAssociateTargetsWithJobResponse

    Declaration

    Objective-C

    - (id)associateTargetsWithJob:
    (nonnull AWSIoTAssociateTargetsWithJobRequest *)request;

    Swift

    func associateTargets(withJob request: AWSIoTAssociateTargetsWithJobRequest) -> Any!

    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.

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

    Requires permission to access the AssociateTargetsWithJob action.

    See

    AWSIoTAssociateTargetsWithJobRequest

    See

    AWSIoTAssociateTargetsWithJobResponse

    Declaration

    Objective-C

    - (void)associateTargetsWithJob:
            (nonnull AWSIoTAssociateTargetsWithJobRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSIoTAssociateTargetsWithJobResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func associateTargets(withJob request: AWSIoTAssociateTargetsWithJobRequest) async throws -> AWSIoTAssociateTargetsWithJobResponse

    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.

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

    Requires permission to access the AttachPolicy action.

    See

    AWSIoTAttachPolicyRequest

    Declaration

    Objective-C

    - (id)attachPolicy:(nonnull AWSIoTAttachPolicyRequest *)request;

    Swift

    func attachPolicy(_ request: AWSIoTAttachPolicyRequest) -> Any!

    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.

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

    Requires permission to access the AttachPolicy action.

    See

    AWSIoTAttachPolicyRequest

    Declaration

    Objective-C

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

    Swift

    func attachPolicy(_ request: AWSIoTAttachPolicyRequest) async throws

    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.

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

    Note: This action is deprecated and works as expected for backward compatibility, but we won’t add enhancements. Use AttachPolicy instead.

    Requires permission to access the AttachPrincipalPolicy action.

    See

    AWSIoTAttachPrincipalPolicyRequest

    Declaration

    Objective-C

    - (id)attachPrincipalPolicy:
    (nonnull AWSIoTAttachPrincipalPolicyRequest *)request;

    Swift

    func attachPrincipalPolicy(_ request: AWSIoTAttachPrincipalPolicyRequest) -> Any!

    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.

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

    Note: This action is deprecated and works as expected for backward compatibility, but we won’t add enhancements. Use AttachPolicy instead.

    Requires permission to access the AttachPrincipalPolicy action.

    See

    AWSIoTAttachPrincipalPolicyRequest

    Declaration

    Objective-C

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

    Swift

    func attachPrincipalPolicy(_ request: AWSIoTAttachPrincipalPolicyRequest) async throws

    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.

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

    Requires permission to access the AttachSecurityProfile action.

    See

    AWSIoTAttachSecurityProfileRequest

    See

    AWSIoTAttachSecurityProfileResponse

    Declaration

    Objective-C

    - (id)attachSecurityProfile:
    (nonnull AWSIoTAttachSecurityProfileRequest *)request;

    Swift

    func attachSecurityProfile(_ request: AWSIoTAttachSecurityProfileRequest) -> Any!

    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.

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

    Requires permission to access the AttachSecurityProfile action.

    See

    AWSIoTAttachSecurityProfileRequest

    See

    AWSIoTAttachSecurityProfileResponse

    Declaration

    Objective-C

    - (void)
    attachSecurityProfile:(nonnull AWSIoTAttachSecurityProfileRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSIoTAttachSecurityProfileResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func attachSecurityProfile(_ request: AWSIoTAttachSecurityProfileRequest) async throws -> AWSIoTAttachSecurityProfileResponse

    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.

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

    Requires permission to access the AttachThingPrincipal action.

    See

    AWSIoTAttachThingPrincipalRequest

    See

    AWSIoTAttachThingPrincipalResponse

    Declaration

    Objective-C

    - (id)attachThingPrincipal:(nonnull AWSIoTAttachThingPrincipalRequest *)request;

    Swift

    func attachThingPrincipal(_ request: AWSIoTAttachThingPrincipalRequest) -> Any!

    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.

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

    Requires permission to access the AttachThingPrincipal action.

    See

    AWSIoTAttachThingPrincipalRequest

    See

    AWSIoTAttachThingPrincipalResponse

    Declaration

    Objective-C

    - (void)attachThingPrincipal:
            (nonnull AWSIoTAttachThingPrincipalRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSIoTAttachThingPrincipalResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func attachThingPrincipal(_ request: AWSIoTAttachThingPrincipalRequest) async throws -> AWSIoTAttachThingPrincipalResponse

    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.

  • Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.

    Requires permission to access the CancelAuditMitigationActionsTask action.

    See

    AWSIoTCancelAuditMitigationActionsTaskRequest

    See

    AWSIoTCancelAuditMitigationActionsTaskResponse

    Declaration

    Objective-C

    - (id)cancelAuditMitigationActionsTask:
    (nonnull AWSIoTCancelAuditMitigationActionsTaskRequest *)request;

    Swift

    func cancelAuditMitigationActionsTask(_ request: AWSIoTCancelAuditMitigationActionsTaskRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.

    Requires permission to access the CancelAuditMitigationActionsTask action.

    See

    AWSIoTCancelAuditMitigationActionsTaskRequest

    See

    AWSIoTCancelAuditMitigationActionsTaskResponse

    Declaration

    Objective-C

    - (void)cancelAuditMitigationActionsTask:
            (nonnull AWSIoTCancelAuditMitigationActionsTaskRequest *)request
                       completionHandler:
                           (void (^_Nullable)(
                               AWSIoTCancelAuditMitigationActionsTaskResponse
                                   *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func cancelAuditMitigationActionsTask(_ request: AWSIoTCancelAuditMitigationActionsTaskRequest) async throws -> AWSIoTCancelAuditMitigationActionsTaskResponse

    Parameters

    request

    A container for the necessary parameters to execute the CancelAuditMitigationActionsTask 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.

  • Cancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn’t in progress, an “InvalidRequestException” occurs.

    Requires permission to access the CancelAuditTask action.

    See

    AWSIoTCancelAuditTaskRequest

    See

    AWSIoTCancelAuditTaskResponse

    Declaration

    Objective-C

    - (id)cancelAuditTask:(nonnull AWSIoTCancelAuditTaskRequest *)request;

    Swift

    func cancelAuditTask(_ request: AWSIoTCancelAuditTaskRequest) -> Any!

    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.

  • Cancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn’t in progress, an “InvalidRequestException” occurs.

    Requires permission to access the CancelAuditTask action.

    See

    AWSIoTCancelAuditTaskRequest

    See

    AWSIoTCancelAuditTaskResponse

    Declaration

    Objective-C

    - (void)cancelAuditTask:(nonnull AWSIoTCancelAuditTaskRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSIoTCancelAuditTaskResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func cancelAuditTask(_ request: AWSIoTCancelAuditTaskRequest) async throws -> AWSIoTCancelAuditTaskResponse

    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.

  • 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, 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.

    Requires permission to access the CancelCertificateTransfer action.

    See

    AWSIoTCancelCertificateTransferRequest

    Declaration

    Objective-C

    - (id)cancelCertificateTransfer:
    (nonnull AWSIoTCancelCertificateTransferRequest *)request;

    Swift

    func cancelCertificateTransfer(_ request: AWSIoTCancelCertificateTransferRequest) -> Any!

    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.

  • 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, 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.

    Requires permission to access the CancelCertificateTransfer action.

    See

    AWSIoTCancelCertificateTransferRequest

    Declaration

    Objective-C

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

    Swift

    func cancelCertificateTransfer(_ request: AWSIoTCancelCertificateTransferRequest) async throws

    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.

  • Cancels a Device Defender ML Detect mitigation action.

    Requires permission to access the CancelDetectMitigationActionsTask action.

    See

    AWSIoTCancelDetectMitigationActionsTaskRequest

    See

    AWSIoTCancelDetectMitigationActionsTaskResponse

    Declaration

    Objective-C

    - (id)cancelDetectMitigationActionsTask:
    (nonnull AWSIoTCancelDetectMitigationActionsTaskRequest *)request;

    Swift

    func cancelDetectMitigationActionsTask(_ request: AWSIoTCancelDetectMitigationActionsTaskRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Cancels a Device Defender ML Detect mitigation action.

    Requires permission to access the CancelDetectMitigationActionsTask action.

    See

    AWSIoTCancelDetectMitigationActionsTaskRequest

    See

    AWSIoTCancelDetectMitigationActionsTaskResponse

    Declaration

    Objective-C

    - (void)cancelDetectMitigationActionsTask:
            (nonnull AWSIoTCancelDetectMitigationActionsTaskRequest *)request
                        completionHandler:
                            (void (^_Nullable)(
                                AWSIoTCancelDetectMitigationActionsTaskResponse
                                    *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func cancelDetectMitigationActionsTask(_ request: AWSIoTCancelDetectMitigationActionsTaskRequest) async throws -> AWSIoTCancelDetectMitigationActionsTaskResponse

    Parameters

    request

    A container for the necessary parameters to execute the CancelDetectMitigationActionsTask 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.

  • Cancels a job.

    Requires permission to access the CancelJob action.

    See

    AWSIoTCancelJobRequest

    See

    AWSIoTCancelJobResponse

    Declaration

    Objective-C

    - (id)cancelJob:(nonnull AWSIoTCancelJobRequest *)request;

    Swift

    func cancelJob(_ request: AWSIoTCancelJobRequest) -> Any!

    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, AWSIoTErrorLimitExceeded.

  • Cancels a job.

    Requires permission to access the CancelJob action.

    See

    AWSIoTCancelJobRequest

    See

    AWSIoTCancelJobResponse

    Declaration

    Objective-C

    - (void)cancelJob:(nonnull AWSIoTCancelJobRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTCancelJobResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func cancelJob(_ request: AWSIoTCancelJobRequest) async throws -> AWSIoTCancelJobResponse

    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, AWSIoTErrorLimitExceeded.

  • Cancels the execution of a job for a given thing.

    Requires permission to access the CancelJobExecution action.

    See

    AWSIoTCancelJobExecutionRequest

    Declaration

    Objective-C

    - (id)cancelJobExecution:(nonnull AWSIoTCancelJobExecutionRequest *)request;

    Swift

    func cancelJobExecution(_ request: AWSIoTCancelJobExecutionRequest) -> Any!

    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.

  • Cancels the execution of a job for a given thing.

    Requires permission to access the CancelJobExecution action.

    See

    AWSIoTCancelJobExecutionRequest

    Declaration

    Objective-C

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

    Swift

    func cancelJobExecution(_ request: AWSIoTCancelJobExecutionRequest) async throws

    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.

  • Clears the default authorizer.

    Requires permission to access the ClearDefaultAuthorizer action.

    See

    AWSIoTClearDefaultAuthorizerRequest

    See

    AWSIoTClearDefaultAuthorizerResponse

    Declaration

    Objective-C

    - (id)clearDefaultAuthorizer:
    (nonnull AWSIoTClearDefaultAuthorizerRequest *)request;

    Swift

    func clearDefaultAuthorizer(_ request: AWSIoTClearDefaultAuthorizerRequest) -> Any!

    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.

  • Clears the default authorizer.

    Requires permission to access the ClearDefaultAuthorizer action.

    See

    AWSIoTClearDefaultAuthorizerRequest

    See

    AWSIoTClearDefaultAuthorizerResponse

    Declaration

    Objective-C

    - (void)
    clearDefaultAuthorizer:
        (nonnull AWSIoTClearDefaultAuthorizerRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSIoTClearDefaultAuthorizerResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func clearDefaultAuthorizer(_ request: AWSIoTClearDefaultAuthorizerRequest) async throws -> AWSIoTClearDefaultAuthorizerResponse

    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.

  • Confirms a topic rule destination. When you create a rule requiring a destination, IoT sends a confirmation message to the endpoint or base address you specify. The message includes a token which you pass back when calling ConfirmTopicRuleDestination to confirm that you own or have access to the endpoint.

    Requires permission to access the ConfirmTopicRuleDestination action.

    See

    AWSIoTConfirmTopicRuleDestinationRequest

    See

    AWSIoTConfirmTopicRuleDestinationResponse

    Declaration

    Objective-C

    - (id)confirmTopicRuleDestination:
    (nonnull AWSIoTConfirmTopicRuleDestinationRequest *)request;

    Swift

    func confirmTopicRuleDestination(_ request: AWSIoTConfirmTopicRuleDestinationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Confirms a topic rule destination. When you create a rule requiring a destination, IoT sends a confirmation message to the endpoint or base address you specify. The message includes a token which you pass back when calling ConfirmTopicRuleDestination to confirm that you own or have access to the endpoint.

    Requires permission to access the ConfirmTopicRuleDestination action.

    See

    AWSIoTConfirmTopicRuleDestinationRequest

    See

    AWSIoTConfirmTopicRuleDestinationResponse

    Declaration

    Objective-C

    - (void)confirmTopicRuleDestination:
            (nonnull AWSIoTConfirmTopicRuleDestinationRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSIoTConfirmTopicRuleDestinationResponse *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func confirmTopicRuleDestination(_ request: AWSIoTConfirmTopicRuleDestinationRequest) async throws -> AWSIoTConfirmTopicRuleDestinationResponse

    Parameters

    request

    A container for the necessary parameters to execute the ConfirmTopicRuleDestination 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, AWSIoTErrorConflictingResourceUpdate.

  • Creates a Device Defender audit suppression.

    Requires permission to access the CreateAuditSuppression action.

    See

    AWSIoTCreateAuditSuppressionRequest

    See

    AWSIoTCreateAuditSuppressionResponse

    Declaration

    Objective-C

    - (id)createAuditSuppression:
    (nonnull AWSIoTCreateAuditSuppressionRequest *)request;

    Swift

    func createAuditSuppression(_ request: AWSIoTCreateAuditSuppressionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates a Device Defender audit suppression.

    Requires permission to access the CreateAuditSuppression action.

    See

    AWSIoTCreateAuditSuppressionRequest

    See

    AWSIoTCreateAuditSuppressionResponse

    Declaration

    Objective-C

    - (void)
    createAuditSuppression:
        (nonnull AWSIoTCreateAuditSuppressionRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSIoTCreateAuditSuppressionResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func createAuditSuppression(_ request: AWSIoTCreateAuditSuppressionRequest) async throws -> AWSIoTCreateAuditSuppressionResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateAuditSuppression 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, AWSIoTErrorLimitExceeded.

  • Creates an authorizer.

    Requires permission to access the CreateAuthorizer action.

    See

    AWSIoTCreateAuthorizerRequest

    See

    AWSIoTCreateAuthorizerResponse

    Declaration

    Objective-C

    - (id)createAuthorizer:(nonnull AWSIoTCreateAuthorizerRequest *)request;

    Swift

    func createAuthorizer(_ request: AWSIoTCreateAuthorizerRequest) -> Any!

    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.

  • Creates an authorizer.

    Requires permission to access the CreateAuthorizer action.

    See

    AWSIoTCreateAuthorizerRequest

    See

    AWSIoTCreateAuthorizerResponse

    Declaration

    Objective-C

    - (void)createAuthorizer:(nonnull AWSIoTCreateAuthorizerRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSIoTCreateAuthorizerResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func createAuthorizer(_ request: AWSIoTCreateAuthorizerRequest) async throws -> AWSIoTCreateAuthorizerResponse

    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.

  • Creates a billing group.

    Requires permission to access the CreateBillingGroup action.

    See

    AWSIoTCreateBillingGroupRequest

    See

    AWSIoTCreateBillingGroupResponse

    Declaration

    Objective-C

    - (id)createBillingGroup:(nonnull AWSIoTCreateBillingGroupRequest *)request;

    Swift

    func createBillingGroup(_ request: AWSIoTCreateBillingGroupRequest) -> Any!

    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.

  • Creates a billing group.

    Requires permission to access the CreateBillingGroup action.

    See

    AWSIoTCreateBillingGroupRequest

    See

    AWSIoTCreateBillingGroupResponse

    Declaration

    Objective-C

    - (void)createBillingGroup:(nonnull AWSIoTCreateBillingGroupRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSIoTCreateBillingGroupResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func createBillingGroup(_ request: AWSIoTCreateBillingGroupRequest) async throws -> AWSIoTCreateBillingGroupResponse

    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.

  • 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, NIST P-384, or NIST P-512 curves. For supported certificates, consult Certificate signing algorithms supported by IoT.

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

    Requires permission to access the CreateCertificateFromCsr action.

    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 Amazon Web Services 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”

    See

    AWSIoTCreateCertificateFromCsrRequest

    See

    AWSIoTCreateCertificateFromCsrResponse

    Declaration

    Objective-C

    - (id)createCertificateFromCsr:
    (nonnull AWSIoTCreateCertificateFromCsrRequest *)request;

    Swift

    func createCertificate(fromCsr request: AWSIoTCreateCertificateFromCsrRequest) -> Any!

    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.

  • 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, NIST P-384, or NIST P-512 curves. For supported certificates, consult Certificate signing algorithms supported by IoT.

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

    Requires permission to access the CreateCertificateFromCsr action.

    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 Amazon Web Services 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”

    See

    AWSIoTCreateCertificateFromCsrRequest

    See

    AWSIoTCreateCertificateFromCsrResponse

    Declaration

    Objective-C

    - (void)createCertificateFromCsr:
            (nonnull AWSIoTCreateCertificateFromCsrRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSIoTCreateCertificateFromCsrResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func createCertificate(fromCsr request: AWSIoTCreateCertificateFromCsrRequest) async throws -> AWSIoTCreateCertificateFromCsrResponse

    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.

  • Use this API to define a Custom Metric published by your devices to Device Defender.

    Requires permission to access the CreateCustomMetric action.

    See

    AWSIoTCreateCustomMetricRequest

    See

    AWSIoTCreateCustomMetricResponse

    Declaration

    Objective-C

    - (id)createCustomMetric:(nonnull AWSIoTCreateCustomMetricRequest *)request;

    Swift

    func createCustomMetric(_ request: AWSIoTCreateCustomMetricRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Use this API to define a Custom Metric published by your devices to Device Defender.

    Requires permission to access the CreateCustomMetric action.

    See

    AWSIoTCreateCustomMetricRequest

    See

    AWSIoTCreateCustomMetricResponse

    Declaration

    Objective-C

    - (void)createCustomMetric:(nonnull AWSIoTCreateCustomMetricRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSIoTCreateCustomMetricResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func createCustomMetric(_ request: AWSIoTCreateCustomMetricRequest) async throws -> AWSIoTCreateCustomMetricResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateCustomMetric 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, AWSIoTErrorResourceAlreadyExists, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

  • Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device Defender. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.

    Requires permission to access the CreateDimension action.

    See

    AWSIoTCreateDimensionRequest

    See

    AWSIoTCreateDimensionResponse

    Declaration

    Objective-C

    - (id)createDimension:(nonnull AWSIoTCreateDimensionRequest *)request;

    Swift

    func createDimension(_ request: AWSIoTCreateDimensionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device Defender. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.

    Requires permission to access the CreateDimension action.

    See

    AWSIoTCreateDimensionRequest

    See

    AWSIoTCreateDimensionResponse

    Declaration

    Objective-C

    - (void)createDimension:(nonnull AWSIoTCreateDimensionRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSIoTCreateDimensionResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func createDimension(_ request: AWSIoTCreateDimensionRequest) async throws -> AWSIoTCreateDimensionResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateDimension 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, AWSIoTErrorLimitExceeded, AWSIoTErrorResourceAlreadyExists, AWSIoTErrorThrottling.

  • Creates a domain configuration.

    Requires permission to access the CreateDomainConfiguration action.

    See

    AWSIoTCreateDomainConfigurationRequest

    See

    AWSIoTCreateDomainConfigurationResponse

    Declaration

    Objective-C

    - (id)createDomainConfiguration:
    (nonnull AWSIoTCreateDomainConfigurationRequest *)request;

    Swift

    func createDomainConfiguration(_ request: AWSIoTCreateDomainConfigurationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates a domain configuration.

    Requires permission to access the CreateDomainConfiguration action.

    See

    AWSIoTCreateDomainConfigurationRequest

    See

    AWSIoTCreateDomainConfigurationResponse

    Declaration

    Objective-C

    - (void)createDomainConfiguration:
            (nonnull AWSIoTCreateDomainConfigurationRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSIoTCreateDomainConfigurationResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func createDomainConfiguration(_ request: AWSIoTCreateDomainConfigurationRequest) async throws -> AWSIoTCreateDomainConfigurationResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateDomainConfiguration 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: AWSIoTErrorLimitExceeded, AWSIoTErrorCertificateValidation, AWSIoTErrorResourceAlreadyExists, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorInvalidRequest, AWSIoTErrorUnauthorized, AWSIoTErrorThrottling.

  • Creates a dynamic thing group.

    Requires permission to access the CreateDynamicThingGroup action.

    See

    AWSIoTCreateDynamicThingGroupRequest

    See

    AWSIoTCreateDynamicThingGroupResponse

    Declaration

    Objective-C

    - (id)createDynamicThingGroup:
    (nonnull AWSIoTCreateDynamicThingGroupRequest *)request;

    Swift

    func createDynamicThingGroup(_ request: AWSIoTCreateDynamicThingGroupRequest) -> Any!

    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.

  • Creates a dynamic thing group.

    Requires permission to access the CreateDynamicThingGroup action.

    See

    AWSIoTCreateDynamicThingGroupRequest

    See

    AWSIoTCreateDynamicThingGroupResponse

    Declaration

    Objective-C

    - (void)createDynamicThingGroup:
            (nonnull AWSIoTCreateDynamicThingGroupRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSIoTCreateDynamicThingGroupResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func createDynamicThingGroup(_ request: AWSIoTCreateDynamicThingGroupRequest) async throws -> AWSIoTCreateDynamicThingGroupResponse

    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.

  • Creates a fleet metric.

    Requires permission to access the CreateFleetMetric action.

    See

    AWSIoTCreateFleetMetricRequest

    See

    AWSIoTCreateFleetMetricResponse

    Declaration

    Objective-C

    - (id)createFleetMetric:(nonnull AWSIoTCreateFleetMetricRequest *)request;

    Swift

    func createFleetMetric(_ request: AWSIoTCreateFleetMetricRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates a fleet metric.

    Requires permission to access the CreateFleetMetric action.

    See

    AWSIoTCreateFleetMetricRequest

    See

    AWSIoTCreateFleetMetricResponse

    Declaration

    Objective-C

    - (void)createFleetMetric:(nonnull AWSIoTCreateFleetMetricRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSIoTCreateFleetMetricResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func createFleetMetric(_ request: AWSIoTCreateFleetMetricRequest) async throws -> AWSIoTCreateFleetMetricResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateFleetMetric 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, AWSIoTErrorLimitExceeded, AWSIoTErrorResourceAlreadyExists, AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidQuery, AWSIoTErrorInvalidAggregation, AWSIoTErrorIndexNotReady.

  • Creates a job.

    Requires permission to access the CreateJob action.

    See

    AWSIoTCreateJobRequest

    See

    AWSIoTCreateJobResponse

    Declaration

    Objective-C

    - (id)createJob:(nonnull AWSIoTCreateJobRequest *)request;

    Swift

    func createJob(_ request: AWSIoTCreateJobRequest) -> Any!

    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.

  • Creates a job.

    Requires permission to access the CreateJob action.

    See

    AWSIoTCreateJobRequest

    See

    AWSIoTCreateJobResponse

    Declaration

    Objective-C

    - (void)createJob:(nonnull AWSIoTCreateJobRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTCreateJobResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func createJob(_ request: AWSIoTCreateJobRequest) async throws -> AWSIoTCreateJobResponse

    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.

  • Creates a job template.

    Requires permission to access the CreateJobTemplate action.

    See

    AWSIoTCreateJobTemplateRequest

    See

    AWSIoTCreateJobTemplateResponse

    Declaration

    Objective-C

    - (id)createJobTemplate:(nonnull AWSIoTCreateJobTemplateRequest *)request;

    Swift

    func createJobTemplate(_ request: AWSIoTCreateJobTemplateRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates a job template.

    Requires permission to access the CreateJobTemplate action.

    See

    AWSIoTCreateJobTemplateRequest

    See

    AWSIoTCreateJobTemplateResponse

    Declaration

    Objective-C

    - (void)createJobTemplate:(nonnull AWSIoTCreateJobTemplateRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSIoTCreateJobTemplateResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func createJobTemplate(_ request: AWSIoTCreateJobTemplateRequest) async throws -> AWSIoTCreateJobTemplateResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateJobTemplate 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, AWSIoTErrorConflict, AWSIoTErrorLimitExceeded, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

  • Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. You can also call CreateKeysAndCertificate over MQTT from a device, for more information, see Provisioning MQTT API.

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

    Requires permission to access the CreateKeysAndCertificate action.

    See

    AWSIoTCreateKeysAndCertificateRequest

    See

    AWSIoTCreateKeysAndCertificateResponse

    Declaration

    Objective-C

    - (id)createKeysAndCertificate:
    (nonnull AWSIoTCreateKeysAndCertificateRequest *)request;

    Swift

    func createKeysAndCertificate(_ request: AWSIoTCreateKeysAndCertificateRequest) -> Any!

    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.

  • Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. You can also call CreateKeysAndCertificate over MQTT from a device, for more information, see Provisioning MQTT API.

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

    Requires permission to access the CreateKeysAndCertificate action.

    See

    AWSIoTCreateKeysAndCertificateRequest

    See

    AWSIoTCreateKeysAndCertificateResponse

    Declaration

    Objective-C

    - (void)createKeysAndCertificate:
            (nonnull AWSIoTCreateKeysAndCertificateRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSIoTCreateKeysAndCertificateResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func createKeysAndCertificate(_ request: AWSIoTCreateKeysAndCertificateRequest) async throws -> AWSIoTCreateKeysAndCertificateResponse

    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.

  • Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions. Each mitigation action can apply only one type of change.

    Requires permission to access the CreateMitigationAction action.

    See

    AWSIoTCreateMitigationActionRequest

    See

    AWSIoTCreateMitigationActionResponse

    Declaration

    Objective-C

    - (id)createMitigationAction:
    (nonnull AWSIoTCreateMitigationActionRequest *)request;

    Swift

    func createMitigationAction(_ request: AWSIoTCreateMitigationActionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions. Each mitigation action can apply only one type of change.

    Requires permission to access the CreateMitigationAction action.

    See

    AWSIoTCreateMitigationActionRequest

    See

    AWSIoTCreateMitigationActionResponse

    Declaration

    Objective-C

    - (void)
    createMitigationAction:
        (nonnull AWSIoTCreateMitigationActionRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSIoTCreateMitigationActionResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func createMitigationAction(_ request: AWSIoTCreateMitigationActionRequest) async throws -> AWSIoTCreateMitigationActionResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateMitigationAction 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, AWSIoTErrorLimitExceeded, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

  • Creates an IoT OTA update on a target group of things or groups.

    Requires permission to access the CreateOTAUpdate action.

    See

    AWSIoTCreateOTAUpdateRequest

    See

    AWSIoTCreateOTAUpdateResponse

    Declaration

    Objective-C

    - (id)createOTAUpdate:(nonnull AWSIoTCreateOTAUpdateRequest *)request;

    Swift

    func createOTAUpdate(_ request: AWSIoTCreateOTAUpdateRequest) -> Any!

    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.

  • Creates an IoT OTA update on a target group of things or groups.

    Requires permission to access the CreateOTAUpdate action.

    See

    AWSIoTCreateOTAUpdateRequest

    See

    AWSIoTCreateOTAUpdateResponse

    Declaration

    Objective-C

    - (void)createOTAUpdate:(nonnull AWSIoTCreateOTAUpdateRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSIoTCreateOTAUpdateResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func createOTAUpdate(_ request: AWSIoTCreateOTAUpdateRequest) async throws -> AWSIoTCreateOTAUpdateResponse

    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.

  • Creates an 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.

    Requires permission to access the CreatePolicy action.

    See

    AWSIoTCreatePolicyRequest

    See

    AWSIoTCreatePolicyResponse

    Declaration

    Objective-C

    - (id)createPolicy:(nonnull AWSIoTCreatePolicyRequest *)request;

    Swift

    func createPolicy(_ request: AWSIoTCreatePolicyRequest) -> Any!

    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.

  • Creates an 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.

    Requires permission to access the CreatePolicy action.

    See

    AWSIoTCreatePolicyRequest

    See

    AWSIoTCreatePolicyResponse

    Declaration

    Objective-C

    - (void)createPolicy:(nonnull AWSIoTCreatePolicyRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTCreatePolicyResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func createPolicy(_ request: AWSIoTCreatePolicyRequest) async throws -> AWSIoTCreatePolicyResponse

    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.

  • Creates a new version of the specified 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).

    Requires permission to access the CreatePolicyVersion action.

    See

    AWSIoTCreatePolicyVersionRequest

    See

    AWSIoTCreatePolicyVersionResponse

    Declaration

    Objective-C

    - (id)createPolicyVersion:(nonnull AWSIoTCreatePolicyVersionRequest *)request;

    Swift

    func createPolicyVersion(_ request: AWSIoTCreatePolicyVersionRequest) -> Any!

    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.

  • Creates a new version of the specified 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).

    Requires permission to access the CreatePolicyVersion action.

    See

    AWSIoTCreatePolicyVersionRequest

    See

    AWSIoTCreatePolicyVersionResponse

    Declaration

    Objective-C

    - (void)createPolicyVersion:(nonnull AWSIoTCreatePolicyVersionRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSIoTCreatePolicyVersionResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func createPolicyVersion(_ request: AWSIoTCreatePolicyVersionRequest) async throws -> AWSIoTCreatePolicyVersionResponse

    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.

  • Creates a provisioning claim.

    Requires permission to access the CreateProvisioningClaim action.

    See

    AWSIoTCreateProvisioningClaimRequest

    See

    AWSIoTCreateProvisioningClaimResponse

    Declaration

    Objective-C

    - (id)createProvisioningClaim:
    (nonnull AWSIoTCreateProvisioningClaimRequest *)request;

    Swift

    func createProvisioningClaim(_ request: AWSIoTCreateProvisioningClaimRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates a provisioning claim.

    Requires permission to access the CreateProvisioningClaim action.

    See

    AWSIoTCreateProvisioningClaimRequest

    See

    AWSIoTCreateProvisioningClaimResponse

    Declaration

    Objective-C

    - (void)createProvisioningClaim:
            (nonnull AWSIoTCreateProvisioningClaimRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSIoTCreateProvisioningClaimResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func createProvisioningClaim(_ request: AWSIoTCreateProvisioningClaimRequest) async throws -> AWSIoTCreateProvisioningClaimResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateProvisioningClaim 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.

  • Creates a provisioning template.

    Requires permission to access the CreateProvisioningTemplate action.

    See

    AWSIoTCreateProvisioningTemplateRequest

    See

    AWSIoTCreateProvisioningTemplateResponse

    Declaration

    Objective-C

    - (id)createProvisioningTemplate:
    (nonnull AWSIoTCreateProvisioningTemplateRequest *)request;

    Swift

    func createProvisioningTemplate(_ request: AWSIoTCreateProvisioningTemplateRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates a provisioning template.

    Requires permission to access the CreateProvisioningTemplate action.

    See

    AWSIoTCreateProvisioningTemplateRequest

    See

    AWSIoTCreateProvisioningTemplateResponse

    Declaration

    Objective-C

    - (void)createProvisioningTemplate:
            (nonnull AWSIoTCreateProvisioningTemplateRequest *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSIoTCreateProvisioningTemplateResponse *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func createProvisioningTemplate(_ request: AWSIoTCreateProvisioningTemplateRequest) async throws -> AWSIoTCreateProvisioningTemplateResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateProvisioningTemplate 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, AWSIoTErrorLimitExceeded, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorResourceAlreadyExists.

  • Creates a new version of a provisioning template.

    Requires permission to access the CreateProvisioningTemplateVersion action.

    See

    AWSIoTCreateProvisioningTemplateVersionRequest

    See

    AWSIoTCreateProvisioningTemplateVersionResponse

    Declaration

    Objective-C

    - (id)createProvisioningTemplateVersion:
    (nonnull AWSIoTCreateProvisioningTemplateVersionRequest *)request;

    Swift

    func createProvisioningTemplateVersion(_ request: AWSIoTCreateProvisioningTemplateVersionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates a new version of a provisioning template.

    Requires permission to access the CreateProvisioningTemplateVersion action.

    See

    AWSIoTCreateProvisioningTemplateVersionRequest

    See

    AWSIoTCreateProvisioningTemplateVersionResponse

    Declaration

    Objective-C

    - (void)createProvisioningTemplateVersion:
            (nonnull AWSIoTCreateProvisioningTemplateVersionRequest *)request
                        completionHandler:
                            (void (^_Nullable)(
                                AWSIoTCreateProvisioningTemplateVersionResponse
                                    *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func createProvisioningTemplateVersion(_ request: AWSIoTCreateProvisioningTemplateVersionRequest) async throws -> AWSIoTCreateProvisioningTemplateVersionResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateProvisioningTemplateVersion 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: AWSIoTErrorVersionsLimitExceeded, AWSIoTErrorInternalFailure, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorResourceNotFound, AWSIoTErrorUnauthorized, AWSIoTErrorConflictingResourceUpdate.

  • Creates a role alias.

    Requires permission to access the CreateRoleAlias action.

    See

    AWSIoTCreateRoleAliasRequest

    See

    AWSIoTCreateRoleAliasResponse

    Declaration

    Objective-C

    - (id)createRoleAlias:(nonnull AWSIoTCreateRoleAliasRequest *)request;

    Swift

    func createRoleAlias(_ request: AWSIoTCreateRoleAliasRequest) -> Any!

    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.

  • Creates a role alias.

    Requires permission to access the CreateRoleAlias action.

    See

    AWSIoTCreateRoleAliasRequest

    See

    AWSIoTCreateRoleAliasResponse

    Declaration

    Objective-C

    - (void)createRoleAlias:(nonnull AWSIoTCreateRoleAliasRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSIoTCreateRoleAliasResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func createRoleAlias(_ request: AWSIoTCreateRoleAliasRequest) async throws -> AWSIoTCreateRoleAliasResponse

    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.

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

    Requires permission to access the CreateScheduledAudit action.

    See

    AWSIoTCreateScheduledAuditRequest

    See

    AWSIoTCreateScheduledAuditResponse

    Declaration

    Objective-C

    - (id)createScheduledAudit:(nonnull AWSIoTCreateScheduledAuditRequest *)request;

    Swift

    func createScheduledAudit(_ request: AWSIoTCreateScheduledAuditRequest) -> Any!

    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, AWSIoTErrorResourceAlreadyExists, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorLimitExceeded.

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

    Requires permission to access the CreateScheduledAudit action.

    See

    AWSIoTCreateScheduledAuditRequest

    See

    AWSIoTCreateScheduledAuditResponse

    Declaration

    Objective-C

    - (void)createScheduledAudit:
            (nonnull AWSIoTCreateScheduledAuditRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSIoTCreateScheduledAuditResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func createScheduledAudit(_ request: AWSIoTCreateScheduledAuditRequest) async throws -> AWSIoTCreateScheduledAuditResponse

    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, AWSIoTErrorResourceAlreadyExists, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorLimitExceeded.

  • Creates a Device Defender security profile.

    Requires permission to access the CreateSecurityProfile action.

    See

    AWSIoTCreateSecurityProfileRequest

    See

    AWSIoTCreateSecurityProfileResponse

    Declaration

    Objective-C

    - (id)createSecurityProfile:
    (nonnull AWSIoTCreateSecurityProfileRequest *)request;

    Swift

    func createSecurityProfile(_ request: AWSIoTCreateSecurityProfileRequest) -> Any!

    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.

  • Creates a Device Defender security profile.

    Requires permission to access the CreateSecurityProfile action.

    See

    AWSIoTCreateSecurityProfileRequest

    See

    AWSIoTCreateSecurityProfileResponse

    Declaration

    Objective-C

    - (void)
    createSecurityProfile:(nonnull AWSIoTCreateSecurityProfileRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSIoTCreateSecurityProfileResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func createSecurityProfile(_ request: AWSIoTCreateSecurityProfileRequest) async throws -> AWSIoTCreateSecurityProfileResponse

    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.

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

    Requires permission to access the CreateStream action.

    See

    AWSIoTCreateStreamRequest

    See

    AWSIoTCreateStreamResponse

    Declaration

    Objective-C

    - (id)createStream:(nonnull AWSIoTCreateStreamRequest *)request;

    Swift

    func createStream(_ request: AWSIoTCreateStreamRequest) -> Any!

    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.

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

    Requires permission to access the CreateStream action.

    See

    AWSIoTCreateStreamRequest

    See

    AWSIoTCreateStreamResponse

    Declaration

    Objective-C

    - (void)createStream:(nonnull AWSIoTCreateStreamRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTCreateStreamResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func createStream(_ request: AWSIoTCreateStreamRequest) async throws -> AWSIoTCreateStreamResponse

    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.

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

    Requires permission to access the CreateThing action.

    See

    AWSIoTCreateThingRequest

    See

    AWSIoTCreateThingResponse

    Declaration

    Objective-C

    - (id)createThing:(nonnull AWSIoTCreateThingRequest *)request;

    Swift

    func createThing(_ request: AWSIoTCreateThingRequest) -> Any!

    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.

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

    Requires permission to access the CreateThing action.

    See

    AWSIoTCreateThingRequest

    See

    AWSIoTCreateThingResponse

    Declaration

    Objective-C

    - (void)createThing:(nonnull AWSIoTCreateThingRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTCreateThingResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func createThing(_ request: AWSIoTCreateThingRequest) async throws -> AWSIoTCreateThingResponse

    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.

  • Create a thing group.

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

    Requires permission to access the CreateThingGroup action.

    See

    AWSIoTCreateThingGroupRequest

    See

    AWSIoTCreateThingGroupResponse

    Declaration

    Objective-C

    - (id)createThingGroup:(nonnull AWSIoTCreateThingGroupRequest *)request;

    Swift

    func createThingGroup(_ request: AWSIoTCreateThingGroupRequest) -> Any!

    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.

  • Create a thing group.

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

    Requires permission to access the CreateThingGroup action.

    See

    AWSIoTCreateThingGroupRequest

    See

    AWSIoTCreateThingGroupResponse

    Declaration

    Objective-C

    - (void)createThingGroup:(nonnull AWSIoTCreateThingGroupRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSIoTCreateThingGroupResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func createThingGroup(_ request: AWSIoTCreateThingGroupRequest) async throws -> AWSIoTCreateThingGroupResponse

    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.

  • Creates a new thing type.

    Requires permission to access the CreateThingType action.

    See

    AWSIoTCreateThingTypeRequest

    See

    AWSIoTCreateThingTypeResponse

    Declaration

    Objective-C

    - (id)createThingType:(nonnull AWSIoTCreateThingTypeRequest *)request;

    Swift

    func createThingType(_ request: AWSIoTCreateThingTypeRequest) -> Any!

    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.

  • Creates a new thing type.

    Requires permission to access the CreateThingType action.

    See

    AWSIoTCreateThingTypeRequest

    See

    AWSIoTCreateThingTypeResponse

    Declaration

    Objective-C

    - (void)createThingType:(nonnull AWSIoTCreateThingTypeRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSIoTCreateThingTypeResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func createThingType(_ request: AWSIoTCreateThingTypeRequest) async throws -> AWSIoTCreateThingTypeResponse

    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.

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

    Requires permission to access the CreateTopicRule action.

    See

    AWSIoTCreateTopicRuleRequest

    Declaration

    Objective-C

    - (id)createTopicRule:(nonnull AWSIoTCreateTopicRuleRequest *)request;

    Swift

    func createTopicRule(_ request: AWSIoTCreateTopicRuleRequest) -> Any!

    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.

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

    Requires permission to access the CreateTopicRule action.

    See

    AWSIoTCreateTopicRuleRequest

    Declaration

    Objective-C

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

    Swift

    func createTopicRule(_ request: AWSIoTCreateTopicRuleRequest) async throws

    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.

  • Creates a topic rule destination. The destination must be confirmed prior to use.

    Requires permission to access the CreateTopicRuleDestination action.

    See

    AWSIoTCreateTopicRuleDestinationRequest

    See

    AWSIoTCreateTopicRuleDestinationResponse

    Declaration

    Objective-C

    - (id)createTopicRuleDestination:
    (nonnull AWSIoTCreateTopicRuleDestinationRequest *)request;

    Swift

    func createTopicRuleDestination(_ request: AWSIoTCreateTopicRuleDestinationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates a topic rule destination. The destination must be confirmed prior to use.

    Requires permission to access the CreateTopicRuleDestination action.

    See

    AWSIoTCreateTopicRuleDestinationRequest

    See

    AWSIoTCreateTopicRuleDestinationResponse

    Declaration

    Objective-C

    - (void)createTopicRuleDestination:
            (nonnull AWSIoTCreateTopicRuleDestinationRequest *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSIoTCreateTopicRuleDestinationResponse *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func createTopicRuleDestination(_ request: AWSIoTCreateTopicRuleDestinationRequest) async throws -> AWSIoTCreateTopicRuleDestinationResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateTopicRuleDestination 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, AWSIoTErrorResourceAlreadyExists, AWSIoTErrorServiceUnavailable, AWSIoTErrorConflictingResourceUpdate.

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

    Requires permission to access the DeleteAccountAuditConfiguration action.

    See

    AWSIoTDeleteAccountAuditConfigurationRequest

    See

    AWSIoTDeleteAccountAuditConfigurationResponse

    Declaration

    Objective-C

    - (id)deleteAccountAuditConfiguration:
    (nonnull AWSIoTDeleteAccountAuditConfigurationRequest *)request;

    Swift

    func deleteAccountAuditConfiguration(_ request: AWSIoTDeleteAccountAuditConfigurationRequest) -> Any!

    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.

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

    Requires permission to access the DeleteAccountAuditConfiguration action.

    See

    AWSIoTDeleteAccountAuditConfigurationRequest

    See

    AWSIoTDeleteAccountAuditConfigurationResponse

    Declaration

    Objective-C

    - (void)deleteAccountAuditConfiguration:
            (nonnull AWSIoTDeleteAccountAuditConfigurationRequest *)request
                      completionHandler:
                          (void (^_Nullable)(
                              AWSIoTDeleteAccountAuditConfigurationResponse
                                  *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func deleteAccountAuditConfiguration(_ request: AWSIoTDeleteAccountAuditConfigurationRequest) async throws -> AWSIoTDeleteAccountAuditConfigurationResponse

    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.

  • Deletes a Device Defender audit suppression.

    Requires permission to access the DeleteAuditSuppression action.

    See

    AWSIoTDeleteAuditSuppressionRequest

    See

    AWSIoTDeleteAuditSuppressionResponse

    Declaration

    Objective-C

    - (id)deleteAuditSuppression:
    (nonnull AWSIoTDeleteAuditSuppressionRequest *)request;

    Swift

    func deleteAuditSuppression(_ request: AWSIoTDeleteAuditSuppressionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Deletes a Device Defender audit suppression.

    Requires permission to access the DeleteAuditSuppression action.

    See

    AWSIoTDeleteAuditSuppressionRequest

    See

    AWSIoTDeleteAuditSuppressionResponse

    Declaration

    Objective-C

    - (void)
    deleteAuditSuppression:
        (nonnull AWSIoTDeleteAuditSuppressionRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSIoTDeleteAuditSuppressionResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func deleteAuditSuppression(_ request: AWSIoTDeleteAuditSuppressionRequest) async throws -> AWSIoTDeleteAuditSuppressionResponse

    Parameters

    request

    A container for the necessary parameters to execute the DeleteAuditSuppression 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.

  • Deletes an authorizer.

    Requires permission to access the DeleteAuthorizer action.

    See

    AWSIoTDeleteAuthorizerRequest

    See

    AWSIoTDeleteAuthorizerResponse

    Declaration

    Objective-C

    - (id)deleteAuthorizer:(nonnull AWSIoTDeleteAuthorizerRequest *)request;

    Swift

    func deleteAuthorizer(_ request: AWSIoTDeleteAuthorizerRequest) -> Any!

    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.

  • Deletes an authorizer.

    Requires permission to access the DeleteAuthorizer action.

    See

    AWSIoTDeleteAuthorizerRequest

    See

    AWSIoTDeleteAuthorizerResponse

    Declaration

    Objective-C

    - (void)deleteAuthorizer:(nonnull AWSIoTDeleteAuthorizerRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSIoTDeleteAuthorizerResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func deleteAuthorizer(_ request: AWSIoTDeleteAuthorizerRequest) async throws -> AWSIoTDeleteAuthorizerResponse

    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.

  • Deletes the billing group.

    Requires permission to access the DeleteBillingGroup action.

    See

    AWSIoTDeleteBillingGroupRequest

    See

    AWSIoTDeleteBillingGroupResponse

    Declaration

    Objective-C

    - (id)deleteBillingGroup:(nonnull AWSIoTDeleteBillingGroupRequest *)request;

    Swift

    func deleteBillingGroup(_ request: AWSIoTDeleteBillingGroupRequest) -> Any!

    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.

  • Deletes the billing group.

    Requires permission to access the DeleteBillingGroup action.

    See

    AWSIoTDeleteBillingGroupRequest

    See

    AWSIoTDeleteBillingGroupResponse

    Declaration

    Objective-C

    - (void)deleteBillingGroup:(nonnull AWSIoTDeleteBillingGroupRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSIoTDeleteBillingGroupResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func deleteBillingGroup(_ request: AWSIoTDeleteBillingGroupRequest) async throws -> AWSIoTDeleteBillingGroupResponse

    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.

  • Deletes a registered CA certificate.

    Requires permission to access the DeleteCACertificate action.

    See

    AWSIoTDeleteCACertificateRequest

    See

    AWSIoTDeleteCACertificateResponse

    Declaration

    Objective-C

    - (id)deleteCACertificate:(nonnull AWSIoTDeleteCACertificateRequest *)request;

    Swift

    func deleteCACertificate(_ request: AWSIoTDeleteCACertificateRequest) -> Any!

    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.

  • Deletes a registered CA certificate.

    Requires permission to access the DeleteCACertificate action.

    See

    AWSIoTDeleteCACertificateRequest

    See

    AWSIoTDeleteCACertificateResponse

    Declaration

    Objective-C

    - (void)deleteCACertificate:(nonnull AWSIoTDeleteCACertificateRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSIoTDeleteCACertificateResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func deleteCACertificate(_ request: AWSIoTDeleteCACertificateRequest) async throws -> AWSIoTDeleteCACertificateResponse

    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.

  • Deletes the specified certificate.

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

    Requires permission to access the DeleteCertificate action.

    See

    AWSIoTDeleteCertificateRequest

    Declaration

    Objective-C

    - (id)deleteCertificate:(nonnull AWSIoTDeleteCertificateRequest *)request;

    Swift

    func deleteCertificate(_ request: AWSIoTDeleteCertificateRequest) -> Any!

    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.

  • Deletes the specified certificate.

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

    Requires permission to access the DeleteCertificate action.

    See

    AWSIoTDeleteCertificateRequest

    Declaration

    Objective-C

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

    Swift

    func deleteCertificate(_ request: AWSIoTDeleteCertificateRequest) async throws

    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.

  • Deletes a Device Defender detect custom metric.

    Requires permission to access the DeleteCustomMetric action.

    Before you can delete a custom metric, you must first remove the custom metric from all security profiles it’s a part of. The security profile associated with the custom metric can be found using the ListSecurityProfiles API with metricName set to your custom metric name.

    See

    AWSIoTDeleteCustomMetricRequest

    See

    AWSIoTDeleteCustomMetricResponse

    Declaration

    Objective-C

    - (id)deleteCustomMetric:(nonnull AWSIoTDeleteCustomMetricRequest *)request;

    Swift

    func deleteCustomMetric(_ request: AWSIoTDeleteCustomMetricRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Deletes a Device Defender detect custom metric.

    Requires permission to access the DeleteCustomMetric action.

    Before you can delete a custom metric, you must first remove the custom metric from all security profiles it’s a part of. The security profile associated with the custom metric can be found using the ListSecurityProfiles API with metricName set to your custom metric name.

    See

    AWSIoTDeleteCustomMetricRequest

    See

    AWSIoTDeleteCustomMetricResponse

    Declaration

    Objective-C

    - (void)deleteCustomMetric:(nonnull AWSIoTDeleteCustomMetricRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSIoTDeleteCustomMetricResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func deleteCustomMetric(_ request: AWSIoTDeleteCustomMetricRequest) async throws -> AWSIoTDeleteCustomMetricResponse

    Parameters

    request

    A container for the necessary parameters to execute the DeleteCustomMetric 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.

  • Removes the specified dimension from your Amazon Web Services accounts.

    Requires permission to access the DeleteDimension action.

    See

    AWSIoTDeleteDimensionRequest

    See

    AWSIoTDeleteDimensionResponse

    Declaration

    Objective-C

    - (id)deleteDimension:(nonnull AWSIoTDeleteDimensionRequest *)request;

    Swift

    func deleteDimension(_ request: AWSIoTDeleteDimensionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Removes the specified dimension from your Amazon Web Services accounts.

    Requires permission to access the DeleteDimension action.

    See

    AWSIoTDeleteDimensionRequest

    See

    AWSIoTDeleteDimensionResponse

    Declaration

    Objective-C

    - (void)deleteDimension:(nonnull AWSIoTDeleteDimensionRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSIoTDeleteDimensionResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func deleteDimension(_ request: AWSIoTDeleteDimensionRequest) async throws -> AWSIoTDeleteDimensionResponse

    Parameters

    request

    A container for the necessary parameters to execute the DeleteDimension 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, AWSIoTErrorThrottling.

  • Deletes the specified domain configuration.

    Requires permission to access the DeleteDomainConfiguration action.

    See

    AWSIoTDeleteDomainConfigurationRequest

    See

    AWSIoTDeleteDomainConfigurationResponse

    Declaration

    Objective-C

    - (id)deleteDomainConfiguration:
    (nonnull AWSIoTDeleteDomainConfigurationRequest *)request;

    Swift

    func deleteDomainConfiguration(_ request: AWSIoTDeleteDomainConfigurationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Deletes the specified domain configuration.

    Requires permission to access the DeleteDomainConfiguration action.

    See

    AWSIoTDeleteDomainConfigurationRequest

    See

    AWSIoTDeleteDomainConfigurationResponse

    Declaration

    Objective-C

    - (void)deleteDomainConfiguration:
            (nonnull AWSIoTDeleteDomainConfigurationRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSIoTDeleteDomainConfigurationResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func deleteDomainConfiguration(_ request: AWSIoTDeleteDomainConfigurationRequest) async throws -> AWSIoTDeleteDomainConfigurationResponse

    Parameters

    request

    A container for the necessary parameters to execute the DeleteDomainConfiguration 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, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorInvalidRequest.

  • Deletes a dynamic thing group.

    Requires permission to access the DeleteDynamicThingGroup action.

    See

    AWSIoTDeleteDynamicThingGroupRequest

    See

    AWSIoTDeleteDynamicThingGroupResponse

    Declaration

    Objective-C

    - (id)deleteDynamicThingGroup:
    (nonnull AWSIoTDeleteDynamicThingGroupRequest *)request;

    Swift

    func deleteDynamicThingGroup(_ request: AWSIoTDeleteDynamicThingGroupRequest) -> Any!

    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.

  • Deletes a dynamic thing group.

    Requires permission to access the DeleteDynamicThingGroup action.

    See

    AWSIoTDeleteDynamicThingGroupRequest

    See

    AWSIoTDeleteDynamicThingGroupResponse

    Declaration

    Objective-C

    - (void)deleteDynamicThingGroup:
            (nonnull AWSIoTDeleteDynamicThingGroupRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSIoTDeleteDynamicThingGroupResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func deleteDynamicThingGroup(_ request: AWSIoTDeleteDynamicThingGroupRequest) async throws -> AWSIoTDeleteDynamicThingGroupResponse

    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.

  • Deletes the specified fleet metric. Returns successfully with no error if the deletion is successful or you specify a fleet metric that doesn’t exist.

    Requires permission to access the DeleteFleetMetric action.

    See

    AWSIoTDeleteFleetMetricRequest

    Declaration

    Objective-C

    - (id)deleteFleetMetric:(nonnull AWSIoTDeleteFleetMetricRequest *)request;

    Swift

    func deleteFleetMetric(_ request: AWSIoTDeleteFleetMetricRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteFleetMetric 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, AWSIoTErrorVersionConflict.

  • Deletes the specified fleet metric. Returns successfully with no error if the deletion is successful or you specify a fleet metric that doesn’t exist.

    Requires permission to access the DeleteFleetMetric action.

    See

    AWSIoTDeleteFleetMetricRequest

    Declaration

    Objective-C

    - (void)deleteFleetMetric:(nonnull AWSIoTDeleteFleetMetricRequest *)request
        completionHandler:
            (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteFleetMetric(_ request: AWSIoTDeleteFleetMetricRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeleteFleetMetric 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, AWSIoTErrorVersionConflict.

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

    Requires permission to access the DeleteJob action.

    See

    AWSIoTDeleteJobRequest

    Declaration

    Objective-C

    - (id)deleteJob:(nonnull AWSIoTDeleteJobRequest *)request;

    Swift

    func deleteJob(_ request: AWSIoTDeleteJobRequest) -> Any!

    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.

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

    Requires permission to access the DeleteJob action.

    See

    AWSIoTDeleteJobRequest

    Declaration

    Objective-C

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

    Swift

    func deleteJob(_ request: AWSIoTDeleteJobRequest) async throws

    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.

  • Deletes a job execution.

    Requires permission to access the DeleteJobExecution action.

    See

    AWSIoTDeleteJobExecutionRequest

    Declaration

    Objective-C

    - (id)deleteJobExecution:(nonnull AWSIoTDeleteJobExecutionRequest *)request;

    Swift

    func deleteJobExecution(_ request: AWSIoTDeleteJobExecutionRequest) -> Any!

    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.

  • Deletes a job execution.

    Requires permission to access the DeleteJobExecution action.

    See

    AWSIoTDeleteJobExecutionRequest

    Declaration

    Objective-C

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

    Swift

    func deleteJobExecution(_ request: AWSIoTDeleteJobExecutionRequest) async throws

    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.

  • Deletes the specified job template.

    See

    AWSIoTDeleteJobTemplateRequest

    Declaration

    Objective-C

    - (id)deleteJobTemplate:(nonnull AWSIoTDeleteJobTemplateRequest *)request;

    Swift

    func deleteJobTemplate(_ request: AWSIoTDeleteJobTemplateRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteJobTemplate 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, AWSIoTErrorInternalFailure.

  • Deletes the specified job template.

    See

    AWSIoTDeleteJobTemplateRequest

    Declaration

    Objective-C

    - (void)deleteJobTemplate:(nonnull AWSIoTDeleteJobTemplateRequest *)request
        completionHandler:
            (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteJobTemplate(_ request: AWSIoTDeleteJobTemplateRequest) async throws

    Parameters

    request

    A container for the necessary parameters to execute the DeleteJobTemplate 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, AWSIoTErrorInternalFailure.

  • Deletes a defined mitigation action from your Amazon Web Services accounts.

    Requires permission to access the DeleteMitigationAction action.

    See

    AWSIoTDeleteMitigationActionRequest

    See

    AWSIoTDeleteMitigationActionResponse

    Declaration

    Objective-C

    - (id)deleteMitigationAction:
    (nonnull AWSIoTDeleteMitigationActionRequest *)request;

    Swift

    func deleteMitigationAction(_ request: AWSIoTDeleteMitigationActionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Deletes a defined mitigation action from your Amazon Web Services accounts.

    Requires permission to access the DeleteMitigationAction action.

    See

    AWSIoTDeleteMitigationActionRequest

    See

    AWSIoTDeleteMitigationActionResponse

    Declaration

    Objective-C

    - (void)
    deleteMitigationAction:
        (nonnull AWSIoTDeleteMitigationActionRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSIoTDeleteMitigationActionResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func deleteMitigationAction(_ request: AWSIoTDeleteMitigationActionRequest) async throws -> AWSIoTDeleteMitigationActionResponse

    Parameters

    request

    A container for the necessary parameters to execute the DeleteMitigationAction 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.

  • Delete an OTA update.

    Requires permission to access the DeleteOTAUpdate action.

    See

    AWSIoTDeleteOTAUpdateRequest

    See

    AWSIoTDeleteOTAUpdateResponse

    Declaration

    Objective-C

    - (id)deleteOTAUpdate:(nonnull AWSIoTDeleteOTAUpdateRequest *)request;

    Swift

    func deleteOTAUpdate(_ request: AWSIoTDeleteOTAUpdateRequest) -> Any!

    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.

  • Delete an OTA update.

    Requires permission to access the DeleteOTAUpdate action.

    See

    AWSIoTDeleteOTAUpdateRequest

    See

    AWSIoTDeleteOTAUpdateResponse

    Declaration

    Objective-C

    - (void)deleteOTAUpdate:(nonnull AWSIoTDeleteOTAUpdateRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSIoTDeleteOTAUpdateResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func deleteOTAUpdate(_ request: AWSIoTDeleteOTAUpdateRequest) async throws -> AWSIoTDeleteOTAUpdateResponse

    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.

  • 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 action to delete all non-default versions of the policy; use the DetachPolicy action to detach the policy from any certificate; and then use the DeletePolicy action to delete the policy.

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

    Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it’s ready to be deleted.

    Requires permission to access the DeletePolicy action.

    See

    AWSIoTDeletePolicyRequest

    Declaration

    Objective-C

    - (id)deletePolicy:(nonnull AWSIoTDeletePolicyRequest *)request;

    Swift

    func deletePolicy(_ request: AWSIoTDeletePolicyRequest) -> Any!

    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.

  • 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 action to delete all non-default versions of the policy; use the DetachPolicy action to detach the policy from any certificate; and then use the DeletePolicy action to delete the policy.

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

    Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it’s ready to be deleted.

    Requires permission to access the DeletePolicy action.

    See

    AWSIoTDeletePolicyRequest

    Declaration

    Objective-C

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

    Swift

    func deletePolicy(_ request: AWSIoTDeletePolicyRequest) async throws

    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.

  • Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this action. 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.

    Requires permission to access the DeletePolicyVersion action.

    See

    AWSIoTDeletePolicyVersionRequest

    Declaration

    Objective-C

    - (id)deletePolicyVersion:(nonnull AWSIoTDeletePolicyVersionRequest *)request;

    Swift

    func deletePolicyVersion(_ request: AWSIoTDeletePolicyVersionRequest) -> Any!

    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.

  • Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this action. 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.

    Requires permission to access the DeletePolicyVersion action.

    See

    AWSIoTDeletePolicyVersionRequest

    Declaration

    Objective-C

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

    Swift

    func deletePolicyVersion(_ request: AWSIoTDeletePolicyVersionRequest) async throws

    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.

  • Deletes a provisioning template.

    Requires permission to access the DeleteProvisioningTemplate action.

    See

    AWSIoTDeleteProvisioningTemplateRequest

    See

    AWSIoTDeleteProvisioningTemplateResponse

    Declaration

    Objective-C

    - (id)deleteProvisioningTemplate:
    (nonnull AWSIoTDeleteProvisioningTemplateRequest *)request;

    Swift

    func deleteProvisioningTemplate(_ request: AWSIoTDeleteProvisioningTemplateRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Deletes a provisioning template.

    Requires permission to access the DeleteProvisioningTemplate action.

    See

    AWSIoTDeleteProvisioningTemplateRequest

    See

    AWSIoTDeleteProvisioningTemplateResponse

    Declaration

    Objective-C

    - (void)deleteProvisioningTemplate:
            (nonnull AWSIoTDeleteProvisioningTemplateRequest *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSIoTDeleteProvisioningTemplateResponse *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func deleteProvisioningTemplate(_ request: AWSIoTDeleteProvisioningTemplateRequest) async throws -> AWSIoTDeleteProvisioningTemplateResponse

    Parameters

    request

    A container for the necessary parameters to execute the DeleteProvisioningTemplate 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, AWSIoTErrorResourceNotFound, AWSIoTErrorDeleteConflict, AWSIoTErrorThrottling, AWSIoTErrorConflictingResourceUpdate, AWSIoTErrorUnauthorized.

  • Deletes a provisioning template version.

    Requires permission to access the DeleteProvisioningTemplateVersion action.

    See

    AWSIoTDeleteProvisioningTemplateVersionRequest

    See

    AWSIoTDeleteProvisioningTemplateVersionResponse

    Declaration

    Objective-C

    - (id)deleteProvisioningTemplateVersion:
    (nonnull AWSIoTDeleteProvisioningTemplateVersionRequest *)request;

    Swift

    func deleteProvisioningTemplateVersion(_ request: AWSIoTDeleteProvisioningTemplateVersionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Deletes a provisioning template version.

    Requires permission to access the DeleteProvisioningTemplateVersion action.

    See

    AWSIoTDeleteProvisioningTemplateVersionRequest

    See

    AWSIoTDeleteProvisioningTemplateVersionResponse

    Declaration

    Objective-C

    - (void)deleteProvisioningTemplateVersion:
            (nonnull AWSIoTDeleteProvisioningTemplateVersionRequest *)request
                        completionHandler:
                            (void (^_Nullable)(
                                AWSIoTDeleteProvisioningTemplateVersionResponse
                                    *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func deleteProvisioningTemplateVersion(_ request: AWSIoTDeleteProvisioningTemplateVersionRequest) async throws -> AWSIoTDeleteProvisioningTemplateVersionResponse

    Parameters

    request

    A container for the necessary parameters to execute the DeleteProvisioningTemplateVersion 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, AWSIoTErrorThrottling, AWSIoTErrorResourceNotFound, AWSIoTErrorUnauthorized, AWSIoTErrorConflictingResourceUpdate, AWSIoTErrorDeleteConflict.

  • Deletes a CA certificate registration code.

    Requires permission to access the DeleteRegistrationCode action.

    See

    AWSIoTDeleteRegistrationCodeRequest

    See

    AWSIoTDeleteRegistrationCodeResponse

    Declaration

    Objective-C

    - (id)deleteRegistrationCode:
    (nonnull AWSIoTDeleteRegistrationCodeRequest *)request;

    Swift

    func deleteRegistrationCode(_ request: AWSIoTDeleteRegistrationCodeRequest) -> Any!

    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.

  • Deletes a CA certificate registration code.

    Requires permission to access the DeleteRegistrationCode action.

    See

    AWSIoTDeleteRegistrationCodeRequest

    See

    AWSIoTDeleteRegistrationCodeResponse

    Declaration

    Objective-C

    - (void)
    deleteRegistrationCode:
        (nonnull AWSIoTDeleteRegistrationCodeRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSIoTDeleteRegistrationCodeResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func deleteRegistrationCode(_ request: AWSIoTDeleteRegistrationCodeRequest) async throws -> AWSIoTDeleteRegistrationCodeResponse

    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.

  • Deletes a role alias

    Requires permission to access the DeleteRoleAlias action.

    See

    AWSIoTDeleteRoleAliasRequest

    See

    AWSIoTDeleteRoleAliasResponse

    Declaration

    Objective-C

    - (id)deleteRoleAlias:(nonnull AWSIoTDeleteRoleAliasRequest *)request;

    Swift

    func deleteRoleAlias(_ request: AWSIoTDeleteRoleAliasRequest) -> Any!

    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.

  • Deletes a role alias

    Requires permission to access the DeleteRoleAlias action.

    See

    AWSIoTDeleteRoleAliasRequest

    See

    AWSIoTDeleteRoleAliasResponse

    Declaration

    Objective-C

    - (void)deleteRoleAlias:(nonnull AWSIoTDeleteRoleAliasRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSIoTDeleteRoleAliasResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func deleteRoleAlias(_ request: AWSIoTDeleteRoleAliasRequest) async throws -> AWSIoTDeleteRoleAliasResponse

    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.

  • Deletes a scheduled audit.

    Requires permission to access the DeleteScheduledAudit action.

    See

    AWSIoTDeleteScheduledAuditRequest

    See

    AWSIoTDeleteScheduledAuditResponse

    Declaration

    Objective-C

    - (id)deleteScheduledAudit:(nonnull AWSIoTDeleteScheduledAuditRequest *)request;

    Swift

    func deleteScheduledAudit(_ request: AWSIoTDeleteScheduledAuditRequest) -> Any!

    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.

  • Deletes a scheduled audit.

    Requires permission to access the DeleteScheduledAudit action.

    See

    AWSIoTDeleteScheduledAuditRequest

    See

    AWSIoTDeleteScheduledAuditResponse

    Declaration

    Objective-C

    - (void)deleteScheduledAudit:
            (nonnull AWSIoTDeleteScheduledAuditRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSIoTDeleteScheduledAuditResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func deleteScheduledAudit(_ request: AWSIoTDeleteScheduledAuditRequest) async throws -> AWSIoTDeleteScheduledAuditResponse

    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.

  • Deletes a Device Defender security profile.

    Requires permission to access the DeleteSecurityProfile action.

    See

    AWSIoTDeleteSecurityProfileRequest

    See

    AWSIoTDeleteSecurityProfileResponse

    Declaration

    Objective-C

    - (id)deleteSecurityProfile:
    (nonnull AWSIoTDeleteSecurityProfileRequest *)request;

    Swift

    func deleteSecurityProfile(_ request: AWSIoTDeleteSecurityProfileRequest) -> Any!

    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.

  • Deletes a Device Defender security profile.

    Requires permission to access the DeleteSecurityProfile action.

    See

    AWSIoTDeleteSecurityProfileRequest

    See

    AWSIoTDeleteSecurityProfileResponse

    Declaration

    Objective-C

    - (void)
    deleteSecurityProfile:(nonnull AWSIoTDeleteSecurityProfileRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSIoTDeleteSecurityProfileResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func deleteSecurityProfile(_ request: AWSIoTDeleteSecurityProfileRequest) async throws -> AWSIoTDeleteSecurityProfileResponse

    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.

  • Deletes a stream.

    Requires permission to access the DeleteStream action.

    See

    AWSIoTDeleteStreamRequest

    See

    AWSIoTDeleteStreamResponse

    Declaration

    Objective-C

    - (id)deleteStream:(nonnull AWSIoTDeleteStreamRequest *)request;

    Swift

    func deleteStream(_ request: AWSIoTDeleteStreamRequest) -> Any!

    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.

  • Deletes a stream.

    Requires permission to access the DeleteStream action.

    See

    AWSIoTDeleteStreamRequest

    See

    AWSIoTDeleteStreamResponse

    Declaration

    Objective-C

    - (void)deleteStream:(nonnull AWSIoTDeleteStreamRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTDeleteStreamResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func deleteStream(_ request: AWSIoTDeleteStreamRequest) async throws -> AWSIoTDeleteStreamResponse

    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.

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

    Requires permission to access the DeleteThing action.

    See

    AWSIoTDeleteThingRequest

    See

    AWSIoTDeleteThingResponse

    Declaration

    Objective-C

    - (id)deleteThing:(nonnull AWSIoTDeleteThingRequest *)request;

    Swift

    func deleteThing(_ request: AWSIoTDeleteThingRequest) -> Any!

    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.

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

    Requires permission to access the DeleteThing action.

    See

    AWSIoTDeleteThingRequest

    See

    AWSIoTDeleteThingResponse

    Declaration

    Objective-C

    - (void)deleteThing:(nonnull AWSIoTDeleteThingRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTDeleteThingResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func deleteThing(_ request: AWSIoTDeleteThingRequest) async throws -> AWSIoTDeleteThingResponse

    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.

  • Deletes a thing group.

    Requires permission to access the DeleteThingGroup action.

    See

    AWSIoTDeleteThingGroupRequest

    See

    AWSIoTDeleteThingGroupResponse

    Declaration

    Objective-C

    - (id)deleteThingGroup:(nonnull AWSIoTDeleteThingGroupRequest *)request;

    Swift

    func deleteThingGroup(_ request: AWSIoTDeleteThingGroupRequest) -> Any!

    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.

  • Deletes a thing group.

    Requires permission to access the DeleteThingGroup action.

    See

    AWSIoTDeleteThingGroupRequest

    See

    AWSIoTDeleteThingGroupResponse

    Declaration

    Objective-C

    - (void)deleteThingGroup:(nonnull AWSIoTDeleteThingGroupRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSIoTDeleteThingGroupResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func deleteThingGroup(_ request: AWSIoTDeleteThingGroupRequest) async throws -> AWSIoTDeleteThingGroupResponse

    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.

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

    Requires permission to access the DeleteThingType action.

    See

    AWSIoTDeleteThingTypeRequest

    See

    AWSIoTDeleteThingTypeResponse

    Declaration

    Objective-C

    - (id)deleteThingType:(nonnull AWSIoTDeleteThingTypeRequest *)request;

    Swift

    func deleteThingType(_ request: AWSIoTDeleteThingTypeRequest) -> Any!

    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.

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

    Requires permission to access the DeleteThingType action.

    See

    AWSIoTDeleteThingTypeRequest

    See

    AWSIoTDeleteThingTypeResponse

    Declaration

    Objective-C

    - (void)deleteThingType:(nonnull AWSIoTDeleteThingTypeRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSIoTDeleteThingTypeResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func deleteThingType(_ request: AWSIoTDeleteThingTypeRequest) async throws -> AWSIoTDeleteThingTypeResponse

    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.

  • Deletes the rule.

    Requires permission to access the DeleteTopicRule action.

    See

    AWSIoTDeleteTopicRuleRequest

    Declaration

    Objective-C

    - (id)deleteTopicRule:(nonnull AWSIoTDeleteTopicRuleRequest *)request;

    Swift

    func deleteTopicRule(_ request: AWSIoTDeleteTopicRuleRequest) -> Any!

    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.

  • Deletes the rule.

    Requires permission to access the DeleteTopicRule action.

    See

    AWSIoTDeleteTopicRuleRequest

    Declaration

    Objective-C

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

    Swift

    func deleteTopicRule(_ request: AWSIoTDeleteTopicRuleRequest) async throws

    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.

  • Deletes a topic rule destination.

    Requires permission to access the DeleteTopicRuleDestination action.

    See

    AWSIoTDeleteTopicRuleDestinationRequest

    See

    AWSIoTDeleteTopicRuleDestinationResponse

    Declaration

    Objective-C

    - (id)deleteTopicRuleDestination:
    (nonnull AWSIoTDeleteTopicRuleDestinationRequest *)request;

    Swift

    func deleteTopicRuleDestination(_ request: AWSIoTDeleteTopicRuleDestinationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Deletes a topic rule destination.

    Requires permission to access the DeleteTopicRuleDestination action.

    See

    AWSIoTDeleteTopicRuleDestinationRequest

    See

    AWSIoTDeleteTopicRuleDestinationResponse

    Declaration

    Objective-C

    - (void)deleteTopicRuleDestination:
            (nonnull AWSIoTDeleteTopicRuleDestinationRequest *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSIoTDeleteTopicRuleDestinationResponse *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func deleteTopicRuleDestination(_ request: AWSIoTDeleteTopicRuleDestinationRequest) async throws -> AWSIoTDeleteTopicRuleDestinationResponse

    Parameters

    request

    A container for the necessary parameters to execute the DeleteTopicRuleDestination 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, AWSIoTErrorConflictingResourceUpdate.

  • Deletes a logging level.

    Requires permission to access the DeleteV2LoggingLevel action.

    See

    AWSIoTDeleteV2LoggingLevelRequest

    Declaration

    Objective-C

    - (id)deleteV2LoggingLevel:(nonnull AWSIoTDeleteV2LoggingLevelRequest *)request;

    Swift

    func deleteV2LoggingLevel(_ request: AWSIoTDeleteV2LoggingLevelRequest) -> Any!

    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.

  • Deletes a logging level.

    Requires permission to access the DeleteV2LoggingLevel action.

    See

    AWSIoTDeleteV2LoggingLevelRequest

    Declaration

    Objective-C

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

    Swift

    func deleteV2LoggingLevel(_ request: AWSIoTDeleteV2LoggingLevelRequest) async throws

    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.

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

    Requires permission to access the DeprecateThingType action.

    See

    AWSIoTDeprecateThingTypeRequest

    See

    AWSIoTDeprecateThingTypeResponse

    Declaration

    Objective-C

    - (id)deprecateThingType:(nonnull AWSIoTDeprecateThingTypeRequest *)request;

    Swift

    func deprecateThingType(_ request: AWSIoTDeprecateThingTypeRequest) -> Any!

    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.

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

    Requires permission to access the DeprecateThingType action.

    See

    AWSIoTDeprecateThingTypeRequest

    See

    AWSIoTDeprecateThingTypeResponse

    Declaration

    Objective-C

    - (void)deprecateThingType:(nonnull AWSIoTDeprecateThingTypeRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSIoTDeprecateThingTypeResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func deprecateThingType(_ request: AWSIoTDeprecateThingTypeRequest) async throws -> AWSIoTDeprecateThingTypeResponse

    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.

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

    Requires permission to access the DescribeAccountAuditConfiguration action.

    See

    AWSIoTDescribeAccountAuditConfigurationRequest

    See

    AWSIoTDescribeAccountAuditConfigurationResponse

    Declaration

    Objective-C

    - (id)describeAccountAuditConfiguration:
    (nonnull AWSIoTDescribeAccountAuditConfigurationRequest *)request;

    Swift

    func describeAccountAuditConfiguration(_ request: AWSIoTDescribeAccountAuditConfigurationRequest) -> Any!

    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.

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

    Requires permission to access the DescribeAccountAuditConfiguration action.

    See

    AWSIoTDescribeAccountAuditConfigurationRequest

    See

    AWSIoTDescribeAccountAuditConfigurationResponse

    Declaration

    Objective-C

    - (void)describeAccountAuditConfiguration:
            (nonnull AWSIoTDescribeAccountAuditConfigurationRequest *)request
                        completionHandler:
                            (void (^_Nullable)(
                                AWSIoTDescribeAccountAuditConfigurationResponse
                                    *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func describeAccountAuditConfiguration(_ request: AWSIoTDescribeAccountAuditConfigurationRequest) async throws -> AWSIoTDescribeAccountAuditConfigurationResponse

    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.

  • Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and the start time when the audit that returned the finding.

    Requires permission to access the DescribeAuditFinding action.

    See

    AWSIoTDescribeAuditFindingRequest

    See

    AWSIoTDescribeAuditFindingResponse

    Declaration

    Objective-C

    - (id)describeAuditFinding:(nonnull AWSIoTDescribeAuditFindingRequest *)request;

    Swift

    func describeAuditFinding(_ request: AWSIoTDescribeAuditFindingRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and the start time when the audit that returned the finding.

    Requires permission to access the DescribeAuditFinding action.

    See

    AWSIoTDescribeAuditFindingRequest

    See

    AWSIoTDescribeAuditFindingResponse

    Declaration

    Objective-C

    - (void)describeAuditFinding:
            (nonnull AWSIoTDescribeAuditFindingRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSIoTDescribeAuditFindingResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func describeAuditFinding(_ request: AWSIoTDescribeAuditFindingRequest) async throws -> AWSIoTDescribeAuditFindingResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeAuditFinding 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.

  • Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they’re being applied, the task status, and aggregated task statistics.

    See

    AWSIoTDescribeAuditMitigationActionsTaskRequest

    See

    AWSIoTDescribeAuditMitigationActionsTaskResponse

    Declaration

    Objective-C

    - (id)describeAuditMitigationActionsTask:
    (nonnull AWSIoTDescribeAuditMitigationActionsTaskRequest *)request;

    Swift

    func describeAuditMitigationActionsTask(_ request: AWSIoTDescribeAuditMitigationActionsTaskRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they’re being applied, the task status, and aggregated task statistics.

    See

    AWSIoTDescribeAuditMitigationActionsTaskRequest

    See

    AWSIoTDescribeAuditMitigationActionsTaskResponse

    Declaration

    Objective-C

    - (void)
    describeAuditMitigationActionsTask:
        (nonnull AWSIoTDescribeAuditMitigationActionsTaskRequest *)request
                     completionHandler:
                         (void (^_Nullable)(
                             AWSIoTDescribeAuditMitigationActionsTaskResponse
                                 *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func describeAuditMitigationActionsTask(_ request: AWSIoTDescribeAuditMitigationActionsTaskRequest) async throws -> AWSIoTDescribeAuditMitigationActionsTaskResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeAuditMitigationActionsTask 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.

  • Gets information about a Device Defender audit suppression.

    See

    AWSIoTDescribeAuditSuppressionRequest

    See

    AWSIoTDescribeAuditSuppressionResponse

    Declaration

    Objective-C

    - (id)describeAuditSuppression:
    (nonnull AWSIoTDescribeAuditSuppressionRequest *)request;

    Swift

    func describeAuditSuppression(_ request: AWSIoTDescribeAuditSuppressionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets information about a Device Defender audit suppression.

    See

    AWSIoTDescribeAuditSuppressionRequest

    See

    AWSIoTDescribeAuditSuppressionResponse

    Declaration

    Objective-C

    - (void)describeAuditSuppression:
            (nonnull AWSIoTDescribeAuditSuppressionRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSIoTDescribeAuditSuppressionResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func describeAuditSuppression(_ request: AWSIoTDescribeAuditSuppressionRequest) async throws -> AWSIoTDescribeAuditSuppressionResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeAuditSuppression 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.

  • Gets information about a Device Defender audit.

    Requires permission to access the DescribeAuditTask action.

    See

    AWSIoTDescribeAuditTaskRequest

    See

    AWSIoTDescribeAuditTaskResponse

    Declaration

    Objective-C

    - (id)describeAuditTask:(nonnull AWSIoTDescribeAuditTaskRequest *)request;

    Swift

    func describeAuditTask(_ request: AWSIoTDescribeAuditTaskRequest) -> Any!

    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.

  • Gets information about a Device Defender audit.

    Requires permission to access the DescribeAuditTask action.

    See

    AWSIoTDescribeAuditTaskRequest

    See

    AWSIoTDescribeAuditTaskResponse

    Declaration

    Objective-C

    - (void)describeAuditTask:(nonnull AWSIoTDescribeAuditTaskRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSIoTDescribeAuditTaskResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func describeAuditTask(_ request: AWSIoTDescribeAuditTaskRequest) async throws -> AWSIoTDescribeAuditTaskResponse

    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.

  • Describes an authorizer.

    Requires permission to access the DescribeAuthorizer action.

    See

    AWSIoTDescribeAuthorizerRequest

    See

    AWSIoTDescribeAuthorizerResponse

    Declaration

    Objective-C

    - (id)describeAuthorizer:(nonnull AWSIoTDescribeAuthorizerRequest *)request;

    Swift

    func describeAuthorizer(_ request: AWSIoTDescribeAuthorizerRequest) -> Any!

    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.

  • Describes an authorizer.

    Requires permission to access the DescribeAuthorizer action.

    See

    AWSIoTDescribeAuthorizerRequest

    See

    AWSIoTDescribeAuthorizerResponse

    Declaration

    Objective-C

    - (void)describeAuthorizer:(nonnull AWSIoTDescribeAuthorizerRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSIoTDescribeAuthorizerResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func describeAuthorizer(_ request: AWSIoTDescribeAuthorizerRequest) async throws -> AWSIoTDescribeAuthorizerResponse

    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.

  • Returns information about a billing group.

    Requires permission to access the DescribeBillingGroup action.

    See

    AWSIoTDescribeBillingGroupRequest

    See

    AWSIoTDescribeBillingGroupResponse

    Declaration

    Objective-C

    - (id)describeBillingGroup:(nonnull AWSIoTDescribeBillingGroupRequest *)request;

    Swift

    func describeBillingGroup(_ request: AWSIoTDescribeBillingGroupRequest) -> Any!

    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.

  • Returns information about a billing group.

    Requires permission to access the DescribeBillingGroup action.

    See

    AWSIoTDescribeBillingGroupRequest

    See

    AWSIoTDescribeBillingGroupResponse

    Declaration

    Objective-C

    - (void)describeBillingGroup:
            (nonnull AWSIoTDescribeBillingGroupRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSIoTDescribeBillingGroupResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func describeBillingGroup(_ request: AWSIoTDescribeBillingGroupRequest) async throws -> AWSIoTDescribeBillingGroupResponse

    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.

  • Describes a registered CA certificate.

    Requires permission to access the DescribeCACertificate action.

    See

    AWSIoTDescribeCACertificateRequest

    See

    AWSIoTDescribeCACertificateResponse

    Declaration

    Objective-C

    - (id)describeCACertificate:
    (nonnull AWSIoTDescribeCACertificateRequest *)request;

    Swift

    func describeCACertificate(_ request: AWSIoTDescribeCACertificateRequest) -> Any!

    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.

  • Describes a registered CA certificate.

    Requires permission to access the DescribeCACertificate action.

    See

    AWSIoTDescribeCACertificateRequest

    See

    AWSIoTDescribeCACertificateResponse

    Declaration

    Objective-C

    - (void)
    describeCACertificate:(nonnull AWSIoTDescribeCACertificateRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSIoTDescribeCACertificateResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func describeCACertificate(_ request: AWSIoTDescribeCACertificateRequest) async throws -> AWSIoTDescribeCACertificateResponse

    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.

  • Gets information about the specified certificate.

    Requires permission to access the DescribeCertificate action.

    See

    AWSIoTDescribeCertificateRequest

    See

    AWSIoTDescribeCertificateResponse

    Declaration

    Objective-C

    - (id)describeCertificate:(nonnull AWSIoTDescribeCertificateRequest *)request;

    Swift

    func describeCertificate(_ request: AWSIoTDescribeCertificateRequest) -> Any!

    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.

  • Gets information about the specified certificate.

    Requires permission to access the DescribeCertificate action.

    See

    AWSIoTDescribeCertificateRequest

    See

    AWSIoTDescribeCertificateResponse

    Declaration

    Objective-C

    - (void)describeCertificate:(nonnull AWSIoTDescribeCertificateRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSIoTDescribeCertificateResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func describeCertificate(_ request: AWSIoTDescribeCertificateRequest) async throws -> AWSIoTDescribeCertificateResponse

    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.

  • Gets information about a Device Defender detect custom metric.

    Requires permission to access the DescribeCustomMetric action.

    See

    AWSIoTDescribeCustomMetricRequest

    See

    AWSIoTDescribeCustomMetricResponse

    Declaration

    Objective-C

    - (id)describeCustomMetric:(nonnull AWSIoTDescribeCustomMetricRequest *)request;

    Swift

    func describeCustomMetric(_ request: AWSIoTDescribeCustomMetricRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets information about a Device Defender detect custom metric.

    Requires permission to access the DescribeCustomMetric action.

    See

    AWSIoTDescribeCustomMetricRequest

    See

    AWSIoTDescribeCustomMetricResponse

    Declaration

    Objective-C

    - (void)describeCustomMetric:
            (nonnull AWSIoTDescribeCustomMetricRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSIoTDescribeCustomMetricResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func describeCustomMetric(_ request: AWSIoTDescribeCustomMetricRequest) async throws -> AWSIoTDescribeCustomMetricResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeCustomMetric 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.

  • Describes the default authorizer.

    Requires permission to access the DescribeDefaultAuthorizer action.

    See

    AWSIoTDescribeDefaultAuthorizerRequest

    See

    AWSIoTDescribeDefaultAuthorizerResponse

    Declaration

    Objective-C

    - (id)describeDefaultAuthorizer:
    (nonnull AWSIoTDescribeDefaultAuthorizerRequest *)request;

    Swift

    func describeDefaultAuthorizer(_ request: AWSIoTDescribeDefaultAuthorizerRequest) -> Any!

    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.

  • Describes the default authorizer.

    Requires permission to access the DescribeDefaultAuthorizer action.

    See

    AWSIoTDescribeDefaultAuthorizerRequest

    See

    AWSIoTDescribeDefaultAuthorizerResponse

    Declaration

    Objective-C

    - (void)describeDefaultAuthorizer:
            (nonnull AWSIoTDescribeDefaultAuthorizerRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSIoTDescribeDefaultAuthorizerResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func describeDefaultAuthorizer(_ request: AWSIoTDescribeDefaultAuthorizerRequest) async throws -> AWSIoTDescribeDefaultAuthorizerResponse

    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.

  • Gets information about a Device Defender ML Detect mitigation action.

    Requires permission to access the DescribeDetectMitigationActionsTask action.

    See

    AWSIoTDescribeDetectMitigationActionsTaskRequest

    See

    AWSIoTDescribeDetectMitigationActionsTaskResponse

    Declaration

    Objective-C

    - (id)describeDetectMitigationActionsTask:
    (nonnull AWSIoTDescribeDetectMitigationActionsTaskRequest *)request;

    Swift

    func describeDetectMitigationActionsTask(_ request: AWSIoTDescribeDetectMitigationActionsTaskRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets information about a Device Defender ML Detect mitigation action.

    Requires permission to access the DescribeDetectMitigationActionsTask action.

    See

    AWSIoTDescribeDetectMitigationActionsTaskRequest

    See

    AWSIoTDescribeDetectMitigationActionsTaskResponse

    Declaration

    Objective-C

    - (void)
    describeDetectMitigationActionsTask:
        (nonnull AWSIoTDescribeDetectMitigationActionsTaskRequest *)request
                      completionHandler:
                          (void (^_Nullable)(
                              AWSIoTDescribeDetectMitigationActionsTaskResponse
                                  *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func describeDetectMitigationActionsTask(_ request: AWSIoTDescribeDetectMitigationActionsTaskRequest) async throws -> AWSIoTDescribeDetectMitigationActionsTaskResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeDetectMitigationActionsTask 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.

  • Provides details about a dimension that is defined in your Amazon Web Services accounts.

    Requires permission to access the DescribeDimension action.

    See

    AWSIoTDescribeDimensionRequest

    See

    AWSIoTDescribeDimensionResponse

    Declaration

    Objective-C

    - (id)describeDimension:(nonnull AWSIoTDescribeDimensionRequest *)request;

    Swift

    func describeDimension(_ request: AWSIoTDescribeDimensionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Provides details about a dimension that is defined in your Amazon Web Services accounts.

    Requires permission to access the DescribeDimension action.

    See

    AWSIoTDescribeDimensionRequest

    See

    AWSIoTDescribeDimensionResponse

    Declaration

    Objective-C

    - (void)describeDimension:(nonnull AWSIoTDescribeDimensionRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSIoTDescribeDimensionResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func describeDimension(_ request: AWSIoTDescribeDimensionRequest) async throws -> AWSIoTDescribeDimensionResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeDimension 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, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling.

  • Gets summary information about a domain configuration.

    Requires permission to access the DescribeDomainConfiguration action.

    See

    AWSIoTDescribeDomainConfigurationRequest

    See

    AWSIoTDescribeDomainConfigurationResponse

    Declaration

    Objective-C

    - (id)describeDomainConfiguration:
    (nonnull AWSIoTDescribeDomainConfigurationRequest *)request;

    Swift

    func describeDomainConfiguration(_ request: AWSIoTDescribeDomainConfigurationRequest)