AWSIoT
Objective-C
@interface AWSIoT
Swift
class AWSIoT
AWS IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.
The service endpoints that expose this API are listed in AWS 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 AWS Signature Version 4 to sign the request is: execute-api.
For more information about how AWS IoT works, see the Developer Guide.
For information about how to use the credentials provider for AWS IoT, see Authorizing Direct Calls to AWS Services.
-
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
Swift
var configuration: UnsafeMutablePointer<Int32> { get }
-
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.
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 benil
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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.
See
AWSIoTAcceptCertificateTransferRequest
Declaration
Objective-C
- (void)acceptCertificateTransfer: (nonnull AWSIoTAcceptCertificateTransferRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func acceptCertificateTransfer(_ request: AWSIoTAcceptCertificateTransferRequest, completionHandler: ((Error?) -> Void)? = nil)
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, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceNotFound
,AWSIoTErrorTransferAlreadyCompleted
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Adds a thing to a billing group.
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 ofAWSIoTAddThingToBillingGroupResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
,AWSIoTErrorResourceNotFound
. -
Adds a thing to a billing group.
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, completionHandler: ((AWSIoTAddThingToBillingGroupResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
,AWSIoTErrorResourceNotFound
. -
Adds a thing to a thing group.
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 ofAWSIoTAddThingToThingGroupResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
,AWSIoTErrorResourceNotFound
. -
Adds a thing to a thing group.
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, completionHandler: ((AWSIoTAddThingToThingGroupResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
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.
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 ofAWSIoTAssociateTargetsWithJobResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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.
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, completionHandler: ((AWSIoTAssociateTargetsWithJobResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceNotFound
,AWSIoTErrorLimitExceeded
,AWSIoTErrorThrottling
,AWSIoTErrorServiceUnavailable
. -
Attaches a policy to the specified target.
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 benil
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceNotFound
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
,AWSIoTErrorLimitExceeded
. -
Attaches a policy to the specified target.
See
AWSIoTAttachPolicyRequest
Declaration
Objective-C
- (void)attachPolicy:(nonnull AWSIoTAttachPolicyRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func attachPolicy(_ request: AWSIoTAttachPolicyRequest, completionHandler: ((Error?) -> Void)? = nil)
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, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
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 API is deprecated. Please use AttachPolicy instead.
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 benil
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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 API is deprecated. Please use AttachPolicy instead.
See
AWSIoTAttachPrincipalPolicyRequest
Declaration
Objective-C
- (void)attachPrincipalPolicy: (nonnull AWSIoTAttachPrincipalPolicyRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func attachPrincipalPolicy(_ request: AWSIoTAttachPrincipalPolicyRequest, completionHandler: ((Error?) -> Void)? = nil)
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, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
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.
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 ofAWSIoTAttachSecurityProfileResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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.
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, completionHandler: ((AWSIoTAttachSecurityProfileResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceNotFound
,AWSIoTErrorLimitExceeded
,AWSIoTErrorVersionConflict
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
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 ofAWSIoTAttachThingPrincipalResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceNotFound
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
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, completionHandler: ((AWSIoTAttachThingPrincipalResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
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.
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 ofAWSIoTCancelAuditMitigationActionsTaskResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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.
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, completionHandler: ((AWSIoTCancelAuditMitigationActionsTaskResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
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.
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 ofAWSIoTCancelAuditTaskResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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.
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, completionHandler: ((AWSIoTCancelAuditTaskResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
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, AWS IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.
After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.
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 benil
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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, AWS IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.
After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.
See
AWSIoTCancelCertificateTransferRequest
Declaration
Objective-C
- (void)cancelCertificateTransfer: (nonnull AWSIoTCancelCertificateTransferRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func cancelCertificateTransfer(_ request: AWSIoTCancelCertificateTransferRequest, completionHandler: ((Error?) -> Void)? = nil)
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, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceNotFound
,AWSIoTErrorTransferAlreadyCompleted
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Cancels a Device Defender ML Detect mitigation 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 ofAWSIoTCancelDetectMitigationActionsTaskResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceNotFound
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Cancels a Device Defender ML Detect mitigation 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, completionHandler: ((AWSIoTCancelDetectMitigationActionsTaskResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceNotFound
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Cancels a job.
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 ofAWSIoTCancelJobResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorServiceUnavailable
. -
Cancels a job.
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, completionHandler: ((AWSIoTCancelJobResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorServiceUnavailable
. -
Cancels the execution of a job for a given thing.
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 benil
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorInvalidStateTransition
,AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorVersionConflict
. -
Cancels the execution of a job for a given thing.
See
AWSIoTCancelJobExecutionRequest
Declaration
Objective-C
- (void)cancelJobExecution:(nonnull AWSIoTCancelJobExecutionRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func cancelJobExecution(_ request: AWSIoTCancelJobExecutionRequest, completionHandler: ((Error?) -> Void)? = nil)
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, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorInvalidStateTransition
,AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorVersionConflict
. -
Clears the default authorizer.
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 ofAWSIoTClearDefaultAuthorizerResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceNotFound
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Clears the default authorizer.
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, completionHandler: ((AWSIoTClearDefaultAuthorizerResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
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, AWS 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.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 ofAWSIoTConfirmTopicRuleDestinationResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInternal
,AWSIoTErrorInvalidRequest
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorUnauthorized
,AWSIoTErrorConflictingResourceUpdate
. -
Confirms a topic rule destination. When you create a rule requiring a destination, AWS 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.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, completionHandler: ((AWSIoTConfirmTopicRuleDestinationResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInternal
,AWSIoTErrorInvalidRequest
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorUnauthorized
,AWSIoTErrorConflictingResourceUpdate
. -
Creates a Device Defender audit suppression.
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 ofAWSIoTCreateAuditSuppressionResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceAlreadyExists
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
,AWSIoTErrorLimitExceeded
. -
Creates a Device Defender audit suppression.
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, completionHandler: ((AWSIoTCreateAuditSuppressionResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceAlreadyExists
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
,AWSIoTErrorLimitExceeded
. -
Creates an authorizer.
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 ofAWSIoTCreateAuthorizerResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceAlreadyExists
,AWSIoTErrorInvalidRequest
,AWSIoTErrorLimitExceeded
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Creates an authorizer.
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, completionHandler: ((AWSIoTCreateAuthorizerResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceAlreadyExists
,AWSIoTErrorInvalidRequest
,AWSIoTErrorLimitExceeded
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Creates a billing group.
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 ofAWSIoTCreateBillingGroupResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceAlreadyExists
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Creates a billing group.
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, completionHandler: ((AWSIoTCreateBillingGroupResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceAlreadyExists
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Creates an X.509 certificate using the specified certificate signing request.
Note: The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves.
Note: Reusing the same certificate signing request (CSR) results in a distinct certificate.
You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs.
Assuming a set of CSRs are located inside of the directory my-csr-directory:
On Linux and OS X, the command is:
$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr –certificate-signing-request file://my-csr-directory/{}
This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR.
The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process:
$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr –certificate-signing-request file://my-csr-directory/{}
On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:
> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr –certificate-signing-request file://my-csr-directory/$_}
On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:
> forfiles /p my-csr-directory /c “cmd /c aws iot create-certificate-from-csr –certificate-signing-request file://@path”
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 ofAWSIoTCreateCertificateFromCsrResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Creates an X.509 certificate using the specified certificate signing request.
Note: The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves.
Note: Reusing the same certificate signing request (CSR) results in a distinct certificate.
You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs.
Assuming a set of CSRs are located inside of the directory my-csr-directory:
On Linux and OS X, the command is:
$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr –certificate-signing-request file://my-csr-directory/{}
This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR.
The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process:
$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr –certificate-signing-request file://my-csr-directory/{}
On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:
> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr –certificate-signing-request file://my-csr-directory/$_}
On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:
> forfiles /p my-csr-directory /c “cmd /c aws iot create-certificate-from-csr –certificate-signing-request file://@path”
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, completionHandler: ((AWSIoTCreateCertificateFromCsrResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Use this API to define a Custom Metric published by your devices to Device Defender.
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 ofAWSIoTCreateCustomMetricResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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.
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, completionHandler: ((AWSIoTCreateCustomMetricResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
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 AWS 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.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 ofAWSIoTCreateDimensionResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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 AWS 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.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, completionHandler: ((AWSIoTCreateDimensionResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInternalFailure
,AWSIoTErrorInvalidRequest
,AWSIoTErrorLimitExceeded
,AWSIoTErrorResourceAlreadyExists
,AWSIoTErrorThrottling
. -
Creates a domain configuration.
The domain configuration feature is in public preview and is subject to change.
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 ofAWSIoTCreateDomainConfigurationResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorLimitExceeded
,AWSIoTErrorCertificateValidation
,AWSIoTErrorResourceAlreadyExists
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
,AWSIoTErrorInvalidRequest
,AWSIoTErrorUnauthorized
,AWSIoTErrorThrottling
. -
Creates a domain configuration.
The domain configuration feature is in public preview and is subject to change.
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, completionHandler: ((AWSIoTCreateDomainConfigurationResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorLimitExceeded
,AWSIoTErrorCertificateValidation
,AWSIoTErrorResourceAlreadyExists
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
,AWSIoTErrorInvalidRequest
,AWSIoTErrorUnauthorized
,AWSIoTErrorThrottling
. -
Creates a dynamic thing group.
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 ofAWSIoTCreateDynamicThingGroupResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceAlreadyExists
,AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
,AWSIoTErrorInvalidQuery
,AWSIoTErrorLimitExceeded
. -
Creates a dynamic thing group.
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, completionHandler: ((AWSIoTCreateDynamicThingGroupResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceAlreadyExists
,AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
,AWSIoTErrorInvalidQuery
,AWSIoTErrorLimitExceeded
. -
Creates a job.
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 ofAWSIoTCreateJobResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceNotFound
,AWSIoTErrorResourceAlreadyExists
,AWSIoTErrorLimitExceeded
,AWSIoTErrorThrottling
,AWSIoTErrorServiceUnavailable
. -
Creates a job.
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, completionHandler: ((AWSIoTCreateJobResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceNotFound
,AWSIoTErrorResourceAlreadyExists
,AWSIoTErrorLimitExceeded
,AWSIoTErrorThrottling
,AWSIoTErrorServiceUnavailable
. -
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 AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.
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 ofAWSIoTCreateKeysAndCertificateResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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 AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.
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, completionHandler: ((AWSIoTCreateKeysAndCertificateResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
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.
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 ofAWSIoTCreateMitigationActionResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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.
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, completionHandler: ((AWSIoTCreateMitigationActionResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceAlreadyExists
,AWSIoTErrorLimitExceeded
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Creates an AWS IoT OTAUpdate on a target group of things or groups.
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 ofAWSIoTCreateOTAUpdateResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorLimitExceeded
,AWSIoTErrorResourceNotFound
,AWSIoTErrorResourceAlreadyExists
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorInternalFailure
,AWSIoTErrorServiceUnavailable
. -
Creates an AWS IoT OTAUpdate on a target group of things or groups.
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, completionHandler: ((AWSIoTCreateOTAUpdateResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorLimitExceeded
,AWSIoTErrorResourceNotFound
,AWSIoTErrorResourceAlreadyExists
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorInternalFailure
,AWSIoTErrorServiceUnavailable
. -
Creates an AWS IoT policy.
The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy’s default version.
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 ofAWSIoTCreatePolicyResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceAlreadyExists
,AWSIoTErrorMalformedPolicy
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Creates an AWS IoT policy.
The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy’s default version.
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, completionHandler: ((AWSIoTCreatePolicyResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceAlreadyExists
,AWSIoTErrorMalformedPolicy
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.
Optionally, you can set the new version as the policy’s default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).
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 ofAWSIoTCreatePolicyVersionResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceNotFound
,AWSIoTErrorMalformedPolicy
,AWSIoTErrorVersionsLimitExceeded
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.
Optionally, you can set the new version as the policy’s default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).
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, completionHandler: ((AWSIoTCreatePolicyVersionResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceNotFound
,AWSIoTErrorMalformedPolicy
,AWSIoTErrorVersionsLimitExceeded
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Creates a provisioning claim.
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 ofAWSIoTCreateProvisioningClaimResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Creates a provisioning claim.
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, completionHandler: ((AWSIoTCreateProvisioningClaimResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Creates a fleet provisioning template.
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 ofAWSIoTCreateProvisioningTemplateResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInternalFailure
,AWSIoTErrorInvalidRequest
,AWSIoTErrorLimitExceeded
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorResourceAlreadyExists
. -
Creates a fleet provisioning template.
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, completionHandler: ((AWSIoTCreateProvisioningTemplateResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInternalFailure
,AWSIoTErrorInvalidRequest
,AWSIoTErrorLimitExceeded
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorResourceAlreadyExists
. -
Creates a new version of a fleet provisioning template.
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 ofAWSIoTCreateProvisioningTemplateVersionResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorVersionsLimitExceeded
,AWSIoTErrorInternalFailure
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorResourceNotFound
,AWSIoTErrorUnauthorized
,AWSIoTErrorConflictingResourceUpdate
. -
Creates a new version of a fleet provisioning template.
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, completionHandler: ((AWSIoTCreateProvisioningTemplateVersionResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorVersionsLimitExceeded
,AWSIoTErrorInternalFailure
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorResourceNotFound
,AWSIoTErrorUnauthorized
,AWSIoTErrorConflictingResourceUpdate
. -
Creates a role alias.
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 ofAWSIoTCreateRoleAliasResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceAlreadyExists
,AWSIoTErrorInvalidRequest
,AWSIoTErrorLimitExceeded
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Creates a role alias.
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, completionHandler: ((AWSIoTCreateRoleAliasResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
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.
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 ofAWSIoTCreateScheduledAuditResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceAlreadyExists
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
,AWSIoTErrorLimitExceeded
. -
Creates a scheduled audit that is run at a specified time interval.
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, completionHandler: ((AWSIoTCreateScheduledAuditResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceAlreadyExists
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
,AWSIoTErrorLimitExceeded
. -
Creates a Device Defender security profile.
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 ofAWSIoTCreateSecurityProfileResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceAlreadyExists
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Creates a Device Defender security profile.
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, completionHandler: ((AWSIoTCreateSecurityProfileResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
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.
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 ofAWSIoTCreateStreamResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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.
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, completionHandler: ((AWSIoTCreateStreamResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
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.
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 ofAWSIoTCreateThingResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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.
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, completionHandler: ((AWSIoTCreateThingResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
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.
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 ofAWSIoTCreateThingGroupResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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.
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, completionHandler: ((AWSIoTCreateThingGroupResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceAlreadyExists
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Creates a new thing type.
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 ofAWSIoTCreateThingTypeResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
,AWSIoTErrorResourceAlreadyExists
. -
Creates a new thing type.
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, completionHandler: ((AWSIoTCreateThingTypeResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
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.
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 benil
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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.
See
AWSIoTCreateTopicRuleRequest
Declaration
Objective-C
- (void)createTopicRule:(nonnull AWSIoTCreateTopicRuleRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func createTopicRule(_ request: AWSIoTCreateTopicRuleRequest, completionHandler: ((Error?) -> Void)? = nil)
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, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
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.
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 ofAWSIoTCreateTopicRuleDestinationResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInternal
,AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceAlreadyExists
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorConflictingResourceUpdate
. -
Creates a topic rule destination. The destination must be confirmed prior to use.
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, completionHandler: ((AWSIoTCreateTopicRuleDestinationResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
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.
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 ofAWSIoTDeleteAccountAuditConfigurationResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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.
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, completionHandler: ((AWSIoTDeleteAccountAuditConfigurationResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Deletes a Device Defender audit suppression.
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 ofAWSIoTDeleteAuditSuppressionResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Deletes a Device Defender audit suppression.
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, completionHandler: ((AWSIoTDeleteAuditSuppressionResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Deletes an authorizer.
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 ofAWSIoTDeleteAuthorizerResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorDeleteConflict
,AWSIoTErrorResourceNotFound
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Deletes an authorizer.
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, completionHandler: ((AWSIoTDeleteAuthorizerResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorDeleteConflict
,AWSIoTErrorResourceNotFound
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Deletes the billing group.
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 ofAWSIoTDeleteBillingGroupResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorVersionConflict
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Deletes the billing group.
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, completionHandler: ((AWSIoTDeleteBillingGroupResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorVersionConflict
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Deletes a registered CA certificate.
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 ofAWSIoTDeleteCACertificateResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorCertificateState
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
,AWSIoTErrorResourceNotFound
. -
Deletes a registered CA certificate.
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, completionHandler: ((AWSIoTDeleteCACertificateResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
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 DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.
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 benil
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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 DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.
See
AWSIoTDeleteCertificateRequest
Declaration
Objective-C
- (void)deleteCertificate:(nonnull AWSIoTDeleteCertificateRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteCertificate(_ request: AWSIoTDeleteCertificateRequest, completionHandler: ((Error?) -> Void)? = nil)
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, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorCertificateState
,AWSIoTErrorDeleteConflict
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
,AWSIoTErrorResourceNotFound
. -
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.Deletes a Device Defender detect custom metric.
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 ofAWSIoTDeleteCustomMetricResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
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.Deletes a Device Defender detect custom metric.
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, completionHandler: ((AWSIoTDeleteCustomMetricResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Removes the specified dimension from your AWS account.
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 ofAWSIoTDeleteDimensionResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInternalFailure
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
. -
Removes the specified dimension from your AWS account.
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, completionHandler: ((AWSIoTDeleteDimensionResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInternalFailure
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
. -
Deletes the specified domain configuration.
The domain configuration feature is in public preview and is subject to change.
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 ofAWSIoTDeleteDomainConfigurationResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
,AWSIoTErrorInvalidRequest
. -
Deletes the specified domain configuration.
The domain configuration feature is in public preview and is subject to change.
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, completionHandler: ((AWSIoTDeleteDomainConfigurationResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
,AWSIoTErrorInvalidRequest
. -
Deletes a dynamic thing group.
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 ofAWSIoTDeleteDynamicThingGroupResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorVersionConflict
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Deletes a dynamic thing group.
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, completionHandler: ((AWSIoTDeleteDynamicThingGroupResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorVersionConflict
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
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.
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 benil
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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.
See
AWSIoTDeleteJobRequest
Declaration
Objective-C
- (void)deleteJob:(nonnull AWSIoTDeleteJobRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteJob(_ request: AWSIoTDeleteJobRequest, completionHandler: ((Error?) -> Void)? = nil)
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, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorInvalidStateTransition
,AWSIoTErrorResourceNotFound
,AWSIoTErrorLimitExceeded
,AWSIoTErrorThrottling
,AWSIoTErrorServiceUnavailable
. -
Deletes a job execution.
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 benil
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorInvalidStateTransition
,AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorServiceUnavailable
. -
Deletes a job execution.
See
AWSIoTDeleteJobExecutionRequest
Declaration
Objective-C
- (void)deleteJobExecution:(nonnull AWSIoTDeleteJobExecutionRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteJobExecution(_ request: AWSIoTDeleteJobExecutionRequest, completionHandler: ((Error?) -> Void)? = nil)
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, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorInvalidStateTransition
,AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorServiceUnavailable
. -
Deletes a defined mitigation action from your AWS account.
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 ofAWSIoTDeleteMitigationActionResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Deletes a defined mitigation action from your AWS account.
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, completionHandler: ((AWSIoTDeleteMitigationActionResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Delete an OTA update.
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 ofAWSIoTDeleteOTAUpdateResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorInternalFailure
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorVersionConflict
. -
Delete an OTA update.
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, completionHandler: ((AWSIoTDeleteOTAUpdateResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorInternalFailure
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorVersionConflict
. -
Deletes the specified policy.
A policy cannot be deleted if it has non-default versions or it is attached to any certificate.
To delete a policy, use the DeletePolicyVersion API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy.
When a policy is deleted using DeletePolicy, its default version is deleted with it.
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 benil
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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 API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy.
When a policy is deleted using DeletePolicy, its default version is deleted with it.
See
AWSIoTDeletePolicyRequest
Declaration
Objective-C
- (void)deletePolicy:(nonnull AWSIoTDeletePolicyRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deletePolicy(_ request: AWSIoTDeletePolicyRequest, completionHandler: ((Error?) -> Void)? = nil)
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, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
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 API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.
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 benil
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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 API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.
See
AWSIoTDeletePolicyVersionRequest
Declaration
Objective-C
- (void)deletePolicyVersion:(nonnull AWSIoTDeletePolicyVersionRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deletePolicyVersion(_ request: AWSIoTDeletePolicyVersionRequest, completionHandler: ((Error?) -> Void)? = nil)
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, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorDeleteConflict
,AWSIoTErrorResourceNotFound
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Deletes a fleet provisioning template.
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 ofAWSIoTDeleteProvisioningTemplateResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInternalFailure
,AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceNotFound
,AWSIoTErrorDeleteConflict
,AWSIoTErrorThrottling
,AWSIoTErrorConflictingResourceUpdate
,AWSIoTErrorUnauthorized
. -
Deletes a fleet provisioning template.
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, completionHandler: ((AWSIoTDeleteProvisioningTemplateResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInternalFailure
,AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceNotFound
,AWSIoTErrorDeleteConflict
,AWSIoTErrorThrottling
,AWSIoTErrorConflictingResourceUpdate
,AWSIoTErrorUnauthorized
. -
Deletes a fleet provisioning template version.
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 ofAWSIoTDeleteProvisioningTemplateVersionResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInternalFailure
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorResourceNotFound
,AWSIoTErrorUnauthorized
,AWSIoTErrorConflictingResourceUpdate
,AWSIoTErrorDeleteConflict
. -
Deletes a fleet provisioning template version.
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, completionHandler: ((AWSIoTDeleteProvisioningTemplateVersionResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInternalFailure
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorResourceNotFound
,AWSIoTErrorUnauthorized
,AWSIoTErrorConflictingResourceUpdate
,AWSIoTErrorDeleteConflict
. -
Deletes a CA certificate registration code.
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 ofAWSIoTDeleteRegistrationCodeResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorThrottling
,AWSIoTErrorResourceNotFound
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Deletes a CA certificate registration code.
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, completionHandler: ((AWSIoTDeleteRegistrationCodeResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorThrottling
,AWSIoTErrorResourceNotFound
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Deletes a role alias
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 ofAWSIoTDeleteRoleAliasResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorDeleteConflict
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
,AWSIoTErrorResourceNotFound
. -
Deletes a role alias
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, completionHandler: ((AWSIoTDeleteRoleAliasResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorDeleteConflict
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
,AWSIoTErrorResourceNotFound
. -
Deletes a scheduled audit.
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 ofAWSIoTDeleteScheduledAuditResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Deletes a scheduled audit.
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, completionHandler: ((AWSIoTDeleteScheduledAuditResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Deletes a Device Defender security profile.
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 ofAWSIoTDeleteSecurityProfileResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
,AWSIoTErrorVersionConflict
. -
Deletes a Device Defender security profile.
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, completionHandler: ((AWSIoTDeleteSecurityProfileResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
,AWSIoTErrorVersionConflict
. -
Deletes a stream.
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 ofAWSIoTDeleteStreamResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceNotFound
,AWSIoTErrorDeleteConflict
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Deletes a stream.
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, completionHandler: ((AWSIoTDeleteStreamResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
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.
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 ofAWSIoTDeleteThingResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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.
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, completionHandler: ((AWSIoTDeleteThingResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceNotFound
,AWSIoTErrorVersionConflict
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Deletes a thing group.
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 ofAWSIoTDeleteThingGroupResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorVersionConflict
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Deletes a thing group.
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, completionHandler: ((AWSIoTDeleteThingGroupResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
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.
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 ofAWSIoTDeleteThingTypeResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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.
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, completionHandler: ((AWSIoTDeleteThingTypeResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceNotFound
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Deletes the rule.
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 benil
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInternal
,AWSIoTErrorInvalidRequest
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorUnauthorized
,AWSIoTErrorConflictingResourceUpdate
. -
Deletes the rule.
See
AWSIoTDeleteTopicRuleRequest
Declaration
Objective-C
- (void)deleteTopicRule:(nonnull AWSIoTDeleteTopicRuleRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteTopicRule(_ request: AWSIoTDeleteTopicRuleRequest, completionHandler: ((Error?) -> Void)? = nil)
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, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInternal
,AWSIoTErrorInvalidRequest
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorUnauthorized
,AWSIoTErrorConflictingResourceUpdate
. -
Deletes a topic rule destination.
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 ofAWSIoTDeleteTopicRuleDestinationResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInternal
,AWSIoTErrorInvalidRequest
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorUnauthorized
,AWSIoTErrorConflictingResourceUpdate
. -
Deletes a topic rule destination.
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, completionHandler: ((AWSIoTDeleteTopicRuleDestinationResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInternal
,AWSIoTErrorInvalidRequest
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorUnauthorized
,AWSIoTErrorConflictingResourceUpdate
. -
Deletes a logging level.
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 benil
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInternal
,AWSIoTErrorInvalidRequest
,AWSIoTErrorServiceUnavailable
. -
Deletes a logging level.
See
AWSIoTDeleteV2LoggingLevelRequest
Declaration
Objective-C
- (void)deleteV2LoggingLevel: (nonnull AWSIoTDeleteV2LoggingLevelRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteV2LoggingLevel(_ request: AWSIoTDeleteV2LoggingLevelRequest, completionHandler: ((Error?) -> Void)? = nil)
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, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInternal
,AWSIoTErrorInvalidRequest
,AWSIoTErrorServiceUnavailable
. -
Deprecates a thing type. You can not associate new things with deprecated thing type.
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 ofAWSIoTDeprecateThingTypeResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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.
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, completionHandler: ((AWSIoTDeprecateThingTypeResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
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.
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 ofAWSIoTDescribeAccountAuditConfigurationResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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.
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, completionHandler: ((AWSIoTDescribeAccountAuditConfigurationResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
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.
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 ofAWSIoTDescribeAuditFindingResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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.
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, completionHandler: ((AWSIoTDescribeAuditFindingResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
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 ofAWSIoTDescribeAuditMitigationActionsTaskResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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, completionHandler: ((AWSIoTDescribeAuditMitigationActionsTaskResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
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 ofAWSIoTDescribeAuditSuppressionResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
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, completionHandler: ((AWSIoTDescribeAuditSuppressionResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Gets information about a Device Defender audit.
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 ofAWSIoTDescribeAuditTaskResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Gets information about a Device Defender audit.
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, completionHandler: ((AWSIoTDescribeAuditTaskResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Describes an authorizer.
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 ofAWSIoTDescribeAuthorizerResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceNotFound
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Describes an authorizer.
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, completionHandler: ((AWSIoTDescribeAuthorizerResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceNotFound
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Returns information about a billing group.
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 ofAWSIoTDescribeBillingGroupResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
,AWSIoTErrorResourceNotFound
. -
Returns information about a billing group.
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, completionHandler: ((AWSIoTDescribeBillingGroupResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
,AWSIoTErrorResourceNotFound
. -
Describes a registered CA certificate.
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 ofAWSIoTDescribeCACertificateResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
,AWSIoTErrorResourceNotFound
. -
Describes a registered CA certificate.
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, completionHandler: ((AWSIoTDescribeCACertificateResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
,AWSIoTErrorResourceNotFound
. -
Gets information about the specified certificate.
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 ofAWSIoTDescribeCertificateResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
,AWSIoTErrorResourceNotFound
. -
Gets information about the specified certificate.
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, completionHandler: ((AWSIoTDescribeCertificateResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
,AWSIoTErrorResourceNotFound
. -
Gets information about a Device Defender detect custom metric.
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 ofAWSIoTDescribeCustomMetricResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Gets information about a Device Defender detect custom metric.
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, completionHandler: ((AWSIoTDescribeCustomMetricResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Describes the default authorizer.
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 ofAWSIoTDescribeDefaultAuthorizerResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceNotFound
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Describes the default authorizer.
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, completionHandler: ((AWSIoTDescribeDefaultAuthorizerResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceNotFound
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Gets information about a Device Defender ML Detect mitigation 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 ofAWSIoTDescribeDetectMitigationActionsTaskResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceNotFound
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Gets information about a Device Defender ML Detect mitigation 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, completionHandler: ((AWSIoTDescribeDetectMitigationActionsTaskResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceNotFound
,AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorInternalFailure
. -
Provides details about a dimension that is defined in your AWS account.
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 ofAWSIoTDescribeDimensionResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInternalFailure
,AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
. -
Provides details about a dimension that is defined in your AWS account.
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, completionHandler: ((AWSIoTDescribeDimensionResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInternalFailure
,AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
. -
Gets summary information about a domain configuration.
The domain configuration feature is in public preview and is subject to change.
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 ofAWSIoTDescribeDomainConfigurationResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorInvalidRequest
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Gets summary information about a domain configuration.
The domain configuration feature is in public preview and is subject to change.
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, completionHandler: ((AWSIoTDescribeDomainConfigurationResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorInvalidRequest
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
. -
Returns a unique endpoint specific to the AWS account making the call.
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 ofAWSIoTDescribeEndpointResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInternalFailure
,AWSIoTErrorInvalidRequest
,AWSIoTErrorUnauthorized
,AWSIoTErrorThrottling
. -
Returns a unique endpoint specific to the AWS account making the call.
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, completionHandler: ((AWSIoTDescribeEndpointResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInternalFailure
,AWSIoTErrorInvalidRequest
,AWSIoTErrorUnauthorized
,AWSIoTErrorThrottling
. -
Describes event configurations.
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 ofAWSIoTDescribeEventConfigurationsResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInternalFailure
,AWSIoTErrorThrottling
. -
Describes event configurations.
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, completionHandler: ((AWSIoTDescribeEventConfigurationsResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInternalFailure
,AWSIoTErrorThrottling
. -
Describes a search index.
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 ofAWSIoTDescribeIndexResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
,AWSIoTErrorResourceNotFound
. -
Describes a search index.
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, completionHandler: ((AWSIoTDescribeIndexResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorThrottling
,AWSIoTErrorUnauthorized
,AWSIoTErrorServiceUnavailable
,AWSIoTErrorInternalFailure
,AWSIoTErrorResourceNotFound
. -
Describes a job.
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 ofAWSIoTDescribeJobResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorServiceUnavailable
. -
Describes a job.
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, completionHandler: ((AWSIoTDescribeJobResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorServiceUnavailable
. -
Describes a job execution.
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 ofAWSIoTDescribeJobExecutionResponse
. On failed execution,task.error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorServiceUnavailable
. -
Describes a job execution.
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, completionHandler: ((AWSIoTDescribeJobExecutionResponse?, Error?) -> Void)? = nil)
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, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSIoTErrorDomain
domain and the following error code:AWSIoTErrorInvalidRequest
,AWSIoTErrorResourceNotFound
,AWSIoTErrorThrottling
,AWSIoTErrorServiceUnavailable
. -
Gets information about a mitigation 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 ofAWSIoTDescribeMitigationActionResponse
. On failed execution,task.error
may