Classes
The following classes are available globally.
-
Undocumented
See moreDeclaration
Objective-C
@interface AWSIoTMQTTLastWillAndTestament: NSObject /** The topic to publish the Last Will and Testament message to. Default value: @"". */ @property(nonatomic, strong) NSString *topic; /** The Last Will and Testament message. Default value: @"". */ @property(nonatomic, strong) NSString *message; /** The Quality of Service to use when publishing the Last Will and Testament message. Default value: AWSIoTMQTTQoSAtMostOnce. */ @property(nonatomic, assign) AWSIoTMQTTQoS qos; /** Sets the retain flag for the Will and Testament */ @property (nonatomic, assign) BOOL willRetain; @end
Swift
class AWSIoTMQTTLastWillAndTestament : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface AWSIoTMQTTConfiguration : NSObject /** The time in seconds to wait before attempting the first reconnect. If the MQTT client becomes disconnected, it will attempt to reconnect after a quiet period; this quiet period doubles with each failed connection attempt, e.g. 1 second, 2 seconds, 4, 8, 16, 32, etc... up until a maximum reconnection time (maximumReconnectTimeInterval) is reached. If a connection is active for the minimum connection time (minimumConnectionTimeInterval), the quiet period is reset to the initial value. Default value: 1 second. */ @property(nonatomic, assign, readonly) NSTimeInterval baseReconnectTimeInterval; /** The time in seconds that a connection must be active before resetting the current reconnection time to the base reconnection time. Default value: 20 seconds. */ @property(nonatomic, assign, readonly) NSTimeInterval minimumConnectionTimeInterval; /** The maximum time in seconds to wait prior to attempting to reconnect. Default value: 128 seconds. */ @property(nonatomic, assign, readonly) NSTimeInterval maximumReconnectTimeInterval; /** The MQTT keep-alive time in seconds. Default value: 300 seconds. */ @property(nonatomic, assign, readonly) NSTimeInterval keepAliveTimeInterval; /** The last will and testament (LWT) to be used when connecting to AWS IoT; in the event that this client disconnects improperly, AWS IoT will use this to notify any interested clients. Default value: nil */ @property(atomic, strong, readonly) AWSIoTMQTTLastWillAndTestament *lastWillAndTestament; /** The run loop to execute the MQTT client in. Default value: [NSRunLoop currentRunLoop] */ @property(atomic, strong, readonly) NSRunLoop *runLoop; /** The run loop mode to use when executing the MQTT client. Default value: NSDefaultRunLoopMode */ @property(nonatomic, strong, readonly) NSString *runLoopMode; /** Boolean flag to indicate whether auto-resubscribe feature is enabled. Default value: YES When enabled, in the event of abnormal network disconnection, the sdk automatically subscribes to previously subscribed topics. */ @property(nonatomic, assign, readonly) BOOL autoResubscribe; /** The max number of publish messages to retry per second if the pub-ack is not received within 60 seconds **/ @property(nonatomic, assign, readonly) NSUInteger publishRetryThrottle; /** MQTT username used to construct the MQTT username field for enhanced custom authentication use case: https://docs.aws.amazon.com/iot/latest/developerguide/enhanced-custom-auth-using.html#enhanced-custom-auth-using-mqtt **/ @property (nonatomic, copy) NSString *username; /** MQTT password used for the MQTT password field for enhanced custom authentication use case: https://docs.aws.amazon.com/iot/latest/developerguide/enhanced-custom-auth-using.html#enhanced-custom-auth-using-mqtt **/ @property (nonatomic, copy) NSString *password; /** Create an AWSIoTMQTTConfiguration object and initialize its parameters. The AWSIoTMQTTConfiguration object is then passed to AWSIoTDataManager to initialize it. Note, clients need to either specify all parameters explicitly or not customize any parameter in which case default parameter values will be used to initialize AWSIoTMqttConfiguration. @param kat keepAliveTimeInterval, Mqtt Keep Alive time in seconds @param brt baseReconnectTimeInterval, The time in seconds to wait before attempting the first reconnect @param mct minimumConnectionTimeInterval, The time in seconds that a connection must be active before resetting the current reconnection time to the base reconnection time. @param mrt maximumReconnectTimeInterval, The maximum time in seconds to wait prior to attempting to reconnect @param rlp The run loop to execute the MQTT client in @param rlm The run loop mode to use when executing the MQTT client @param ars autoResubscribe, Boolean flag to indicate whether auto-resubscribe feature is enabled @param lwt lastWillAndTestament, The last will and testament (LWT) to be used when connecting to AWS IoT */ - (instancetype)initWithKeepAliveTimeInterval:(NSTimeInterval)kat baseReconnectTimeInterval:(NSTimeInterval)brt minimumConnectionTimeInterval:(NSTimeInterval)mct maximumReconnectTimeInterval:(NSTimeInterval)mrt runLoop:(NSRunLoop*)rlp runLoopMode:(NSString*)rlm autoResubscribe:(BOOL)ars lastWillAndTestament:(AWSIoTMQTTLastWillAndTestament*)lwt; /** Create an AWSIoTMQTTConfiguration object and initialize its parameters. The AWSIoTMQTTConfiguration object is then passed to AWSIoTDataManager to initialize it. Note, clients need to either specify all parameters explicitly or not customize any parameter in which case default parameter values will be used to initialize AWSIoTMqttConfiguration. @param kat keepAliveTimeInterval, Mqtt Keep Alive time in seconds @param brt baseReconnectTimeInterval, The time in seconds to wait before attempting the first reconnect @param mct minimumConnectionTimeInterval, The time in seconds that a connection must be active before resetting the current reconnection time to the base reconnection time. @param mrt maximumReconnectTimeInterval, The maximum time in seconds to wait prior to attempting to reconnect @param rlp The run loop to execute the MQTT client in @param rlm The run loop mode to use when executing the MQTT client @param ars autoResubscribe, Boolean flag to indicate whether auto-resubscribe feature is enabled @param lwt lastWillAndTestament, The last will and testament (LWT) to be used when connecting to AWS IoT @param prt publishRetryThrottle, the max number of publish messages to retry per second if the pub-ack is not received within 60 seconds */ - (instancetype)initWithKeepAliveTimeInterval:(NSTimeInterval)kat baseReconnectTimeInterval:(NSTimeInterval)brt minimumConnectionTimeInterval:(NSTimeInterval)mct maximumReconnectTimeInterval:(NSTimeInterval)mrt runLoop:(NSRunLoop*)rlp runLoopMode:(NSString*)rlm autoResubscribe:(BOOL)ars lastWillAndTestament:(AWSIoTMQTTLastWillAndTestament*)lwt publishRetryThrottle:(NSUInteger)prt; @end
Swift
class AWSIoTMQTTConfiguration : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface AWSIoTDataManager : AWSService /** 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. */ @property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration; /** The MQTT configuration used by this service client. Any changes to this configuration object will take effect upon the next invocation of either the connectWithClientId or connectUsingWebSocketWithClientId methods. */ @property (nonatomic, strong, readonly) AWSIoTMQTTConfiguration *mqttConfiguration; /** 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 IoTDataManager = AWSIoTDataManager.default() *Objective-C* AWSIoTDataManager *IoTDataManager = [AWSIoTDataManager defaultIoTDataManager]; @return The default service client. */ + (instancetype)defaultIoTDataManager __attribute__ ((deprecated("Use `registerIoTDataManagerWithConfiguration:forKey:` with the custom endpoint to initialize AWSIoTDataManager"))); /** 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) AWSIoTDataManager.register(with: configuration!, forKey: "USWest2IoTDataManager") 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]; [AWSIoTDataManager registerIoTDataManagerWithConfiguration:configuration forKey:@"USWest2IoTDataManager"]; return YES; } Then call the following to get the service client: *Swift* let IoTDataManager = AWSIoTDataManager(forKey: "USWest2IoTDataManager") *Objective-C* AWSIoTDataManager *IoTDataManager = [AWSIoTDataManager IoTDataManagerForKey:@"USWest2IoTDataManager"]; @warning After calling this method, do not modify the configuration object. It may cause unspecified behaviors. @param configuration A service configuration object. @param key A string to identify the service client. */ + (void)registerIoTDataManagerWithConfiguration:(AWSServiceConfiguration *)configuration forKey:(NSString *)key; /** Creates a service client with the given service configuration and AWSIoTMQTTConfiguration and registers it for the key. For example: *Swift* let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) let mqttConfig = AWSIoTMQTTConfiguration(keepAliveTimeInterval: 60.0, baseReconnectTimeInterval: 1.0, minimumConnectionTimeInterval: 20.0, maximumReconnectTimeInterval: 128.0, runLoop: RunLoop.current, runLoopMode: RunLoopMode.defaultRunLoopMode.rawValue, autoResubscribe: true, lastWillAndTestament: AWSIoTMQTTLastWillAndTestament() ) AWSIoTDataManager.register(with: configuration!, with: mqttConfig!, forKey: "USWest2IoTDataManager") *Objective-C* AWSCognitoCredentialsProvider *credentialsProvider = [ [AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 identityPoolId:@"YourIdentityPoolId"]; AWSServiceConfiguration *configuration = [ [AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 credentialsProvider:credentialsProvider]; AWSIoTMQTTConfiguration *mqttConfig = [ [AWSIoTMQTTConfiguration alloc] initWithKeepAliveTimeInterval:60.0 baseReconnectTimeInterval:1.0 minimumConnectionTimeInterval:20.0 maximumReconnectTimeInterval:128.0 runLoop:[NSRunLoop currentRunLoop] runLoopMode:NSDefaultRunLoopMode autoResubscribe:YES lastWillAndTestament:[AWSIoTMQTTLastWillAndTestament new] ]; [AWSIoTDataManager registerIoTDataManagerWithConfiguration:configuration withMQTTConfiguration:mqttConfig forKey:@"USWest2IoTDataManager"]; Then call the following to get the service client: *Swift* let IoTDataManager = AWSIoTDataManager(forKey: "USWest2IoTDataManager") *Objective-C* AWSIoTDataManager *IoTDataManager = [AWSIoTDataManager IoTDataManagerForKey:@"USWest2IoTDataManager"]; @warning After calling this method, do not modify the configuration object. It may cause unspecified behaviors. @param configuration A service configuration object. @param mqttConfig A AWSIoTMQTTConfiguration object. @param key A string to identify the service client. */ + (void)registerIoTDataManagerWithConfiguration:(AWSServiceConfiguration *)configuration withMQTTConfiguration:(AWSIoTMQTTConfiguration *)mqttConfig forKey:(NSString *)key; /** Retrieves the service client associated with the key. You need to call `+ registerIoTDataManagerWithConfiguration: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) AWSIoTDataManager.register(with: configuration!, forKey: "USWest2IoTDataManager") 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]; [AWSIoTDataManager registerIoTDataManagerWithConfiguration:configuration forKey:@"USWest2IoTDataManager"]; return YES; } Then call the following to get the service client: *Swift* let IoTDataManager = AWSIoTDataManager(forKey: "USWest2IoTDataManager") *Objective-C* AWSIoTDataManager *IoTDataManager = [AWSIoTDataManager IoTDataManagerForKey:@"USWest2IoTDataManager"]; @param key A string to identify the service client. @return An instance of the service client. */ + (instancetype)IoTDataManagerForKey:(NSString *)key; /** 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. @param key A string to identify the service client. */ + (void)removeIoTDataManagerForKey:(NSString *)key; /** Enable or disable sending SDK name and version in the Mqtt Connect message. Enabled by default. Must be called before calling connect. */ - (void)enableMetricsCollection:(BOOL)enabled; /** @deprecated This method is deprecated and will be deleted in the next minor version. Please use `updateUserMetaData` instead. Set user-specified dictionary of the additional values to be passed as components of connection username. *Swift* let userMetaData: [String: String] = ["AFRSDK": "ios", "AFRSDKVersion": "1.0.0", "AFRLibVersion":"1.4.1"] iotDataManager.addUserMetaData(userMetaData) @param userMetaData A dictionary of key-value metadata pairs to be appended to the connection username */ - (void)addUserMetaData:(NSDictionary<NSString *, NSString *> *)userMetaData DEPRECATED_MSG_ATTRIBUTE("Use `updateUserMetaData` for updating the user meta data"); /** Set user-specified dictionary of the additional values to be passed as components of connection username. *Swift* let userMetaData: [String: String] = ["AFRSDK": "ios", "AFRSDKVersion": "1.0.0", "AFRLibVersion":"1.4.1"] iotDataManager.addUserMetaData(userMetaData) @param userMetaData A dictionary of key-value metadata pairs to be appended to the connection username */ - (void)updateUserMetaData:(NSDictionary<NSString *, NSString *> *)userMetaData; /** Initialises the MQTT session and connects to AWS IoT using certificate-based mutual authentication @return true if initialise finished with success @param clientId The Client Identifier identifies the Client to the Server. @param cleanSession specifies if the server should discard previous session information. @param certificateId contains the ID of the certificate to use in the connection; must be in the keychain @param callback When new mqtt session status is received callback will be called with new connection status. */ - (BOOL)connectWithClientId:(NSString *)clientId cleanSession:(BOOL)cleanSession certificateId:(NSString *)certificateId statusCallback:(void (^)(AWSIoTMQTTStatus status))callback; /** Initialises the MQTT session and connects to AWS IoT on port 443 using certificate-based mutual authentication and ALPN (Application Layer Protocol Negotiation) @return true if initialise finished with success @param clientId The Client Identifier identifies the Client to the Server. @param cleanSession specifies if the server should discard previous session information. @param certificateId contains the ID of the certificate to use in the connection; must be in the keychain @param callback When new mqtt session status is received callback will be called with new connection status. */ - (BOOL)connectUsingALPNWithClientId:(NSString *)clientId cleanSession:(BOOL)cleanSession certificateId:(NSString *)certificateId statusCallback:(void (^)(AWSIoTMQTTStatus status))callback API_AVAILABLE(ios(11), macosx(10.13)); /** Initialises the MQTT session and connects to AWS IoT using WebSocket/SigV4 authentication. IAM credentials are taken from the current service configuration. @return true if initialise finished with success @param clientId The Client Identifier identifies the Client to the Server. @param cleanSession specifies if the server should discard previous session information. @param callback When new mqtt session status is received the callback will be called with new connection status. */ - (BOOL)connectUsingWebSocketWithClientId:(NSString *)clientId cleanSession:(BOOL)cleanSession statusCallback:(void (^)(AWSIoTMQTTStatus status))callback; /** Initialises the MQTT session and connects to AWS IoT using WebSocket/CustomAuthorizer mechanism. @param clientId The Client Identifier identifies the Client to the Server. @param cleanSession specifies if the server should discard previous session information. @param customAuthorizerName Name of the AWS IoT custom authorizer. @param tokenKeyName This specifies the key name that your device chooses, which indicates the token in the custom authorization HTTP request header. @param tokenValue This specifies the custom authorization token to authorize the request to the AWS IoT gateway. @param tokenSignature This specifies the token signature for the custom authorizer to validate the tokenValue. @param callback When new mqtt session status is received the callback will be called with new connection status. @return true if initialise finished with success. */ - (BOOL)connectUsingWebSocketWithClientId:(NSString *)clientId cleanSession:(BOOL)cleanSession customAuthorizerName:(NSString *)customAuthorizerName tokenKeyName:(NSString *)tokenKeyName tokenValue:(NSString *)tokenValue tokenSignature:(NSString *)tokenSignature statusCallback:(void (^)(AWSIoTMQTTStatus status))callback; /** Disconnect from a mqtt client (close current mqtt session) */ - (void)disconnect; /** Get the current connection status @return AWSIoTMQTTStatus */ - (AWSIoTMQTTStatus)getConnectionStatus; /** Send MQTT message to specified topic @param string The message (As NSString object) to be sent. @param qos The QoS value to use when publishing (optional, default AWSIoTMQTTQoSAtMostOnce). @param topic The topic for publish to. @return Boolean value indicating success or failure. */ - (BOOL) publishString:(NSString *)string onTopic:(NSString *)topic QoS:(AWSIoTMQTTQoS)qos; /** Send MQTT message to specified topic @param string The message (As NSString object) to be sent. @param qos The QoS value to use when publishing (optional, default AWSIoTMQTTQoSAtMostOnce). @param topic The topic for publish to. @param ackCallback the callback for ack if QoS > 0. @return Boolean value indicating success or failure. */ - (BOOL)publishString:(NSString *)string onTopic:(NSString *)topic QoS:(AWSIoTMQTTQoS)qos ackCallback:(nullable AWSIoTMQTTAckBlock)ackCallback; /** Send MQTT message to specified topic @param data The message (As NSData) to be sent. @param qos The QoS value to use when publishing (optional, default AWSIoTMQTTQoSAtMostOnce). @param topic The topic for publish to. @return Boolean value indicating success or failure. */ - (BOOL)publishData:(NSData *)data onTopic:(NSString *)topic QoS:(AWSIoTMQTTQoS)qos; /** Send MQTT message to specified topic @param data The message (As NSData) to be sent. @param topic The topic for publish to. @param qos The QoS value to use when publishing (optional, default AWSIoTMQTTQoSAtMostOnce). @param ackCallback the callback for ack if QoS > 0. @return Boolean value indicating success or failure. */ - (BOOL)publishData:(NSData *)data onTopic:(NSString *)topic QoS:(AWSIoTMQTTQoS)qos ackCallback:(nullable AWSIoTMQTTAckBlock)ackCallback; /** Send MQTT message to specified topic @param data The message (As NSData) to be sent. @param topic The topic for publish to. @param qos The QoS value to use when publishing (optional, default AWSIoTMQTTQoSAtMostOnce). @param retain The retain message flag. @param ackCallback the callback for ack if QoS > 0. @return Boolean value indicating success or failure. */ - (BOOL)publishData:(NSData *)data onTopic:(NSString *)topic QoS:(AWSIoTMQTTQoS)qos retain:(BOOL)retain ackCallback:(nullable AWSIoTMQTTAckBlock)ackCallback; /** Subscribes to a topic at a specific QoS level @param topic The Topic to subscribe to. @param qos Specifies the QoS Level of the subscription: AWSIoTMQTTQoSAtMostOnce or AWSIoTMQTTQoSAtLeastOnce @param callback Reference to AWSIOTMQTTNewMessageBlock. When new message is received the callback will be invoked. @return Boolean value indicating success or failure. */ - (BOOL) subscribeToTopic:(NSString *)topic QoS:(AWSIoTMQTTQoS)qos messageCallback:(AWSIoTMQTTNewMessageBlock)callback; /** Subscribes to a topic at a specific QoS level @param topic The Topic to subscribe to. @param qos Specifies the QoS Level of the subscription: AWSIoTMQTTQoSAtMostOnce or AWSIoTMQTTQoSAtLeastOnce @param callback Reference to AWSIOTMQTTNewMessageBlock. When new message is received the callback will be invoked. @param ackCallback the callback for ack if QoS > 0. @return Boolean value indicating success or failure. */ - (BOOL)subscribeToTopic:(NSString *)topic QoS:(AWSIoTMQTTQoS)qos messageCallback:(AWSIoTMQTTNewMessageBlock)callback ackCallback:(nullable AWSIoTMQTTAckBlock)ackCallback; /** Subscribes to a topic at a specific QoS level @param topic The Topic to subscribe to. @param qos Specifies the QoS Level of the subscription: AWSIoTMQTTQoSAtMostOnce or AWSIoTMQTTQoSAtLeastOnce @param callback Reference to AWSIOTMQTTExtendedNewMessageBlock. When new message is received the callback will be invoked. @return Boolean value indicating success or failure. */ - (BOOL) subscribeToTopic:(NSString *)topic QoS:(AWSIoTMQTTQoS)qos extendedCallback:(AWSIoTMQTTExtendedNewMessageBlock)callback; /** Subscribes to a topic at a specific QoS level @param topic The Topic to subscribe to. @param qos Specifies the QoS Level of the subscription: AWSIoTMQTTQoSAtMostOnce or AWSIoTMQTTQoSAtLeastOnce @param callback Reference to AWSIOTMQTTExtendedNewMessageBlock. When new message is received the callback will be invoked. @param ackCallback the callback for ack if QoS > 0. @return Boolean value indicating success or failure. */ - (BOOL)subscribeToTopic:(NSString *)topic QoS:(AWSIoTMQTTQoS)qos extendedCallback:(AWSIoTMQTTExtendedNewMessageBlock)callback ackCallback:(nullable AWSIoTMQTTAckBlock)ackCallback; /** Subscribes to a topic at a specific QoS level @param topic The Topic to subscribe to. @param qos Specifies the QoS Level of the subscription: AWSIoTMQTTQoSAtMostOnce or AWSIoTMQTTQoSAtLeastOnce @param callback Reference to AWSIoTMQTTFullMessageBlock. When new message is received the callback will be invoked. @return Boolean value indicating success or failure. */ - (BOOL)subscribeToTopic:(NSString *)topic QoS:(AWSIoTMQTTQoS)qos fullCallback:(AWSIoTMQTTFullMessageBlock)callback; /** Subscribes to a topic at a specific QoS level @param topic The Topic to subscribe to. @param qos Specifies the QoS Level of the subscription: AWSIoTMQTTQoSAtMostOnce or AWSIoTMQTTQoSAtLeastOnce @param callback Reference to AWSIoTMQTTFullMessageBlock. When new message is received the callback will be invoked. @param ackCallback the callback for ack if QoS > 0. @return Boolean value indicating success or failure. */ - (BOOL)subscribeToTopic:(NSString *)topic QoS:(AWSIoTMQTTQoS)qos fullCallback:(AWSIoTMQTTFullMessageBlock)callback ackCallback:(nullable AWSIoTMQTTAckBlock)ackCallback; /** Unsubscribes from a topic @param topic The Topic to unsubscribe from. */ - (void)unsubscribeTopic:(NSString *)topic; typedef NS_ENUM(NSInteger, AWSIoTShadowOperationType) { // // NOTE: the first 4 values in this enum may not be re-ordered. // It must align with the same order in AWSIoTShadowOperationTypeStrings // An internal array in the implementation depends on their // values and order. // AWSIoTShadowOperationTypeUpdate, AWSIoTShadowOperationTypeGet, AWSIoTShadowOperationTypeDelete, AWSIoTShadowOperationTypeCount, // Internal class use only AWSIoTShadowOperationTypeNone // Internal class use only }; typedef NS_ENUM(NSInteger, AWSIoTShadowOperationStatusType) { // // NOTE: the first 5 values in this enum may not be re-ordered. // It must align with the same order in AWSIoTShadowOperationStatusTypeStrings // An internal array in the implementation depends on their // values and order. // AWSIoTShadowOperationStatusTypeAccepted, AWSIoTShadowOperationStatusTypeRejected, AWSIoTShadowOperationStatusTypeDelta, AWSIoTShadowOperationStatusTypeDocuments, AWSIoTShadowOperationStatusTypeCount, // Internal class use only AWSIoTShadowOperationStatusTypeForeignUpdate, AWSIoTShadowOperationStatusTypeTimeout }; /** Register for updates on a device shadow @param name The device shadow to register for updates on. @param options A dictionary with device shadow registration options. The options are: enableDebugging: BOOL, set to YES to enable additional console debugging (default NO) enableVersioning: BOOL, set to NO to disable versioning (default YES) enableForeignStateUpdateNotifications: BOOL, set to YES to enable foreign state updates (default NO) enableStaleDiscards: BOOL, set to NO to disable discarding stale updates (default YES) enableIgnoreDeltas: BOOL, set to YES to disable delta updates (default NO) QoS: AWSIoTMQTTQoS (default AWSIoTMQTTQoSMessageDeliveryAttemptedAtMostOnce) shadowOperationTimeoutSeconds: double, device shadow operation timeout (default 10.0) @param callback The function to call when updates are received for the device shadow. @return Boolean value indicating success or failure. */ - (BOOL) registerWithShadow:(NSString *)name options:(NSDictionary<NSString *, NSNumber *> * _Nullable)options eventCallback:(void(^)(NSString *name, AWSIoTShadowOperationType operation, AWSIoTShadowOperationStatusType status, NSString *clientToken, NSData *payload))callback; /** Register for updates on a device shadow @param name The device shadow to register for updates on. @param options A dictionary with device shadow registration options. The options are: enableDebugging: BOOL, set to YES to enable additional console debugging (default NO) enableVersioning: BOOL, set to NO to disable versioning (default YES) enableForeignStateUpdateNotifications: BOOL, set to YES to enable foreign state updates (default NO) enableStaleDiscards: BOOL, set to NO to disable discarding stale updates (default YES) enableIgnoreDeltas: BOOL, set to YES to disable delta updates (default NO) QoS: AWSIoTMQTTQoS (default AWSIoTMQTTQoSMessageDeliveryAttemptedAtMostOnce) shadowOperationTimeoutSeconds: double, device shadow operation timeout (default 10.0) @param callback The function to call when updates are received for the device shadow. @param completionCallback The function to call when the operation is completed. @return Boolean value indicating success or failure. */ - (BOOL) registerWithShadow:(NSString *)name options:(NSDictionary<NSString *, NSNumber *> * _Nullable)options eventCallback:(void(^)(NSString *name, AWSIoTShadowOperationType operation, AWSIoTShadowOperationStatusType status, NSString *clientToken, NSData *payload))callback completionCallback:(void(^)(void))completionCallback; /** Unregister from updates on a device shadow @param name The device shadow to unregister from updates on. @return Boolean value indicating success or failure. */ - (BOOL) unregisterFromShadow:(NSString *)name; /** Unregister from updates on a device shadow @param name The device shadow to unregister from updates on. @param completionCallback The function to call when the operation is completed. @return Boolean value indicating success or failure. */ - (BOOL) unregisterFromShadow:(NSString *)name completionCallback:(void(^)(void))completionCallback; /** Update a device shadow @param name The device shadow to update. @param jsonString The JSON string to update the device shadow with. @return Boolean value indicating success or failure. */ - (BOOL) updateShadow:(NSString *)name jsonString:(NSString *)jsonString; /** Update a device shadow with json data and client token. If the json data is not valid, it returns false, and no update message will be published. If the json data is valid, it publishes the data on $aws/things/thingName/shadow/update topic, then return true. @param name The name of the device shadow to be updated @param jsonString The shadow state in format of JSON string @param clientToken The client id to use when upadating the shadow @return True if json string is valid and can be serialized successfully; False if it cannot be serialized successfully. */ - (BOOL) updateShadow:(NSString *)name jsonString:(NSString *)jsonString clientToken:(NSString * _Nullable)clientToken; /** Get a device shadow @param name The device shadow to get. @return Boolean value indicating success or failure. */ - (BOOL) getShadow:(NSString *)name; /** Get a device shadow @param name The device shadow to get. @param clientToken A client token to use when requesting the device shadow. @return Boolean value indicating success or failure. */ - (BOOL) getShadow:(NSString *)name clientToken:(NSString * _Nullable)clientToken; /** Delete a device shadow @param name The device shadow to delete. @return Boolean value indicating success or failure. */ - (BOOL) deleteShadow:(NSString *)name; /** Delete a device shadow @param name The device shadow to delete. @param clientToken A client token to use when deleting the device shadow. @return Boolean value indicating success or failure. */ - (BOOL) deleteShadow:(NSString *)name clientToken:(NSString * _Nullable)clientToken; @end
Swift
class AWSIoTDataManager
-
Declaration
Objective-C
@interface AWSIoTDataDeleteThingShadowRequest
Swift
class AWSIoTDataDeleteThingShadowRequest
-
Declaration
Objective-C
@interface AWSIoTDataDeleteThingShadowResponse
Swift
class AWSIoTDataDeleteThingShadowResponse
-
Declaration
Objective-C
@interface AWSIoTDataGetRetainedMessageRequest
Swift
class AWSIoTDataGetRetainedMessageRequest
-
The output from the GetRetainedMessage operation.
See moreDeclaration
Objective-C
@interface AWSIoTDataGetRetainedMessageResponse
Swift
class AWSIoTDataGetRetainedMessageResponse
-
Declaration
Objective-C
@interface AWSIoTDataGetThingShadowRequest
Swift
class AWSIoTDataGetThingShadowRequest
-
The output from the GetThingShadow operation.
See moreDeclaration
Objective-C
@interface AWSIoTDataGetThingShadowResponse
Swift
class AWSIoTDataGetThingShadowResponse
-
Declaration
Objective-C
@interface AWSIoTDataListNamedShadowsForThingRequest
Swift
class AWSIoTDataListNamedShadowsForThingRequest
-
Declaration
Objective-C
@interface AWSIoTDataListNamedShadowsForThingResponse
Swift
class AWSIoTDataListNamedShadowsForThingResponse
-
Declaration
Objective-C
@interface AWSIoTDataListRetainedMessagesRequest
Swift
class AWSIoTDataListRetainedMessagesRequest
-
Declaration
Objective-C
@interface AWSIoTDataListRetainedMessagesResponse
Swift
class AWSIoTDataListRetainedMessagesResponse
-
Declaration
Objective-C
@interface AWSIoTDataPublishRequest
Swift
class AWSIoTDataPublishRequest
-
Information about a single retained message.
See moreDeclaration
Objective-C
@interface AWSIoTDataRetainedMessageSummary
Swift
class AWSIoTDataRetainedMessageSummary
-
Declaration
Objective-C
@interface AWSIoTDataUpdateThingShadowRequest
Swift
class AWSIoTDataUpdateThingShadowRequest
-
The output from the UpdateThingShadow operation.
See moreDeclaration
Objective-C
@interface AWSIoTDataUpdateThingShadowResponse
Swift
class AWSIoTDataUpdateThingShadowResponse
-
Undocumented
See moreDeclaration
Objective-C
@interface AWSIoTDataResources : NSObject + (instancetype)sharedInstance; - (NSDictionary *)JSONObject; @end
Swift
class AWSIoTDataResources : NSObject
-
IoT data IoT data enables secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud. It implements a broker for applications and things to publish messages over HTTP (Publish) and retrieve, update, and delete shadows. A shadow is a persistent representation of your things and their state in the Amazon Web Services cloud.
Find the endpoint address for actions in IoT data by running this CLI command:
aws iot describe-endpoint --endpoint-type iot:Data-ATS
The service name used by Amazon Web ServicesSignature Version 4 to sign requests is: iotdevicegateway.
See moreDeclaration
Objective-C
@interface AWSIoTData
Swift
class AWSIoTData
-
Undocumented
See moreDeclaration
Objective-C
@interface AWSIoTCreateCertificateResponse : AWSModel @property (nonatomic, strong) NSString *certificateArn; @property (nonatomic, strong) NSString *certificateId; @property (nonatomic, strong) NSString *certificatePem; @end
Swift
class AWSIoTCreateCertificateResponse
-
Undocumented
See moreDeclaration
Objective-C
@interface AWSIoTManager : AWSService /** 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. */ @property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration; /** Enables the custom tag which will include the certificateId when adding a certificate. Default: False */ @property (nonatomic, class, assign) BOOL tagCertificateEnabled; /** 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 IoTManager = AWSIoTManager.default() *Objective-C* AWSIoTManager *IoTManager = [AWSIoTManager defaultIoTManager]; @return The default service client. */ + (instancetype)defaultIoTManager; /** 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) AWSIoTManager.register(with: configuration!, forKey: "USWest2IoTManager") 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]; [AWSIoTManager registerIoTManagerWithConfiguration:configuration forKey:@"USWest2IoTManager"]; return YES; } Then call the following to get the service client: *Swift* let IoTManager = AWSIoTManager(forKey: "USWest2IoTManager") *Objective-C* AWSIoTManager *IoTManager = [AWSIoTManager IoTManagerForKey:@"USWest2IoTManager"]; @warning After calling this method, do not modify the configuration object. It may cause unspecified behaviors. @param configuration A service configuration object. @param key A string to identify the service client. */ + (void)registerIoTManagerWithConfiguration:(AWSServiceConfiguration *)configuration forKey:(NSString *)key; /** Retrieves the service client associated with the key. You need to call `+ registerIoTManagerWithConfiguration: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) AWSIoTManager.register(with: configuration!, forKey: "USWest2IoTManager") 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]; [AWSIoTManager registerIoTManagerWithConfiguration:configuration forKey:@"USWest2IoTManager"]; return YES; } Then call the following to get the service client: *Swift* let IoTManager = AWSIoTManager(forKey: "USWest2IoTManager") *Objective-C* AWSIoTManager *IoTManager = [AWSIoTManager IoTManagerForKey:@"USWest2IoTManager"]; @param key A string to identify the service client. @return An instance of the service client. */ + (instancetype)IoTManagerForKey:(NSString *)key; /** 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. @param key A string to identify the service client. */ + (void)removeIoTManagerForKey:(NSString *)key; /** * Creates keys and certificate from a CSR created using the specified dictionary * * @param csrDictionary contains values used to generate the CSR. Requires values for * keys: commonName, countryName, organizationName, organizationalUnitName * * @param callback When new certificate is created the function of block will be called with an instance of `AWSIOTDescribeCertificateResponse` */ - (void)createKeysAndCertificateFromCsr:(NSDictionary<NSString *, NSString*> *)csrDictionary callback:(void (^)(AWSIoTCreateCertificateResponse *mainResponse))callback; /** * Import PKCS12 identity into keychain. This method allows you to import an * identity created using the AWS console or CLI into the keychain. The identity is * contained in PKCS12 data; you can create PKCS12 files (suffix .p12) using openssl * as follows: * * openssl pkcs12 -export -in cert.pem -inkey key.pem -CAfile root-ca.crt -out awsiot-identity.p12 * * @param pkcs12Data pkcs12 raw data. Will only import the first item. * * @param passPhrase Pass phrase used to decrypt the pkcs12 data. * * @param certificateId Unique identifier used to find the key/certificate for use. * */ + (BOOL)importIdentityFromPKCS12Data:(NSData *)pkcs12Data passPhrase:(NSString *)passPhrase certificateId:(NSString *)certificateId; /** * Validates the certificate with the given identifier of certificate. * * @param certificateId The certificate identifier * * @return TRUE if certificate is valid, else FALSE */ + (BOOL)isValidCertificate:(NSString *)certificateId; /** * Deletes keys and certificate * * @return TRUE if certificate is deleted, else FALSE */ + (BOOL)deleteCertificate; + (BOOL)deleteCertificateWithCertificateId:(NSString*)certificateId NS_SWIFT_NAME(deleteCertificate(certificateId:)); + (void)setKeyChainAccessibility:(AWSIoTKeyChainAccessibility)accessibility; + (NSString *)certTagWithCertificateId:(NSString *)certificateId; @end
Swift
class AWSIoTManager
-
Undocumented
See moreDeclaration
Objective-C
@interface AWSIoTMessage : NSObject @property (assign) AWSIoTMQTTMessageType type; @property (assign) AWSIoTMQTTQoS qos; @property (assign) BOOL retainFlag; @property (assign) BOOL isDuplicate; @property (nonatomic, copy) NSData * rawData; @property (nonatomic, copy) NSData * messageData; @property (nonatomic, copy) NSString * topic; @property (nonatomic, copy) NSString * message; @end
Swift
class AWSIoTMessage : NSObject
-
The criteria that determine when and how a job abort takes place.
Required parameters: [criteriaList]
See moreDeclaration
Objective-C
@interface AWSIoTAbortConfig
Swift
class AWSIoTAbortConfig
-
The criteria that determine when and how a job abort takes place.
Required parameters: [failureType, action, thresholdPercentage, minNumberOfExecutedThings]
See moreDeclaration
Objective-C
@interface AWSIoTAbortCriteria
Swift
class AWSIoTAbortCriteria
-
The input for the AcceptCertificateTransfer operation.
Required parameters: [certificateId]
See moreDeclaration
Objective-C
@interface AWSIoTAcceptCertificateTransferRequest
Swift
class AWSIoTAcceptCertificateTransferRequest
-
Describes the actions associated with a rule.
See moreDeclaration
Objective-C
@interface AWSIoTAction
Swift
class AWSIoTAction
-
Information about an active Device Defender security profile behavior violation.
See moreDeclaration
Objective-C
@interface AWSIoTActiveViolation
Swift
class AWSIoTActiveViolation
-
Declaration
Objective-C
@interface AWSIoTAddThingToBillingGroupRequest
Swift
class AWSIoTAddThingToBillingGroupRequest
-
Declaration
Objective-C
@interface AWSIoTAddThingToBillingGroupResponse
Swift
class AWSIoTAddThingToBillingGroupResponse
-
Declaration
Objective-C
@interface AWSIoTAddThingToThingGroupRequest
Swift
class AWSIoTAddThingToThingGroupRequest
-
Declaration
Objective-C
@interface AWSIoTAddThingToThingGroupResponse
Swift
class AWSIoTAddThingToThingGroupResponse
-
Parameters used when defining a mitigation action that move a set of things to a thing group.
Required parameters: [thingGroupNames]
See moreDeclaration
Objective-C
@interface AWSIoTAddThingsToThingGroupParams
Swift
class AWSIoTAddThingsToThingGroupParams
-
Declaration
Objective-C
@interface AWSIoTAggregationType
Swift
class AWSIoTAggregationType
-
A structure containing the alert target ARN and the role ARN.
Required parameters: [alertTargetArn, roleArn]
See moreDeclaration
Objective-C
@interface AWSIoTAlertTarget
Swift
class AWSIoTAlertTarget
-
Contains information that allowed the authorization.
See moreDeclaration
Objective-C
@interface AWSIoTAllowed
Swift
class AWSIoTAllowed
-
An asset property timestamp entry containing the following information.
Required parameters: [timeInSeconds]
See moreDeclaration
Objective-C
@interface AWSIoTAssetPropertyTimestamp
Swift
class AWSIoTAssetPropertyTimestamp
-
An asset property value entry containing the following information.
Required parameters: [value, timestamp]
See moreDeclaration
Objective-C
@interface AWSIoTAssetPropertyValue
Swift
class AWSIoTAssetPropertyValue
-
Contains an asset property value (of a single type).
See moreDeclaration
Objective-C
@interface AWSIoTAssetPropertyVariant
Swift
class AWSIoTAssetPropertyVariant
-
Declaration
Objective-C
@interface AWSIoTAssociateTargetsWithJobRequest
Swift
class AWSIoTAssociateTargetsWithJobRequest
-
Declaration
Objective-C
@interface AWSIoTAssociateTargetsWithJobResponse
Swift
class AWSIoTAssociateTargetsWithJobResponse
-
Declaration
Objective-C
@interface AWSIoTAttachPolicyRequest
Swift
class AWSIoTAttachPolicyRequest
-
The input for the AttachPrincipalPolicy operation.
Required parameters: [policyName, principal]
See moreDeclaration
Objective-C
@interface AWSIoTAttachPrincipalPolicyRequest
Swift
class AWSIoTAttachPrincipalPolicyRequest
-
Declaration
Objective-C
@interface AWSIoTAttachSecurityProfileRequest
Swift
class AWSIoTAttachSecurityProfileRequest
-
Declaration
Objective-C
@interface AWSIoTAttachSecurityProfileResponse
Swift
class AWSIoTAttachSecurityProfileResponse
-
The input for the AttachThingPrincipal operation.
Required parameters: [thingName, principal]
See moreDeclaration
Objective-C
@interface AWSIoTAttachThingPrincipalRequest
Swift
class AWSIoTAttachThingPrincipalRequest
-
The output from the AttachThingPrincipal operation.
Declaration
Objective-C
@interface AWSIoTAttachThingPrincipalResponse
Swift
class AWSIoTAttachThingPrincipalResponse
-
The attribute payload.
See moreDeclaration
Objective-C
@interface AWSIoTAttributePayload
Swift
class AWSIoTAttributePayload
-
Which audit checks are enabled and disabled for this account.
See moreDeclaration
Objective-C
@interface AWSIoTAuditCheckConfiguration
Swift
class AWSIoTAuditCheckConfiguration
-
Information about the audit check.
See moreDeclaration
Objective-C
@interface AWSIoTAuditCheckDetails
Swift
class AWSIoTAuditCheckDetails
-
The findings (results) of the audit.
See moreDeclaration
Objective-C
@interface AWSIoTAuditFinding
Swift
class AWSIoTAuditFinding
-
Returned by ListAuditMitigationActionsTask, this object contains information that describes a mitigation action that has been started.
See moreDeclaration
Objective-C
@interface AWSIoTAuditMitigationActionExecutionMetadata
Swift
class AWSIoTAuditMitigationActionExecutionMetadata
-
Information about an audit mitigation actions task that is returned by
See moreListAuditMitigationActionsTasks
.Declaration
Objective-C
@interface AWSIoTAuditMitigationActionsTaskMetadata
Swift
class AWSIoTAuditMitigationActionsTaskMetadata
-
Used in MitigationActionParams, this information identifies the target findings to which the mitigation actions are applied. Only one entry appears.
See moreDeclaration
Objective-C
@interface AWSIoTAuditMitigationActionsTaskTarget
Swift
class AWSIoTAuditMitigationActionsTaskTarget
-
Information about the targets to which audit notifications are sent.
See moreDeclaration
Objective-C
@interface AWSIoTAuditNotificationTarget
Swift
class AWSIoTAuditNotificationTarget
-
Filters out specific findings of a Device Defender audit.
Required parameters: [checkName, resourceIdentifier]
See moreDeclaration
Objective-C
@interface AWSIoTAuditSuppression
Swift
class AWSIoTAuditSuppression
-
The audits that were performed.
See moreDeclaration
Objective-C
@interface AWSIoTAuditTaskMetadata
Swift
class AWSIoTAuditTaskMetadata
-
Declaration
Objective-C
@interface AWSIoTAuthInfo
Swift
class AWSIoTAuthInfo
-
The authorizer result.
See moreDeclaration
Objective-C
@interface AWSIoTAuthResult
Swift
class AWSIoTAuthResult
-
An object that specifies the authorization service for a domain.
See moreDeclaration
Objective-C
@interface AWSIoTAuthorizerConfig
Swift
class AWSIoTAuthorizerConfig
-
The authorizer description.
See moreDeclaration
Objective-C
@interface AWSIoTAuthorizerDescription
Swift
class AWSIoTAuthorizerDescription
-
The authorizer summary.
See moreDeclaration
Objective-C
@interface AWSIoTAuthorizerSummary
Swift
class AWSIoTAuthorizerSummary
-
The criteria that determine when and how a job abort takes place.
Required parameters: [abortCriteriaList]
See moreDeclaration
Objective-C
@interface AWSIoTAwsJobAbortConfig
Swift
class AWSIoTAwsJobAbortConfig
-
The criteria that determine when and how a job abort takes place.
Required parameters: [failureType, action, thresholdPercentage, minNumberOfExecutedThings]
See moreDeclaration
Objective-C
@interface AWSIoTAwsJobAbortCriteria
Swift
class AWSIoTAwsJobAbortCriteria
-
Configuration for the rollout of OTA updates.
See moreDeclaration
Objective-C
@interface AWSIoTAwsJobExecutionsRolloutConfig
Swift
class AWSIoTAwsJobExecutionsRolloutConfig
-
The rate of increase for a job rollout. This parameter allows you to define an exponential rate increase for a job rollout.
Required parameters: [baseRatePerMinute, incrementFactor, rateIncreaseCriteria]
See moreDeclaration
Objective-C
@interface AWSIoTAwsJobExponentialRolloutRate
Swift
class AWSIoTAwsJobExponentialRolloutRate
-
Configuration information for pre-signed URLs. Valid when
See moreprotocols
contains HTTP.Declaration
Objective-C
@interface AWSIoTAwsJobPresignedUrlConfig
Swift
class AWSIoTAwsJobPresignedUrlConfig
-
The criteria to initiate the increase in rate of rollout for a job.
See moreDeclaration
Objective-C
@interface AWSIoTAwsJobRateIncreaseCriteria
Swift
class AWSIoTAwsJobRateIncreaseCriteria
-
Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to
See moreIN_PROGRESS
. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set toTIMED_OUT
.Declaration
Objective-C
@interface AWSIoTAwsJobTimeoutConfig
Swift
class AWSIoTAwsJobTimeoutConfig
-
Declaration
Objective-C
@interface AWSIoTBehavior
Swift
class AWSIoTBehavior
-
The criteria by which the behavior is determined to be normal.
See moreDeclaration
Objective-C
@interface AWSIoTBehaviorCriteria
Swift
class AWSIoTBehaviorCriteria
-
The summary of an ML Detect behavior model.
See moreDeclaration
Objective-C
@interface AWSIoTBehaviorModelTrainingSummary
Swift
class AWSIoTBehaviorModelTrainingSummary
-
Additional information about the billing group.
See moreDeclaration
Objective-C
@interface AWSIoTBillingGroupMetadata
Swift
class AWSIoTBillingGroupMetadata
-
The properties of a billing group.
See moreDeclaration
Objective-C
@interface AWSIoTBillingGroupProperties
Swift
class AWSIoTBillingGroupProperties
-
A count of documents that meets a specific aggregation criteria.
See moreDeclaration
Objective-C
@interface AWSIoTBucket
Swift
class AWSIoTBucket
-
The type of bucketed aggregation performed.
See moreDeclaration
Objective-C
@interface AWSIoTBucketsAggregationType
Swift
class AWSIoTBucketsAggregationType
-
A CA certificate.
See moreDeclaration
Objective-C
@interface AWSIoTCACertificate
Swift
class AWSIoTCACertificate
-
Describes a CA certificate.
See moreDeclaration
Objective-C
@interface AWSIoTCACertificateDescription
Swift
class AWSIoTCACertificateDescription
-
Declaration
Objective-C
@interface AWSIoTCancelAuditMitigationActionsTaskRequest
Swift
class AWSIoTCancelAuditMitigationActionsTaskRequest
-
Declaration
Objective-C
@interface AWSIoTCancelAuditMitigationActionsTaskResponse
Swift
class AWSIoTCancelAuditMitigationActionsTaskResponse
-
Declaration
Objective-C
@interface AWSIoTCancelAuditTaskRequest
Swift
class AWSIoTCancelAuditTaskRequest
-
Declaration
Objective-C
@interface AWSIoTCancelAuditTaskResponse
Swift
class AWSIoTCancelAuditTaskResponse
-
The input for the CancelCertificateTransfer operation.
Required parameters: [certificateId]
See moreDeclaration
Objective-C
@interface AWSIoTCancelCertificateTransferRequest
Swift
class AWSIoTCancelCertificateTransferRequest
-
Declaration
Objective-C
@interface AWSIoTCancelDetectMitigationActionsTaskRequest
Swift
class AWSIoTCancelDetectMitigationActionsTaskRequest
-
Declaration
Objective-C
@interface AWSIoTCancelDetectMitigationActionsTaskResponse
Swift
class AWSIoTCancelDetectMitigationActionsTaskResponse
-
Declaration
Objective-C
@interface AWSIoTCancelJobExecutionRequest
Swift
class AWSIoTCancelJobExecutionRequest
-
Declaration
Objective-C
@interface AWSIoTCancelJobRequest
Swift
class AWSIoTCancelJobRequest
-
Declaration
Objective-C
@interface AWSIoTCancelJobResponse
Swift
class AWSIoTCancelJobResponse
-
Information about a certificate.
See moreDeclaration
Objective-C
@interface AWSIoTCertificate
Swift
class AWSIoTCertificate
-
Describes a certificate.
See moreDeclaration
Objective-C
@interface AWSIoTCertificateDescription
Swift
class AWSIoTCertificateDescription
-
The certificate provider summary.
See moreDeclaration
Objective-C
@interface AWSIoTCertificateProviderSummary
Swift
class AWSIoTCertificateProviderSummary
-
When the certificate is valid.
See moreDeclaration
Objective-C
@interface AWSIoTCertificateValidity
Swift
class AWSIoTCertificateValidity
-
Declaration
Objective-C
@interface AWSIoTClearDefaultAuthorizerRequest
Swift
class AWSIoTClearDefaultAuthorizerRequest
-
Declaration
Objective-C
@interface AWSIoTClearDefaultAuthorizerResponse
Swift
class AWSIoTClearDefaultAuthorizerResponse
-
Describes an action that updates a CloudWatch alarm.
Required parameters: [roleArn, alarmName, stateReason, stateValue]
See moreDeclaration
Objective-C
@interface AWSIoTCloudwatchAlarmAction
Swift
class AWSIoTCloudwatchAlarmAction
-
Describes an action that sends data to CloudWatch Logs.
Required parameters: [roleArn, logGroupName]
See moreDeclaration
Objective-C
@interface AWSIoTCloudwatchLogsAction
Swift
class AWSIoTCloudwatchLogsAction
-
Describes an action that captures a CloudWatch metric.
Required parameters: [roleArn, metricNamespace, metricName, metricValue, metricUnit]
See moreDeclaration
Objective-C
@interface AWSIoTCloudwatchMetricAction
Swift
class AWSIoTCloudwatchMetricAction
-
Describes the method to use when code signing a file.
See moreDeclaration
Objective-C
@interface AWSIoTCodeSigning
Swift
class AWSIoTCodeSigning
-
Describes the certificate chain being used when code signing a file.
See moreDeclaration
Objective-C
@interface AWSIoTCodeSigningCertificateChain
Swift
class AWSIoTCodeSigningCertificateChain
-
Describes the signature for a file.
See moreDeclaration
Objective-C
@interface AWSIoTCodeSigningSignature
Swift
class AWSIoTCodeSigningSignature
-
Configuration.
See moreDeclaration
Objective-C
@interface AWSIoTConfiguration
Swift
class AWSIoTConfiguration
-
Declaration
Objective-C
@interface AWSIoTConfirmTopicRuleDestinationRequest
Swift
class AWSIoTConfirmTopicRuleDestinationRequest
-
Declaration
Objective-C
@interface AWSIoTConfirmTopicRuleDestinationResponse
Swift
class AWSIoTConfirmTopicRuleDestinationResponse
-
Declaration
Objective-C
@interface AWSIoTCreateAuditSuppressionRequest
Swift
class AWSIoTCreateAuditSuppressionRequest
-
Declaration
Objective-C
@interface AWSIoTCreateAuditSuppressionResponse
Swift
class AWSIoTCreateAuditSuppressionResponse
-
Declaration
Objective-C
@interface AWSIoTCreateAuthorizerRequest
Swift
class AWSIoTCreateAuthorizerRequest
-
Declaration
Objective-C
@interface AWSIoTCreateAuthorizerResponse
Swift
class AWSIoTCreateAuthorizerResponse
-
Declaration
Objective-C
@interface AWSIoTCreateBillingGroupRequest
Swift
class AWSIoTCreateBillingGroupRequest
-
Declaration
Objective-C
@interface AWSIoTCreateBillingGroupResponse
Swift
class AWSIoTCreateBillingGroupResponse
-
The input for the CreateCertificateFromCsr operation.
Required parameters: [certificateSigningRequest]
See moreDeclaration
Objective-C
@interface AWSIoTCreateCertificateFromCsrRequest
Swift
class AWSIoTCreateCertificateFromCsrRequest
-
The output from the CreateCertificateFromCsr operation.
See moreDeclaration
Objective-C
@interface AWSIoTCreateCertificateFromCsrResponse
Swift
class AWSIoTCreateCertificateFromCsrResponse
-
Declaration
Objective-C
@interface AWSIoTCreateCertificateProviderRequest
Swift
class AWSIoTCreateCertificateProviderRequest
-
Declaration
Objective-C
@interface AWSIoTCreateCertificateProviderResponse
Swift
class AWSIoTCreateCertificateProviderResponse
-
Declaration
Objective-C
@interface AWSIoTCreateCustomMetricRequest
Swift
class AWSIoTCreateCustomMetricRequest
-
Declaration
Objective-C
@interface AWSIoTCreateCustomMetricResponse
Swift
class AWSIoTCreateCustomMetricResponse
-
Declaration
Objective-C
@interface AWSIoTCreateDimensionRequest
Swift
class AWSIoTCreateDimensionRequest
-
Declaration
Objective-C
@interface AWSIoTCreateDimensionResponse
Swift
class AWSIoTCreateDimensionResponse
-
Declaration
Objective-C
@interface AWSIoTCreateDomainConfigurationRequest
Swift
class AWSIoTCreateDomainConfigurationRequest
-
Declaration
Objective-C
@interface AWSIoTCreateDomainConfigurationResponse
Swift
class AWSIoTCreateDomainConfigurationResponse
-
Declaration
Objective-C
@interface AWSIoTCreateDynamicThingGroupRequest
Swift
class AWSIoTCreateDynamicThingGroupRequest
-
Declaration
Objective-C
@interface AWSIoTCreateDynamicThingGroupResponse
Swift
class AWSIoTCreateDynamicThingGroupResponse
-
Declaration
Objective-C
@interface AWSIoTCreateFleetMetricRequest
Swift
class AWSIoTCreateFleetMetricRequest
-
Declaration
Objective-C
@interface AWSIoTCreateFleetMetricResponse
Swift
class AWSIoTCreateFleetMetricResponse
-
Declaration
Objective-C
@interface AWSIoTCreateJobRequest
Swift
class AWSIoTCreateJobRequest
-
Declaration
Objective-C
@interface AWSIoTCreateJobResponse
Swift
class AWSIoTCreateJobResponse
-
Declaration
Objective-C
@interface AWSIoTCreateJobTemplateRequest
Swift
class AWSIoTCreateJobTemplateRequest
-
Declaration
Objective-C
@interface AWSIoTCreateJobTemplateResponse
Swift
class AWSIoTCreateJobTemplateResponse
-
The input for the CreateKeysAndCertificate operation.
Requires permission to access the CreateKeysAndCertificateRequest action.
See moreDeclaration
Objective-C
@interface AWSIoTCreateKeysAndCertificateRequest
Swift
class AWSIoTCreateKeysAndCertificateRequest
-
The output of the CreateKeysAndCertificate operation.
See moreDeclaration
Objective-C
@interface AWSIoTCreateKeysAndCertificateResponse
Swift
class AWSIoTCreateKeysAndCertificateResponse
-
Declaration
Objective-C
@interface AWSIoTCreateMitigationActionRequest
Swift
class AWSIoTCreateMitigationActionRequest
-
Declaration
Objective-C
@interface AWSIoTCreateMitigationActionResponse
Swift
class AWSIoTCreateMitigationActionResponse
-
Declaration
Objective-C
@interface AWSIoTCreateOTAUpdateRequest
Swift
class AWSIoTCreateOTAUpdateRequest
-
Declaration
Objective-C
@interface AWSIoTCreateOTAUpdateResponse
Swift
class AWSIoTCreateOTAUpdateResponse
-
Declaration
Objective-C
@interface AWSIoTCreatePackageRequest
Swift
class AWSIoTCreatePackageRequest
-
Declaration
Objective-C
@interface AWSIoTCreatePackageResponse
Swift
class AWSIoTCreatePackageResponse
-
Declaration
Objective-C
@interface AWSIoTCreatePackageVersionRequest
Swift
class AWSIoTCreatePackageVersionRequest
-
Declaration
Objective-C
@interface AWSIoTCreatePackageVersionResponse
Swift
class AWSIoTCreatePackageVersionResponse
-
The input for the CreatePolicy operation.
Required parameters: [policyName, policyDocument]
See moreDeclaration
Objective-C
@interface AWSIoTCreatePolicyRequest
Swift
class AWSIoTCreatePolicyRequest
-
The output from the CreatePolicy operation.
See moreDeclaration
Objective-C
@interface AWSIoTCreatePolicyResponse
Swift
class AWSIoTCreatePolicyResponse
-
The input for the CreatePolicyVersion operation.
Required parameters: [policyName, policyDocument]
See moreDeclaration
Objective-C
@interface AWSIoTCreatePolicyVersionRequest
Swift
class AWSIoTCreatePolicyVersionRequest
-
The output of the CreatePolicyVersion operation.
See moreDeclaration
Objective-C
@interface AWSIoTCreatePolicyVersionResponse
Swift
class AWSIoTCreatePolicyVersionResponse
-
Declaration
Objective-C
@interface AWSIoTCreateProvisioningClaimRequest
Swift
class AWSIoTCreateProvisioningClaimRequest
-
Declaration
Objective-C
@interface AWSIoTCreateProvisioningClaimResponse
Swift
class AWSIoTCreateProvisioningClaimResponse
-
Declaration
Objective-C
@interface AWSIoTCreateProvisioningTemplateRequest
Swift
class AWSIoTCreateProvisioningTemplateRequest
-
Declaration
Objective-C
@interface AWSIoTCreateProvisioningTemplateResponse
Swift
class AWSIoTCreateProvisioningTemplateResponse
-
Declaration
Objective-C
@interface AWSIoTCreateProvisioningTemplateVersionRequest
Swift
class AWSIoTCreateProvisioningTemplateVersionRequest
-
Declaration
Objective-C
@interface AWSIoTCreateProvisioningTemplateVersionResponse
Swift
class AWSIoTCreateProvisioningTemplateVersionResponse
-
Declaration
Objective-C
@interface AWSIoTCreateRoleAliasRequest
Swift
class AWSIoTCreateRoleAliasRequest
-
Declaration
Objective-C
@interface AWSIoTCreateRoleAliasResponse
Swift
class AWSIoTCreateRoleAliasResponse
-
Declaration
Objective-C
@interface AWSIoTCreateScheduledAuditRequest
Swift
class AWSIoTCreateScheduledAuditRequest
-
Declaration
Objective-C
@interface AWSIoTCreateScheduledAuditResponse
Swift
class AWSIoTCreateScheduledAuditResponse
-
Declaration
Objective-C
@interface AWSIoTCreateSecurityProfileRequest
Swift
class AWSIoTCreateSecurityProfileRequest
-
Declaration
Objective-C
@interface AWSIoTCreateSecurityProfileResponse
Swift
class AWSIoTCreateSecurityProfileResponse
-
Declaration
Objective-C
@interface AWSIoTCreateStreamRequest
Swift
class AWSIoTCreateStreamRequest
-
Declaration
Objective-C
@interface AWSIoTCreateStreamResponse
Swift
class AWSIoTCreateStreamResponse
-
Declaration
Objective-C
@interface AWSIoTCreateThingGroupRequest
Swift
class AWSIoTCreateThingGroupRequest
-
Declaration
Objective-C
@interface AWSIoTCreateThingGroupResponse
Swift
class AWSIoTCreateThingGroupResponse
-
Declaration
Objective-C
@interface AWSIoTCreateThingRequest
Swift
class AWSIoTCreateThingRequest
-
The output of the CreateThing operation.
See moreDeclaration
Objective-C
@interface AWSIoTCreateThingResponse
Swift
class AWSIoTCreateThingResponse
-
Declaration
Objective-C
@interface AWSIoTCreateThingTypeRequest
Swift
class AWSIoTCreateThingTypeRequest
-
The output of the CreateThingType operation.
See moreDeclaration
Objective-C
@interface AWSIoTCreateThingTypeResponse
Swift
class AWSIoTCreateThingTypeResponse
-
Declaration
Objective-C
@interface AWSIoTCreateTopicRuleDestinationRequest
Swift
class AWSIoTCreateTopicRuleDestinationRequest
-
Declaration
Objective-C
@interface AWSIoTCreateTopicRuleDestinationResponse
Swift
class AWSIoTCreateTopicRuleDestinationResponse
-
The input for the CreateTopicRule operation.
Required parameters: [ruleName, topicRulePayload]
See moreDeclaration
Objective-C
@interface AWSIoTCreateTopicRuleRequest
Swift
class AWSIoTCreateTopicRuleRequest
-
Describes a custom method used to code sign a file.
See moreDeclaration
Objective-C
@interface AWSIoTCustomCodeSigning
Swift
class AWSIoTCustomCodeSigning
-
Declaration
Objective-C
@interface AWSIoTDeleteAccountAuditConfigurationRequest
Swift
class AWSIoTDeleteAccountAuditConfigurationRequest
-
Declaration
Objective-C
@interface AWSIoTDeleteAccountAuditConfigurationResponse
Swift
class AWSIoTDeleteAccountAuditConfigurationResponse
-
Declaration
Objective-C
@interface AWSIoTDeleteAuditSuppressionRequest
Swift
class AWSIoTDeleteAuditSuppressionRequest
-
Declaration
Objective-C
@interface AWSIoTDeleteAuditSuppressionResponse
Swift
class AWSIoTDeleteAuditSuppressionResponse
-
Declaration
Objective-C
@interface AWSIoTDeleteAuthorizerRequest
Swift
class AWSIoTDeleteAuthorizerRequest
-
Declaration
Objective-C
@interface AWSIoTDeleteAuthorizerResponse
Swift
class AWSIoTDeleteAuthorizerResponse
-
Declaration
Objective-C
@interface AWSIoTDeleteBillingGroupRequest
Swift
class AWSIoTDeleteBillingGroupRequest
-
Declaration
Objective-C
@interface AWSIoTDeleteBillingGroupResponse
Swift
class AWSIoTDeleteBillingGroupResponse
-
Declaration
Objective-C
@interface AWSIoTDeleteCACertificateRequest
Swift
class AWSIoTDeleteCACertificateRequest
-
The output for the DeleteCACertificate operation.
Declaration
Objective-C
@interface AWSIoTDeleteCACertificateResponse
Swift
class AWSIoTDeleteCACertificateResponse
-
Declaration
Objective-C
@interface AWSIoTDeleteCertificateProviderRequest
Swift
class AWSIoTDeleteCertificateProviderRequest
-
Declaration
Objective-C
@interface AWSIoTDeleteCertificateProviderResponse
Swift
class AWSIoTDeleteCertificateProviderResponse
-
Declaration
Objective-C
@interface AWSIoTDeleteCertificateRequest
Swift
class AWSIoTDeleteCertificateRequest
-
Declaration
Objective-C
@interface AWSIoTDeleteCustomMetricRequest
Swift
class AWSIoTDeleteCustomMetricRequest
-
Declaration
Objective-C
@interface AWSIoTDeleteCustomMetricResponse
Swift
class AWSIoTDeleteCustomMetricResponse
-
Declaration
Objective-C
@interface AWSIoTDeleteDimensionRequest
Swift
class AWSIoTDeleteDimensionRequest
-
Declaration
Objective-C
@interface AWSIoTDeleteDimensionResponse
Swift
class AWSIoTDeleteDimensionResponse
-
Declaration
Objective-C
@interface AWSIoTDeleteDomainConfigurationRequest
Swift
class AWSIoTDeleteDomainConfigurationRequest
-
Declaration
Objective-C
@interface AWSIoTDeleteDomainConfigurationResponse
Swift
class AWSIoTDeleteDomainConfigurationResponse
-
Declaration
Objective-C
@interface AWSIoTDeleteDynamicThingGroupRequest
Swift
class AWSIoTDeleteDynamicThingGroupRequest
-
Declaration
Objective-C
@interface AWSIoTDeleteDynamicThingGroupResponse
Swift
class AWSIoTDeleteDynamicThingGroupResponse
-
Declaration
Objective-C
@interface AWSIoTDeleteFleetMetricRequest
Swift
class AWSIoTDeleteFleetMetricRequest
-
Declaration
Objective-C
@interface AWSIoTDeleteJobExecutionRequest
Swift
class AWSIoTDeleteJobExecutionRequest
-
Declaration
Objective-C
@interface AWSIoTDeleteJobRequest
Swift
class AWSIoTDeleteJobRequest
-
Declaration
Objective-C
@interface AWSIoTDeleteJobTemplateRequest
Swift
class AWSIoTDeleteJobTemplateRequest
-
Declaration
Objective-C
@interface AWSIoTDeleteMitigationActionRequest
Swift
class AWSIoTDeleteMitigationActionRequest
-
Declaration
Objective-C
@interface AWSIoTDeleteMitigationActionResponse
Swift
class AWSIoTDeleteMitigationActionResponse
-
Declaration
Objective-C
@interface AWSIoTDeleteOTAUpdateRequest
Swift
class AWSIoTDeleteOTAUpdateRequest
-
Declaration
Objective-C
@interface AWSIoTDeleteOTAUpdateResponse
Swift
class AWSIoTDeleteOTAUpdateResponse
-
Declaration
Objective-C
@interface AWSIoTDeletePackageRequest
Swift
class AWSIoTDeletePackageRequest
-
Declaration
Objective-C
@interface AWSIoTDeletePackageResponse
Swift
class AWSIoTDeletePackageResponse
-
Declaration
Objective-C
@interface AWSIoTDeletePackageVersionRequest
Swift
class AWSIoTDeletePackageVersionRequest
-
Declaration
Objective-C
@interface AWSIoTDeletePackageVersionResponse
Swift
class AWSIoTDeletePackageVersionResponse
-
Declaration
Objective-C
@interface AWSIoTDeletePolicyRequest
Swift
class AWSIoTDeletePolicyRequest
-
The input for the DeletePolicyVersion operation.
Required parameters: [policyName, policyVersionId]
See moreDeclaration
Objective-C
@interface AWSIoTDeletePolicyVersionRequest
Swift
class AWSIoTDeletePolicyVersionRequest
-
Declaration
Objective-C
@interface AWSIoTDeleteProvisioningTemplateRequest
Swift
class AWSIoTDeleteProvisioningTemplateRequest
-
Declaration
Objective-C
@interface AWSIoTDeleteProvisioningTemplateResponse
Swift
class AWSIoTDeleteProvisioningTemplateResponse
-
Declaration
Objective-C
@interface AWSIoTDeleteProvisioningTemplateVersionRequest
Swift
class AWSIoTDeleteProvisioningTemplateVersionRequest
-
Declaration
Objective-C
@interface AWSIoTDeleteProvisioningTemplateVersionResponse
Swift
class AWSIoTDeleteProvisioningTemplateVersionResponse
-
The input for the DeleteRegistrationCode operation.
Declaration
Objective-C
@interface AWSIoTDeleteRegistrationCodeRequest
Swift
class AWSIoTDeleteRegistrationCodeRequest
-
The output for the DeleteRegistrationCode operation.
Declaration
Objective-C
@interface AWSIoTDeleteRegistrationCodeResponse
Swift
class AWSIoTDeleteRegistrationCodeResponse
-
Declaration
Objective-C
@interface AWSIoTDeleteRoleAliasRequest
Swift
class AWSIoTDeleteRoleAliasRequest
-
Declaration
Objective-C
@interface AWSIoTDeleteRoleAliasResponse
Swift
class AWSIoTDeleteRoleAliasResponse
-
Declaration
Objective-C
@interface AWSIoTDeleteScheduledAuditRequest
Swift
class AWSIoTDeleteScheduledAuditRequest
-
Declaration
Objective-C
@interface AWSIoTDeleteScheduledAuditResponse
Swift
class AWSIoTDeleteScheduledAuditResponse
-
Declaration
Objective-C
@interface AWSIoTDeleteSecurityProfileRequest
Swift
class AWSIoTDeleteSecurityProfileRequest
-
Declaration
Objective-C
@interface AWSIoTDeleteSecurityProfileResponse
Swift
class AWSIoTDeleteSecurityProfileResponse
-
Declaration
Objective-C
@interface AWSIoTDeleteStreamRequest
Swift
class AWSIoTDeleteStreamRequest
-
Declaration
Objective-C
@interface AWSIoTDeleteStreamResponse
Swift
class AWSIoTDeleteStreamResponse
-
Declaration
Objective-C
@interface AWSIoTDeleteThingGroupRequest
Swift
class AWSIoTDeleteThingGroupRequest
-
Declaration
Objective-C
@interface AWSIoTDeleteThingGroupResponse
Swift
class AWSIoTDeleteThingGroupResponse
-
Declaration
Objective-C
@interface AWSIoTDeleteThingRequest
Swift
class AWSIoTDeleteThingRequest
-
The output of the DeleteThing operation.
Declaration
Objective-C
@interface AWSIoTDeleteThingResponse
Swift
class AWSIoTDeleteThingResponse
-
Declaration
Objective-C
@interface AWSIoTDeleteThingTypeRequest
Swift
class AWSIoTDeleteThingTypeRequest
-
The output for the DeleteThingType operation.
Declaration
Objective-C
@interface AWSIoTDeleteThingTypeResponse
Swift
class AWSIoTDeleteThingTypeResponse
-
Declaration
Objective-C
@interface AWSIoTDeleteTopicRuleDestinationRequest
Swift
class AWSIoTDeleteTopicRuleDestinationRequest
-
Declaration
Objective-C
@interface AWSIoTDeleteTopicRuleDestinationResponse
Swift
class AWSIoTDeleteTopicRuleDestinationResponse
-
Declaration
Objective-C
@interface AWSIoTDeleteTopicRuleRequest
Swift
class AWSIoTDeleteTopicRuleRequest
-
Declaration
Objective-C
@interface AWSIoTDeleteV2LoggingLevelRequest
Swift
class AWSIoTDeleteV2LoggingLevelRequest
-
Contains information that denied the authorization.
See moreDeclaration
Objective-C
@interface AWSIoTDenied
Swift
class AWSIoTDenied
-
Declaration
Objective-C
@interface AWSIoTDeprecateThingTypeRequest
Swift
class AWSIoTDeprecateThingTypeRequest
-
The output for the DeprecateThingType operation.
Declaration
Objective-C
@interface AWSIoTDeprecateThingTypeResponse
Swift
class AWSIoTDeprecateThingTypeResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeAccountAuditConfigurationRequest
Swift
class AWSIoTDescribeAccountAuditConfigurationRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeAccountAuditConfigurationResponse
Swift
class AWSIoTDescribeAccountAuditConfigurationResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeAuditFindingRequest
Swift
class AWSIoTDescribeAuditFindingRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeAuditFindingResponse
Swift
class AWSIoTDescribeAuditFindingResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeAuditMitigationActionsTaskRequest
Swift
class AWSIoTDescribeAuditMitigationActionsTaskRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeAuditMitigationActionsTaskResponse
Swift
class AWSIoTDescribeAuditMitigationActionsTaskResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeAuditSuppressionRequest
Swift
class AWSIoTDescribeAuditSuppressionRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeAuditSuppressionResponse
Swift
class AWSIoTDescribeAuditSuppressionResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeAuditTaskRequest
Swift
class AWSIoTDescribeAuditTaskRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeAuditTaskResponse
Swift
class AWSIoTDescribeAuditTaskResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeAuthorizerRequest
Swift
class AWSIoTDescribeAuthorizerRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeAuthorizerResponse
Swift
class AWSIoTDescribeAuthorizerResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeBillingGroupRequest
Swift
class AWSIoTDescribeBillingGroupRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeBillingGroupResponse
Swift
class AWSIoTDescribeBillingGroupResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeCACertificateRequest
Swift
class AWSIoTDescribeCACertificateRequest
-
The output from the DescribeCACertificate operation.
See moreDeclaration
Objective-C
@interface AWSIoTDescribeCACertificateResponse
Swift
class AWSIoTDescribeCACertificateResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeCertificateProviderRequest
Swift
class AWSIoTDescribeCertificateProviderRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeCertificateProviderResponse
Swift
class AWSIoTDescribeCertificateProviderResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeCertificateRequest
Swift
class AWSIoTDescribeCertificateRequest
-
The output of the DescribeCertificate operation.
See moreDeclaration
Objective-C
@interface AWSIoTDescribeCertificateResponse
Swift
class AWSIoTDescribeCertificateResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeCustomMetricRequest
Swift
class AWSIoTDescribeCustomMetricRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeCustomMetricResponse
Swift
class AWSIoTDescribeCustomMetricResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeDefaultAuthorizerRequest
Swift
class AWSIoTDescribeDefaultAuthorizerRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeDefaultAuthorizerResponse
Swift
class AWSIoTDescribeDefaultAuthorizerResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeDetectMitigationActionsTaskRequest
Swift
class AWSIoTDescribeDetectMitigationActionsTaskRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeDetectMitigationActionsTaskResponse
Swift
class AWSIoTDescribeDetectMitigationActionsTaskResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeDimensionRequest
Swift
class AWSIoTDescribeDimensionRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeDimensionResponse
Swift
class AWSIoTDescribeDimensionResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeDomainConfigurationRequest
Swift
class AWSIoTDescribeDomainConfigurationRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeDomainConfigurationResponse
Swift
class AWSIoTDescribeDomainConfigurationResponse
-
The input for the DescribeEndpoint operation.
See moreDeclaration
Objective-C
@interface AWSIoTDescribeEndpointRequest
Swift
class AWSIoTDescribeEndpointRequest
-
The output from the DescribeEndpoint operation.
See moreDeclaration
Objective-C
@interface AWSIoTDescribeEndpointResponse
Swift
class AWSIoTDescribeEndpointResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeEventConfigurationsRequest
Swift
class AWSIoTDescribeEventConfigurationsRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeEventConfigurationsResponse
Swift
class AWSIoTDescribeEventConfigurationsResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeFleetMetricRequest
Swift
class AWSIoTDescribeFleetMetricRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeFleetMetricResponse
Swift
class AWSIoTDescribeFleetMetricResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeIndexRequest
Swift
class AWSIoTDescribeIndexRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeIndexResponse
Swift
class AWSIoTDescribeIndexResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeJobExecutionRequest
Swift
class AWSIoTDescribeJobExecutionRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeJobExecutionResponse
Swift
class AWSIoTDescribeJobExecutionResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeJobRequest
Swift
class AWSIoTDescribeJobRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeJobResponse
Swift
class AWSIoTDescribeJobResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeJobTemplateRequest
Swift
class AWSIoTDescribeJobTemplateRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeJobTemplateResponse
Swift
class AWSIoTDescribeJobTemplateResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeManagedJobTemplateRequest
Swift
class AWSIoTDescribeManagedJobTemplateRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeManagedJobTemplateResponse
Swift
class AWSIoTDescribeManagedJobTemplateResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeMitigationActionRequest
Swift
class AWSIoTDescribeMitigationActionRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeMitigationActionResponse
Swift
class AWSIoTDescribeMitigationActionResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeProvisioningTemplateRequest
Swift
class AWSIoTDescribeProvisioningTemplateRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeProvisioningTemplateResponse
Swift
class AWSIoTDescribeProvisioningTemplateResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeProvisioningTemplateVersionRequest
Swift
class AWSIoTDescribeProvisioningTemplateVersionRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeProvisioningTemplateVersionResponse
Swift
class AWSIoTDescribeProvisioningTemplateVersionResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeRoleAliasRequest
Swift
class AWSIoTDescribeRoleAliasRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeRoleAliasResponse
Swift
class AWSIoTDescribeRoleAliasResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeScheduledAuditRequest
Swift
class AWSIoTDescribeScheduledAuditRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeScheduledAuditResponse
Swift
class AWSIoTDescribeScheduledAuditResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeSecurityProfileRequest
Swift
class AWSIoTDescribeSecurityProfileRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeSecurityProfileResponse
Swift
class AWSIoTDescribeSecurityProfileResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeStreamRequest
Swift
class AWSIoTDescribeStreamRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeStreamResponse
Swift
class AWSIoTDescribeStreamResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeThingGroupRequest
Swift
class AWSIoTDescribeThingGroupRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeThingGroupResponse
Swift
class AWSIoTDescribeThingGroupResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeThingRegistrationTaskRequest
Swift
class AWSIoTDescribeThingRegistrationTaskRequest
-
Declaration
Objective-C
@interface AWSIoTDescribeThingRegistrationTaskResponse
Swift
class AWSIoTDescribeThingRegistrationTaskResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeThingRequest
Swift
class AWSIoTDescribeThingRequest
-
The output from the DescribeThing operation.
See moreDeclaration
Objective-C
@interface AWSIoTDescribeThingResponse
Swift
class AWSIoTDescribeThingResponse
-
Declaration
Objective-C
@interface AWSIoTDescribeThingTypeRequest
Swift
class AWSIoTDescribeThingTypeRequest
-
The output for the DescribeThingType operation.
See moreDeclaration
Objective-C
@interface AWSIoTDescribeThingTypeResponse
Swift
class AWSIoTDescribeThingTypeResponse
-
Describes the location of the updated firmware.
See moreDeclaration
Objective-C
@interface AWSIoTDestination
Swift
class AWSIoTDestination
-
Declaration
Objective-C
@interface AWSIoTDetachPolicyRequest
Swift
class AWSIoTDetachPolicyRequest
-
The input for the DetachPrincipalPolicy operation.
Required parameters: [policyName, principal]
See moreDeclaration
Objective-C
@interface AWSIoTDetachPrincipalPolicyRequest
Swift
class AWSIoTDetachPrincipalPolicyRequest
-
Declaration
Objective-C
@interface AWSIoTDetachSecurityProfileRequest
Swift
class AWSIoTDetachSecurityProfileRequest
-
Declaration
Objective-C
@interface AWSIoTDetachSecurityProfileResponse
Swift
class AWSIoTDetachSecurityProfileResponse
-
The input for the DetachThingPrincipal operation.
Required parameters: [thingName, principal]
See moreDeclaration
Objective-C
@interface AWSIoTDetachThingPrincipalRequest
Swift
class AWSIoTDetachThingPrincipalRequest
-
The output from the DetachThingPrincipal operation.
Declaration
Objective-C
@interface AWSIoTDetachThingPrincipalResponse
Swift
class AWSIoTDetachThingPrincipalResponse
-
Describes which mitigation actions should be executed.
See moreDeclaration
Objective-C
@interface AWSIoTDetectMitigationActionExecution
Swift
class AWSIoTDetectMitigationActionExecution
-
The statistics of a mitigation action task.
See moreDeclaration
Objective-C
@interface AWSIoTDetectMitigationActionsTaskStatistics
Swift
class AWSIoTDetectMitigationActionsTaskStatistics
-
The summary of the mitigation action tasks.
See moreDeclaration
Objective-C
@interface AWSIoTDetectMitigationActionsTaskSummary
Swift
class AWSIoTDetectMitigationActionsTaskSummary
-
The target of a mitigation action task.
See moreDeclaration
Objective-C
@interface AWSIoTDetectMitigationActionsTaskTarget
Swift
class AWSIoTDetectMitigationActionsTaskTarget
-
Declaration
Objective-C
@interface AWSIoTDisableTopicRuleRequest
Swift
class AWSIoTDisableTopicRuleRequest
-
A map of key-value pairs containing the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.
See moredocumentParameters
can only be used when creating jobs from Amazon Web Services managed templates. This parameter can’t be used with custom job templates or to create jobs from them.Declaration
Objective-C
@interface AWSIoTDocumentParameter
Swift
class AWSIoTDocumentParameter
-
The summary of a domain configuration. A domain configuration specifies custom IoT-specific information about a domain. A domain configuration can be associated with an Amazon Web Services-managed domain (for example, dbc123defghijk.iot.us-west-2.amazonaws.com), a customer managed domain, or a default endpoint.
Data
Jobs
CredentialProvider
Declaration
Objective-C
@interface AWSIoTDomainConfigurationSummary
Swift
class AWSIoTDomainConfigurationSummary
-
Describes an action to write to a DynamoDB table.
The
tableName
,hashKeyField
, andrangeKeyField
values must match the values used when you created the table.The
hashKeyValue
andrangeKeyvalue
fields use a substitution template syntax. These templates provide data at runtime. The syntax is as follows: ${sql-expression}.You can specify any valid expression in a WHERE or SELECT clause, including JSON properties, comparisons, calculations, and functions. For example, the following field uses the third level of the topic:
"hashKeyValue": "${topic(3)}"
The following field uses the timestamp:
"rangeKeyValue": "${timestamp()}"
Required parameters: [tableName, roleArn, hashKeyField, hashKeyValue]
See moreDeclaration
Objective-C
@interface AWSIoTDynamoDBAction
Swift
class AWSIoTDynamoDBAction
-
Describes an action to write to a DynamoDB table.
This DynamoDB action writes each attribute in the message payload into it’s own column in the DynamoDB table.
Required parameters: [roleArn, putItem]
See moreDeclaration
Objective-C
@interface AWSIoTDynamoDBv2Action
Swift
class AWSIoTDynamoDBv2Action
-
The policy that has the effect on the authorization results.
See moreDeclaration
Objective-C
@interface AWSIoTEffectivePolicy
Swift
class AWSIoTEffectivePolicy
-
Describes an action that writes data to an Amazon OpenSearch Service domain.
Required parameters: [roleArn, endpoint, index, type, id] See moreThe
Elasticsearch
action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use theOpenSearch
rule action instead. For more information, see OpenSearchAction.Declaration
Objective-C
@interface AWSIoTElasticsearchAction
Swift
class AWSIoTElasticsearchAction
-
Parameters used when defining a mitigation action that enable Amazon Web Services IoT Core logging.
Required parameters: [roleArnForLogging, logLevel]
See moreDeclaration
Objective-C
@interface AWSIoTEnableIoTLoggingParams
Swift
class AWSIoTEnableIoTLoggingParams
-
Declaration
Objective-C
@interface AWSIoTEnableTopicRuleRequest
Swift
class AWSIoTEnableTopicRuleRequest
-
Error information.
See moreDeclaration
Objective-C
@interface AWSIoTErrorInfo
Swift
class AWSIoTErrorInfo
-
Information that explicitly denies authorization.
See moreDeclaration
Objective-C
@interface AWSIoTExplicitDeny
Swift
class AWSIoTExplicitDeny
-
Allows you to create an exponential rate of rollout for a job.
Required parameters: [baseRatePerMinute, incrementFactor, rateIncreaseCriteria]
See moreDeclaration
Objective-C
@interface AWSIoTExponentialRolloutRate
Swift
class AWSIoTExponentialRolloutRate
-
Describes the name and data type at a field.
See moreDeclaration
Objective-C
@interface AWSIoTField
Swift
class AWSIoTField
-
The location of the OTA update.
See moreDeclaration
Objective-C
@interface AWSIoTFileLocation
Swift
class AWSIoTFileLocation
-
Describes an action that writes data to an Amazon Kinesis Firehose stream.
Required parameters: [roleArn, deliveryStreamName]
See moreDeclaration
Objective-C
@interface AWSIoTFirehoseAction
Swift
class AWSIoTFirehoseAction
-
The name and ARN of a fleet metric.
See moreDeclaration
Objective-C
@interface AWSIoTFleetMetricNameAndArn
Swift
class AWSIoTFleetMetricNameAndArn
-
A geolocation target that you select to index. Each geolocation target contains a
See morename
andorder
key-value pair that specifies the geolocation target fields.Declaration
Objective-C
@interface AWSIoTGeoLocationTarget
Swift
class AWSIoTGeoLocationTarget
-
Declaration
Objective-C
@interface AWSIoTGetBehaviorModelTrainingSummariesRequest
Swift
class AWSIoTGetBehaviorModelTrainingSummariesRequest
-
Declaration
Objective-C
@interface AWSIoTGetBehaviorModelTrainingSummariesResponse
Swift
class AWSIoTGetBehaviorModelTrainingSummariesResponse
-
Declaration
Objective-C
@interface AWSIoTGetBucketsAggregationRequest
Swift
class AWSIoTGetBucketsAggregationRequest
-
Declaration
Objective-C
@interface AWSIoTGetBucketsAggregationResponse
Swift
class AWSIoTGetBucketsAggregationResponse
-
Declaration
Objective-C
@interface AWSIoTGetCardinalityRequest
Swift
class AWSIoTGetCardinalityRequest
-
Declaration
Objective-C
@interface AWSIoTGetCardinalityResponse
Swift
class AWSIoTGetCardinalityResponse
-
Declaration
Objective-C
@interface AWSIoTGetEffectivePoliciesRequest
Swift
class AWSIoTGetEffectivePoliciesRequest
-
Declaration
Objective-C
@interface AWSIoTGetEffectivePoliciesResponse
Swift
class AWSIoTGetEffectivePoliciesResponse
-
Declaration
Objective-C
@interface AWSIoTGetIndexingConfigurationRequest
Swift
class AWSIoTGetIndexingConfigurationRequest
-
Declaration
Objective-C
@interface AWSIoTGetIndexingConfigurationResponse
Swift
class AWSIoTGetIndexingConfigurationResponse
-
Declaration
Objective-C
@interface AWSIoTGetJobDocumentRequest
Swift
class AWSIoTGetJobDocumentRequest
-
Declaration
Objective-C
@interface AWSIoTGetJobDocumentResponse
Swift
class AWSIoTGetJobDocumentResponse
-
The input for the GetLoggingOptions operation.
Declaration
Objective-C
@interface AWSIoTGetLoggingOptionsRequest
Swift
class AWSIoTGetLoggingOptionsRequest
-
The output from the GetLoggingOptions operation.
See moreDeclaration
Objective-C
@interface AWSIoTGetLoggingOptionsResponse
Swift
class AWSIoTGetLoggingOptionsResponse
-
Declaration
Objective-C
@interface AWSIoTGetOTAUpdateRequest
Swift
class AWSIoTGetOTAUpdateRequest
-
Declaration
Objective-C
@interface AWSIoTGetOTAUpdateResponse
Swift
class AWSIoTGetOTAUpdateResponse
-
Declaration
Objective-C
@interface AWSIoTGetPackageConfigurationRequest
Swift
class AWSIoTGetPackageConfigurationRequest
-
Declaration
Objective-C
@interface AWSIoTGetPackageConfigurationResponse
Swift
class AWSIoTGetPackageConfigurationResponse
-
Declaration
Objective-C
@interface AWSIoTGetPackageRequest
Swift
class AWSIoTGetPackageRequest
-
Declaration
Objective-C
@interface AWSIoTGetPackageResponse
Swift
class AWSIoTGetPackageResponse
-
Declaration
Objective-C
@interface AWSIoTGetPackageVersionRequest
Swift
class AWSIoTGetPackageVersionRequest
-
Declaration
Objective-C
@interface AWSIoTGetPackageVersionResponse
Swift
class AWSIoTGetPackageVersionResponse
-
Declaration
Objective-C
@interface AWSIoTGetPercentilesRequest
Swift
class AWSIoTGetPercentilesRequest
-
Declaration
Objective-C
@interface AWSIoTGetPercentilesResponse
Swift
class AWSIoTGetPercentilesResponse
-
Declaration
Objective-C
@interface AWSIoTGetPolicyRequest
Swift
class AWSIoTGetPolicyRequest
-
The output from the GetPolicy operation.
See moreDeclaration
Objective-C
@interface AWSIoTGetPolicyResponse
Swift
class AWSIoTGetPolicyResponse
-
The input for the GetPolicyVersion operation.
Required parameters: [policyName, policyVersionId]
See moreDeclaration
Objective-C
@interface AWSIoTGetPolicyVersionRequest
Swift
class AWSIoTGetPolicyVersionRequest
-
The output from the GetPolicyVersion operation.
See moreDeclaration
Objective-C
@interface AWSIoTGetPolicyVersionResponse
Swift
class AWSIoTGetPolicyVersionResponse
-
The input to the GetRegistrationCode operation.
Declaration
Objective-C
@interface AWSIoTGetRegistrationCodeRequest
Swift
class AWSIoTGetRegistrationCodeRequest
-
The output from the GetRegistrationCode operation.
See moreDeclaration
Objective-C
@interface AWSIoTGetRegistrationCodeResponse
Swift
class AWSIoTGetRegistrationCodeResponse
-
Declaration
Objective-C
@interface AWSIoTGetStatisticsRequest
Swift
class AWSIoTGetStatisticsRequest
-
Declaration
Objective-C
@interface AWSIoTGetStatisticsResponse
Swift
class AWSIoTGetStatisticsResponse
-
Declaration
Objective-C
@interface AWSIoTGetTopicRuleDestinationRequest
Swift
class AWSIoTGetTopicRuleDestinationRequest
-
Declaration
Objective-C
@interface AWSIoTGetTopicRuleDestinationResponse
Swift
class AWSIoTGetTopicRuleDestinationResponse
-
Declaration
Objective-C
@interface AWSIoTGetTopicRuleRequest
Swift
class AWSIoTGetTopicRuleRequest
-
The output from the GetTopicRule operation.
See moreDeclaration
Objective-C
@interface AWSIoTGetTopicRuleResponse
Swift
class AWSIoTGetTopicRuleResponse
-
Declaration
Objective-C
@interface AWSIoTGetV2LoggingOptionsRequest
Swift
class AWSIoTGetV2LoggingOptionsRequest
-
Declaration
Objective-C
@interface AWSIoTGetV2LoggingOptionsResponse
Swift
class AWSIoTGetV2LoggingOptionsResponse
-
The name and ARN of a group.
See moreDeclaration
Objective-C
@interface AWSIoTGroupNameAndArn
Swift
class AWSIoTGroupNameAndArn
-
Declaration
Objective-C
@interface AWSIoTHttpAction
Swift
class AWSIoTHttpAction
-
Declaration
Objective-C
@interface AWSIoTHttpActionHeader
Swift
class AWSIoTHttpActionHeader
-
The authorization method used to send messages.
See moreDeclaration
Objective-C
@interface AWSIoTHttpAuthorization
Swift
class AWSIoTHttpAuthorization
-
Specifies the HTTP context to use for the test authorizer request.
See moreDeclaration
Objective-C
@interface AWSIoTHttpContext
Swift
class AWSIoTHttpContext
-
HTTP URL destination configuration used by the topic rule’s HTTP action.
Required parameters: [confirmationUrl]
See moreDeclaration
Objective-C
@interface AWSIoTHttpUrlDestinationConfiguration
Swift
class AWSIoTHttpUrlDestinationConfiguration
-
HTTP URL destination properties.
See moreDeclaration
Objective-C
@interface AWSIoTHttpUrlDestinationProperties
Swift
class AWSIoTHttpUrlDestinationProperties
-
Information about an HTTP URL destination.
See moreDeclaration
Objective-C
@interface AWSIoTHttpUrlDestinationSummary
Swift
class AWSIoTHttpUrlDestinationSummary
-
Information that implicitly denies authorization. When policy doesn’t explicitly deny or allow an action on a resource it is considered an implicit deny.
See moreDeclaration
Objective-C
@interface AWSIoTImplicitDeny
Swift
class AWSIoTImplicitDeny
-
Provides additional selections for named shadows and geolocation data.
To add named shadows to your fleet indexing configuration, set
namedShadowIndexingMode
to be ON and specify your shadow names innamedShadowNames
filter.To add geolocation data to your fleet indexing configuration:
If you store geolocation data in a class/unnamed shadow, set
thingIndexingMode
to beREGISTRY_AND_SHADOW
and specify your geolocation data ingeoLocations
filter.If you store geolocation data in a named shadow, set
namedShadowIndexingMode
to beON
, add the shadow name innamedShadowNames
filter, and specify your geolocation data ingeoLocations
filter. For more information, see Managing fleet indexing.
Declaration
Objective-C
@interface AWSIoTIndexingFilter
Swift
class AWSIoTIndexingFilter
-
Sends message data to an IoT Analytics channel.
See moreDeclaration
Objective-C
@interface AWSIoTIotAnalyticsAction
Swift
class AWSIoTIotAnalyticsAction
-
Declaration
Objective-C
@interface AWSIoTIotEventsAction
Swift
class AWSIoTIotEventsAction
-
Describes an action to send data from an MQTT message that triggered the rule to IoT SiteWise asset properties.
Required parameters: [putAssetPropertyValueEntries, roleArn]
See moreDeclaration
Objective-C
@interface AWSIoTIotSiteWiseAction
Swift
class AWSIoTIotSiteWiseAction
-
The certificate issuer indentifier.
See moreDeclaration
Objective-C
@interface AWSIoTIssuerCertificateIdentifier
Swift
class AWSIoTIssuerCertificateIdentifier
-
The
See moreJob
object contains details about a job.Declaration
Objective-C
@interface AWSIoTJob
Swift
class AWSIoTJob
-
The job execution object represents the execution of a job on a particular device.
See moreDeclaration
Objective-C
@interface AWSIoTJobExecution
Swift
class AWSIoTJobExecution
-
Details of the job execution status.
See moreDeclaration
Objective-C
@interface AWSIoTJobExecutionStatusDetails
Swift
class AWSIoTJobExecutionStatusDetails
-
The job execution summary.
See moreDeclaration
Objective-C
@interface AWSIoTJobExecutionSummary
Swift
class AWSIoTJobExecutionSummary
-
Contains a summary of information about job executions for a specific job.
See moreDeclaration
Objective-C
@interface AWSIoTJobExecutionSummaryForJob
Swift
class AWSIoTJobExecutionSummaryForJob
-
The job execution summary for a thing.
See moreDeclaration
Objective-C
@interface AWSIoTJobExecutionSummaryForThing
Swift
class AWSIoTJobExecutionSummaryForThing
-
The configuration that determines how many retries are allowed for each failure type for a job.
Required parameters: [criteriaList]
See moreDeclaration
Objective-C
@interface AWSIoTJobExecutionsRetryConfig
Swift
class AWSIoTJobExecutionsRetryConfig
-
Allows you to create a staged rollout of a job.
See moreDeclaration
Objective-C
@interface AWSIoTJobExecutionsRolloutConfig
Swift
class AWSIoTJobExecutionsRolloutConfig
-
The job process details.
See moreDeclaration
Objective-C
@interface AWSIoTJobProcessDetails
Swift
class AWSIoTJobProcessDetails
-
The job summary.
See moreDeclaration
Objective-C
@interface AWSIoTJobSummary
Swift
class AWSIoTJobSummary
-
An object that contains information about the job template.
See moreDeclaration
Objective-C
@interface AWSIoTJobTemplateSummary
Swift
class AWSIoTJobTemplateSummary
-
Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
Required parameters: [destinationArn, topic, clientProperties]
See moreDeclaration
Objective-C
@interface AWSIoTKafkaAction
Swift
class AWSIoTKafkaAction
-
Specifies a Kafka header using key-value pairs when you create a Rule’s Kafka Action. You can use these headers to route data from IoT clients to downstream Kafka clusters without modifying your message payload.
For more information about Rule’s Kafka action, see Apache Kafka.
Required parameters: [key, value]
See moreDeclaration
Objective-C
@interface AWSIoTKafkaActionHeader
Swift
class AWSIoTKafkaActionHeader
-
Describes a key pair.
See moreDeclaration
Objective-C
@interface AWSIoTKeyPair
Swift
class AWSIoTKeyPair
-
Describes an action to write data to an Amazon Kinesis stream.
Required parameters: [roleArn, streamName]
See moreDeclaration
Objective-C
@interface AWSIoTKinesisAction
Swift
class AWSIoTKinesisAction
-
Declaration
Objective-C
@interface AWSIoTLambdaAction
Swift
class AWSIoTLambdaAction
-
Declaration
Objective-C
@interface AWSIoTListActiveViolationsRequest
Swift
class AWSIoTListActiveViolationsRequest
-
Declaration
Objective-C
@interface AWSIoTListActiveViolationsResponse
Swift
class AWSIoTListActiveViolationsResponse
-
Declaration
Objective-C
@interface AWSIoTListAttachedPoliciesRequest
Swift
class AWSIoTListAttachedPoliciesRequest
-
Declaration
Objective-C
@interface AWSIoTListAttachedPoliciesResponse
Swift
class AWSIoTListAttachedPoliciesResponse
-
Declaration
Objective-C
@interface AWSIoTListAuditFindingsRequest
Swift
class AWSIoTListAuditFindingsRequest
-
Declaration
Objective-C
@interface AWSIoTListAuditFindingsResponse
Swift
class AWSIoTListAuditFindingsResponse
-
Declaration
Objective-C
@interface AWSIoTListAuditMitigationActionsExecutionsRequest
Swift
class AWSIoTListAuditMitigationActionsExecutionsRequest
-
Declaration
Objective-C
@interface AWSIoTListAuditMitigationActionsExecutionsResponse
Swift
class AWSIoTListAuditMitigationActionsExecutionsResponse
-
Declaration
Objective-C
@interface AWSIoTListAuditMitigationActionsTasksRequest
Swift
class AWSIoTListAuditMitigationActionsTasksRequest
-
Declaration
Objective-C
@interface AWSIoTListAuditMitigationActionsTasksResponse
Swift
class AWSIoTListAuditMitigationActionsTasksResponse
-
Declaration
Objective-C
@interface AWSIoTListAuditSuppressionsRequest
Swift
class AWSIoTListAuditSuppressionsRequest
-
Declaration
Objective-C
@interface AWSIoTListAuditSuppressionsResponse
Swift
class AWSIoTListAuditSuppressionsResponse
-
Declaration
Objective-C
@interface AWSIoTListAuditTasksRequest
Swift
class AWSIoTListAuditTasksRequest
-
Declaration
Objective-C
@interface AWSIoTListAuditTasksResponse
Swift
class AWSIoTListAuditTasksResponse
-
Declaration
Objective-C
@interface AWSIoTListAuthorizersRequest
Swift
class AWSIoTListAuthorizersRequest
-
Declaration
Objective-C
@interface AWSIoTListAuthorizersResponse
Swift
class AWSIoTListAuthorizersResponse
-
Declaration
Objective-C
@interface AWSIoTListBillingGroupsRequest
Swift
class AWSIoTListBillingGroupsRequest
-
Declaration
Objective-C
@interface AWSIoTListBillingGroupsResponse
Swift
class AWSIoTListBillingGroupsResponse
-
Input for the ListCACertificates operation.
See moreDeclaration
Objective-C
@interface AWSIoTListCACertificatesRequest
Swift
class AWSIoTListCACertificatesRequest
-
The output from the ListCACertificates operation.
See moreDeclaration
Objective-C
@interface AWSIoTListCACertificatesResponse
Swift
class AWSIoTListCACertificatesResponse
-
Declaration
Objective-C
@interface AWSIoTListCertificateProvidersRequest
Swift
class AWSIoTListCertificateProvidersRequest
-
Declaration
Objective-C
@interface AWSIoTListCertificateProvidersResponse
Swift
class AWSIoTListCertificateProvidersResponse
-
Declaration
Objective-C
@interface AWSIoTListCertificatesByCARequest
Swift
class AWSIoTListCertificatesByCARequest
-
The output of the ListCertificatesByCA operation.
See moreDeclaration
Objective-C
@interface AWSIoTListCertificatesByCAResponse
Swift
class AWSIoTListCertificatesByCAResponse
-
The input for the ListCertificates operation.
See moreDeclaration
Objective-C
@interface AWSIoTListCertificatesRequest
Swift
class AWSIoTListCertificatesRequest
-
The output of the ListCertificates operation.
See moreDeclaration
Objective-C
@interface AWSIoTListCertificatesResponse
Swift
class AWSIoTListCertificatesResponse
-
Declaration
Objective-C
@interface AWSIoTListCustomMetricsRequest
Swift
class AWSIoTListCustomMetricsRequest
-
Declaration
Objective-C
@interface AWSIoTListCustomMetricsResponse
Swift
class AWSIoTListCustomMetricsResponse
-
Declaration
Objective-C
@interface AWSIoTListDetectMitigationActionsExecutionsRequest
Swift
class AWSIoTListDetectMitigationActionsExecutionsRequest
-
Declaration
Objective-C
@interface AWSIoTListDetectMitigationActionsExecutionsResponse
Swift
class AWSIoTListDetectMitigationActionsExecutionsResponse
-
Declaration
Objective-C
@interface AWSIoTListDetectMitigationActionsTasksRequest
Swift
class AWSIoTListDetectMitigationActionsTasksRequest
-
Declaration
Objective-C
@interface AWSIoTListDetectMitigationActionsTasksResponse
Swift
class AWSIoTListDetectMitigationActionsTasksResponse
-
Declaration
Objective-C
@interface AWSIoTListDimensionsRequest
Swift
class AWSIoTListDimensionsRequest
-
Declaration
Objective-C
@interface AWSIoTListDimensionsResponse
Swift
class AWSIoTListDimensionsResponse
-
Declaration
Objective-C
@interface AWSIoTListDomainConfigurationsRequest
Swift
class AWSIoTListDomainConfigurationsRequest
-
Declaration
Objective-C
@interface AWSIoTListDomainConfigurationsResponse
Swift
class AWSIoTListDomainConfigurationsResponse
-
Declaration
Objective-C
@interface AWSIoTListFleetMetricsRequest
Swift
class AWSIoTListFleetMetricsRequest
-
Declaration
Objective-C
@interface AWSIoTListFleetMetricsResponse
Swift
class AWSIoTListFleetMetricsResponse
-
Declaration
Objective-C
@interface AWSIoTListIndicesRequest
Swift
class AWSIoTListIndicesRequest
-
Declaration
Objective-C
@interface AWSIoTListIndicesResponse
Swift
class AWSIoTListIndicesResponse
-
Declaration
Objective-C
@interface AWSIoTListJobExecutionsForJobRequest
Swift
class AWSIoTListJobExecutionsForJobRequest
-
Declaration
Objective-C
@interface AWSIoTListJobExecutionsForJobResponse
Swift
class AWSIoTListJobExecutionsForJobResponse
-
Declaration
Objective-C
@interface AWSIoTListJobExecutionsForThingRequest
Swift
class AWSIoTListJobExecutionsForThingRequest
-
Declaration
Objective-C
@interface AWSIoTListJobExecutionsForThingResponse
Swift
class AWSIoTListJobExecutionsForThingResponse
-
Declaration
Objective-C
@interface AWSIoTListJobTemplatesRequest
Swift
class AWSIoTListJobTemplatesRequest
-
Declaration
Objective-C
@interface AWSIoTListJobTemplatesResponse
Swift
class AWSIoTListJobTemplatesResponse
-
Declaration
Objective-C
@interface AWSIoTListJobsRequest
Swift
class AWSIoTListJobsRequest
-
Declaration
Objective-C
@interface AWSIoTListJobsResponse
Swift
class AWSIoTListJobsResponse
-
Declaration
Objective-C
@interface AWSIoTListManagedJobTemplatesRequest
Swift
class AWSIoTListManagedJobTemplatesRequest
-
Declaration
Objective-C
@interface AWSIoTListManagedJobTemplatesResponse
Swift
class AWSIoTListManagedJobTemplatesResponse
-
Declaration
Objective-C
@interface AWSIoTListMetricValuesRequest
Swift
class AWSIoTListMetricValuesRequest
-
Declaration
Objective-C
@interface AWSIoTListMetricValuesResponse
Swift
class AWSIoTListMetricValuesResponse
-
Declaration
Objective-C
@interface AWSIoTListMitigationActionsRequest
Swift
class AWSIoTListMitigationActionsRequest
-
Declaration
Objective-C
@interface AWSIoTListMitigationActionsResponse
Swift
class AWSIoTListMitigationActionsResponse
-
Declaration
Objective-C
@interface AWSIoTListOTAUpdatesRequest
Swift
class AWSIoTListOTAUpdatesRequest
-
Declaration
Objective-C
@interface AWSIoTListOTAUpdatesResponse
Swift
class AWSIoTListOTAUpdatesResponse
-
The input to the ListOutgoingCertificates operation.
See moreDeclaration
Objective-C
@interface AWSIoTListOutgoingCertificatesRequest
Swift
class AWSIoTListOutgoingCertificatesRequest
-
The output from the ListOutgoingCertificates operation.
See moreDeclaration
Objective-C
@interface AWSIoTListOutgoingCertificatesResponse
Swift
class AWSIoTListOutgoingCertificatesResponse
-
Declaration
Objective-C
@interface AWSIoTListPackageVersionsRequest
Swift
class AWSIoTListPackageVersionsRequest
-
Declaration
Objective-C
@interface AWSIoTListPackageVersionsResponse
Swift
class AWSIoTListPackageVersionsResponse
-
Declaration
Objective-C
@interface AWSIoTListPackagesRequest
Swift
class AWSIoTListPackagesRequest
-
Declaration
Objective-C
@interface AWSIoTListPackagesResponse
Swift
class AWSIoTListPackagesResponse
-
The input for the ListPolicies operation.
See moreDeclaration
Objective-C
@interface AWSIoTListPoliciesRequest
Swift
class AWSIoTListPoliciesRequest
-
The output from the ListPolicies operation.
See moreDeclaration
Objective-C
@interface AWSIoTListPoliciesResponse
Swift
class AWSIoTListPoliciesResponse
-
Declaration
Objective-C
@interface AWSIoTListPolicyPrincipalsRequest
Swift
class AWSIoTListPolicyPrincipalsRequest
-
The output from the ListPolicyPrincipals operation.
See moreDeclaration
Objective-C
@interface AWSIoTListPolicyPrincipalsResponse
Swift
class AWSIoTListPolicyPrincipalsResponse
-
Declaration
Objective-C
@interface AWSIoTListPolicyVersionsRequest
Swift
class AWSIoTListPolicyVersionsRequest
-
The output from the ListPolicyVersions operation.
See moreDeclaration
Objective-C
@interface AWSIoTListPolicyVersionsResponse
Swift
class AWSIoTListPolicyVersionsResponse
-
Declaration
Objective-C
@interface AWSIoTListPrincipalPoliciesRequest
Swift
class AWSIoTListPrincipalPoliciesRequest
-
The output from the ListPrincipalPolicies operation.
See moreDeclaration
Objective-C
@interface AWSIoTListPrincipalPoliciesResponse
Swift
class AWSIoTListPrincipalPoliciesResponse
-
Declaration
Objective-C
@interface AWSIoTListPrincipalThingsRequest
Swift
class AWSIoTListPrincipalThingsRequest
-
The output from the ListPrincipalThings operation.
See moreDeclaration
Objective-C
@interface AWSIoTListPrincipalThingsResponse
Swift
class AWSIoTListPrincipalThingsResponse
-
Declaration
Objective-C
@interface AWSIoTListProvisioningTemplateVersionsRequest
Swift
class AWSIoTListProvisioningTemplateVersionsRequest
-
Declaration
Objective-C
@interface AWSIoTListProvisioningTemplateVersionsResponse
Swift
class AWSIoTListProvisioningTemplateVersionsResponse
-
Declaration
Objective-C
@interface AWSIoTListProvisioningTemplatesRequest
Swift
class AWSIoTListProvisioningTemplatesRequest
-
Declaration
Objective-C
@interface AWSIoTListProvisioningTemplatesResponse
Swift
class AWSIoTListProvisioningTemplatesResponse
-
Declaration
Objective-C
@interface AWSIoTListRelatedResourcesForAuditFindingRequest
Swift
class AWSIoTListRelatedResourcesForAuditFindingRequest
-
Declaration
Objective-C
@interface AWSIoTListRelatedResourcesForAuditFindingResponse
Swift
class AWSIoTListRelatedResourcesForAuditFindingResponse
-
Declaration
Objective-C
@interface AWSIoTListRoleAliasesRequest
Swift
class AWSIoTListRoleAliasesRequest
-
Declaration
Objective-C
@interface AWSIoTListRoleAliasesResponse
Swift
class AWSIoTListRoleAliasesResponse
-
Declaration
Objective-C
@interface AWSIoTListScheduledAuditsRequest
Swift
class AWSIoTListScheduledAuditsRequest
-
Declaration
Objective-C
@interface AWSIoTListScheduledAuditsResponse
Swift
class AWSIoTListScheduledAuditsResponse
-
Declaration
Objective-C
@interface AWSIoTListSecurityProfilesForTargetRequest
Swift
class AWSIoTListSecurityProfilesForTargetRequest
-
Declaration
Objective-C
@interface AWSIoTListSecurityProfilesForTargetResponse
Swift
class AWSIoTListSecurityProfilesForTargetResponse
-
Declaration
Objective-C
@interface AWSIoTListSecurityProfilesRequest
Swift
class AWSIoTListSecurityProfilesRequest
-
Declaration
Objective-C
@interface AWSIoTListSecurityProfilesResponse
Swift
class AWSIoTListSecurityProfilesResponse
-
Declaration
Objective-C
@interface AWSIoTListStreamsRequest
Swift
class AWSIoTListStreamsRequest
-
Declaration
Objective-C
@interface AWSIoTListStreamsResponse
Swift
class AWSIoTListStreamsResponse
-
Declaration
Objective-C
@interface AWSIoTListTagsForResourceRequest
Swift
class AWSIoTListTagsForResourceRequest
-
Declaration
Objective-C
@interface AWSIoTListTagsForResourceResponse
Swift
class AWSIoTListTagsForResourceResponse
-
Declaration
Objective-C
@interface AWSIoTListTargetsForPolicyRequest
Swift
class AWSIoTListTargetsForPolicyRequest
-
Declaration
Objective-C
@interface AWSIoTListTargetsForPolicyResponse
Swift
class AWSIoTListTargetsForPolicyResponse
-