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

    Requires permission to access the CreateCertificateFromCsr action.

    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-521 curves. For supported certificates, consult Certificate signing algorithms supported by IoT.

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

    You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs. In the following commands, we assume that 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.

    You can also run the aws iot create-certificate-from-csr part of the command 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.

    Requires permission to access the CreateCertificateFromCsr action.

    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-521 curves. For supported certificates, consult Certificate signing algorithms supported by IoT.

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

    You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs. In the following commands, we assume that 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.

    You can also run the aws iot create-certificate-from-csr part of the command 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.

  • Creates an Amazon Web Services IoT Core certificate provider. You can use Amazon Web Services IoT Core certificate provider to customize how to sign a certificate signing request (CSR) in IoT fleet provisioning. For more information, see Customizing certificate signing using Amazon Web Services IoT Core certificate provider from Amazon Web Services IoT Core Developer Guide.

    Requires permission to access the CreateCertificateProvider action.

    After you create a certificate provider, the behavior of CreateCertificateFromCsr API for fleet provisioning will change and all API calls to CreateCertificateFromCsr will invoke the certificate provider to create the certificates. It can take up to a few minutes for this behavior to change after a certificate provider is created.

    See

    AWSIoTCreateCertificateProviderRequest

    See

    AWSIoTCreateCertificateProviderResponse

    Declaration

    Objective-C

    - (id)createCertificateProvider:
    (nonnull AWSIoTCreateCertificateProviderRequest *)request;

    Swift

    func createCertificateProvider(_ request: AWSIoTCreateCertificateProviderRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates an Amazon Web Services IoT Core certificate provider. You can use Amazon Web Services IoT Core certificate provider to customize how to sign a certificate signing request (CSR) in IoT fleet provisioning. For more information, see Customizing certificate signing using Amazon Web Services IoT Core certificate provider from Amazon Web Services IoT Core Developer Guide.

    Requires permission to access the CreateCertificateProvider action.

    After you create a certificate provider, the behavior of CreateCertificateFromCsr API for fleet provisioning will change and all API calls to CreateCertificateFromCsr will invoke the certificate provider to create the certificates. It can take up to a few minutes for this behavior to change after a certificate provider is created.

    See

    AWSIoTCreateCertificateProviderRequest

    See

    AWSIoTCreateCertificateProviderResponse

    Declaration

    Objective-C

    - (void)createCertificateProvider:
            (nonnull AWSIoTCreateCertificateProviderRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSIoTCreateCertificateProviderResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func createCertificateProvider(_ request: AWSIoTCreateCertificateProviderRequest) async throws -> AWSIoTCreateCertificateProviderResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateCertificateProvider 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, AWSIoTErrorResourceAlreadyExists, 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 software package that can be deployed to your fleet.

    Requires permission to access the CreatePackage and GetIndexingConfiguration actions.

    See

    AWSIoTCreatePackageRequest

    See

    AWSIoTCreatePackageResponse

    Declaration

    Objective-C

    - (id)createPackage:(nonnull AWSIoTCreatePackageRequest *)request;

    Swift

    func createPackage(_ request: AWSIoTCreatePackageRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTCreatePackageResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorThrottling, AWSIoTErrorConflict, AWSIoTErrorInternalServer, AWSIoTErrorValidation, AWSIoTErrorServiceQuotaExceeded.

  • Creates an IoT software package that can be deployed to your fleet.

    Requires permission to access the CreatePackage and GetIndexingConfiguration actions.

    See

    AWSIoTCreatePackageRequest

    See

    AWSIoTCreatePackageResponse

    Declaration

    Objective-C

    - (void)createPackage:(nonnull AWSIoTCreatePackageRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTCreatePackageResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func createPackage(_ request: AWSIoTCreatePackageRequest) async throws -> AWSIoTCreatePackageResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreatePackage 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, AWSIoTErrorConflict, AWSIoTErrorInternalServer, AWSIoTErrorValidation, AWSIoTErrorServiceQuotaExceeded.

  • Creates a new version for an existing IoT software package.

    Requires permission to access the CreatePackageVersion and GetIndexingConfiguration actions.

    See

    AWSIoTCreatePackageVersionRequest

    See

    AWSIoTCreatePackageVersionResponse

    Declaration

    Objective-C

    - (id)createPackageVersion:(nonnull AWSIoTCreatePackageVersionRequest *)request;

    Swift

    func createPackageVersion(_ request: AWSIoTCreatePackageVersionRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTCreatePackageVersionResponse. On failed execution, task.error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorThrottling, AWSIoTErrorConflict, AWSIoTErrorInternalServer, AWSIoTErrorValidation, AWSIoTErrorServiceQuotaExceeded.

  • Creates a new version for an existing IoT software package.

    Requires permission to access the CreatePackageVersion and GetIndexingConfiguration actions.

    See

    AWSIoTCreatePackageVersionRequest

    See

    AWSIoTCreatePackageVersionResponse

    Declaration

    Objective-C

    - (void)createPackageVersion:
            (nonnull AWSIoTCreatePackageVersionRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSIoTCreatePackageVersionResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func createPackageVersion(_ request: AWSIoTCreatePackageVersionRequest) async throws -> AWSIoTCreatePackageVersionResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreatePackageVersion 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, AWSIoTErrorConflict, AWSIoTErrorInternalServer, AWSIoTErrorValidation, AWSIoTErrorServiceQuotaExceeded.

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

    If the ThingGroup that you create has the exact same attributes as an existing ThingGroup, you will get a 200 success response.

    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.

    If the ThingGroup that you create has the exact same attributes as an existing ThingGroup, you will get a 200 success response.

    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 certificate provider.

    Requires permission to access the DeleteCertificateProvider action.

    If you delete the certificate provider resource, the behavior of CreateCertificateFromCsr will resume, and IoT will create certificates signed by IoT from a certificate signing request (CSR).

    See

    AWSIoTDeleteCertificateProviderRequest

    See

    AWSIoTDeleteCertificateProviderResponse

    Declaration

    Objective-C

    - (id)deleteCertificateProvider:
    (nonnull AWSIoTDeleteCertificateProviderRequest *)request;

    Swift

    func deleteCertificateProvider(_ request: AWSIoTDeleteCertificateProviderRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDeleteCertificateProviderResponse. 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 a certificate provider.

    Requires permission to access the DeleteCertificateProvider action.

    If you delete the certificate provider resource, the behavior of CreateCertificateFromCsr will resume, and IoT will create certificates signed by IoT from a certificate signing request (CSR).

    See

    AWSIoTDeleteCertificateProviderRequest

    See

    AWSIoTDeleteCertificateProviderResponse

    Declaration

    Objective-C

    - (void)deleteCertificateProvider:
            (nonnull AWSIoTDeleteCertificateProviderRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSIoTDeleteCertificateProviderResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func deleteCertificateProvider(_ request: AWSIoTDeleteCertificateProviderRequest) async throws -> AWSIoTDeleteCertificateProviderResponse

    Parameters

    request

    A container for the necessary parameters to execute the DeleteCertificateProvider 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 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 a specific version from a software package.

    Note: All package versions must be deleted before deleting the software package.

    Requires permission to access the DeletePackageVersion action.

    See

    AWSIoTDeletePackageRequest

    See

    AWSIoTDeletePackageResponse

    Declaration

    Objective-C

    - (id)deletePackage:(nonnull AWSIoTDeletePackageRequest *)request;

    Swift

    func deletePackage(_ request: AWSIoTDeletePackageRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Deletes a specific version from a software package.

    Note: All package versions must be deleted before deleting the software package.

    Requires permission to access the DeletePackageVersion action.

    See

    AWSIoTDeletePackageRequest

    See

    AWSIoTDeletePackageResponse

    Declaration

    Objective-C

    - (void)deletePackage:(nonnull AWSIoTDeletePackageRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTDeletePackageResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func deletePackage(_ request: AWSIoTDeletePackageRequest) async throws -> AWSIoTDeletePackageResponse

    Parameters

    request

    A container for the necessary parameters to execute the DeletePackage 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, AWSIoTErrorInternalServer, AWSIoTErrorValidation.

  • Deletes a specific version from a software package.

    Note: If a package version is designated as default, you must remove the designation from the software package using the UpdatePackage action.

    See

    AWSIoTDeletePackageVersionRequest

    See

    AWSIoTDeletePackageVersionResponse

    Declaration

    Objective-C

    - (id)deletePackageVersion:(nonnull AWSIoTDeletePackageVersionRequest *)request;

    Swift

    func deletePackageVersion(_ request: AWSIoTDeletePackageVersionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Deletes a specific version from a software package.

    Note: If a package version is designated as default, you must remove the designation from the software package using the UpdatePackage action.

    See

    AWSIoTDeletePackageVersionRequest

    See

    AWSIoTDeletePackageVersionResponse

    Declaration

    Objective-C

    - (void)deletePackageVersion:
            (nonnull AWSIoTDeletePackageVersionRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSIoTDeletePackageVersionResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func deletePackageVersion(_ request: AWSIoTDeletePackageVersionRequest) async throws -> AWSIoTDeletePackageVersionResponse

    Parameters

    request

    A container for the necessary parameters to execute the DeletePackageVersion 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, AWSIoTErrorInternalServer, AWSIoTErrorValidation.

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

  • Describes a certificate provider.

    Requires permission to access the DescribeCertificateProvider action.

    See

    AWSIoTDescribeCertificateProviderRequest

    See

    AWSIoTDescribeCertificateProviderResponse

    Declaration

    Objective-C

    - (id)describeCertificateProvider:
    (nonnull AWSIoTDescribeCertificateProviderRequest *)request;

    Swift

    func describeCertificateProvider(_ request: AWSIoTDescribeCertificateProviderRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Describes a certificate provider.

    Requires permission to access the DescribeCertificateProvider action.

    See

    AWSIoTDescribeCertificateProviderRequest

    See

    AWSIoTDescribeCertificateProviderResponse

    Declaration

    Objective-C

    - (void)describeCertificateProvider:
            (nonnull AWSIoTDescribeCertificateProviderRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSIoTDescribeCertificateProviderResponse *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func describeCertificateProvider(_ request: AWSIoTDescribeCertificateProviderRequest) async throws -> AWSIoTDescribeCertificateProviderResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeCertificateProvider 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 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) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets summary information about a domain configuration.

    Requires permission to access the DescribeDomainConfiguration action.

    See

    AWSIoTDescribeDomainConfigurationRequest

    See

    AWSIoTDescribeDomainConfigurationResponse

    Declaration

    Objective-C

    - (void)describeDomainConfiguration:
            (nonnull AWSIoTDescribeDomainConfigurationRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSIoTDescribeDomainConfigurationResponse *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func describeDomainConfiguration(_ request: AWSIoTDescribeDomainConfigurationRequest) async throws -> AWSIoTDescribeDomainConfigurationResponse

    Parameters

    request

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

  • Returns or creates a unique endpoint specific to the Amazon Web Services account making the call.

    The first time DescribeEndpoint is called, an endpoint is created. All subsequent calls to DescribeEndpoint return the same endpoint.

    Requires permission to access the DescribeEndpoint action.

    See

    AWSIoTDescribeEndpointRequest

    See

    AWSIoTDescribeEndpointResponse

    Declaration

    Objective-C

    - (id)describeEndpoint:(nonnull AWSIoTDescribeEndpointRequest *)request;

    Swift

    func describeEndpoint(_ request: AWSIoTDescribeEndpointRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns or creates a unique endpoint specific to the Amazon Web Services account making the call.

    The first time DescribeEndpoint is called, an endpoint is created. All subsequent calls to DescribeEndpoint return the same endpoint.

    Requires permission to access the DescribeEndpoint action.

    See

    AWSIoTDescribeEndpointRequest

    See

    AWSIoTDescribeEndpointResponse

    Declaration

    Objective-C

    - (void)describeEndpoint:(nonnull AWSIoTDescribeEndpointRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSIoTDescribeEndpointResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func describeEndpoint(_ request: AWSIoTDescribeEndpointRequest) async throws -> AWSIoTDescribeEndpointResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternalFailure, AWSIoTErrorInvalidRequest, AWSIoTErrorUnauthorized, AWSIoTErrorThrottling.

  • Describes event configurations.

    Requires permission to access the DescribeEventConfigurations action.

    See

    AWSIoTDescribeEventConfigurationsRequest

    See

    AWSIoTDescribeEventConfigurationsResponse

    Declaration

    Objective-C

    - (id)describeEventConfigurations:
    (nonnull AWSIoTDescribeEventConfigurationsRequest *)request;

    Swift

    func describeEventConfigurations(_ request: AWSIoTDescribeEventConfigurationsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Describes event configurations.

    Requires permission to access the DescribeEventConfigurations action.

    See

    AWSIoTDescribeEventConfigurationsRequest

    See

    AWSIoTDescribeEventConfigurationsResponse

    Declaration

    Objective-C

    - (void)describeEventConfigurations:
            (nonnull AWSIoTDescribeEventConfigurationsRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSIoTDescribeEventConfigurationsResponse *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func describeEventConfigurations(_ request: AWSIoTDescribeEventConfigurationsRequest) async throws -> AWSIoTDescribeEventConfigurationsResponse

    Parameters

    request

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

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

  • Gets information about the specified fleet metric.

    Requires permission to access the DescribeFleetMetric action.

    See

    AWSIoTDescribeFleetMetricRequest

    See

    AWSIoTDescribeFleetMetricResponse

    Declaration

    Objective-C

    - (id)describeFleetMetric:(nonnull AWSIoTDescribeFleetMetricRequest *)request;

    Swift

    func describeFleetMetric(_ request: AWSIoTDescribeFleetMetricRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDescribeFleetMetricResponse. 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 fleet metric.

    Requires permission to access the DescribeFleetMetric action.

    See

    AWSIoTDescribeFleetMetricRequest

    See

    AWSIoTDescribeFleetMetricResponse

    Declaration

    Objective-C

    - (void)describeFleetMetric:(nonnull AWSIoTDescribeFleetMetricRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSIoTDescribeFleetMetricResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func describeFleetMetric(_ request: AWSIoTDescribeFleetMetricRequest) async throws -> AWSIoTDescribeFleetMetricResponse

    Parameters

    request

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

  • Describes a search index.

    Requires permission to access the DescribeIndex action.

    See

    AWSIoTDescribeIndexRequest

    See

    AWSIoTDescribeIndexResponse

    Declaration

    Objective-C

    - (id)describeIndex:(nonnull AWSIoTDescribeIndexRequest *)request;

    Swift

    func describeIndex(_ request: AWSIoTDescribeIndexRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Describes a search index.

    Requires permission to access the DescribeIndex action.

    See

    AWSIoTDescribeIndexRequest

    See

    AWSIoTDescribeIndexResponse

    Declaration

    Objective-C

    - (void)describeIndex:(nonnull AWSIoTDescribeIndexRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTDescribeIndexResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func describeIndex(_ request: AWSIoTDescribeIndexRequest) async throws -> AWSIoTDescribeIndexResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

  • Describes a job.

    Requires permission to access the DescribeJob action.

    See

    AWSIoTDescribeJobRequest

    See

    AWSIoTDescribeJobResponse

    Declaration

    Objective-C

    - (id)describeJob:(nonnull AWSIoTDescribeJobRequest *)request;

    Swift

    func describeJob(_ request: AWSIoTDescribeJobRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Describes a job.

    Requires permission to access the DescribeJob action.

    See

    AWSIoTDescribeJobRequest

    See

    AWSIoTDescribeJobResponse

    Declaration

    Objective-C

    - (void)describeJob:(nonnull AWSIoTDescribeJobRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTDescribeJobResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func describeJob(_ request: AWSIoTDescribeJobRequest) async throws -> AWSIoTDescribeJobResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

  • Describes a job execution.

    Requires permission to access the DescribeJobExecution action.

    See

    AWSIoTDescribeJobExecutionRequest

    See

    AWSIoTDescribeJobExecutionResponse

    Declaration

    Objective-C

    - (id)describeJobExecution:(nonnull AWSIoTDescribeJobExecutionRequest *)request;

    Swift

    func describeJobExecution(_ request: AWSIoTDescribeJobExecutionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Describes a job execution.

    Requires permission to access the DescribeJobExecution action.

    See

    AWSIoTDescribeJobExecutionRequest

    See

    AWSIoTDescribeJobExecutionResponse

    Declaration

    Objective-C

    - (void)describeJobExecution:
            (nonnull AWSIoTDescribeJobExecutionRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSIoTDescribeJobExecutionResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func describeJobExecution(_ request: AWSIoTDescribeJobExecutionRequest) async throws -> AWSIoTDescribeJobExecutionResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

  • Returns information about a job template.

    See

    AWSIoTDescribeJobTemplateRequest

    See

    AWSIoTDescribeJobTemplateResponse

    Declaration

    Objective-C

    - (id)describeJobTemplate:(nonnull AWSIoTDescribeJobTemplateRequest *)request;

    Swift

    func describeJobTemplate(_ request: AWSIoTDescribeJobTemplateRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns information about a job template.

    See

    AWSIoTDescribeJobTemplateRequest

    See

    AWSIoTDescribeJobTemplateResponse

    Declaration

    Objective-C

    - (void)describeJobTemplate:(nonnull AWSIoTDescribeJobTemplateRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSIoTDescribeJobTemplateResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func describeJobTemplate(_ request: AWSIoTDescribeJobTemplateRequest) async throws -> AWSIoTDescribeJobTemplateResponse

    Parameters

    request

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

  • View details of a managed job template.

    See

    AWSIoTDescribeManagedJobTemplateRequest

    See

    AWSIoTDescribeManagedJobTemplateResponse

    Declaration

    Objective-C

    - (id)describeManagedJobTemplate:
    (nonnull AWSIoTDescribeManagedJobTemplateRequest *)request;

    Swift

    func describeManagedJobTemplate(_ request: AWSIoTDescribeManagedJobTemplateRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • View details of a managed job template.

    See

    AWSIoTDescribeManagedJobTemplateRequest

    See

    AWSIoTDescribeManagedJobTemplateResponse

    Declaration

    Objective-C

    - (void)describeManagedJobTemplate:
            (nonnull AWSIoTDescribeManagedJobTemplateRequest *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSIoTDescribeManagedJobTemplateResponse *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func describeManagedJobTemplate(_ request: AWSIoTDescribeManagedJobTemplateRequest) async throws -> AWSIoTDescribeManagedJobTemplateResponse

    Parameters

    request

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

  • Gets information about a mitigation action.

    Requires permission to access the DescribeMitigationAction action.

    See

    AWSIoTDescribeMitigationActionRequest

    See

    AWSIoTDescribeMitigationActionResponse

    Declaration

    Objective-C

    - (id)describeMitigationAction:
    (nonnull AWSIoTDescribeMitigationActionRequest *)request;

    Swift

    func describeMitigationAction(_ request: AWSIoTDescribeMitigationActionRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSIoTDescribeMitigationActionResponse. 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 mitigation action.

    Requires permission to access the DescribeMitigationAction action.

    See

    AWSIoTDescribeMitigationActionRequest

    See

    AWSIoTDescribeMitigationActionResponse

    Declaration

    Objective-C

    - (void)describeMitigationAction:
            (nonnull AWSIoTDescribeMitigationActionRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSIoTDescribeMitigationActionResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func describeMitigationAction(_ request: AWSIoTDescribeMitigationActionRequest) async throws -> AWSIoTDescribeMitigationActionResponse

    Parameters

    request

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

  • Returns information about a provisioning template.

    Requires permission to access the DescribeProvisioningTemplate action.

    See

    AWSIoTDescribeProvisioningTemplateRequest

    See

    AWSIoTDescribeProvisioningTemplateResponse

    Declaration

    Objective-C

    - (id)describeProvisioningTemplate:
    (nonnull AWSIoTDescribeProvisioningTemplateRequest *)request;

    Swift

    func describeProvisioningTemplate(_ request: AWSIoTDescribeProvisioningTemplateRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns information about a provisioning template.

    Requires permission to access the DescribeProvisioningTemplate action.

    See

    AWSIoTDescribeProvisioningTemplateRequest

    See

    AWSIoTDescribeProvisioningTemplateResponse

    Declaration

    Objective-C

    - (void)
    describeProvisioningTemplate:
        (nonnull AWSIoTDescribeProvisioningTemplateRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSIoTDescribeProvisioningTemplateResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func describeProvisioningTemplate(_ request: AWSIoTDescribeProvisioningTemplateRequest) async throws -> AWSIoTDescribeProvisioningTemplateResponse

    Parameters

    request

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

  • Returns information about a provisioning template version.

    Requires permission to access the DescribeProvisioningTemplateVersion action.

    See

    AWSIoTDescribeProvisioningTemplateVersionRequest

    See

    AWSIoTDescribeProvisioningTemplateVersionResponse

    Declaration

    Objective-C

    - (id)describeProvisioningTemplateVersion:
    (nonnull AWSIoTDescribeProvisioningTemplateVersionRequest *)request;

    Swift

    func describeProvisioningTemplateVersion(_ request: AWSIoTDescribeProvisioningTemplateVersionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns information about a provisioning template version.

    Requires permission to access the DescribeProvisioningTemplateVersion action.

    See

    AWSIoTDescribeProvisioningTemplateVersionRequest

    See

    AWSIoTDescribeProvisioningTemplateVersionResponse

    Declaration

    Objective-C

    - (void)
    describeProvisioningTemplateVersion:
        (nonnull AWSIoTDescribeProvisioningTemplateVersionRequest *)request
                      completionHandler:
                          (void (^_Nullable)(
                              AWSIoTDescribeProvisioningTemplateVersionResponse
                                  *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func describeProvisioningTemplateVersion(_ request: AWSIoTDescribeProvisioningTemplateVersionRequest) async throws -> AWSIoTDescribeProvisioningTemplateVersionResponse

    Parameters

    request

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

  • Describes a role alias.

    Requires permission to access the DescribeRoleAlias action.

    See

    AWSIoTDescribeRoleAliasRequest

    See

    AWSIoTDescribeRoleAliasResponse

    Declaration

    Objective-C

    - (id)describeRoleAlias:(nonnull AWSIoTDescribeRoleAliasRequest *)request;

    Swift

    func describeRoleAlias(_ request: AWSIoTDescribeRoleAliasRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Describes a role alias.

    Requires permission to access the DescribeRoleAlias action.

    See

    AWSIoTDescribeRoleAliasRequest

    See

    AWSIoTDescribeRoleAliasResponse

    Declaration

    Objective-C

    - (void)describeRoleAlias:(nonnull AWSIoTDescribeRoleAliasRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSIoTDescribeRoleAliasResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func describeRoleAlias(_ request: AWSIoTDescribeRoleAliasRequest) async throws -> AWSIoTDescribeRoleAliasResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

  • Gets information about a scheduled audit.

    Requires permission to access the DescribeScheduledAudit action.

    See

    AWSIoTDescribeScheduledAuditRequest

    See

    AWSIoTDescribeScheduledAuditResponse

    Declaration

    Objective-C

    - (id)describeScheduledAudit:
    (nonnull AWSIoTDescribeScheduledAuditRequest *)request;

    Swift

    func describeScheduledAudit(_ request: AWSIoTDescribeScheduledAuditRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets information about a scheduled audit.

    Requires permission to access the DescribeScheduledAudit action.

    See

    AWSIoTDescribeScheduledAuditRequest

    See

    AWSIoTDescribeScheduledAuditResponse

    Declaration

    Objective-C

    - (void)
    describeScheduledAudit:
        (nonnull AWSIoTDescribeScheduledAuditRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSIoTDescribeScheduledAuditResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func describeScheduledAudit(_ request: AWSIoTDescribeScheduledAuditRequest) async throws -> AWSIoTDescribeScheduledAuditResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

  • Gets information about a Device Defender security profile.

    Requires permission to access the DescribeSecurityProfile action.

    See

    AWSIoTDescribeSecurityProfileRequest

    See

    AWSIoTDescribeSecurityProfileResponse

    Declaration

    Objective-C

    - (id)describeSecurityProfile:
    (nonnull AWSIoTDescribeSecurityProfileRequest *)request;

    Swift

    func describeSecurityProfile(_ request: AWSIoTDescribeSecurityProfileRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets information about a Device Defender security profile.

    Requires permission to access the DescribeSecurityProfile action.

    See

    AWSIoTDescribeSecurityProfileRequest

    See

    AWSIoTDescribeSecurityProfileResponse

    Declaration

    Objective-C

    - (void)describeSecurityProfile:
            (nonnull AWSIoTDescribeSecurityProfileRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSIoTDescribeSecurityProfileResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func describeSecurityProfile(_ request: AWSIoTDescribeSecurityProfileRequest) async throws -> AWSIoTDescribeSecurityProfileResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

  • Gets information about a stream.

    Requires permission to access the DescribeStream action.

    See

    AWSIoTDescribeStreamRequest

    See

    AWSIoTDescribeStreamResponse

    Declaration

    Objective-C

    - (id)describeStream:(nonnull AWSIoTDescribeStreamRequest *)request;

    Swift

    func describeStream(_ request: AWSIoTDescribeStreamRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets information about a stream.

    Requires permission to access the DescribeStream action.

    See

    AWSIoTDescribeStreamRequest

    See

    AWSIoTDescribeStreamResponse

    Declaration

    Objective-C

    - (void)describeStream:(nonnull AWSIoTDescribeStreamRequest *)request
     completionHandler:
         (void (^_Nullable)(AWSIoTDescribeStreamResponse *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func describeStream(_ request: AWSIoTDescribeStreamRequest) async throws -> AWSIoTDescribeStreamResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

  • Gets information about the specified thing.

    Requires permission to access the DescribeThing action.

    See

    AWSIoTDescribeThingRequest

    See

    AWSIoTDescribeThingResponse

    Declaration

    Objective-C

    - (id)describeThing:(nonnull AWSIoTDescribeThingRequest *)request;

    Swift

    func describeThing(_ request: AWSIoTDescribeThingRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets information about the specified thing.

    Requires permission to access the DescribeThing action.

    See

    AWSIoTDescribeThingRequest

    See

    AWSIoTDescribeThingResponse

    Declaration

    Objective-C

    - (void)describeThing:(nonnull AWSIoTDescribeThingRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTDescribeThingResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func describeThing(_ request: AWSIoTDescribeThingRequest) async throws -> AWSIoTDescribeThingResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

  • Describe a thing group.

    Requires permission to access the DescribeThingGroup action.

    See

    AWSIoTDescribeThingGroupRequest

    See

    AWSIoTDescribeThingGroupResponse

    Declaration

    Objective-C

    - (id)describeThingGroup:(nonnull AWSIoTDescribeThingGroupRequest *)request;

    Swift

    func describeThingGroup(_ request: AWSIoTDescribeThingGroupRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Describe a thing group.

    Requires permission to access the DescribeThingGroup action.

    See

    AWSIoTDescribeThingGroupRequest

    See

    AWSIoTDescribeThingGroupResponse

    Declaration

    Objective-C

    - (void)describeThingGroup:(nonnull AWSIoTDescribeThingGroupRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSIoTDescribeThingGroupResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func describeThingGroup(_ request: AWSIoTDescribeThingGroupRequest) async throws -> AWSIoTDescribeThingGroupResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

  • Describes a bulk thing provisioning task.

    Requires permission to access the DescribeThingRegistrationTask action.

    See

    AWSIoTDescribeThingRegistrationTaskRequest

    See

    AWSIoTDescribeThingRegistrationTaskResponse

    Declaration

    Objective-C

    - (id)describeThingRegistrationTask:
    (nonnull AWSIoTDescribeThingRegistrationTaskRequest *)request;

    Swift

    func describeThingRegistrationTask(_ request: AWSIoTDescribeThingRegistrationTaskRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Describes a bulk thing provisioning task.

    Requires permission to access the DescribeThingRegistrationTask action.

    See

    AWSIoTDescribeThingRegistrationTaskRequest

    See

    AWSIoTDescribeThingRegistrationTaskResponse

    Declaration

    Objective-C

    - (void)
    describeThingRegistrationTask:
        (nonnull AWSIoTDescribeThingRegistrationTaskRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSIoTDescribeThingRegistrationTaskResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func describeThingRegistrationTask(_ request: AWSIoTDescribeThingRegistrationTaskRequest) async throws -> AWSIoTDescribeThingRegistrationTaskResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

  • Gets information about the specified thing type.

    Requires permission to access the DescribeThingType action.

    See

    AWSIoTDescribeThingTypeRequest

    See

    AWSIoTDescribeThingTypeResponse

    Declaration

    Objective-C

    - (id)describeThingType:(nonnull AWSIoTDescribeThingTypeRequest *)request;

    Swift

    func describeThingType(_ request: AWSIoTDescribeThingTypeRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets information about the specified thing type.

    Requires permission to access the DescribeThingType action.

    See

    AWSIoTDescribeThingTypeRequest

    See

    AWSIoTDescribeThingTypeResponse

    Declaration

    Objective-C

    - (void)describeThingType:(nonnull AWSIoTDescribeThingTypeRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSIoTDescribeThingTypeResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func describeThingType(_ request: AWSIoTDescribeThingTypeRequest) async throws -> AWSIoTDescribeThingTypeResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

  • Detaches a policy from the specified target.

    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 DetachPolicy action.

    See

    AWSIoTDetachPolicyRequest

    Declaration

    Objective-C

    - (id)detachPolicy:(nonnull AWSIoTDetachPolicyRequest *)request;

    Swift

    func detachPolicy(_ request: AWSIoTDetachPolicyRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Detaches a policy from the specified target.

    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 DetachPolicy action.

    See

    AWSIoTDetachPolicyRequest

    Declaration

    Objective-C

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

    Swift

    func detachPolicy(_ request: AWSIoTDetachPolicyRequest) async throws

    Parameters

    request

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

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorLimitExceeded.

  • Removes the specified policy from the specified certificate.

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

    Requires permission to access the DetachPrincipalPolicy action.

    See

    AWSIoTDetachPrincipalPolicyRequest

    Declaration

    Objective-C

    - (id)detachPrincipalPolicy:
    (nonnull AWSIoTDetachPrincipalPolicyRequest *)request;

    Swift

    func detachPrincipalPolicy(_ request: AWSIoTDetachPrincipalPolicyRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Removes the specified policy from the specified certificate.

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

    Requires permission to access the DetachPrincipalPolicy action.

    See

    AWSIoTDetachPrincipalPolicyRequest

    Declaration

    Objective-C

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

    Swift

    func detachPrincipalPolicy(_ request: AWSIoTDetachPrincipalPolicyRequest) async throws

    Parameters

    request

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

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

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

    Requires permission to access the DetachSecurityProfile action.

    See

    AWSIoTDetachSecurityProfileRequest

    See

    AWSIoTDetachSecurityProfileResponse

    Declaration

    Objective-C

    - (id)detachSecurityProfile:
    (nonnull AWSIoTDetachSecurityProfileRequest *)request;

    Swift

    func detachSecurityProfile(_ request: AWSIoTDetachSecurityProfileRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Requires permission to access the DetachSecurityProfile action.

    See

    AWSIoTDetachSecurityProfileRequest

    See

    AWSIoTDetachSecurityProfileResponse

    Declaration

    Objective-C

    - (void)
    detachSecurityProfile:(nonnull AWSIoTDetachSecurityProfileRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSIoTDetachSecurityProfileResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func detachSecurityProfile(_ request: AWSIoTDetachSecurityProfileRequest) async throws -> AWSIoTDetachSecurityProfileResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

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

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

    Requires permission to access the DetachThingPrincipal action.

    See

    AWSIoTDetachThingPrincipalRequest

    See

    AWSIoTDetachThingPrincipalResponse

    Declaration

    Objective-C

    - (id)detachThingPrincipal:(nonnull AWSIoTDetachThingPrincipalRequest *)request;

    Swift

    func detachThingPrincipal(_ request: AWSIoTDetachThingPrincipalRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

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

    Requires permission to access the DetachThingPrincipal action.

    See

    AWSIoTDetachThingPrincipalRequest

    See

    AWSIoTDetachThingPrincipalResponse

    Declaration

    Objective-C

    - (void)detachThingPrincipal:
            (nonnull AWSIoTDetachThingPrincipalRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSIoTDetachThingPrincipalResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func detachThingPrincipal(_ request: AWSIoTDetachThingPrincipalRequest) async throws -> AWSIoTDetachThingPrincipalResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

  • Disables the rule.

    Requires permission to access the DisableTopicRule action.

    See

    AWSIoTDisableTopicRuleRequest

    Declaration

    Objective-C

    - (id)disableTopicRule:(nonnull AWSIoTDisableTopicRuleRequest *)request;

    Swift

    func disableTopicRule(_ request: AWSIoTDisableTopicRuleRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Disables the rule.

    Requires permission to access the DisableTopicRule action.

    See

    AWSIoTDisableTopicRuleRequest

    Declaration

    Objective-C

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

    Swift

    func disableTopicRule(_ request: AWSIoTDisableTopicRuleRequest) async throws

    Parameters

    request

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

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable, AWSIoTErrorUnauthorized, AWSIoTErrorConflictingResourceUpdate.

  • Enables the rule.

    Requires permission to access the EnableTopicRule action.

    See

    AWSIoTEnableTopicRuleRequest

    Declaration

    Objective-C

    - (id)enableTopicRule:(nonnull AWSIoTEnableTopicRuleRequest *)request;

    Swift

    func enableTopicRule(_ request: AWSIoTEnableTopicRuleRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Enables the rule.

    Requires permission to access the EnableTopicRule action.

    See

    AWSIoTEnableTopicRuleRequest

    Declaration

    Objective-C

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

    Swift

    func enableTopicRule(_ request: AWSIoTEnableTopicRuleRequest) async throws

    Parameters

    request

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

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable, AWSIoTErrorUnauthorized, AWSIoTErrorConflictingResourceUpdate.

  • Returns a Device Defender’s ML Detect Security Profile training model’s status.

    Requires permission to access the GetBehaviorModelTrainingSummaries action.

    See

    AWSIoTGetBehaviorModelTrainingSummariesRequest

    See

    AWSIoTGetBehaviorModelTrainingSummariesResponse

    Declaration

    Objective-C

    - (id)getBehaviorModelTrainingSummaries:
    (nonnull AWSIoTGetBehaviorModelTrainingSummariesRequest *)request;

    Swift

    func getBehaviorModelTrainingSummaries(_ request: AWSIoTGetBehaviorModelTrainingSummariesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns a Device Defender’s ML Detect Security Profile training model’s status.

    Requires permission to access the GetBehaviorModelTrainingSummaries action.

    See

    AWSIoTGetBehaviorModelTrainingSummariesRequest

    See

    AWSIoTGetBehaviorModelTrainingSummariesResponse

    Declaration

    Objective-C

    - (void)getBehaviorModelTrainingSummaries:
            (nonnull AWSIoTGetBehaviorModelTrainingSummariesRequest *)request
                        completionHandler:
                            (void (^_Nullable)(
                                AWSIoTGetBehaviorModelTrainingSummariesResponse
                                    *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func behaviorModelTrainingSummaries(_ request: AWSIoTGetBehaviorModelTrainingSummariesRequest) async throws -> AWSIoTGetBehaviorModelTrainingSummariesResponse

    Parameters

    request

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

  • Aggregates on indexed data with search queries pertaining to particular fields.

    Requires permission to access the GetBucketsAggregation action.

    See

    AWSIoTGetBucketsAggregationRequest

    See

    AWSIoTGetBucketsAggregationResponse

    Declaration

    Objective-C

    - (id)getBucketsAggregation:
    (nonnull AWSIoTGetBucketsAggregationRequest *)request;

    Swift

    func getBucketsAggregation(_ request: AWSIoTGetBucketsAggregationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Aggregates on indexed data with search queries pertaining to particular fields.

    Requires permission to access the GetBucketsAggregation action.

    See

    AWSIoTGetBucketsAggregationRequest

    See

    AWSIoTGetBucketsAggregationResponse

    Declaration

    Objective-C

    - (void)
    getBucketsAggregation:(nonnull AWSIoTGetBucketsAggregationRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSIoTGetBucketsAggregationResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func bucketsAggregation(_ request: AWSIoTGetBucketsAggregationRequest) async throws -> AWSIoTGetBucketsAggregationResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidQuery, AWSIoTErrorInvalidAggregation, AWSIoTErrorIndexNotReady.

  • Returns the approximate count of unique values that match the query.

    Requires permission to access the GetCardinality action.

    See

    AWSIoTGetCardinalityRequest

    See

    AWSIoTGetCardinalityResponse

    Declaration

    Objective-C

    - (id)getCardinality:(nonnull AWSIoTGetCardinalityRequest *)request;

    Swift

    func getCardinality(_ request: AWSIoTGetCardinalityRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns the approximate count of unique values that match the query.

    Requires permission to access the GetCardinality action.

    See

    AWSIoTGetCardinalityRequest

    See

    AWSIoTGetCardinalityResponse

    Declaration

    Objective-C

    - (void)getCardinality:(nonnull AWSIoTGetCardinalityRequest *)request
     completionHandler:
         (void (^_Nullable)(AWSIoTGetCardinalityResponse *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func cardinality(_ request: AWSIoTGetCardinalityRequest) async throws -> AWSIoTGetCardinalityResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidQuery, AWSIoTErrorInvalidAggregation, AWSIoTErrorIndexNotReady.

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

    Requires permission to access the GetEffectivePolicies action.

    See

    AWSIoTGetEffectivePoliciesRequest

    See

    AWSIoTGetEffectivePoliciesResponse

    Declaration

    Objective-C

    - (id)getEffectivePolicies:(nonnull AWSIoTGetEffectivePoliciesRequest *)request;

    Swift

    func getEffectivePolicies(_ request: AWSIoTGetEffectivePoliciesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Requires permission to access the GetEffectivePolicies action.

    See

    AWSIoTGetEffectivePoliciesRequest

    See

    AWSIoTGetEffectivePoliciesResponse

    Declaration

    Objective-C

    - (void)getEffectivePolicies:
            (nonnull AWSIoTGetEffectivePoliciesRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSIoTGetEffectivePoliciesResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func effectivePolicies(_ request: AWSIoTGetEffectivePoliciesRequest) async throws -> AWSIoTGetEffectivePoliciesResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorLimitExceeded.

  • Gets the indexing configuration.

    Requires permission to access the GetIndexingConfiguration action.

    See

    AWSIoTGetIndexingConfigurationRequest

    See

    AWSIoTGetIndexingConfigurationResponse

    Declaration

    Objective-C

    - (id)getIndexingConfiguration:
    (nonnull AWSIoTGetIndexingConfigurationRequest *)request;

    Swift

    func getIndexingConfiguration(_ request: AWSIoTGetIndexingConfigurationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets the indexing configuration.

    Requires permission to access the GetIndexingConfiguration action.

    See

    AWSIoTGetIndexingConfigurationRequest

    See

    AWSIoTGetIndexingConfigurationResponse

    Declaration

    Objective-C

    - (void)getIndexingConfiguration:
            (nonnull AWSIoTGetIndexingConfigurationRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSIoTGetIndexingConfigurationResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func indexingConfiguration(_ request: AWSIoTGetIndexingConfigurationRequest) async throws -> AWSIoTGetIndexingConfigurationResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

  • Gets a job document.

    Requires permission to access the GetJobDocument action.

    See

    AWSIoTGetJobDocumentRequest

    See

    AWSIoTGetJobDocumentResponse

    Declaration

    Objective-C

    - (id)getJobDocument:(nonnull AWSIoTGetJobDocumentRequest *)request;

    Swift

    func getJobDocument(_ request: AWSIoTGetJobDocumentRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets a job document.

    Requires permission to access the GetJobDocument action.

    See

    AWSIoTGetJobDocumentRequest

    See

    AWSIoTGetJobDocumentResponse

    Declaration

    Objective-C

    - (void)getJobDocument:(nonnull AWSIoTGetJobDocumentRequest *)request
     completionHandler:
         (void (^_Nullable)(AWSIoTGetJobDocumentResponse *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func jobDocument(_ request: AWSIoTGetJobDocumentRequest) async throws -> AWSIoTGetJobDocumentResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

  • Gets the logging options.

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

    Requires permission to access the GetLoggingOptions action.

    See

    AWSIoTGetLoggingOptionsRequest

    See

    AWSIoTGetLoggingOptionsResponse

    Declaration

    Objective-C

    - (id)getLoggingOptions:(nonnull AWSIoTGetLoggingOptionsRequest *)request;

    Swift

    func getLoggingOptions(_ request: AWSIoTGetLoggingOptionsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets the logging options.

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

    Requires permission to access the GetLoggingOptions action.

    See

    AWSIoTGetLoggingOptionsRequest

    See

    AWSIoTGetLoggingOptionsResponse

    Declaration

    Objective-C

    - (void)getLoggingOptions:(nonnull AWSIoTGetLoggingOptionsRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSIoTGetLoggingOptionsResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func loggingOptions(_ request: AWSIoTGetLoggingOptionsRequest) async throws -> AWSIoTGetLoggingOptionsResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable.

  • Gets an OTA update.

    Requires permission to access the GetOTAUpdate action.

    See

    AWSIoTGetOTAUpdateRequest

    See

    AWSIoTGetOTAUpdateResponse

    Declaration

    Objective-C

    - (id)getOTAUpdate:(nonnull AWSIoTGetOTAUpdateRequest *)request;

    Swift

    func getOTAUpdate(_ request: AWSIoTGetOTAUpdateRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets an OTA update.

    Requires permission to access the GetOTAUpdate action.

    See

    AWSIoTGetOTAUpdateRequest

    See

    AWSIoTGetOTAUpdateResponse

    Declaration

    Objective-C

    - (void)getOTAUpdate:(nonnull AWSIoTGetOTAUpdateRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTGetOTAUpdateResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func otaUpdate(_ request: AWSIoTGetOTAUpdateRequest) async throws -> AWSIoTGetOTAUpdateResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorInternalFailure, AWSIoTErrorServiceUnavailable, AWSIoTErrorResourceNotFound.

  • Gets information about the specified software package.

    Requires permission to access the GetPackage action.

    See

    AWSIoTGetPackageRequest

    See

    AWSIoTGetPackageResponse

    Declaration

    Objective-C

    - (id)getPackage:(nonnull AWSIoTGetPackageRequest *)request;

    Swift

    func getPackage(_ request: AWSIoTGetPackageRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets information about the specified software package.

    Requires permission to access the GetPackage action.

    See

    AWSIoTGetPackageRequest

    See

    AWSIoTGetPackageResponse

    Declaration

    Objective-C

    - (void)getPackage:(nonnull AWSIoTGetPackageRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTGetPackageResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func package(_ request: AWSIoTGetPackageRequest) async throws -> AWSIoTGetPackageResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetPackage 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, AWSIoTErrorInternalServer, AWSIoTErrorValidation, AWSIoTErrorResourceNotFound.

  • Gets information about the specified software package’s configuration.

    Requires permission to access the GetPackageConfiguration action.

    See

    AWSIoTGetPackageConfigurationRequest

    See

    AWSIoTGetPackageConfigurationResponse

    Declaration

    Objective-C

    - (id)getPackageConfiguration:
    (nonnull AWSIoTGetPackageConfigurationRequest *)request;

    Swift

    func getPackageConfiguration(_ request: AWSIoTGetPackageConfigurationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets information about the specified software package’s configuration.

    Requires permission to access the GetPackageConfiguration action.

    See

    AWSIoTGetPackageConfigurationRequest

    See

    AWSIoTGetPackageConfigurationResponse

    Declaration

    Objective-C

    - (void)getPackageConfiguration:
            (nonnull AWSIoTGetPackageConfigurationRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSIoTGetPackageConfigurationResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func packageConfiguration(_ request: AWSIoTGetPackageConfigurationRequest) async throws -> AWSIoTGetPackageConfigurationResponse

    Parameters

    request

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

  • Gets information about the specified package version.

    Requires permission to access the GetPackageVersion action.

    See

    AWSIoTGetPackageVersionRequest

    See

    AWSIoTGetPackageVersionResponse

    Declaration

    Objective-C

    - (id)getPackageVersion:(nonnull AWSIoTGetPackageVersionRequest *)request;

    Swift

    func getPackageVersion(_ request: AWSIoTGetPackageVersionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets information about the specified package version.

    Requires permission to access the GetPackageVersion action.

    See

    AWSIoTGetPackageVersionRequest

    See

    AWSIoTGetPackageVersionResponse

    Declaration

    Objective-C

    - (void)getPackageVersion:(nonnull AWSIoTGetPackageVersionRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSIoTGetPackageVersionResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func packageVersion(_ request: AWSIoTGetPackageVersionRequest) async throws -> AWSIoTGetPackageVersionResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetPackageVersion 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, AWSIoTErrorInternalServer, AWSIoTErrorValidation, AWSIoTErrorResourceNotFound.

  • Groups the aggregated values that match the query into percentile groupings. The default percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own when you call GetPercentiles. This function returns a value for each percentile group specified (or the default percentile groupings). The percentile group “1” contains the aggregated field value that occurs in approximately one percent of the values that match the query. The percentile group “5” contains the aggregated field value that occurs in approximately five percent of the values that match the query, and so on. The result is an approximation, the more values that match the query, the more accurate the percentile values.

    Requires permission to access the GetPercentiles action.

    See

    AWSIoTGetPercentilesRequest

    See

    AWSIoTGetPercentilesResponse

    Declaration

    Objective-C

    - (id)getPercentiles:(nonnull AWSIoTGetPercentilesRequest *)request;

    Swift

    func getPercentiles(_ request: AWSIoTGetPercentilesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Groups the aggregated values that match the query into percentile groupings. The default percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own when you call GetPercentiles. This function returns a value for each percentile group specified (or the default percentile groupings). The percentile group “1” contains the aggregated field value that occurs in approximately one percent of the values that match the query. The percentile group “5” contains the aggregated field value that occurs in approximately five percent of the values that match the query, and so on. The result is an approximation, the more values that match the query, the more accurate the percentile values.

    Requires permission to access the GetPercentiles action.

    See

    AWSIoTGetPercentilesRequest

    See

    AWSIoTGetPercentilesResponse

    Declaration

    Objective-C

    - (void)getPercentiles:(nonnull AWSIoTGetPercentilesRequest *)request
     completionHandler:
         (void (^_Nullable)(AWSIoTGetPercentilesResponse *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func percentiles(_ request: AWSIoTGetPercentilesRequest) async throws -> AWSIoTGetPercentilesResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidQuery, AWSIoTErrorInvalidAggregation, AWSIoTErrorIndexNotReady.

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

    Requires permission to access the GetPolicy action.

    See

    AWSIoTGetPolicyRequest

    See

    AWSIoTGetPolicyResponse

    Declaration

    Objective-C

    - (id)getPolicy:(nonnull AWSIoTGetPolicyRequest *)request;

    Swift

    func getPolicy(_ request: AWSIoTGetPolicyRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Requires permission to access the GetPolicy action.

    See

    AWSIoTGetPolicyRequest

    See

    AWSIoTGetPolicyResponse

    Declaration

    Objective-C

    - (void)getPolicy:(nonnull AWSIoTGetPolicyRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTGetPolicyResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func policy(_ request: AWSIoTGetPolicyRequest) async throws -> AWSIoTGetPolicyResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

  • Gets information about the specified policy version.

    Requires permission to access the GetPolicyVersion action.

    See

    AWSIoTGetPolicyVersionRequest

    See

    AWSIoTGetPolicyVersionResponse

    Declaration

    Objective-C

    - (id)getPolicyVersion:(nonnull AWSIoTGetPolicyVersionRequest *)request;

    Swift

    func getPolicyVersion(_ request: AWSIoTGetPolicyVersionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets information about the specified policy version.

    Requires permission to access the GetPolicyVersion action.

    See

    AWSIoTGetPolicyVersionRequest

    See

    AWSIoTGetPolicyVersionResponse

    Declaration

    Objective-C

    - (void)getPolicyVersion:(nonnull AWSIoTGetPolicyVersionRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSIoTGetPolicyVersionResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func policyVersion(_ request: AWSIoTGetPolicyVersionRequest) async throws -> AWSIoTGetPolicyVersionResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

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

    IoT will create a registration code as part of this API call if the registration code doesn’t exist or has been deleted. If you already have a registration code, this API call will return the same registration code.

    Requires permission to access the GetRegistrationCode action.

    See

    AWSIoTGetRegistrationCodeRequest

    See

    AWSIoTGetRegistrationCodeResponse

    Declaration

    Objective-C

    - (id)getRegistrationCode:(nonnull AWSIoTGetRegistrationCodeRequest *)request;

    Swift

    func getRegistrationCode(_ request: AWSIoTGetRegistrationCodeRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    IoT will create a registration code as part of this API call if the registration code doesn’t exist or has been deleted. If you already have a registration code, this API call will return the same registration code.

    Requires permission to access the GetRegistrationCode action.

    See

    AWSIoTGetRegistrationCodeRequest

    See

    AWSIoTGetRegistrationCodeResponse

    Declaration

    Objective-C

    - (void)getRegistrationCode:(nonnull AWSIoTGetRegistrationCodeRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSIoTGetRegistrationCodeResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func registrationCode(_ request: AWSIoTGetRegistrationCodeRequest) async throws -> AWSIoTGetRegistrationCodeResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorInvalidRequest.

  • Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field. If the aggregation field is of type String, only the count statistic is returned.

    Requires permission to access the GetStatistics action.

    See

    AWSIoTGetStatisticsRequest

    See

    AWSIoTGetStatisticsResponse

    Declaration

    Objective-C

    - (id)getStatistics:(nonnull AWSIoTGetStatisticsRequest *)request;

    Swift

    func getStatistics(_ request: AWSIoTGetStatisticsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field. If the aggregation field is of type String, only the count statistic is returned.

    Requires permission to access the GetStatistics action.

    See

    AWSIoTGetStatisticsRequest

    See

    AWSIoTGetStatisticsResponse

    Declaration

    Objective-C

    - (void)getStatistics:(nonnull AWSIoTGetStatisticsRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTGetStatisticsResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func statistics(_ request: AWSIoTGetStatisticsRequest) async throws -> AWSIoTGetStatisticsResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidQuery, AWSIoTErrorInvalidAggregation, AWSIoTErrorIndexNotReady.

  • Gets information about the rule.

    Requires permission to access the GetTopicRule action.

    See

    AWSIoTGetTopicRuleRequest

    See

    AWSIoTGetTopicRuleResponse

    Declaration

    Objective-C

    - (id)getTopicRule:(nonnull AWSIoTGetTopicRuleRequest *)request;

    Swift

    func getTopicRule(_ request: AWSIoTGetTopicRuleRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets information about the rule.

    Requires permission to access the GetTopicRule action.

    See

    AWSIoTGetTopicRuleRequest

    See

    AWSIoTGetTopicRuleResponse

    Declaration

    Objective-C

    - (void)getTopicRule:(nonnull AWSIoTGetTopicRuleRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTGetTopicRuleResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func topicRule(_ request: AWSIoTGetTopicRuleRequest) async throws -> AWSIoTGetTopicRuleResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable, AWSIoTErrorUnauthorized.

  • Gets information about a topic rule destination.

    Requires permission to access the GetTopicRuleDestination action.

    See

    AWSIoTGetTopicRuleDestinationRequest

    See

    AWSIoTGetTopicRuleDestinationResponse

    Declaration

    Objective-C

    - (id)getTopicRuleDestination:
    (nonnull AWSIoTGetTopicRuleDestinationRequest *)request;

    Swift

    func getTopicRuleDestination(_ request: AWSIoTGetTopicRuleDestinationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets information about a topic rule destination.

    Requires permission to access the GetTopicRuleDestination action.

    See

    AWSIoTGetTopicRuleDestinationRequest

    See

    AWSIoTGetTopicRuleDestinationResponse

    Declaration

    Objective-C

    - (void)getTopicRuleDestination:
            (nonnull AWSIoTGetTopicRuleDestinationRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSIoTGetTopicRuleDestinationResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func topicRuleDestination(_ request: AWSIoTGetTopicRuleDestinationRequest) async throws -> AWSIoTGetTopicRuleDestinationResponse

    Parameters

    request

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

  • Gets the fine grained logging options.

    Requires permission to access the GetV2LoggingOptions action.

    See

    AWSIoTGetV2LoggingOptionsRequest

    See

    AWSIoTGetV2LoggingOptionsResponse

    Declaration

    Objective-C

    - (id)getV2LoggingOptions:(nonnull AWSIoTGetV2LoggingOptionsRequest *)request;

    Swift

    func getV2LoggingOptions(_ request: AWSIoTGetV2LoggingOptionsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets the fine grained logging options.

    Requires permission to access the GetV2LoggingOptions action.

    See

    AWSIoTGetV2LoggingOptionsRequest

    See

    AWSIoTGetV2LoggingOptionsResponse

    Declaration

    Objective-C

    - (void)getV2LoggingOptions:(nonnull AWSIoTGetV2LoggingOptionsRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSIoTGetV2LoggingOptionsResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func v2LoggingOptions(_ request: AWSIoTGetV2LoggingOptionsRequest) async throws -> AWSIoTGetV2LoggingOptionsResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorNotConfigured, AWSIoTErrorServiceUnavailable.

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

    Requires permission to access the ListActiveViolations action.

    See

    AWSIoTListActiveViolationsRequest

    See

    AWSIoTListActiveViolationsResponse

    Declaration

    Objective-C

    - (id)listActiveViolations:(nonnull AWSIoTListActiveViolationsRequest *)request;

    Swift

    func listActiveViolations(_ request: AWSIoTListActiveViolationsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Requires permission to access the ListActiveViolations action.

    See

    AWSIoTListActiveViolationsRequest

    See

    AWSIoTListActiveViolationsResponse

    Declaration

    Objective-C

    - (void)listActiveViolations:
            (nonnull AWSIoTListActiveViolationsRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSIoTListActiveViolationsResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func listActiveViolations(_ request: AWSIoTListActiveViolationsRequest) async throws -> AWSIoTListActiveViolationsResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

  • Lists the policies attached to the specified thing group.

    Requires permission to access the ListAttachedPolicies action.

    See

    AWSIoTListAttachedPoliciesRequest

    See

    AWSIoTListAttachedPoliciesResponse

    Declaration

    Objective-C

    - (id)listAttachedPolicies:(nonnull AWSIoTListAttachedPoliciesRequest *)request;

    Swift

    func listAttachedPolicies(_ request: AWSIoTListAttachedPoliciesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists the policies attached to the specified thing group.

    Requires permission to access the ListAttachedPolicies action.

    See

    AWSIoTListAttachedPoliciesRequest

    See

    AWSIoTListAttachedPoliciesResponse

    Declaration

    Objective-C

    - (void)listAttachedPolicies:
            (nonnull AWSIoTListAttachedPoliciesRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSIoTListAttachedPoliciesResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func listAttachedPolicies(_ request: AWSIoTListAttachedPoliciesRequest) async throws -> AWSIoTListAttachedPoliciesResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorLimitExceeded.

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

    Requires permission to access the ListAuditFindings action.

    See

    AWSIoTListAuditFindingsRequest

    See

    AWSIoTListAuditFindingsResponse

    Declaration

    Objective-C

    - (id)listAuditFindings:(nonnull AWSIoTListAuditFindingsRequest *)request;

    Swift

    func listAuditFindings(_ request: AWSIoTListAuditFindingsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Requires permission to access the ListAuditFindings action.

    See

    AWSIoTListAuditFindingsRequest

    See

    AWSIoTListAuditFindingsResponse

    Declaration

    Objective-C

    - (void)listAuditFindings:(nonnull AWSIoTListAuditFindingsRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSIoTListAuditFindingsResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func listAuditFindings(_ request: AWSIoTListAuditFindingsRequest) async throws -> AWSIoTListAuditFindingsResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

  • Gets the status of audit mitigation action tasks that were executed.

    Requires permission to access the ListAuditMitigationActionsExecutions action.

    See

    AWSIoTListAuditMitigationActionsExecutionsRequest

    See

    AWSIoTListAuditMitigationActionsExecutionsResponse

    Declaration

    Objective-C

    - (id)listAuditMitigationActionsExecutions:
    (nonnull AWSIoTListAuditMitigationActionsExecutionsRequest *)request;

    Swift

    func listAuditMitigationActionsExecutions(_ request: AWSIoTListAuditMitigationActionsExecutionsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets the status of audit mitigation action tasks that were executed.

    Requires permission to access the ListAuditMitigationActionsExecutions action.

    See

    AWSIoTListAuditMitigationActionsExecutionsRequest

    See

    AWSIoTListAuditMitigationActionsExecutionsResponse

    Declaration

    Objective-C

    - (void)
    listAuditMitigationActionsExecutions:
        (nonnull AWSIoTListAuditMitigationActionsExecutionsRequest *)request
                       completionHandler:
                           (void (^_Nullable)(
                               AWSIoTListAuditMitigationActionsExecutionsResponse
                                   *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func listAuditMitigationActionsExecutions(_ request: AWSIoTListAuditMitigationActionsExecutionsRequest) async throws -> AWSIoTListAuditMitigationActionsExecutionsResponse

    Parameters

    request

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

  • Gets a list of audit mitigation action tasks that match the specified filters.

    Requires permission to access the ListAuditMitigationActionsTasks action.

    See

    AWSIoTListAuditMitigationActionsTasksRequest

    See

    AWSIoTListAuditMitigationActionsTasksResponse

    Declaration

    Objective-C

    - (id)listAuditMitigationActionsTasks:
    (nonnull AWSIoTListAuditMitigationActionsTasksRequest *)request;

    Swift

    func listAuditMitigationActionsTasks(_ request: AWSIoTListAuditMitigationActionsTasksRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets a list of audit mitigation action tasks that match the specified filters.

    Requires permission to access the ListAuditMitigationActionsTasks action.

    See

    AWSIoTListAuditMitigationActionsTasksRequest

    See

    AWSIoTListAuditMitigationActionsTasksResponse

    Declaration

    Objective-C

    - (void)listAuditMitigationActionsTasks:
            (nonnull AWSIoTListAuditMitigationActionsTasksRequest *)request
                      completionHandler:
                          (void (^_Nullable)(
                              AWSIoTListAuditMitigationActionsTasksResponse
                                  *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func listAuditMitigationActionsTasks(_ request: AWSIoTListAuditMitigationActionsTasksRequest) async throws -> AWSIoTListAuditMitigationActionsTasksResponse

    Parameters

    request

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

  • Lists your Device Defender audit listings.

    Requires permission to access the ListAuditSuppressions action.

    See

    AWSIoTListAuditSuppressionsRequest

    See

    AWSIoTListAuditSuppressionsResponse

    Declaration

    Objective-C

    - (id)listAuditSuppressions:
    (nonnull AWSIoTListAuditSuppressionsRequest *)request;

    Swift

    func listAuditSuppressions(_ request: AWSIoTListAuditSuppressionsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists your Device Defender audit listings.

    Requires permission to access the ListAuditSuppressions action.

    See

    AWSIoTListAuditSuppressionsRequest

    See

    AWSIoTListAuditSuppressionsResponse

    Declaration

    Objective-C

    - (void)
    listAuditSuppressions:(nonnull AWSIoTListAuditSuppressionsRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSIoTListAuditSuppressionsResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func listAuditSuppressions(_ request: AWSIoTListAuditSuppressionsRequest) async throws -> AWSIoTListAuditSuppressionsResponse

    Parameters

    request

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

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

    Requires permission to access the ListAuditTasks action.

    See

    AWSIoTListAuditTasksRequest

    See

    AWSIoTListAuditTasksResponse

    Declaration

    Objective-C

    - (id)listAuditTasks:(nonnull AWSIoTListAuditTasksRequest *)request;

    Swift

    func listAuditTasks(_ request: AWSIoTListAuditTasksRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Requires permission to access the ListAuditTasks action.

    See

    AWSIoTListAuditTasksRequest

    See

    AWSIoTListAuditTasksResponse

    Declaration

    Objective-C

    - (void)listAuditTasks:(nonnull AWSIoTListAuditTasksRequest *)request
     completionHandler:
         (void (^_Nullable)(AWSIoTListAuditTasksResponse *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func listAuditTasks(_ request: AWSIoTListAuditTasksRequest) async throws -> AWSIoTListAuditTasksResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

  • Lists the authorizers registered in your account.

    Requires permission to access the ListAuthorizers action.

    See

    AWSIoTListAuthorizersRequest

    See

    AWSIoTListAuthorizersResponse

    Declaration

    Objective-C

    - (id)listAuthorizers:(nonnull AWSIoTListAuthorizersRequest *)request;

    Swift

    func listAuthorizers(_ request: AWSIoTListAuthorizersRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists the authorizers registered in your account.

    Requires permission to access the ListAuthorizers action.

    See

    AWSIoTListAuthorizersRequest

    See

    AWSIoTListAuthorizersResponse

    Declaration

    Objective-C

    - (void)listAuthorizers:(nonnull AWSIoTListAuthorizersRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSIoTListAuthorizersResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func listAuthorizers(_ request: AWSIoTListAuthorizersRequest) async throws -> AWSIoTListAuthorizersResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

  • Lists the billing groups you have created.

    Requires permission to access the ListBillingGroups action.

    See

    AWSIoTListBillingGroupsRequest

    See

    AWSIoTListBillingGroupsResponse

    Declaration

    Objective-C

    - (id)listBillingGroups:(nonnull AWSIoTListBillingGroupsRequest *)request;

    Swift

    func listBillingGroups(_ request: AWSIoTListBillingGroupsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists the billing groups you have created.

    Requires permission to access the ListBillingGroups action.

    See

    AWSIoTListBillingGroupsRequest

    See

    AWSIoTListBillingGroupsResponse

    Declaration

    Objective-C

    - (void)listBillingGroups:(nonnull AWSIoTListBillingGroupsRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSIoTListBillingGroupsResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func listBillingGroups(_ request: AWSIoTListBillingGroupsRequest) async throws -> AWSIoTListBillingGroupsResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling.

  • Lists the CA certificates registered for your Amazon Web Services account.

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

    Requires permission to access the ListCACertificates action.

    See

    AWSIoTListCACertificatesRequest

    See

    AWSIoTListCACertificatesResponse

    Declaration

    Objective-C

    - (id)listCACertificates:(nonnull AWSIoTListCACertificatesRequest *)request;

    Swift

    func listCACertificates(_ request: AWSIoTListCACertificatesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists the CA certificates registered for your Amazon Web Services account.

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

    Requires permission to access the ListCACertificates action.

    See

    AWSIoTListCACertificatesRequest

    See

    AWSIoTListCACertificatesResponse

    Declaration

    Objective-C

    - (void)listCACertificates:(nonnull AWSIoTListCACertificatesRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSIoTListCACertificatesResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func listCACertificates(_ request: AWSIoTListCACertificatesRequest) async throws -> AWSIoTListCACertificatesResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

  • Lists all your certificate providers in your Amazon Web Services account.

    Requires permission to access the ListCertificateProviders action.

    See

    AWSIoTListCertificateProvidersRequest

    See

    AWSIoTListCertificateProvidersResponse

    Declaration

    Objective-C

    - (id)listCertificateProviders:
    (nonnull AWSIoTListCertificateProvidersRequest *)request;

    Swift

    func listCertificateProviders(_ request: AWSIoTListCertificateProvidersRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists all your certificate providers in your Amazon Web Services account.

    Requires permission to access the ListCertificateProviders action.

    See

    AWSIoTListCertificateProvidersRequest

    See

    AWSIoTListCertificateProvidersResponse

    Declaration

    Objective-C

    - (void)listCertificateProviders:
            (nonnull AWSIoTListCertificateProvidersRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSIoTListCertificateProvidersResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func listCertificateProviders(_ request: AWSIoTListCertificateProvidersRequest) async throws -> AWSIoTListCertificateProvidersResponse

    Parameters

    request

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

  • Lists the certificates registered in your Amazon Web Services account.

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

    Requires permission to access the ListCertificates action.

    See

    AWSIoTListCertificatesRequest

    See

    AWSIoTListCertificatesResponse

    Declaration

    Objective-C

    - (id)listCertificates:(nonnull AWSIoTListCertificatesRequest *)request;

    Swift

    func listCertificates(_ request: AWSIoTListCertificatesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists the certificates registered in your Amazon Web Services account.

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

    Requires permission to access the ListCertificates action.

    See

    AWSIoTListCertificatesRequest

    See

    AWSIoTListCertificatesResponse

    Declaration

    Objective-C

    - (void)listCertificates:(nonnull AWSIoTListCertificatesRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSIoTListCertificatesResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func listCertificates(_ request: AWSIoTListCertificatesRequest) async throws -> AWSIoTListCertificatesResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

  • List the device certificates signed by the specified CA certificate.

    Requires permission to access the ListCertificatesByCA action.

    See

    AWSIoTListCertificatesByCARequest

    See

    AWSIoTListCertificatesByCAResponse

    Declaration

    Objective-C

    - (id)listCertificatesByCA:(nonnull AWSIoTListCertificatesByCARequest *)request;

    Swift

    func listCertificates(byCA request: AWSIoTListCertificatesByCARequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • List the device certificates signed by the specified CA certificate.

    Requires permission to access the ListCertificatesByCA action.

    See

    AWSIoTListCertificatesByCARequest

    See

    AWSIoTListCertificatesByCAResponse

    Declaration

    Objective-C

    - (void)listCertificatesByCA:
            (nonnull AWSIoTListCertificatesByCARequest *)request
           completionHandler:
               (void (^_Nullable)(AWSIoTListCertificatesByCAResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func listCertificates(byCA request: AWSIoTListCertificatesByCARequest) async throws -> AWSIoTListCertificatesByCAResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

  • Lists your Device Defender detect custom metrics.

    Requires permission to access the ListCustomMetrics action.

    See

    AWSIoTListCustomMetricsRequest

    See

    AWSIoTListCustomMetricsResponse

    Declaration

    Objective-C

    - (id)listCustomMetrics:(nonnull AWSIoTListCustomMetricsRequest *)request;

    Swift

    func listCustomMetrics(_ request: AWSIoTListCustomMetricsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists your Device Defender detect custom metrics.

    Requires permission to access the ListCustomMetrics action.

    See

    AWSIoTListCustomMetricsRequest

    See

    AWSIoTListCustomMetricsResponse

    Declaration

    Objective-C

    - (void)listCustomMetrics:(nonnull AWSIoTListCustomMetricsRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSIoTListCustomMetricsResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func listCustomMetrics(_ request: AWSIoTListCustomMetricsRequest) async throws -> AWSIoTListCustomMetricsResponse

    Parameters

    request

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

  • Lists mitigation actions executions for a Device Defender ML Detect Security Profile.

    Requires permission to access the ListDetectMitigationActionsExecutions action.

    See

    AWSIoTListDetectMitigationActionsExecutionsRequest

    See

    AWSIoTListDetectMitigationActionsExecutionsResponse

    Declaration

    Objective-C

    - (id)listDetectMitigationActionsExecutions:
    (nonnull AWSIoTListDetectMitigationActionsExecutionsRequest *)request;

    Swift

    func listDetectMitigationActionsExecutions(_ request: AWSIoTListDetectMitigationActionsExecutionsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists mitigation actions executions for a Device Defender ML Detect Security Profile.

    Requires permission to access the ListDetectMitigationActionsExecutions action.

    See

    AWSIoTListDetectMitigationActionsExecutionsRequest

    See

    AWSIoTListDetectMitigationActionsExecutionsResponse

    Declaration

    Objective-C

    - (void)
    listDetectMitigationActionsExecutions:
        (nonnull AWSIoTListDetectMitigationActionsExecutionsRequest *)request
                        completionHandler:
                            (void (^_Nullable)(
                                AWSIoTListDetectMitigationActionsExecutionsResponse
                                    *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func listDetectMitigationActionsExecutions(_ request: AWSIoTListDetectMitigationActionsExecutionsRequest) async throws -> AWSIoTListDetectMitigationActionsExecutionsResponse

    Parameters

    request

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

  • List of Device Defender ML Detect mitigation actions tasks.

    Requires permission to access the ListDetectMitigationActionsTasks action.

    See

    AWSIoTListDetectMitigationActionsTasksRequest

    See

    AWSIoTListDetectMitigationActionsTasksResponse

    Declaration

    Objective-C

    - (id)listDetectMitigationActionsTasks:
    (nonnull AWSIoTListDetectMitigationActionsTasksRequest *)request;

    Swift

    func listDetectMitigationActionsTasks(_ request: AWSIoTListDetectMitigationActionsTasksRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • List of Device Defender ML Detect mitigation actions tasks.

    Requires permission to access the ListDetectMitigationActionsTasks action.

    See

    AWSIoTListDetectMitigationActionsTasksRequest

    See

    AWSIoTListDetectMitigationActionsTasksResponse

    Declaration

    Objective-C

    - (void)listDetectMitigationActionsTasks:
            (nonnull AWSIoTListDetectMitigationActionsTasksRequest *)request
                       completionHandler:
                           (void (^_Nullable)(
                               AWSIoTListDetectMitigationActionsTasksResponse
                                   *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func listDetectMitigationActionsTasks(_ request: AWSIoTListDetectMitigationActionsTasksRequest) async throws -> AWSIoTListDetectMitigationActionsTasksResponse

    Parameters

    request

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

  • List the set of dimensions that are defined for your Amazon Web Services accounts.

    Requires permission to access the ListDimensions action.

    See

    AWSIoTListDimensionsRequest

    See

    AWSIoTListDimensionsResponse

    Declaration

    Objective-C

    - (id)listDimensions:(nonnull AWSIoTListDimensionsRequest *)request;

    Swift

    func listDimensions(_ request: AWSIoTListDimensionsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • List the set of dimensions that are defined for your Amazon Web Services accounts.

    Requires permission to access the ListDimensions action.

    See

    AWSIoTListDimensionsRequest

    See

    AWSIoTListDimensionsResponse

    Declaration

    Objective-C

    - (void)listDimensions:(nonnull AWSIoTListDimensionsRequest *)request
     completionHandler:
         (void (^_Nullable)(AWSIoTListDimensionsResponse *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func listDimensions(_ request: AWSIoTListDimensionsRequest) async throws -> AWSIoTListDimensionsResponse

    Parameters

    request

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

  • Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name.

    Requires permission to access the ListDomainConfigurations action.

    See

    AWSIoTListDomainConfigurationsRequest

    See

    AWSIoTListDomainConfigurationsResponse

    Declaration

    Objective-C

    - (id)listDomainConfigurations:
    (nonnull AWSIoTListDomainConfigurationsRequest *)request;

    Swift

    func listDomainConfigurations(_ request: AWSIoTListDomainConfigurationsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name.

    Requires permission to access the ListDomainConfigurations action.

    See

    AWSIoTListDomainConfigurationsRequest

    See

    AWSIoTListDomainConfigurationsResponse

    Declaration

    Objective-C

    - (void)listDomainConfigurations:
            (nonnull AWSIoTListDomainConfigurationsRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSIoTListDomainConfigurationsResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func listDomainConfigurations(_ request: AWSIoTListDomainConfigurationsRequest) async throws -> AWSIoTListDomainConfigurationsResponse

    Parameters

    request

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

  • Lists all your fleet metrics.

    Requires permission to access the ListFleetMetrics action.

    See

    AWSIoTListFleetMetricsRequest

    See

    AWSIoTListFleetMetricsResponse

    Declaration

    Objective-C

    - (id)listFleetMetrics:(nonnull AWSIoTListFleetMetricsRequest *)request;

    Swift

    func listFleetMetrics(_ request: AWSIoTListFleetMetricsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists all your fleet metrics.

    Requires permission to access the ListFleetMetrics action.

    See

    AWSIoTListFleetMetricsRequest

    See

    AWSIoTListFleetMetricsResponse

    Declaration

    Objective-C

    - (void)listFleetMetrics:(nonnull AWSIoTListFleetMetricsRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSIoTListFleetMetricsResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func listFleetMetrics(_ request: AWSIoTListFleetMetricsRequest) async throws -> AWSIoTListFleetMetricsResponse

    Parameters

    request

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

  • Lists the search indices.

    Requires permission to access the ListIndices action.

    See

    AWSIoTListIndicesRequest

    See

    AWSIoTListIndicesResponse

    Declaration

    Objective-C

    - (id)listIndices:(nonnull AWSIoTListIndicesRequest *)request;

    Swift

    func listIndices(_ request: AWSIoTListIndicesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists the search indices.

    Requires permission to access the ListIndices action.

    See

    AWSIoTListIndicesRequest

    See

    AWSIoTListIndicesResponse

    Declaration

    Objective-C

    - (void)listIndices:(nonnull AWSIoTListIndicesRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTListIndicesResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func listIndices(_ request: AWSIoTListIndicesRequest) async throws -> AWSIoTListIndicesResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

  • Lists the job executions for a job.

    Requires permission to access the ListJobExecutionsForJob action.

    See

    AWSIoTListJobExecutionsForJobRequest

    See

    AWSIoTListJobExecutionsForJobResponse

    Declaration

    Objective-C

    - (id)listJobExecutionsForJob:
    (nonnull AWSIoTListJobExecutionsForJobRequest *)request;

    Swift

    func listJobExecutions(forJob request: AWSIoTListJobExecutionsForJobRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists the job executions for a job.

    Requires permission to access the ListJobExecutionsForJob action.

    See

    AWSIoTListJobExecutionsForJobRequest

    See

    AWSIoTListJobExecutionsForJobResponse

    Declaration

    Objective-C

    - (void)listJobExecutionsForJob:
            (nonnull AWSIoTListJobExecutionsForJobRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSIoTListJobExecutionsForJobResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func listJobExecutions(forJob request: AWSIoTListJobExecutionsForJobRequest) async throws -> AWSIoTListJobExecutionsForJobResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

  • Lists the job executions for the specified thing.

    Requires permission to access the ListJobExecutionsForThing action.

    See

    AWSIoTListJobExecutionsForThingRequest

    See

    AWSIoTListJobExecutionsForThingResponse

    Declaration

    Objective-C

    - (id)listJobExecutionsForThing:
    (nonnull AWSIoTListJobExecutionsForThingRequest *)request;

    Swift

    func listJobExecutions(forThing request: AWSIoTListJobExecutionsForThingRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists the job executions for the specified thing.

    Requires permission to access the ListJobExecutionsForThing action.

    See

    AWSIoTListJobExecutionsForThingRequest

    See

    AWSIoTListJobExecutionsForThingResponse

    Declaration

    Objective-C

    - (void)listJobExecutionsForThing:
            (nonnull AWSIoTListJobExecutionsForThingRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSIoTListJobExecutionsForThingResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func listJobExecutions(forThing request: AWSIoTListJobExecutionsForThingRequest) async throws -> AWSIoTListJobExecutionsForThingResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

  • Returns a list of job templates.

    Requires permission to access the ListJobTemplates action.

    See

    AWSIoTListJobTemplatesRequest

    See

    AWSIoTListJobTemplatesResponse

    Declaration

    Objective-C

    - (id)listJobTemplates:(nonnull AWSIoTListJobTemplatesRequest *)request;

    Swift

    func listJobTemplates(_ request: AWSIoTListJobTemplatesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns a list of job templates.

    Requires permission to access the ListJobTemplates action.

    See

    AWSIoTListJobTemplatesRequest

    See

    AWSIoTListJobTemplatesResponse

    Declaration

    Objective-C

    - (void)listJobTemplates:(nonnull AWSIoTListJobTemplatesRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSIoTListJobTemplatesResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func listJobTemplates(_ request: AWSIoTListJobTemplatesRequest) async throws -> AWSIoTListJobTemplatesResponse

    Parameters

    request

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

  • Lists jobs.

    Requires permission to access the ListJobs action.

    See

    AWSIoTListJobsRequest

    See

    AWSIoTListJobsResponse

    Declaration

    Objective-C

    - (id)listJobs:(nonnull AWSIoTListJobsRequest *)request;

    Swift

    func listJobs(_ request: AWSIoTListJobsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists jobs.

    Requires permission to access the ListJobs action.

    See

    AWSIoTListJobsRequest

    See

    AWSIoTListJobsResponse

    Declaration

    Objective-C

    - (void)listJobs:(nonnull AWSIoTListJobsRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTListJobsResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func listJobs(_ request: AWSIoTListJobsRequest) async throws -> AWSIoTListJobsResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

  • Returns a list of managed job templates.

    See

    AWSIoTListManagedJobTemplatesRequest

    See

    AWSIoTListManagedJobTemplatesResponse

    Declaration

    Objective-C

    - (id)listManagedJobTemplates:
    (nonnull AWSIoTListManagedJobTemplatesRequest *)request;

    Swift

    func listManagedJobTemplates(_ request: AWSIoTListManagedJobTemplatesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns a list of managed job templates.

    See

    AWSIoTListManagedJobTemplatesRequest

    See

    AWSIoTListManagedJobTemplatesResponse

    Declaration

    Objective-C

    - (void)listManagedJobTemplates:
            (nonnull AWSIoTListManagedJobTemplatesRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSIoTListManagedJobTemplatesResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func listManagedJobTemplates(_ request: AWSIoTListManagedJobTemplatesRequest) async throws -> AWSIoTListManagedJobTemplatesResponse

    Parameters

    request

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

  • Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) by the given thing during the specified time period.

    See

    AWSIoTListMetricValuesRequest

    See

    AWSIoTListMetricValuesResponse

    Declaration

    Objective-C

    - (id)listMetricValues:(nonnull AWSIoTListMetricValuesRequest *)request;

    Swift

    func listMetricValues(_ request: AWSIoTListMetricValuesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) by the given thing during the specified time period.

    See

    AWSIoTListMetricValuesRequest

    See

    AWSIoTListMetricValuesResponse

    Declaration

    Objective-C

    - (void)listMetricValues:(nonnull AWSIoTListMetricValuesRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSIoTListMetricValuesResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func listMetricValues(_ request: AWSIoTListMetricValuesRequest) async throws -> AWSIoTListMetricValuesResponse

    Parameters

    request

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

  • Gets a list of all mitigation actions that match the specified filter criteria.

    Requires permission to access the ListMitigationActions action.

    See

    AWSIoTListMitigationActionsRequest

    See

    AWSIoTListMitigationActionsResponse

    Declaration

    Objective-C

    - (id)listMitigationActions:
    (nonnull AWSIoTListMitigationActionsRequest *)request;

    Swift

    func listMitigationActions(_ request: AWSIoTListMitigationActionsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets a list of all mitigation actions that match the specified filter criteria.

    Requires permission to access the ListMitigationActions action.

    See

    AWSIoTListMitigationActionsRequest

    See

    AWSIoTListMitigationActionsResponse

    Declaration

    Objective-C

    - (void)
    listMitigationActions:(nonnull AWSIoTListMitigationActionsRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSIoTListMitigationActionsResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func listMitigationActions(_ request: AWSIoTListMitigationActionsRequest) async throws -> AWSIoTListMitigationActionsResponse

    Parameters

    request

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

  • Lists OTA updates.

    Requires permission to access the ListOTAUpdates action.

    See

    AWSIoTListOTAUpdatesRequest

    See

    AWSIoTListOTAUpdatesResponse

    Declaration

    Objective-C

    - (id)listOTAUpdates:(nonnull AWSIoTListOTAUpdatesRequest *)request;

    Swift

    func listOTAUpdates(_ request: AWSIoTListOTAUpdatesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists OTA updates.

    Requires permission to access the ListOTAUpdates action.

    See

    AWSIoTListOTAUpdatesRequest

    See

    AWSIoTListOTAUpdatesResponse

    Declaration

    Objective-C

    - (void)listOTAUpdates:(nonnull AWSIoTListOTAUpdatesRequest *)request
     completionHandler:
         (void (^_Nullable)(AWSIoTListOTAUpdatesResponse *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func listOTAUpdates(_ request: AWSIoTListOTAUpdatesRequest) async throws -> AWSIoTListOTAUpdatesResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorInternalFailure, AWSIoTErrorServiceUnavailable.

  • Lists certificates that are being transferred but not yet accepted.

    Requires permission to access the ListOutgoingCertificates action.

    See

    AWSIoTListOutgoingCertificatesRequest

    See

    AWSIoTListOutgoingCertificatesResponse

    Declaration

    Objective-C

    - (id)listOutgoingCertificates:
    (nonnull AWSIoTListOutgoingCertificatesRequest *)request;

    Swift

    func listOutgoingCertificates(_ request: AWSIoTListOutgoingCertificatesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists certificates that are being transferred but not yet accepted.

    Requires permission to access the ListOutgoingCertificates action.

    See

    AWSIoTListOutgoingCertificatesRequest

    See

    AWSIoTListOutgoingCertificatesResponse

    Declaration

    Objective-C

    - (void)listOutgoingCertificates:
            (nonnull AWSIoTListOutgoingCertificatesRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSIoTListOutgoingCertificatesResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func listOutgoingCertificates(_ request: AWSIoTListOutgoingCertificatesRequest) async throws -> AWSIoTListOutgoingCertificatesResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

  • Lists the software package versions associated to the account.

    Requires permission to access the ListPackageVersions action.

    See

    AWSIoTListPackageVersionsRequest

    See

    AWSIoTListPackageVersionsResponse

    Declaration

    Objective-C

    - (id)listPackageVersions:(nonnull AWSIoTListPackageVersionsRequest *)request;

    Swift

    func listPackageVersions(_ request: AWSIoTListPackageVersionsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists the software package versions associated to the account.

    Requires permission to access the ListPackageVersions action.

    See

    AWSIoTListPackageVersionsRequest

    See

    AWSIoTListPackageVersionsResponse

    Declaration

    Objective-C

    - (void)listPackageVersions:(nonnull AWSIoTListPackageVersionsRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSIoTListPackageVersionsResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func listPackageVersions(_ request: AWSIoTListPackageVersionsRequest) async throws -> AWSIoTListPackageVersionsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListPackageVersions 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, AWSIoTErrorInternalServer, AWSIoTErrorValidation.

  • Lists the software packages associated to the account.

    Requires permission to access the ListPackages action.

    See

    AWSIoTListPackagesRequest

    See

    AWSIoTListPackagesResponse

    Declaration

    Objective-C

    - (id)listPackages:(nonnull AWSIoTListPackagesRequest *)request;

    Swift

    func listPackages(_ request: AWSIoTListPackagesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists the software packages associated to the account.

    Requires permission to access the ListPackages action.

    See

    AWSIoTListPackagesRequest

    See

    AWSIoTListPackagesResponse

    Declaration

    Objective-C

    - (void)listPackages:(nonnull AWSIoTListPackagesRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTListPackagesResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func listPackages(_ request: AWSIoTListPackagesRequest) async throws -> AWSIoTListPackagesResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListPackages 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, AWSIoTErrorInternalServer, AWSIoTErrorValidation.

  • Lists your policies.

    Requires permission to access the ListPolicies action.

    See

    AWSIoTListPoliciesRequest

    See

    AWSIoTListPoliciesResponse

    Declaration

    Objective-C

    - (id)listPolicies:(nonnull AWSIoTListPoliciesRequest *)request;

    Swift

    func listPolicies(_ request: AWSIoTListPoliciesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists your policies.

    Requires permission to access the ListPolicies action.

    See

    AWSIoTListPoliciesRequest

    See

    AWSIoTListPoliciesResponse

    Declaration

    Objective-C

    - (void)listPolicies:(nonnull AWSIoTListPoliciesRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTListPoliciesResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func listPolicies(_ request: AWSIoTListPoliciesRequest) async throws -> AWSIoTListPoliciesResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

  • Lists the principals associated with the specified policy.

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

    Requires permission to access the ListPolicyPrincipals action.

    See

    AWSIoTListPolicyPrincipalsRequest

    See

    AWSIoTListPolicyPrincipalsResponse

    Declaration

    Objective-C

    - (id)listPolicyPrincipals:(nonnull AWSIoTListPolicyPrincipalsRequest *)request;

    Swift

    func listPolicyPrincipals(_ request: AWSIoTListPolicyPrincipalsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists the principals associated with the specified policy.

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

    Requires permission to access the ListPolicyPrincipals action.

    See

    AWSIoTListPolicyPrincipalsRequest

    See

    AWSIoTListPolicyPrincipalsResponse

    Declaration

    Objective-C

    - (void)listPolicyPrincipals:
            (nonnull AWSIoTListPolicyPrincipalsRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSIoTListPolicyPrincipalsResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func listPolicyPrincipals(_ request: AWSIoTListPolicyPrincipalsRequest) async throws -> AWSIoTListPolicyPrincipalsResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

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

    Requires permission to access the ListPolicyVersions action.

    See

    AWSIoTListPolicyVersionsRequest

    See

    AWSIoTListPolicyVersionsResponse

    Declaration

    Objective-C

    - (id)listPolicyVersions:(nonnull AWSIoTListPolicyVersionsRequest *)request;

    Swift

    func listPolicyVersions(_ request: AWSIoTListPolicyVersionsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Requires permission to access the ListPolicyVersions action.

    See

    AWSIoTListPolicyVersionsRequest

    See

    AWSIoTListPolicyVersionsResponse

    Declaration

    Objective-C

    - (void)listPolicyVersions:(nonnull AWSIoTListPolicyVersionsRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSIoTListPolicyVersionsResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func listPolicyVersions(_ request: AWSIoTListPolicyVersionsRequest) async throws -> AWSIoTListPolicyVersionsResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

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

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

    Requires permission to access the ListPrincipalPolicies action.

    See

    AWSIoTListPrincipalPoliciesRequest

    See

    AWSIoTListPrincipalPoliciesResponse

    Declaration

    Objective-C

    - (id)listPrincipalPolicies:
    (nonnull AWSIoTListPrincipalPoliciesRequest *)request;

    Swift

    func listPrincipalPolicies(_ request: AWSIoTListPrincipalPoliciesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

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

    Requires permission to access the ListPrincipalPolicies action.

    See

    AWSIoTListPrincipalPoliciesRequest

    See

    AWSIoTListPrincipalPoliciesResponse

    Declaration

    Objective-C

    - (void)
    listPrincipalPolicies:(nonnull AWSIoTListPrincipalPoliciesRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSIoTListPrincipalPoliciesResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func listPrincipalPolicies(_ request: AWSIoTListPrincipalPoliciesRequest) async throws -> AWSIoTListPrincipalPoliciesResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

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

    Requires permission to access the ListPrincipalThings action.

    See

    AWSIoTListPrincipalThingsRequest

    See

    AWSIoTListPrincipalThingsResponse

    Declaration

    Objective-C

    - (id)listPrincipalThings:(nonnull AWSIoTListPrincipalThingsRequest *)request;

    Swift

    func listPrincipalThings(_ request: AWSIoTListPrincipalThingsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Requires permission to access the ListPrincipalThings action.

    See

    AWSIoTListPrincipalThingsRequest

    See

    AWSIoTListPrincipalThingsResponse

    Declaration

    Objective-C

    - (void)listPrincipalThings:(nonnull AWSIoTListPrincipalThingsRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSIoTListPrincipalThingsResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func listPrincipalThings(_ request: AWSIoTListPrincipalThingsRequest) async throws -> AWSIoTListPrincipalThingsResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

  • A list of provisioning template versions.

    Requires permission to access the ListProvisioningTemplateVersions action.

    See

    AWSIoTListProvisioningTemplateVersionsRequest

    See

    AWSIoTListProvisioningTemplateVersionsResponse

    Declaration

    Objective-C

    - (id)listProvisioningTemplateVersions:
    (nonnull AWSIoTListProvisioningTemplateVersionsRequest *)request;

    Swift

    func listProvisioningTemplateVersions(_ request: AWSIoTListProvisioningTemplateVersionsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • A list of provisioning template versions.

    Requires permission to access the ListProvisioningTemplateVersions action.

    See

    AWSIoTListProvisioningTemplateVersionsRequest

    See

    AWSIoTListProvisioningTemplateVersionsResponse

    Declaration

    Objective-C

    - (void)listProvisioningTemplateVersions:
            (nonnull AWSIoTListProvisioningTemplateVersionsRequest *)request
                       completionHandler:
                           (void (^_Nullable)(
                               AWSIoTListProvisioningTemplateVersionsResponse
                                   *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func listProvisioningTemplateVersions(_ request: AWSIoTListProvisioningTemplateVersionsRequest) async throws -> AWSIoTListProvisioningTemplateVersionsResponse

    Parameters

    request

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

  • Lists the provisioning templates in your Amazon Web Services account.

    Requires permission to access the ListProvisioningTemplates action.

    See

    AWSIoTListProvisioningTemplatesRequest

    See

    AWSIoTListProvisioningTemplatesResponse

    Declaration

    Objective-C

    - (id)listProvisioningTemplates:
    (nonnull AWSIoTListProvisioningTemplatesRequest *)request;

    Swift

    func listProvisioningTemplates(_ request: AWSIoTListProvisioningTemplatesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists the provisioning templates in your Amazon Web Services account.

    Requires permission to access the ListProvisioningTemplates action.

    See

    AWSIoTListProvisioningTemplatesRequest

    See

    AWSIoTListProvisioningTemplatesResponse

    Declaration

    Objective-C

    - (void)listProvisioningTemplates:
            (nonnull AWSIoTListProvisioningTemplatesRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSIoTListProvisioningTemplatesResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func listProvisioningTemplates(_ request: AWSIoTListProvisioningTemplatesRequest) async throws -> AWSIoTListProvisioningTemplatesResponse

    Parameters

    request

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

  • The related resources of an Audit finding. The following resources can be returned from calling this API:

    • DEVICE_CERTIFICATE

    • CA_CERTIFICATE

    • IOT_POLICY

    • COGNITO_IDENTITY_POOL

    • CLIENT_ID

    • ACCOUNT_SETTINGS

    • ROLE_ALIAS

    • IAM_ROLE

    • ISSUER_CERTIFICATE

    This API is similar to DescribeAuditFinding’s RelatedResources but provides pagination and is not limited to 10 resources. When calling DescribeAuditFinding for the intermediate CA revoked for active device certificates check, RelatedResources will not be populated. You must use this API, ListRelatedResourcesForAuditFinding, to list the certificates.

    See

    AWSIoTListRelatedResourcesForAuditFindingRequest

    See

    AWSIoTListRelatedResourcesForAuditFindingResponse

    Declaration

    Objective-C

    - (id)listRelatedResourcesForAuditFinding:
    (nonnull AWSIoTListRelatedResourcesForAuditFindingRequest *)request;

    Swift

    func listRelatedResources(forAuditFinding request: AWSIoTListRelatedResourcesForAuditFindingRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • The related resources of an Audit finding. The following resources can be returned from calling this API:

    • DEVICE_CERTIFICATE

    • CA_CERTIFICATE

    • IOT_POLICY

    • COGNITO_IDENTITY_POOL

    • CLIENT_ID

    • ACCOUNT_SETTINGS

    • ROLE_ALIAS

    • IAM_ROLE

    • ISSUER_CERTIFICATE

    This API is similar to DescribeAuditFinding’s RelatedResources but provides pagination and is not limited to 10 resources. When calling DescribeAuditFinding for the intermediate CA revoked for active device certificates check, RelatedResources will not be populated. You must use this API, ListRelatedResourcesForAuditFinding, to list the certificates.

    See

    AWSIoTListRelatedResourcesForAuditFindingRequest

    See

    AWSIoTListRelatedResourcesForAuditFindingResponse

    Declaration

    Objective-C

    - (void)
    listRelatedResourcesForAuditFinding:
        (nonnull AWSIoTListRelatedResourcesForAuditFindingRequest *)request
                      completionHandler:
                          (void (^_Nullable)(
                              AWSIoTListRelatedResourcesForAuditFindingResponse
                                  *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func listRelatedResources(forAuditFinding request: AWSIoTListRelatedResourcesForAuditFindingRequest) async throws -> AWSIoTListRelatedResourcesForAuditFindingResponse

    Parameters

    request

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

  • Lists the role aliases registered in your account.

    Requires permission to access the ListRoleAliases action.

    See

    AWSIoTListRoleAliasesRequest

    See

    AWSIoTListRoleAliasesResponse

    Declaration

    Objective-C

    - (id)listRoleAliases:(nonnull AWSIoTListRoleAliasesRequest *)request;

    Swift

    func listRoleAliases(_ request: AWSIoTListRoleAliasesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists the role aliases registered in your account.

    Requires permission to access the ListRoleAliases action.

    See

    AWSIoTListRoleAliasesRequest

    See

    AWSIoTListRoleAliasesResponse

    Declaration

    Objective-C

    - (void)listRoleAliases:(nonnull AWSIoTListRoleAliasesRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSIoTListRoleAliasesResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func listRoleAliases(_ request: AWSIoTListRoleAliasesRequest) async throws -> AWSIoTListRoleAliasesResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

  • Lists all of your scheduled audits.

    Requires permission to access the ListScheduledAudits action.

    See

    AWSIoTListScheduledAuditsRequest

    See

    AWSIoTListScheduledAuditsResponse

    Declaration

    Objective-C

    - (id)listScheduledAudits:(nonnull AWSIoTListScheduledAuditsRequest *)request;

    Swift

    func listScheduledAudits(_ request: AWSIoTListScheduledAuditsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists all of your scheduled audits.

    Requires permission to access the ListScheduledAudits action.

    See

    AWSIoTListScheduledAuditsRequest

    See

    AWSIoTListScheduledAuditsResponse

    Declaration

    Objective-C

    - (void)listScheduledAudits:(nonnull AWSIoTListScheduledAuditsRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSIoTListScheduledAuditsResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func listScheduledAudits(_ request: AWSIoTListScheduledAuditsRequest) async throws -> AWSIoTListScheduledAuditsResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

  • Lists the Device Defender security profiles you’ve created. You can filter security profiles by dimension or custom metric.

    Requires permission to access the ListSecurityProfiles action.

    dimensionName and metricName cannot be used in the same request.

    See

    AWSIoTListSecurityProfilesRequest

    See

    AWSIoTListSecurityProfilesResponse

    Declaration

    Objective-C

    - (id)listSecurityProfiles:(nonnull AWSIoTListSecurityProfilesRequest *)request;

    Swift

    func listSecurityProfiles(_ request: AWSIoTListSecurityProfilesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists the Device Defender security profiles you’ve created. You can filter security profiles by dimension or custom metric.

    Requires permission to access the ListSecurityProfiles action.

    dimensionName and metricName cannot be used in the same request.

    See

    AWSIoTListSecurityProfilesRequest

    See

    AWSIoTListSecurityProfilesResponse

    Declaration

    Objective-C

    - (void)listSecurityProfiles:
            (nonnull AWSIoTListSecurityProfilesRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSIoTListSecurityProfilesResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func listSecurityProfiles(_ request: AWSIoTListSecurityProfilesRequest) async throws -> AWSIoTListSecurityProfilesResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

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

    Requires permission to access the ListSecurityProfilesForTarget action.

    See

    AWSIoTListSecurityProfilesForTargetRequest

    See

    AWSIoTListSecurityProfilesForTargetResponse

    Declaration

    Objective-C

    - (id)listSecurityProfilesForTarget:
    (nonnull AWSIoTListSecurityProfilesForTargetRequest *)request;

    Swift

    func listSecurityProfiles(forTarget request: AWSIoTListSecurityProfilesForTargetRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Requires permission to access the ListSecurityProfilesForTarget action.

    See

    AWSIoTListSecurityProfilesForTargetRequest

    See

    AWSIoTListSecurityProfilesForTargetResponse

    Declaration

    Objective-C

    - (void)
    listSecurityProfilesForTarget:
        (nonnull AWSIoTListSecurityProfilesForTargetRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSIoTListSecurityProfilesForTargetResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func listSecurityProfiles(forTarget request: AWSIoTListSecurityProfilesForTargetRequest) async throws -> AWSIoTListSecurityProfilesForTargetResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

  • Lists all of the streams in your Amazon Web Services account.

    Requires permission to access the ListStreams action.

    See

    AWSIoTListStreamsRequest

    See

    AWSIoTListStreamsResponse

    Declaration

    Objective-C

    - (id)listStreams:(nonnull AWSIoTListStreamsRequest *)request;

    Swift

    func listStreams(_ request: AWSIoTListStreamsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists all of the streams in your Amazon Web Services account.

    Requires permission to access the ListStreams action.

    See

    AWSIoTListStreamsRequest

    See

    AWSIoTListStreamsResponse

    Declaration

    Objective-C

    - (void)listStreams:(nonnull AWSIoTListStreamsRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTListStreamsResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func listStreams(_ request: AWSIoTListStreamsRequest) async throws -> AWSIoTListStreamsResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

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

    Requires permission to access the ListTagsForResource action.

    See

    AWSIoTListTagsForResourceRequest

    See

    AWSIoTListTagsForResourceResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

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

    Requires permission to access the ListTagsForResource action.

    See

    AWSIoTListTagsForResourceRequest

    See

    AWSIoTListTagsForResourceResponse

    Declaration

    Objective-C

    - (void)listTagsForResource:(nonnull AWSIoTListTagsForResourceRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSIoTListTagsForResourceResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func listTags(forResource request: AWSIoTListTagsForResourceRequest) async throws -> AWSIoTListTagsForResourceResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling.

  • List targets for the specified policy.

    Requires permission to access the ListTargetsForPolicy action.

    See

    AWSIoTListTargetsForPolicyRequest

    See

    AWSIoTListTargetsForPolicyResponse

    Declaration

    Objective-C

    - (id)listTargetsForPolicy:(nonnull AWSIoTListTargetsForPolicyRequest *)request;

    Swift

    func listTargets(forPolicy request: AWSIoTListTargetsForPolicyRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • List targets for the specified policy.

    Requires permission to access the ListTargetsForPolicy action.

    See

    AWSIoTListTargetsForPolicyRequest

    See

    AWSIoTListTargetsForPolicyResponse

    Declaration

    Objective-C

    - (void)listTargetsForPolicy:
            (nonnull AWSIoTListTargetsForPolicyRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSIoTListTargetsForPolicyResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func listTargets(forPolicy request: AWSIoTListTargetsForPolicyRequest) async throws -> AWSIoTListTargetsForPolicyResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorLimitExceeded.

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

    Requires permission to access the ListTargetsForSecurityProfile action.

    See

    AWSIoTListTargetsForSecurityProfileRequest

    See

    AWSIoTListTargetsForSecurityProfileResponse

    Declaration

    Objective-C

    - (id)listTargetsForSecurityProfile:
    (nonnull AWSIoTListTargetsForSecurityProfileRequest *)request;

    Swift

    func listTargets(forSecurityProfile request: AWSIoTListTargetsForSecurityProfileRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Requires permission to access the ListTargetsForSecurityProfile action.

    See

    AWSIoTListTargetsForSecurityProfileRequest

    See

    AWSIoTListTargetsForSecurityProfileResponse

    Declaration

    Objective-C

    - (void)
    listTargetsForSecurityProfile:
        (nonnull AWSIoTListTargetsForSecurityProfileRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSIoTListTargetsForSecurityProfileResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func listTargets(forSecurityProfile request: AWSIoTListTargetsForSecurityProfileRequest) async throws -> AWSIoTListTargetsForSecurityProfileResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

  • List the thing groups in your account.

    Requires permission to access the ListThingGroups action.

    See

    AWSIoTListThingGroupsRequest

    See

    AWSIoTListThingGroupsResponse

    Declaration

    Objective-C

    - (id)listThingGroups:(nonnull AWSIoTListThingGroupsRequest *)request;

    Swift

    func listThingGroups(_ request: AWSIoTListThingGroupsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • List the thing groups in your account.

    Requires permission to access the ListThingGroups action.

    See

    AWSIoTListThingGroupsRequest

    See

    AWSIoTListThingGroupsResponse

    Declaration

    Objective-C

    - (void)listThingGroups:(nonnull AWSIoTListThingGroupsRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSIoTListThingGroupsResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func listThingGroups(_ request: AWSIoTListThingGroupsRequest) async throws -> AWSIoTListThingGroupsResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling.

  • List the thing groups to which the specified thing belongs.

    Requires permission to access the ListThingGroupsForThing action.

    See

    AWSIoTListThingGroupsForThingRequest

    See

    AWSIoTListThingGroupsForThingResponse

    Declaration

    Objective-C

    - (id)listThingGroupsForThing:
    (nonnull AWSIoTListThingGroupsForThingRequest *)request;

    Swift

    func listThingGroups(forThing request: AWSIoTListThingGroupsForThingRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • List the thing groups to which the specified thing belongs.

    Requires permission to access the ListThingGroupsForThing action.

    See

    AWSIoTListThingGroupsForThingRequest

    See

    AWSIoTListThingGroupsForThingResponse

    Declaration

    Objective-C

    - (void)listThingGroupsForThing:
            (nonnull AWSIoTListThingGroupsForThingRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSIoTListThingGroupsForThingResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func listThingGroups(forThing request: AWSIoTListThingGroupsForThingRequest) async throws -> AWSIoTListThingGroupsForThingResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling.

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

    Requires permission to access the ListThingPrincipals action.

    See

    AWSIoTListThingPrincipalsRequest

    See

    AWSIoTListThingPrincipalsResponse

    Declaration

    Objective-C

    - (id)listThingPrincipals:(nonnull AWSIoTListThingPrincipalsRequest *)request;

    Swift

    func listThingPrincipals(_ request: AWSIoTListThingPrincipalsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Requires permission to access the ListThingPrincipals action.

    See

    AWSIoTListThingPrincipalsRequest

    See

    AWSIoTListThingPrincipalsResponse

    Declaration

    Objective-C

    - (void)listThingPrincipals:(nonnull AWSIoTListThingPrincipalsRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSIoTListThingPrincipalsResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func listThingPrincipals(_ request: AWSIoTListThingPrincipalsRequest) async throws -> AWSIoTListThingPrincipalsResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

  • Information about the thing registration tasks.

    See

    AWSIoTListThingRegistrationTaskReportsRequest

    See

    AWSIoTListThingRegistrationTaskReportsResponse

    Declaration

    Objective-C

    - (id)listThingRegistrationTaskReports:
    (nonnull AWSIoTListThingRegistrationTaskReportsRequest *)request;

    Swift

    func listThingRegistrationTaskReports(_ request: AWSIoTListThingRegistrationTaskReportsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Information about the thing registration tasks.

    See

    AWSIoTListThingRegistrationTaskReportsRequest

    See

    AWSIoTListThingRegistrationTaskReportsResponse

    Declaration

    Objective-C

    - (void)listThingRegistrationTaskReports:
            (nonnull AWSIoTListThingRegistrationTaskReportsRequest *)request
                       completionHandler:
                           (void (^_Nullable)(
                               AWSIoTListThingRegistrationTaskReportsResponse
                                   *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func listThingRegistrationTaskReports(_ request: AWSIoTListThingRegistrationTaskReportsRequest) async throws -> AWSIoTListThingRegistrationTaskReportsResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorInternalFailure.

  • List bulk thing provisioning tasks.

    Requires permission to access the ListThingRegistrationTasks action.

    See

    AWSIoTListThingRegistrationTasksRequest

    See

    AWSIoTListThingRegistrationTasksResponse

    Declaration

    Objective-C

    - (id)listThingRegistrationTasks:
    (nonnull AWSIoTListThingRegistrationTasksRequest *)request;

    Swift

    func listThingRegistrationTasks(_ request: AWSIoTListThingRegistrationTasksRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • List bulk thing provisioning tasks.

    Requires permission to access the ListThingRegistrationTasks action.

    See

    AWSIoTListThingRegistrationTasksRequest

    See

    AWSIoTListThingRegistrationTasksResponse

    Declaration

    Objective-C

    - (void)listThingRegistrationTasks:
            (nonnull AWSIoTListThingRegistrationTasksRequest *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSIoTListThingRegistrationTasksResponse *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func listThingRegistrationTasks(_ request: AWSIoTListThingRegistrationTasksRequest) async throws -> AWSIoTListThingRegistrationTasksResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorInternalFailure.

  • Lists the existing thing types.

    Requires permission to access the ListThingTypes action.

    See

    AWSIoTListThingTypesRequest

    See

    AWSIoTListThingTypesResponse

    Declaration

    Objective-C

    - (id)listThingTypes:(nonnull AWSIoTListThingTypesRequest *)request;

    Swift

    func listThingTypes(_ request: AWSIoTListThingTypesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists the existing thing types.

    Requires permission to access the ListThingTypes action.

    See

    AWSIoTListThingTypesRequest

    See

    AWSIoTListThingTypesResponse

    Declaration

    Objective-C

    - (void)listThingTypes:(nonnull AWSIoTListThingTypesRequest *)request
     completionHandler:
         (void (^_Nullable)(AWSIoTListThingTypesResponse *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func listThingTypes(_ request: AWSIoTListThingTypesRequest) async throws -> AWSIoTListThingTypesResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

  • Lists your things. Use the attributeName and attributeValue parameters to filter your things. For example, calling ListThings with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute Color with the value Red. For more information, see List Things from the Amazon Web Services IoT Core Developer Guide.

    Requires permission to access the ListThings action.

    You will not be charged for calling this API if an Access denied error is returned. You will also not be charged if no attributes or pagination token was provided in request and no pagination token and no results were returned.

    See

    AWSIoTListThingsRequest

    See

    AWSIoTListThingsResponse

    Declaration

    Objective-C

    - (id)listThings:(nonnull AWSIoTListThingsRequest *)request;

    Swift

    func listThings(_ request: AWSIoTListThingsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists your things. Use the attributeName and attributeValue parameters to filter your things. For example, calling ListThings with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute Color with the value Red. For more information, see List Things from the Amazon Web Services IoT Core Developer Guide.

    Requires permission to access the ListThings action.

    You will not be charged for calling this API if an Access denied error is returned. You will also not be charged if no attributes or pagination token was provided in request and no pagination token and no results were returned.

    See

    AWSIoTListThingsRequest

    See

    AWSIoTListThingsResponse

    Declaration

    Objective-C

    - (void)listThings:(nonnull AWSIoTListThingsRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTListThingsResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func listThings(_ request: AWSIoTListThingsRequest) async throws -> AWSIoTListThingsResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

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

    Requires permission to access the ListThingsInBillingGroup action.

    See

    AWSIoTListThingsInBillingGroupRequest

    See

    AWSIoTListThingsInBillingGroupResponse

    Declaration

    Objective-C

    - (id)listThingsInBillingGroup:
    (nonnull AWSIoTListThingsInBillingGroupRequest *)request;

    Swift

    func listThings(inBillingGroup request: AWSIoTListThingsInBillingGroupRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Requires permission to access the ListThingsInBillingGroup action.

    See

    AWSIoTListThingsInBillingGroupRequest

    See

    AWSIoTListThingsInBillingGroupResponse

    Declaration

    Objective-C

    - (void)listThingsInBillingGroup:
            (nonnull AWSIoTListThingsInBillingGroupRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSIoTListThingsInBillingGroupResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func listThings(inBillingGroup request: AWSIoTListThingsInBillingGroupRequest) async throws -> AWSIoTListThingsInBillingGroupResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling.

  • Lists the things in the specified group.

    Requires permission to access the ListThingsInThingGroup action.

    See

    AWSIoTListThingsInThingGroupRequest

    See

    AWSIoTListThingsInThingGroupResponse

    Declaration

    Objective-C

    - (id)listThingsInThingGroup:
    (nonnull AWSIoTListThingsInThingGroupRequest *)request;

    Swift

    func listThings(inThingGroup request: AWSIoTListThingsInThingGroupRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists the things in the specified group.

    Requires permission to access the ListThingsInThingGroup action.

    See

    AWSIoTListThingsInThingGroupRequest

    See

    AWSIoTListThingsInThingGroupResponse

    Declaration

    Objective-C

    - (void)
    listThingsInThingGroup:
        (nonnull AWSIoTListThingsInThingGroupRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSIoTListThingsInThingGroupResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func listThings(inThingGroup request: AWSIoTListThingsInThingGroupRequest) async throws -> AWSIoTListThingsInThingGroupResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling.

  • Lists all the topic rule destinations in your Amazon Web Services account.

    Requires permission to access the ListTopicRuleDestinations action.

    See

    AWSIoTListTopicRuleDestinationsRequest

    See

    AWSIoTListTopicRuleDestinationsResponse

    Declaration

    Objective-C

    - (id)listTopicRuleDestinations:
    (nonnull AWSIoTListTopicRuleDestinationsRequest *)request;

    Swift

    func listTopicRuleDestinations(_ request: AWSIoTListTopicRuleDestinationsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists all the topic rule destinations in your Amazon Web Services account.

    Requires permission to access the ListTopicRuleDestinations action.

    See

    AWSIoTListTopicRuleDestinationsRequest

    See

    AWSIoTListTopicRuleDestinationsResponse

    Declaration

    Objective-C

    - (void)listTopicRuleDestinations:
            (nonnull AWSIoTListTopicRuleDestinationsRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSIoTListTopicRuleDestinationsResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func listTopicRuleDestinations(_ request: AWSIoTListTopicRuleDestinationsRequest) async throws -> AWSIoTListTopicRuleDestinationsResponse

    Parameters

    request

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

  • Lists the rules for the specific topic.

    Requires permission to access the ListTopicRules action.

    See

    AWSIoTListTopicRulesRequest

    See

    AWSIoTListTopicRulesResponse

    Declaration

    Objective-C

    - (id)listTopicRules:(nonnull AWSIoTListTopicRulesRequest *)request;

    Swift

    func listTopicRules(_ request: AWSIoTListTopicRulesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists the rules for the specific topic.

    Requires permission to access the ListTopicRules action.

    See

    AWSIoTListTopicRulesRequest

    See

    AWSIoTListTopicRulesResponse

    Declaration

    Objective-C

    - (void)listTopicRules:(nonnull AWSIoTListTopicRulesRequest *)request
     completionHandler:
         (void (^_Nullable)(AWSIoTListTopicRulesResponse *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func listTopicRules(_ request: AWSIoTListTopicRulesRequest) async throws -> AWSIoTListTopicRulesResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable.

  • Lists logging levels.

    Requires permission to access the ListV2LoggingLevels action.

    See

    AWSIoTListV2LoggingLevelsRequest

    See

    AWSIoTListV2LoggingLevelsResponse

    Declaration

    Objective-C

    - (id)listV2LoggingLevels:(nonnull AWSIoTListV2LoggingLevelsRequest *)request;

    Swift

    func listV2LoggingLevels(_ request: AWSIoTListV2LoggingLevelsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists logging levels.

    Requires permission to access the ListV2LoggingLevels action.

    See

    AWSIoTListV2LoggingLevelsRequest

    See

    AWSIoTListV2LoggingLevelsResponse

    Declaration

    Objective-C

    - (void)listV2LoggingLevels:(nonnull AWSIoTListV2LoggingLevelsRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSIoTListV2LoggingLevelsResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func listV2LoggingLevels(_ request: AWSIoTListV2LoggingLevelsRequest) async throws -> AWSIoTListV2LoggingLevelsResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorNotConfigured, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable.

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

    Requires permission to access the ListViolationEvents action.

    See

    AWSIoTListViolationEventsRequest

    See

    AWSIoTListViolationEventsResponse

    Declaration

    Objective-C

    - (id)listViolationEvents:(nonnull AWSIoTListViolationEventsRequest *)request;

    Swift

    func listViolationEvents(_ request: AWSIoTListViolationEventsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    Requires permission to access the ListViolationEvents action.

    See

    AWSIoTListViolationEventsRequest

    See

    AWSIoTListViolationEventsResponse

    Declaration

    Objective-C

    - (void)listViolationEvents:(nonnull AWSIoTListViolationEventsRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSIoTListViolationEventsResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func listViolationEvents(_ request: AWSIoTListViolationEventsRequest) async throws -> AWSIoTListViolationEventsResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

  • Set a verification state and provide a description of that verification state on a violation (detect alarm).

    See

    AWSIoTPutVerificationStateOnViolationRequest

    See

    AWSIoTPutVerificationStateOnViolationResponse

    Declaration

    Objective-C

    - (id)putVerificationStateOnViolation:
    (nonnull AWSIoTPutVerificationStateOnViolationRequest *)request;

    Swift

    func putVerificationState(onViolation request: AWSIoTPutVerificationStateOnViolationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Set a verification state and provide a description of that verification state on a violation (detect alarm).

    See

    AWSIoTPutVerificationStateOnViolationRequest

    See

    AWSIoTPutVerificationStateOnViolationResponse

    Declaration

    Objective-C

    - (void)putVerificationStateOnViolation:
            (nonnull AWSIoTPutVerificationStateOnViolationRequest *)request
                      completionHandler:
                          (void (^_Nullable)(
                              AWSIoTPutVerificationStateOnViolationResponse
                                  *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func putVerificationState(onViolation request: AWSIoTPutVerificationStateOnViolationRequest) async throws -> AWSIoTPutVerificationStateOnViolationResponse

    Parameters

    request

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

  • Registers a CA certificate with Amazon Web Services IoT Core. There is no limit to the number of CA certificates you can register in your Amazon Web Services account. You can register up to 10 CA certificates with the same CA subject field per Amazon Web Services account.

    Requires permission to access the RegisterCACertificate action.

    See

    AWSIoTRegisterCACertificateRequest

    See

    AWSIoTRegisterCACertificateResponse

    Declaration

    Objective-C

    - (id)registerCACertificate:
    (nonnull AWSIoTRegisterCACertificateRequest *)request;

    Swift

    func registerCACertificate(_ request: AWSIoTRegisterCACertificateRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Registers a CA certificate with Amazon Web Services IoT Core. There is no limit to the number of CA certificates you can register in your Amazon Web Services account. You can register up to 10 CA certificates with the same CA subject field per Amazon Web Services account.

    Requires permission to access the RegisterCACertificate action.

    See

    AWSIoTRegisterCACertificateRequest

    See

    AWSIoTRegisterCACertificateResponse

    Declaration

    Objective-C

    - (void)
    registerCACertificate:(nonnull AWSIoTRegisterCACertificateRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSIoTRegisterCACertificateResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func registerCACertificate(_ request: AWSIoTRegisterCACertificateRequest) async throws -> AWSIoTRegisterCACertificateResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorResourceAlreadyExists, AWSIoTErrorRegistrationCodeValidation, AWSIoTErrorInvalidRequest, AWSIoTErrorCertificateValidation, AWSIoTErrorThrottling, AWSIoTErrorLimitExceeded, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

  • Registers a device certificate with IoT in the same certificate mode as the signing CA. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered.

    Requires permission to access the RegisterCertificate action.

    See

    AWSIoTRegisterCertificateRequest

    See

    AWSIoTRegisterCertificateResponse

    Declaration

    Objective-C

    - (id)registerCertificate:(nonnull AWSIoTRegisterCertificateRequest *)request;

    Swift

    func registerCertificate(_ request: AWSIoTRegisterCertificateRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Registers a device certificate with IoT in the same certificate mode as the signing CA. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered.

    Requires permission to access the RegisterCertificate action.

    See

    AWSIoTRegisterCertificateRequest

    See

    AWSIoTRegisterCertificateResponse

    Declaration

    Objective-C

    - (void)registerCertificate:(nonnull AWSIoTRegisterCertificateRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSIoTRegisterCertificateResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func registerCertificate(_ request: AWSIoTRegisterCertificateRequest) async throws -> AWSIoTRegisterCertificateResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceAlreadyExists, AWSIoTErrorInvalidRequest, AWSIoTErrorCertificateValidation, AWSIoTErrorCertificateState, AWSIoTErrorCertificateConflict, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

  • Register a certificate that does not have a certificate authority (CA). For supported certificates, consult Certificate signing algorithms supported by IoT.

    See

    AWSIoTRegisterCertificateWithoutCARequest

    See

    AWSIoTRegisterCertificateWithoutCAResponse

    Declaration

    Objective-C

    - (id)registerCertificateWithoutCA:
    (nonnull AWSIoTRegisterCertificateWithoutCARequest *)request;

    Swift

    func registerCertificateWithoutCA(_ request: AWSIoTRegisterCertificateWithoutCARequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Register a certificate that does not have a certificate authority (CA). For supported certificates, consult Certificate signing algorithms supported by IoT.

    See

    AWSIoTRegisterCertificateWithoutCARequest

    See

    AWSIoTRegisterCertificateWithoutCAResponse

    Declaration

    Objective-C

    - (void)
    registerCertificateWithoutCA:
        (nonnull AWSIoTRegisterCertificateWithoutCARequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSIoTRegisterCertificateWithoutCAResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func registerCertificateWithoutCA(_ request: AWSIoTRegisterCertificateWithoutCARequest) async throws -> AWSIoTRegisterCertificateWithoutCAResponse

    Parameters

    request

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

  • Provisions a thing in the device registry. RegisterThing calls other IoT control plane APIs. These calls might exceed your account level IoT Throttling Limits and cause throttle errors. Please contact Amazon Web Services Customer Support to raise your throttling limits if necessary.

    Requires permission to access the RegisterThing action.

    See

    AWSIoTRegisterThingRequest

    See

    AWSIoTRegisterThingResponse

    Declaration

    Objective-C

    - (id)registerThing:(nonnull AWSIoTRegisterThingRequest *)request;

    Swift

    func registerThing(_ request: AWSIoTRegisterThingRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Provisions a thing in the device registry. RegisterThing calls other IoT control plane APIs. These calls might exceed your account level IoT Throttling Limits and cause throttle errors. Please contact Amazon Web Services Customer Support to raise your throttling limits if necessary.

    Requires permission to access the RegisterThing action.

    See

    AWSIoTRegisterThingRequest

    See

    AWSIoTRegisterThingResponse

    Declaration

    Objective-C

    - (void)registerThing:(nonnull AWSIoTRegisterThingRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTRegisterThingResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func registerThing(_ request: AWSIoTRegisterThingRequest) async throws -> AWSIoTRegisterThingResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternalFailure, AWSIoTErrorServiceUnavailable, AWSIoTErrorInvalidRequest, AWSIoTErrorUnauthorized, AWSIoTErrorThrottling, AWSIoTErrorConflictingResourceUpdate, AWSIoTErrorResourceRegistrationFailure.

  • Rejects a pending certificate transfer. After IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE.

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

    This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source’s account in the INACTIVE state.

    Requires permission to access the RejectCertificateTransfer action.

    See

    AWSIoTRejectCertificateTransferRequest

    Declaration

    Objective-C

    - (id)rejectCertificateTransfer:
    (nonnull AWSIoTRejectCertificateTransferRequest *)request;

    Swift

    func rejectCertificateTransfer(_ request: AWSIoTRejectCertificateTransferRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Rejects a pending certificate transfer. After IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE.

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

    This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source’s account in the INACTIVE state.

    Requires permission to access the RejectCertificateTransfer action.

    See

    AWSIoTRejectCertificateTransferRequest

    Declaration

    Objective-C

    - (void)rejectCertificateTransfer:
            (nonnull AWSIoTRejectCertificateTransferRequest *)request
                completionHandler:
                    (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func rejectCertificateTransfer(_ request: AWSIoTRejectCertificateTransferRequest) async throws

    Parameters

    request

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

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorTransferAlreadyCompleted, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

  • Removes the given thing from the billing group.

    Requires permission to access the RemoveThingFromBillingGroup action.

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

    See

    AWSIoTRemoveThingFromBillingGroupRequest

    See

    AWSIoTRemoveThingFromBillingGroupResponse

    Declaration

    Objective-C

    - (id)removeThingFromBillingGroup:
    (nonnull AWSIoTRemoveThingFromBillingGroupRequest *)request;

    Swift

    func removeThing(fromBillingGroup request: AWSIoTRemoveThingFromBillingGroupRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Removes the given thing from the billing group.

    Requires permission to access the RemoveThingFromBillingGroup action.

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

    See

    AWSIoTRemoveThingFromBillingGroupRequest

    See

    AWSIoTRemoveThingFromBillingGroupResponse

    Declaration

    Objective-C

    - (void)removeThingFromBillingGroup:
            (nonnull AWSIoTRemoveThingFromBillingGroupRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSIoTRemoveThingFromBillingGroupResponse *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func removeThing(fromBillingGroup request: AWSIoTRemoveThingFromBillingGroupRequest) async throws -> AWSIoTRemoveThingFromBillingGroupResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

  • Remove the specified thing from the specified group.

    You must specify either a thingGroupArn or a thingGroupName to identify the thing group and either a thingArn or a thingName to identify the thing to remove from the thing group.

    Requires permission to access the RemoveThingFromThingGroup action.

    See

    AWSIoTRemoveThingFromThingGroupRequest

    See

    AWSIoTRemoveThingFromThingGroupResponse

    Declaration

    Objective-C

    - (id)removeThingFromThingGroup:
    (nonnull AWSIoTRemoveThingFromThingGroupRequest *)request;

    Swift

    func removeThing(fromThingGroup request: AWSIoTRemoveThingFromThingGroupRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Remove the specified thing from the specified group.

    You must specify either a thingGroupArn or a thingGroupName to identify the thing group and either a thingArn or a thingName to identify the thing to remove from the thing group.

    Requires permission to access the RemoveThingFromThingGroup action.

    See

    AWSIoTRemoveThingFromThingGroupRequest

    See

    AWSIoTRemoveThingFromThingGroupResponse

    Declaration

    Objective-C

    - (void)removeThingFromThingGroup:
            (nonnull AWSIoTRemoveThingFromThingGroupRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSIoTRemoveThingFromThingGroupResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func removeThing(fromThingGroup request: AWSIoTRemoveThingFromThingGroupRequest) async throws -> AWSIoTRemoveThingFromThingGroupResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

  • Replaces the rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.

    Requires permission to access the ReplaceTopicRule action.

    See

    AWSIoTReplaceTopicRuleRequest

    Declaration

    Objective-C

    - (id)replaceTopicRule:(nonnull AWSIoTReplaceTopicRuleRequest *)request;

    Swift

    func replaceTopicRule(_ request: AWSIoTReplaceTopicRuleRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Replaces the rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.

    Requires permission to access the ReplaceTopicRule action.

    See

    AWSIoTReplaceTopicRuleRequest

    Declaration

    Objective-C

    - (void)replaceTopicRule:(nonnull AWSIoTReplaceTopicRuleRequest *)request
       completionHandler:
           (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func replaceTopicRule(_ request: AWSIoTReplaceTopicRuleRequest) async throws

    Parameters

    request

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

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorSqlParse, AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable, AWSIoTErrorUnauthorized, AWSIoTErrorConflictingResourceUpdate.

  • The query search index.

    Requires permission to access the SearchIndex action.

    See

    AWSIoTSearchIndexRequest

    See

    AWSIoTSearchIndexResponse

    Declaration

    Objective-C

    - (id)searchIndex:(nonnull AWSIoTSearchIndexRequest *)request;

    Swift

    func searchIndex(_ request: AWSIoTSearchIndexRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • The query search index.

    Requires permission to access the SearchIndex action.

    See

    AWSIoTSearchIndexRequest

    See

    AWSIoTSearchIndexResponse

    Declaration

    Objective-C

    - (void)searchIndex:(nonnull AWSIoTSearchIndexRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTSearchIndexResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func searchIndex(_ request: AWSIoTSearchIndexRequest) async throws -> AWSIoTSearchIndexResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidQuery, AWSIoTErrorIndexNotReady.

  • Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.

    Requires permission to access the SetDefaultAuthorizer action.

    See

    AWSIoTSetDefaultAuthorizerRequest

    See

    AWSIoTSetDefaultAuthorizerResponse

    Declaration

    Objective-C

    - (id)setDefaultAuthorizer:(nonnull AWSIoTSetDefaultAuthorizerRequest *)request;

    Swift

    func setDefaultAuthorizer(_ request: AWSIoTSetDefaultAuthorizerRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.

    Requires permission to access the SetDefaultAuthorizer action.

    See

    AWSIoTSetDefaultAuthorizerRequest

    See

    AWSIoTSetDefaultAuthorizerResponse

    Declaration

    Objective-C

    - (void)setDefaultAuthorizer:
            (nonnull AWSIoTSetDefaultAuthorizerRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSIoTSetDefaultAuthorizerResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func setDefaultAuthorizer(_ request: AWSIoTSetDefaultAuthorizerRequest) async throws -> AWSIoTSetDefaultAuthorizerResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceAlreadyExists.

  • Sets the specified version of the specified policy as the policy’s default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicies action.

    Requires permission to access the SetDefaultPolicyVersion action.

    See

    AWSIoTSetDefaultPolicyVersionRequest

    Declaration

    Objective-C

    - (id)setDefaultPolicyVersion:
    (nonnull AWSIoTSetDefaultPolicyVersionRequest *)request;

    Swift

    func setDefaultPolicyVersion(_ request: AWSIoTSetDefaultPolicyVersionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Sets the specified version of the specified policy as the policy’s default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicies action.

    Requires permission to access the SetDefaultPolicyVersion action.

    See

    AWSIoTSetDefaultPolicyVersionRequest

    Declaration

    Objective-C

    - (void)setDefaultPolicyVersion:
            (nonnull AWSIoTSetDefaultPolicyVersionRequest *)request
              completionHandler:
                  (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func setDefaultPolicyVersion(_ request: AWSIoTSetDefaultPolicyVersionRequest) async throws

    Parameters

    request

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

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

  • Sets the logging options.

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

    Requires permission to access the SetLoggingOptions action.

    See

    AWSIoTSetLoggingOptionsRequest

    Declaration

    Objective-C

    - (id)setLoggingOptions:(nonnull AWSIoTSetLoggingOptionsRequest *)request;

    Swift

    func setLoggingOptions(_ request: AWSIoTSetLoggingOptionsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Sets the logging options.

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

    Requires permission to access the SetLoggingOptions action.

    See

    AWSIoTSetLoggingOptionsRequest

    Declaration

    Objective-C

    - (void)setLoggingOptions:(nonnull AWSIoTSetLoggingOptionsRequest *)request
        completionHandler:
            (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func setLoggingOptions(_ request: AWSIoTSetLoggingOptionsRequest) async throws

    Parameters

    request

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

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable.

  • Sets the logging level.

    Requires permission to access the SetV2LoggingLevel action.

    See

    AWSIoTSetV2LoggingLevelRequest

    Declaration

    Objective-C

    - (id)setV2LoggingLevel:(nonnull AWSIoTSetV2LoggingLevelRequest *)request;

    Swift

    func setV2LoggingLevel(_ request: AWSIoTSetV2LoggingLevelRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Sets the logging level.

    Requires permission to access the SetV2LoggingLevel action.

    See

    AWSIoTSetV2LoggingLevelRequest

    Declaration

    Objective-C

    - (void)setV2LoggingLevel:(nonnull AWSIoTSetV2LoggingLevelRequest *)request
        completionHandler:
            (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func setV2LoggingLevel(_ request: AWSIoTSetV2LoggingLevelRequest) async throws

    Parameters

    request

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

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorNotConfigured, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable, AWSIoTErrorLimitExceeded.

  • Sets the logging options for the V2 logging service.

    Requires permission to access the SetV2LoggingOptions action.

    See

    AWSIoTSetV2LoggingOptionsRequest

    Declaration

    Objective-C

    - (id)setV2LoggingOptions:(nonnull AWSIoTSetV2LoggingOptionsRequest *)request;

    Swift

    func setV2LoggingOptions(_ request: AWSIoTSetV2LoggingOptionsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Sets the logging options for the V2 logging service.

    Requires permission to access the SetV2LoggingOptions action.

    See

    AWSIoTSetV2LoggingOptionsRequest

    Declaration

    Objective-C

    - (void)setV2LoggingOptions:(nonnull AWSIoTSetV2LoggingOptionsRequest *)request
          completionHandler:
              (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func setV2LoggingOptions(_ request: AWSIoTSetV2LoggingOptionsRequest) async throws

    Parameters

    request

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

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInternal, AWSIoTErrorInvalidRequest, AWSIoTErrorServiceUnavailable.

  • Starts a task that applies a set of mitigation actions to the specified target.

    Requires permission to access the StartAuditMitigationActionsTask action.

    See

    AWSIoTStartAuditMitigationActionsTaskRequest

    See

    AWSIoTStartAuditMitigationActionsTaskResponse

    Declaration

    Objective-C

    - (id)startAuditMitigationActionsTask:
    (nonnull AWSIoTStartAuditMitigationActionsTaskRequest *)request;

    Swift

    func startAuditMitigationActionsTask(_ request: AWSIoTStartAuditMitigationActionsTaskRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Starts a task that applies a set of mitigation actions to the specified target.

    Requires permission to access the StartAuditMitigationActionsTask action.

    See

    AWSIoTStartAuditMitigationActionsTaskRequest

    See

    AWSIoTStartAuditMitigationActionsTaskResponse

    Declaration

    Objective-C

    - (void)startAuditMitigationActionsTask:
            (nonnull AWSIoTStartAuditMitigationActionsTaskRequest *)request
                      completionHandler:
                          (void (^_Nullable)(
                              AWSIoTStartAuditMitigationActionsTaskResponse
                                  *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func startAuditMitigationActionsTask(_ request: AWSIoTStartAuditMitigationActionsTaskRequest) async throws -> AWSIoTStartAuditMitigationActionsTaskResponse

    Parameters

    request

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

  • Starts a Device Defender ML Detect mitigation actions task.

    Requires permission to access the StartDetectMitigationActionsTask action.

    See

    AWSIoTStartDetectMitigationActionsTaskRequest

    See

    AWSIoTStartDetectMitigationActionsTaskResponse

    Declaration

    Objective-C

    - (id)startDetectMitigationActionsTask:
    (nonnull AWSIoTStartDetectMitigationActionsTaskRequest *)request;

    Swift

    func startDetectMitigationActionsTask(_ request: AWSIoTStartDetectMitigationActionsTaskRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Starts a Device Defender ML Detect mitigation actions task.

    Requires permission to access the StartDetectMitigationActionsTask action.

    See

    AWSIoTStartDetectMitigationActionsTaskRequest

    See

    AWSIoTStartDetectMitigationActionsTaskResponse

    Declaration

    Objective-C

    - (void)startDetectMitigationActionsTask:
            (nonnull AWSIoTStartDetectMitigationActionsTaskRequest *)request
                       completionHandler:
                           (void (^_Nullable)(
                               AWSIoTStartDetectMitigationActionsTaskResponse
                                   *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func startDetectMitigationActionsTask(_ request: AWSIoTStartDetectMitigationActionsTaskRequest) async throws -> AWSIoTStartDetectMitigationActionsTaskResponse

    Parameters

    request

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

  • Starts an on-demand Device Defender audit.

    Requires permission to access the StartOnDemandAuditTask action.

    See

    AWSIoTStartOnDemandAuditTaskRequest

    See

    AWSIoTStartOnDemandAuditTaskResponse

    Declaration

    Objective-C

    - (id)startOnDemandAuditTask:
    (nonnull AWSIoTStartOnDemandAuditTaskRequest *)request;

    Swift

    func start(onDemandAuditTask request: AWSIoTStartOnDemandAuditTaskRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Starts an on-demand Device Defender audit.

    Requires permission to access the StartOnDemandAuditTask action.

    See

    AWSIoTStartOnDemandAuditTaskRequest

    See

    AWSIoTStartOnDemandAuditTaskResponse

    Declaration

    Objective-C

    - (void)
    startOnDemandAuditTask:
        (nonnull AWSIoTStartOnDemandAuditTaskRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSIoTStartOnDemandAuditTaskResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func start(onDemandAuditTask request: AWSIoTStartOnDemandAuditTaskRequest) async throws -> AWSIoTStartOnDemandAuditTaskResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorLimitExceeded.

  • Creates a bulk thing provisioning task.

    Requires permission to access the StartThingRegistrationTask action.

    See

    AWSIoTStartThingRegistrationTaskRequest

    See

    AWSIoTStartThingRegistrationTaskResponse

    Declaration

    Objective-C

    - (id)startThingRegistrationTask:
    (nonnull AWSIoTStartThingRegistrationTaskRequest *)request;

    Swift

    func startThingRegistrationTask(_ request: AWSIoTStartThingRegistrationTaskRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates a bulk thing provisioning task.

    Requires permission to access the StartThingRegistrationTask action.

    See

    AWSIoTStartThingRegistrationTaskRequest

    See

    AWSIoTStartThingRegistrationTaskResponse

    Declaration

    Objective-C

    - (void)startThingRegistrationTask:
            (nonnull AWSIoTStartThingRegistrationTaskRequest *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSIoTStartThingRegistrationTaskResponse *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func startThingRegistrationTask(_ request: AWSIoTStartThingRegistrationTaskRequest) async throws -> AWSIoTStartThingRegistrationTaskResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorInternalFailure.

  • Cancels a bulk thing provisioning task.

    Requires permission to access the StopThingRegistrationTask action.

    See

    AWSIoTStopThingRegistrationTaskRequest

    See

    AWSIoTStopThingRegistrationTaskResponse

    Declaration

    Objective-C

    - (id)stopThingRegistrationTask:
    (nonnull AWSIoTStopThingRegistrationTaskRequest *)request;

    Swift

    func stopThingRegistrationTask(_ request: AWSIoTStopThingRegistrationTaskRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Cancels a bulk thing provisioning task.

    Requires permission to access the StopThingRegistrationTask action.

    See

    AWSIoTStopThingRegistrationTaskRequest

    See

    AWSIoTStopThingRegistrationTaskResponse

    Declaration

    Objective-C

    - (void)stopThingRegistrationTask:
            (nonnull AWSIoTStopThingRegistrationTaskRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSIoTStopThingRegistrationTaskResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func stopThingRegistrationTask(_ request: AWSIoTStopThingRegistrationTaskRequest) async throws -> AWSIoTStopThingRegistrationTaskResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

  • Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.

    Requires permission to access the TagResource action.

    See

    AWSIoTTagResourceRequest

    See

    AWSIoTTagResourceResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

  • Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.

    Requires permission to access the TagResource action.

    See

    AWSIoTTagResourceRequest

    See

    AWSIoTTagResourceResponse

    Declaration

    Objective-C

    - (void)tagResource:(nonnull AWSIoTTagResourceRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTTagResourceResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func tagResource(_ request: AWSIoTTagResourceRequest) async throws -> AWSIoTTagResourceResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorLimitExceeded.

  • Tests if a specified principal is authorized to perform an IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the IoT device gateway.

    Requires permission to access the TestAuthorization action.

    See

    AWSIoTTestAuthorizationRequest

    See

    AWSIoTTestAuthorizationResponse

    Declaration

    Objective-C

    - (id)testAuthorization:(nonnull AWSIoTTestAuthorizationRequest *)request;

    Swift

    func testAuthorization(_ request: AWSIoTTestAuthorizationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Tests if a specified principal is authorized to perform an IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the IoT device gateway.

    Requires permission to access the TestAuthorization action.

    See

    AWSIoTTestAuthorizationRequest

    See

    AWSIoTTestAuthorizationResponse

    Declaration

    Objective-C

    - (void)testAuthorization:(nonnull AWSIoTTestAuthorizationRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSIoTTestAuthorizationResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func testAuthorization(_ request: AWSIoTTestAuthorizationRequest) async throws -> AWSIoTTestAuthorizationResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorLimitExceeded.

  • Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the IoT device gateway.

    Requires permission to access the TestInvokeAuthorizer action.

    See

    AWSIoTTestInvokeAuthorizerRequest

    See

    AWSIoTTestInvokeAuthorizerResponse

    Declaration

    Objective-C

    - (id)testInvokeAuthorizer:(nonnull AWSIoTTestInvokeAuthorizerRequest *)request;

    Swift

    func testInvokeAuthorizer(_ request: AWSIoTTestInvokeAuthorizerRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the IoT device gateway.

    Requires permission to access the TestInvokeAuthorizer action.

    See

    AWSIoTTestInvokeAuthorizerRequest

    See

    AWSIoTTestInvokeAuthorizerResponse

    Declaration

    Objective-C

    - (void)testInvokeAuthorizer:
            (nonnull AWSIoTTestInvokeAuthorizerRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSIoTTestInvokeAuthorizerResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func testInvokeAuthorizer(_ request: AWSIoTTestInvokeAuthorizerRequest) async throws -> AWSIoTTestInvokeAuthorizerResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorInvalidResponse.

  • Transfers the specified certificate to the specified Amazon Web Services account.

    Requires permission to access the TransferCertificate action.

    You can cancel the transfer until it is acknowledged by the recipient.

    No notification is sent to the transfer destination’s account. It is up to the caller to notify the transfer target.

    The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate action to deactivate it.

    The certificate must not have any policies attached to it. You can use the DetachPolicy action to detach them.

    See

    AWSIoTTransferCertificateRequest

    See

    AWSIoTTransferCertificateResponse

    Declaration

    Objective-C

    - (id)transferCertificate:(nonnull AWSIoTTransferCertificateRequest *)request;

    Swift

    func transferCertificate(_ request: AWSIoTTransferCertificateRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Transfers the specified certificate to the specified Amazon Web Services account.

    Requires permission to access the TransferCertificate action.

    You can cancel the transfer until it is acknowledged by the recipient.

    No notification is sent to the transfer destination’s account. It is up to the caller to notify the transfer target.

    The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate action to deactivate it.

    The certificate must not have any policies attached to it. You can use the DetachPolicy action to detach them.

    See

    AWSIoTTransferCertificateRequest

    See

    AWSIoTTransferCertificateResponse

    Declaration

    Objective-C

    - (void)transferCertificate:(nonnull AWSIoTTransferCertificateRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSIoTTransferCertificateResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func transferCertificate(_ request: AWSIoTTransferCertificateRequest) async throws -> AWSIoTTransferCertificateResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorCertificateState, AWSIoTErrorTransferConflict, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

  • Removes the given tags (metadata) from the resource.

    Requires permission to access the UntagResource action.

    See

    AWSIoTUntagResourceRequest

    See

    AWSIoTUntagResourceResponse

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    request

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

    Return Value

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

  • Removes the given tags (metadata) from the resource.

    Requires permission to access the UntagResource action.

    See

    AWSIoTUntagResourceRequest

    See

    AWSIoTUntagResourceResponse

    Declaration

    Objective-C

    - (void)untagResource:(nonnull AWSIoTUntagResourceRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTUntagResourceResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func untagResource(_ request: AWSIoTUntagResourceRequest) async throws -> AWSIoTUntagResourceResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling.

  • Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.

    Requires permission to access the UpdateAccountAuditConfiguration action.

    See

    AWSIoTUpdateAccountAuditConfigurationRequest

    See

    AWSIoTUpdateAccountAuditConfigurationResponse

    Declaration

    Objective-C

    - (id)updateAccountAuditConfiguration:
    (nonnull AWSIoTUpdateAccountAuditConfigurationRequest *)request;

    Swift

    func updateAccountAuditConfiguration(_ request: AWSIoTUpdateAccountAuditConfigurationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.

    Requires permission to access the UpdateAccountAuditConfiguration action.

    See

    AWSIoTUpdateAccountAuditConfigurationRequest

    See

    AWSIoTUpdateAccountAuditConfigurationResponse

    Declaration

    Objective-C

    - (void)updateAccountAuditConfiguration:
            (nonnull AWSIoTUpdateAccountAuditConfigurationRequest *)request
                      completionHandler:
                          (void (^_Nullable)(
                              AWSIoTUpdateAccountAuditConfigurationResponse
                                  *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func updateAccountAuditConfiguration(_ request: AWSIoTUpdateAccountAuditConfigurationRequest) async throws -> AWSIoTUpdateAccountAuditConfigurationResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

  • Updates a Device Defender audit suppression.

    See

    AWSIoTUpdateAuditSuppressionRequest

    See

    AWSIoTUpdateAuditSuppressionResponse

    Declaration

    Objective-C

    - (id)updateAuditSuppression:
    (nonnull AWSIoTUpdateAuditSuppressionRequest *)request;

    Swift

    func updateAuditSuppression(_ request: AWSIoTUpdateAuditSuppressionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates a Device Defender audit suppression.

    See

    AWSIoTUpdateAuditSuppressionRequest

    See

    AWSIoTUpdateAuditSuppressionResponse

    Declaration

    Objective-C

    - (void)
    updateAuditSuppression:
        (nonnull AWSIoTUpdateAuditSuppressionRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSIoTUpdateAuditSuppressionResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func updateAuditSuppression(_ request: AWSIoTUpdateAuditSuppressionRequest) async throws -> AWSIoTUpdateAuditSuppressionResponse

    Parameters

    request

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

  • Updates an authorizer.

    Requires permission to access the UpdateAuthorizer action.

    See

    AWSIoTUpdateAuthorizerRequest

    See

    AWSIoTUpdateAuthorizerResponse

    Declaration

    Objective-C

    - (id)updateAuthorizer:(nonnull AWSIoTUpdateAuthorizerRequest *)request;

    Swift

    func updateAuthorizer(_ request: AWSIoTUpdateAuthorizerRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates an authorizer.

    Requires permission to access the UpdateAuthorizer action.

    See

    AWSIoTUpdateAuthorizerRequest

    See

    AWSIoTUpdateAuthorizerResponse

    Declaration

    Objective-C

    - (void)updateAuthorizer:(nonnull AWSIoTUpdateAuthorizerRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSIoTUpdateAuthorizerResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func updateAuthorizer(_ request: AWSIoTUpdateAuthorizerRequest) async throws -> AWSIoTUpdateAuthorizerResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorLimitExceeded, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

  • Updates information about the billing group.

    Requires permission to access the UpdateBillingGroup action.

    See

    AWSIoTUpdateBillingGroupRequest

    See

    AWSIoTUpdateBillingGroupResponse

    Declaration

    Objective-C

    - (id)updateBillingGroup:(nonnull AWSIoTUpdateBillingGroupRequest *)request;

    Swift

    func updateBillingGroup(_ request: AWSIoTUpdateBillingGroupRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates information about the billing group.

    Requires permission to access the UpdateBillingGroup action.

    See

    AWSIoTUpdateBillingGroupRequest

    See

    AWSIoTUpdateBillingGroupResponse

    Declaration

    Objective-C

    - (void)updateBillingGroup:(nonnull AWSIoTUpdateBillingGroupRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSIoTUpdateBillingGroupResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func updateBillingGroup(_ request: AWSIoTUpdateBillingGroupRequest) async throws -> AWSIoTUpdateBillingGroupResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorVersionConflict, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

  • Updates a registered CA certificate.

    Requires permission to access the UpdateCACertificate action.

    See

    AWSIoTUpdateCACertificateRequest

    Declaration

    Objective-C

    - (id)updateCACertificate:(nonnull AWSIoTUpdateCACertificateRequest *)request;

    Swift

    func updateCACertificate(_ request: AWSIoTUpdateCACertificateRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates a registered CA certificate.

    Requires permission to access the UpdateCACertificate action.

    See

    AWSIoTUpdateCACertificateRequest

    Declaration

    Objective-C

    - (void)updateCACertificate:(nonnull AWSIoTUpdateCACertificateRequest *)request
          completionHandler:
              (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updateCACertificate(_ request: AWSIoTUpdateCACertificateRequest) async throws

    Parameters

    request

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

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

  • Updates the status of the specified certificate. This operation is idempotent.

    Requires permission to access the UpdateCertificate action.

    Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to IoT.

    Within a few minutes of updating a certificate from the ACTIVE state to any other state, IoT disconnects all devices that used that certificate to connect. Devices cannot use a certificate that is not in the ACTIVE state to reconnect.

    See

    AWSIoTUpdateCertificateRequest

    Declaration

    Objective-C

    - (id)updateCertificate:(nonnull AWSIoTUpdateCertificateRequest *)request;

    Swift

    func updateCertificate(_ request: AWSIoTUpdateCertificateRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates the status of the specified certificate. This operation is idempotent.

    Requires permission to access the UpdateCertificate action.

    Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to IoT.

    Within a few minutes of updating a certificate from the ACTIVE state to any other state, IoT disconnects all devices that used that certificate to connect. Devices cannot use a certificate that is not in the ACTIVE state to reconnect.

    See

    AWSIoTUpdateCertificateRequest

    Declaration

    Objective-C

    - (void)updateCertificate:(nonnull AWSIoTUpdateCertificateRequest *)request
        completionHandler:
            (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updateCertificate(_ request: AWSIoTUpdateCertificateRequest) async throws

    Parameters

    request

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

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorCertificateState, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

  • Updates a certificate provider.

    Requires permission to access the UpdateCertificateProvider action.

    See

    AWSIoTUpdateCertificateProviderRequest

    See

    AWSIoTUpdateCertificateProviderResponse

    Declaration

    Objective-C

    - (id)updateCertificateProvider:
    (nonnull AWSIoTUpdateCertificateProviderRequest *)request;

    Swift

    func updateCertificateProvider(_ request: AWSIoTUpdateCertificateProviderRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates a certificate provider.

    Requires permission to access the UpdateCertificateProvider action.

    See

    AWSIoTUpdateCertificateProviderRequest

    See

    AWSIoTUpdateCertificateProviderResponse

    Declaration

    Objective-C

    - (void)updateCertificateProvider:
            (nonnull AWSIoTUpdateCertificateProviderRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSIoTUpdateCertificateProviderResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func updateCertificateProvider(_ request: AWSIoTUpdateCertificateProviderRequest) async throws -> AWSIoTUpdateCertificateProviderResponse

    Parameters

    request

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

  • Updates a Device Defender detect custom metric.

    Requires permission to access the UpdateCustomMetric action.

    See

    AWSIoTUpdateCustomMetricRequest

    See

    AWSIoTUpdateCustomMetricResponse

    Declaration

    Objective-C

    - (id)updateCustomMetric:(nonnull AWSIoTUpdateCustomMetricRequest *)request;

    Swift

    func updateCustomMetric(_ request: AWSIoTUpdateCustomMetricRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates a Device Defender detect custom metric.

    Requires permission to access the UpdateCustomMetric action.

    See

    AWSIoTUpdateCustomMetricRequest

    See

    AWSIoTUpdateCustomMetricResponse

    Declaration

    Objective-C

    - (void)updateCustomMetric:(nonnull AWSIoTUpdateCustomMetricRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSIoTUpdateCustomMetricResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func updateCustomMetric(_ request: AWSIoTUpdateCustomMetricRequest) async throws -> AWSIoTUpdateCustomMetricResponse

    Parameters

    request

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

  • Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it).

    Requires permission to access the UpdateDimension action.

    See

    AWSIoTUpdateDimensionRequest

    See

    AWSIoTUpdateDimensionResponse

    Declaration

    Objective-C

    - (id)updateDimension:(nonnull AWSIoTUpdateDimensionRequest *)request;

    Swift

    func updateDimension(_ request: AWSIoTUpdateDimensionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it).

    Requires permission to access the UpdateDimension action.

    See

    AWSIoTUpdateDimensionRequest

    See

    AWSIoTUpdateDimensionResponse

    Declaration

    Objective-C

    - (void)updateDimension:(nonnull AWSIoTUpdateDimensionRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSIoTUpdateDimensionResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func updateDimension(_ request: AWSIoTUpdateDimensionRequest) async throws -> AWSIoTUpdateDimensionResponse

    Parameters

    request

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

  • Updates values stored in the domain configuration. Domain configurations for default endpoints can’t be updated.

    Requires permission to access the UpdateDomainConfiguration action.

    See

    AWSIoTUpdateDomainConfigurationRequest

    See

    AWSIoTUpdateDomainConfigurationResponse

    Declaration

    Objective-C

    - (id)updateDomainConfiguration:
    (nonnull AWSIoTUpdateDomainConfigurationRequest *)request;

    Swift

    func updateDomainConfiguration(_ request: AWSIoTUpdateDomainConfigurationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates values stored in the domain configuration. Domain configurations for default endpoints can’t be updated.

    Requires permission to access the UpdateDomainConfiguration action.

    See

    AWSIoTUpdateDomainConfigurationRequest

    See

    AWSIoTUpdateDomainConfigurationResponse

    Declaration

    Objective-C

    - (void)updateDomainConfiguration:
            (nonnull AWSIoTUpdateDomainConfigurationRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSIoTUpdateDomainConfigurationResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func updateDomainConfiguration(_ request: AWSIoTUpdateDomainConfigurationRequest) async throws -> AWSIoTUpdateDomainConfigurationResponse

    Parameters

    request

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

  • Updates a dynamic thing group.

    Requires permission to access the UpdateDynamicThingGroup action.

    See

    AWSIoTUpdateDynamicThingGroupRequest

    See

    AWSIoTUpdateDynamicThingGroupResponse

    Declaration

    Objective-C

    - (id)updateDynamicThingGroup:
    (nonnull AWSIoTUpdateDynamicThingGroupRequest *)request;

    Swift

    func updateDynamicThingGroup(_ request: AWSIoTUpdateDynamicThingGroupRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates a dynamic thing group.

    Requires permission to access the UpdateDynamicThingGroup action.

    See

    AWSIoTUpdateDynamicThingGroupRequest

    See

    AWSIoTUpdateDynamicThingGroupResponse

    Declaration

    Objective-C

    - (void)updateDynamicThingGroup:
            (nonnull AWSIoTUpdateDynamicThingGroupRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSIoTUpdateDynamicThingGroupResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func updateDynamicThingGroup(_ request: AWSIoTUpdateDynamicThingGroupRequest) async throws -> AWSIoTUpdateDynamicThingGroupResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorVersionConflict, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidQuery.

  • Updates the event configurations.

    Requires permission to access the UpdateEventConfigurations action.

    See

    AWSIoTUpdateEventConfigurationsRequest

    See

    AWSIoTUpdateEventConfigurationsResponse

    Declaration

    Objective-C

    - (id)updateEventConfigurations:
    (nonnull AWSIoTUpdateEventConfigurationsRequest *)request;

    Swift

    func updateEventConfigurations(_ request: AWSIoTUpdateEventConfigurationsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates the event configurations.

    Requires permission to access the UpdateEventConfigurations action.

    See

    AWSIoTUpdateEventConfigurationsRequest

    See

    AWSIoTUpdateEventConfigurationsResponse

    Declaration

    Objective-C

    - (void)updateEventConfigurations:
            (nonnull AWSIoTUpdateEventConfigurationsRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSIoTUpdateEventConfigurationsResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func updateEventConfigurations(_ request: AWSIoTUpdateEventConfigurationsRequest) async throws -> AWSIoTUpdateEventConfigurationsResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorInternalFailure, AWSIoTErrorThrottling.

  • Updates the data for a fleet metric.

    Requires permission to access the UpdateFleetMetric action.

    See

    AWSIoTUpdateFleetMetricRequest

    Declaration

    Objective-C

    - (id)updateFleetMetric:(nonnull AWSIoTUpdateFleetMetricRequest *)request;

    Swift

    func updateFleetMetric(_ request: AWSIoTUpdateFleetMetricRequest) -> Any!

    Parameters

    request

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

  • Updates the data for a fleet metric.

    Requires permission to access the UpdateFleetMetric action.

    See

    AWSIoTUpdateFleetMetricRequest

    Declaration

    Objective-C

    - (void)updateFleetMetric:(nonnull AWSIoTUpdateFleetMetricRequest *)request
        completionHandler:
            (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updateFleetMetric(_ request: AWSIoTUpdateFleetMetricRequest) async throws

    Parameters

    request

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

  • Updates the search configuration.

    Requires permission to access the UpdateIndexingConfiguration action.

    See

    AWSIoTUpdateIndexingConfigurationRequest

    See

    AWSIoTUpdateIndexingConfigurationResponse

    Declaration

    Objective-C

    - (id)updateIndexingConfiguration:
    (nonnull AWSIoTUpdateIndexingConfigurationRequest *)request;

    Swift

    func updateIndexingConfiguration(_ request: AWSIoTUpdateIndexingConfigurationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates the search configuration.

    Requires permission to access the UpdateIndexingConfiguration action.

    See

    AWSIoTUpdateIndexingConfigurationRequest

    See

    AWSIoTUpdateIndexingConfigurationResponse

    Declaration

    Objective-C

    - (void)updateIndexingConfiguration:
            (nonnull AWSIoTUpdateIndexingConfigurationRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSIoTUpdateIndexingConfigurationResponse *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func updateIndexingConfiguration(_ request: AWSIoTUpdateIndexingConfigurationRequest) async throws -> AWSIoTUpdateIndexingConfigurationResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

  • Updates supported fields of the specified job.

    Requires permission to access the UpdateJob action.

    See

    AWSIoTUpdateJobRequest

    Declaration

    Objective-C

    - (id)updateJob:(nonnull AWSIoTUpdateJobRequest *)request;

    Swift

    func updateJob(_ request: AWSIoTUpdateJobRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates supported fields of the specified job.

    Requires permission to access the UpdateJob action.

    See

    AWSIoTUpdateJobRequest

    Declaration

    Objective-C

    - (void)updateJob:(nonnull AWSIoTUpdateJobRequest *)request
    completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func updateJob(_ request: AWSIoTUpdateJobRequest) async throws

    Parameters

    request

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

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorServiceUnavailable.

  • Updates the definition for the specified mitigation action.

    Requires permission to access the UpdateMitigationAction action.

    See

    AWSIoTUpdateMitigationActionRequest

    See

    AWSIoTUpdateMitigationActionResponse

    Declaration

    Objective-C

    - (id)updateMitigationAction:
    (nonnull AWSIoTUpdateMitigationActionRequest *)request;

    Swift

    func updateMitigationAction(_ request: AWSIoTUpdateMitigationActionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates the definition for the specified mitigation action.

    Requires permission to access the UpdateMitigationAction action.

    See

    AWSIoTUpdateMitigationActionRequest

    See

    AWSIoTUpdateMitigationActionResponse

    Declaration

    Objective-C

    - (void)
    updateMitigationAction:
        (nonnull AWSIoTUpdateMitigationActionRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSIoTUpdateMitigationActionResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func updateMitigationAction(_ request: AWSIoTUpdateMitigationActionRequest) async throws -> AWSIoTUpdateMitigationActionResponse

    Parameters

    request

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

  • Updates the supported fields for a specific software package.

    Requires permission to access the UpdatePackage and GetIndexingConfiguration actions.

    See

    AWSIoTUpdatePackageRequest

    See

    AWSIoTUpdatePackageResponse

    Declaration

    Objective-C

    - (id)updatePackage:(nonnull AWSIoTUpdatePackageRequest *)request;

    Swift

    func updatePackage(_ request: AWSIoTUpdatePackageRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates the supported fields for a specific software package.

    Requires permission to access the UpdatePackage and GetIndexingConfiguration actions.

    See

    AWSIoTUpdatePackageRequest

    See

    AWSIoTUpdatePackageResponse

    Declaration

    Objective-C

    - (void)updatePackage:(nonnull AWSIoTUpdatePackageRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTUpdatePackageResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func updatePackage(_ request: AWSIoTUpdatePackageRequest) async throws -> AWSIoTUpdatePackageResponse

    Parameters

    request

    A container for the necessary parameters to execute the UpdatePackage 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, AWSIoTErrorConflict, AWSIoTErrorInternalServer, AWSIoTErrorValidation, AWSIoTErrorResourceNotFound.

  • Updates the software package configuration.

    Requires permission to access the UpdatePackageConfiguration and iam:PassRole actions.

    See

    AWSIoTUpdatePackageConfigurationRequest

    See

    AWSIoTUpdatePackageConfigurationResponse

    Declaration

    Objective-C

    - (id)updatePackageConfiguration:
    (nonnull AWSIoTUpdatePackageConfigurationRequest *)request;

    Swift

    func updatePackageConfiguration(_ request: AWSIoTUpdatePackageConfigurationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates the software package configuration.

    Requires permission to access the UpdatePackageConfiguration and iam:PassRole actions.

    See

    AWSIoTUpdatePackageConfigurationRequest

    See

    AWSIoTUpdatePackageConfigurationResponse

    Declaration

    Objective-C

    - (void)updatePackageConfiguration:
            (nonnull AWSIoTUpdatePackageConfigurationRequest *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSIoTUpdatePackageConfigurationResponse *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func updatePackageConfiguration(_ request: AWSIoTUpdatePackageConfigurationRequest) async throws -> AWSIoTUpdatePackageConfigurationResponse

    Parameters

    request

    A container for the necessary parameters to execute the UpdatePackageConfiguration 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, AWSIoTErrorConflict, AWSIoTErrorInternalServer, AWSIoTErrorValidation.

  • Updates the supported fields for a specific package version.

    Requires permission to access the UpdatePackageVersion and GetIndexingConfiguration actions.

    See

    AWSIoTUpdatePackageVersionRequest

    See

    AWSIoTUpdatePackageVersionResponse

    Declaration

    Objective-C

    - (id)updatePackageVersion:(nonnull AWSIoTUpdatePackageVersionRequest *)request;

    Swift

    func updatePackageVersion(_ request: AWSIoTUpdatePackageVersionRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates the supported fields for a specific package version.

    Requires permission to access the UpdatePackageVersion and GetIndexingConfiguration actions.

    See

    AWSIoTUpdatePackageVersionRequest

    See

    AWSIoTUpdatePackageVersionResponse

    Declaration

    Objective-C

    - (void)updatePackageVersion:
            (nonnull AWSIoTUpdatePackageVersionRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSIoTUpdatePackageVersionResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func updatePackageVersion(_ request: AWSIoTUpdatePackageVersionRequest) async throws -> AWSIoTUpdatePackageVersionResponse

    Parameters

    request

    A container for the necessary parameters to execute the UpdatePackageVersion 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, AWSIoTErrorConflict, AWSIoTErrorInternalServer, AWSIoTErrorValidation, AWSIoTErrorResourceNotFound.

  • Updates a provisioning template.

    Requires permission to access the UpdateProvisioningTemplate action.

    See

    AWSIoTUpdateProvisioningTemplateRequest

    See

    AWSIoTUpdateProvisioningTemplateResponse

    Declaration

    Objective-C

    - (id)updateProvisioningTemplate:
    (nonnull AWSIoTUpdateProvisioningTemplateRequest *)request;

    Swift

    func updateProvisioningTemplate(_ request: AWSIoTUpdateProvisioningTemplateRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates a provisioning template.

    Requires permission to access the UpdateProvisioningTemplate action.

    See

    AWSIoTUpdateProvisioningTemplateRequest

    See

    AWSIoTUpdateProvisioningTemplateResponse

    Declaration

    Objective-C

    - (void)updateProvisioningTemplate:
            (nonnull AWSIoTUpdateProvisioningTemplateRequest *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSIoTUpdateProvisioningTemplateResponse *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func updateProvisioningTemplate(_ request: AWSIoTUpdateProvisioningTemplateRequest) async throws -> AWSIoTUpdateProvisioningTemplateResponse

    Parameters

    request

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

  • Updates a role alias.

    Requires permission to access the UpdateRoleAlias action.

    See

    AWSIoTUpdateRoleAliasRequest

    See

    AWSIoTUpdateRoleAliasResponse

    Declaration

    Objective-C

    - (id)updateRoleAlias:(nonnull AWSIoTUpdateRoleAliasRequest *)request;

    Swift

    func updateRoleAlias(_ request: AWSIoTUpdateRoleAliasRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates a role alias.

    Requires permission to access the UpdateRoleAlias action.

    See

    AWSIoTUpdateRoleAliasRequest

    See

    AWSIoTUpdateRoleAliasResponse

    Declaration

    Objective-C

    - (void)updateRoleAlias:(nonnull AWSIoTUpdateRoleAliasRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSIoTUpdateRoleAliasResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func updateRoleAlias(_ request: AWSIoTUpdateRoleAliasRequest) async throws -> AWSIoTUpdateRoleAliasResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorResourceNotFound, AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

  • Updates a scheduled audit, including which checks are performed and how often the audit takes place.

    Requires permission to access the UpdateScheduledAudit action.

    See

    AWSIoTUpdateScheduledAuditRequest

    See

    AWSIoTUpdateScheduledAuditResponse

    Declaration

    Objective-C

    - (id)updateScheduledAudit:(nonnull AWSIoTUpdateScheduledAuditRequest *)request;

    Swift

    func updateScheduledAudit(_ request: AWSIoTUpdateScheduledAuditRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates a scheduled audit, including which checks are performed and how often the audit takes place.

    Requires permission to access the UpdateScheduledAudit action.

    See

    AWSIoTUpdateScheduledAuditRequest

    See

    AWSIoTUpdateScheduledAuditResponse

    Declaration

    Objective-C

    - (void)updateScheduledAudit:
            (nonnull AWSIoTUpdateScheduledAuditRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSIoTUpdateScheduledAuditResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func updateScheduledAudit(_ request: AWSIoTUpdateScheduledAuditRequest) async throws -> AWSIoTUpdateScheduledAuditResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

  • Updates a Device Defender security profile.

    Requires permission to access the UpdateSecurityProfile action.

    See

    AWSIoTUpdateSecurityProfileRequest

    See

    AWSIoTUpdateSecurityProfileResponse

    Declaration

    Objective-C

    - (id)updateSecurityProfile:
    (nonnull AWSIoTUpdateSecurityProfileRequest *)request;

    Swift

    func updateSecurityProfile(_ request: AWSIoTUpdateSecurityProfileRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates a Device Defender security profile.

    Requires permission to access the UpdateSecurityProfile action.

    See

    AWSIoTUpdateSecurityProfileRequest

    See

    AWSIoTUpdateSecurityProfileResponse

    Declaration

    Objective-C

    - (void)
    updateSecurityProfile:(nonnull AWSIoTUpdateSecurityProfileRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSIoTUpdateSecurityProfileResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func updateSecurityProfile(_ request: AWSIoTUpdateSecurityProfileRequest) async throws -> AWSIoTUpdateSecurityProfileResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorVersionConflict, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.

  • Updates an existing stream. The stream version will be incremented by one.

    Requires permission to access the UpdateStream action.

    See

    AWSIoTUpdateStreamRequest

    See

    AWSIoTUpdateStreamResponse

    Declaration

    Objective-C

    - (id)updateStream:(nonnull AWSIoTUpdateStreamRequest *)request;

    Swift

    func updateStream(_ request: AWSIoTUpdateStreamRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates an existing stream. The stream version will be incremented by one.

    Requires permission to access the UpdateStream action.

    See

    AWSIoTUpdateStreamRequest

    See

    AWSIoTUpdateStreamResponse

    Declaration

    Objective-C

    - (void)updateStream:(nonnull AWSIoTUpdateStreamRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTUpdateStreamResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func updateStream(_ request: AWSIoTUpdateStreamRequest) async throws -> AWSIoTUpdateStreamResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorResourceNotFound, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure.

  • Updates the data for a thing.

    Requires permission to access the UpdateThing action.

    See

    AWSIoTUpdateThingRequest

    See

    AWSIoTUpdateThingResponse

    Declaration

    Objective-C

    - (id)updateThing:(nonnull AWSIoTUpdateThingRequest *)request;

    Swift

    func updateThing(_ request: AWSIoTUpdateThingRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates the data for a thing.

    Requires permission to access the UpdateThing action.

    See

    AWSIoTUpdateThingRequest

    See

    AWSIoTUpdateThingResponse

    Declaration

    Objective-C

    - (void)updateThing:(nonnull AWSIoTUpdateThingRequest *)request
    completionHandler:(void (^_Nullable)(AWSIoTUpdateThingResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func updateThing(_ request: AWSIoTUpdateThingRequest) async throws -> AWSIoTUpdateThingResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorVersionConflict, AWSIoTErrorThrottling, AWSIoTErrorUnauthorized, AWSIoTErrorServiceUnavailable, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

  • Update a thing group.

    Requires permission to access the UpdateThingGroup action.

    See

    AWSIoTUpdateThingGroupRequest

    See

    AWSIoTUpdateThingGroupResponse

    Declaration

    Objective-C

    - (id)updateThingGroup:(nonnull AWSIoTUpdateThingGroupRequest *)request;

    Swift

    func updateThingGroup(_ request: AWSIoTUpdateThingGroupRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Update a thing group.

    Requires permission to access the UpdateThingGroup action.

    See

    AWSIoTUpdateThingGroupRequest

    See

    AWSIoTUpdateThingGroupResponse

    Declaration

    Objective-C

    - (void)updateThingGroup:(nonnull AWSIoTUpdateThingGroupRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSIoTUpdateThingGroupResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func updateThingGroup(_ request: AWSIoTUpdateThingGroupRequest) async throws -> AWSIoTUpdateThingGroupResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorVersionConflict, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

  • Updates the groups to which the thing belongs.

    Requires permission to access the UpdateThingGroupsForThing action.

    See

    AWSIoTUpdateThingGroupsForThingRequest

    See

    AWSIoTUpdateThingGroupsForThingResponse

    Declaration

    Objective-C

    - (id)updateThingGroupsForThing:
    (nonnull AWSIoTUpdateThingGroupsForThingRequest *)request;

    Swift

    func updateThingGroups(forThing request: AWSIoTUpdateThingGroupsForThingRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates the groups to which the thing belongs.

    Requires permission to access the UpdateThingGroupsForThing action.

    See

    AWSIoTUpdateThingGroupsForThingRequest

    See

    AWSIoTUpdateThingGroupsForThingResponse

    Declaration

    Objective-C

    - (void)updateThingGroupsForThing:
            (nonnull AWSIoTUpdateThingGroupsForThingRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSIoTUpdateThingGroupsForThingResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func updateThingGroups(forThing request: AWSIoTUpdateThingGroupsForThingRequest) async throws -> AWSIoTUpdateThingGroupsForThingResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure, AWSIoTErrorResourceNotFound.

  • Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination.

    Requires permission to access the UpdateTopicRuleDestination action.

    See

    AWSIoTUpdateTopicRuleDestinationRequest

    See

    AWSIoTUpdateTopicRuleDestinationResponse

    Declaration

    Objective-C

    - (id)updateTopicRuleDestination:
    (nonnull AWSIoTUpdateTopicRuleDestinationRequest *)request;

    Swift

    func updateTopicRuleDestination(_ request: AWSIoTUpdateTopicRuleDestinationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination.

    Requires permission to access the UpdateTopicRuleDestination action.

    See

    AWSIoTUpdateTopicRuleDestinationRequest

    See

    AWSIoTUpdateTopicRuleDestinationResponse

    Declaration

    Objective-C

    - (void)updateTopicRuleDestination:
            (nonnull AWSIoTUpdateTopicRuleDestinationRequest *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSIoTUpdateTopicRuleDestinationResponse *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func updateTopicRuleDestination(_ request: AWSIoTUpdateTopicRuleDestinationRequest) async throws -> AWSIoTUpdateTopicRuleDestinationResponse

    Parameters

    request

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

  • Validates a Device Defender security profile behaviors specification.

    Requires permission to access the ValidateSecurityProfileBehaviors action.

    See

    AWSIoTValidateSecurityProfileBehaviorsRequest

    See

    AWSIoTValidateSecurityProfileBehaviorsResponse

    Declaration

    Objective-C

    - (id)validateSecurityProfileBehaviors:
    (nonnull AWSIoTValidateSecurityProfileBehaviorsRequest *)request;

    Swift

    func validateSecurityProfileBehaviors(_ request: AWSIoTValidateSecurityProfileBehaviorsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Validates a Device Defender security profile behaviors specification.

    Requires permission to access the ValidateSecurityProfileBehaviors action.

    See

    AWSIoTValidateSecurityProfileBehaviorsRequest

    See

    AWSIoTValidateSecurityProfileBehaviorsResponse

    Declaration

    Objective-C

    - (void)validateSecurityProfileBehaviors:
            (nonnull AWSIoTValidateSecurityProfileBehaviorsRequest *)request
                       completionHandler:
                           (void (^_Nullable)(
                               AWSIoTValidateSecurityProfileBehaviorsResponse
                                   *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func validateSecurityProfileBehaviors(_ request: AWSIoTValidateSecurityProfileBehaviorsRequest) async throws -> AWSIoTValidateSecurityProfileBehaviorsResponse

    Parameters

    request

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

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSIoTErrorDomain domain and the following error code: AWSIoTErrorInvalidRequest, AWSIoTErrorThrottling, AWSIoTErrorInternalFailure.