2025/03/04 - Managed integrations for AWS IoT Device Management - 57 new api methods
Changes Adding managed integrations APIs for IoT Device Management to setup and control devices across different manufacturers and connectivity protocols. APIs include managedthing operations, credential and provisioning profile management, notification configuration, and OTA update.
Get the over-the-air (OTA) task.
See also: AWS API Documentation
Request Syntax
client.get_ota_task(
Identifier='string'
)
string
[REQUIRED]
The over-the-air (OTA) task id.
dict
Response Syntax
{
'TaskId': 'string',
'TaskArn': 'string',
'Description': 'string',
'S3Url': 'string',
'Protocol': 'HTTP',
'OtaType': 'ONE_TIME'|'CONTINUOUS',
'OtaTargetQueryString': 'string',
'OtaMechanism': 'PUSH',
'Target': [
'string',
],
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'TaskConfigurationId': 'string',
'TaskProcessingDetails': {
'NumberOfCanceledThings': 123,
'NumberOfFailedThings': 123,
'NumberOfInProgressThings': 123,
'numberOfQueuedThings': 123,
'numberOfRejectedThings': 123,
'numberOfRemovedThings': 123,
'numberOfSucceededThings': 123,
'numberOfTimedOutThings': 123,
'processingTargets': [
'string',
]
},
'OtaSchedulingConfig': {
'EndBehavior': 'STOP_ROLLOUT'|'CANCEL'|'FORCE_CANCEL',
'EndTime': 'string',
'MaintenanceWindows': [
{
'DurationInMinutes': 123,
'StartTime': 'string'
},
],
'StartTime': 'string'
},
'OtaTaskExecutionRetryConfig': {
'RetryConfigCriteria': [
{
'FailureType': 'FAILED'|'TIMED_OUT'|'ALL',
'MinNumberOfRetries': 123
},
]
},
'Status': 'IN_PROGRESS'|'CANCELED'|'COMPLETED'|'DELETION_IN_PROGRESS'|'SCHEDULED'
}
Response Structure
(dict) --
TaskId (string) --
The id of the over-the-air (OTA) task.
TaskArn (string) --
The Amazon Resource Name (ARN) of the over-the-air (OTA) task
Description (string) --
The description of the over-the-air (OTA) task.
S3Url (string) --
The URL to the Amazon S3 bucket where the over-the-air (OTA) task is stored.
Protocol (string) --
The connection protocol the over-the-air (OTA) task uses to update the device.
OtaType (string) --
The frequency type for the over-the-air (OTA) task.
OtaTargetQueryString (string) --
The query string to add things to the thing group.
OtaMechanism (string) --
The deployment mechanism for the over-the-air (OTA) task.
Target (list) --
The device targeted for the over-the-air (OTA) task.
(string) --
CreatedAt (datetime) --
The timestamp value of when the over-the-air (OTA) task was created.
LastUpdatedAt (datetime) --
The timestamp value of when the over-the-air (OTA) task was last updated at.
TaskConfigurationId (string) --
The identifier for the over-the-air (OTA) task configuration.
TaskProcessingDetails (dict) --
The processing details of all over-the-air (OTA) tasks.
NumberOfCanceledThings (integer) --
The number of canceled things in an over-the-air (OTA) task.
NumberOfFailedThings (integer) --
The number of failed things in an over-the-air (OTA) task.
NumberOfInProgressThings (integer) --
The number of in progress things in an over-the-air (OTA) task.
numberOfQueuedThings (integer) --
The number of queued things in an over-the-air (OTA) task.
numberOfRejectedThings (integer) --
The number of rejected things in an over-the-air (OTA) task.
numberOfRemovedThings (integer) --
The number of removed things in an over-the-air (OTA) task.
numberOfSucceededThings (integer) --
The number of succeeded things in an over-the-air (OTA) task.
numberOfTimedOutThings (integer) --
The number of timed out things in an over-the-air (OTA) task.
processingTargets (list) --
The targets of the over-the-air (OTA) task.
(string) --
OtaSchedulingConfig (dict) --
Over-the-air (OTA) task scheduling config.
EndBehavior (string) --
Specifies the end behavior for all task executions after a task reaches the selected endTime. If endTime is not selected when creating the task, then endBehavior does not apply.
EndTime (string) --
The time an over-the-air (OTA) task will stop.
MaintenanceWindows (list) --
Maintenance window list for over-the-air (OTA) task scheduling config.
(dict) --
Structure representing scheduling maintenance window.
DurationInMinutes (integer) --
Displays the duration of the next maintenance window.
StartTime (string) --
Displays the start time of the next maintenance window.
StartTime (string) --
The time an over-the-air (OTA) task will start.
OtaTaskExecutionRetryConfig (dict) --
Over-the-air (OTA) task retry config.
RetryConfigCriteria (list) --
The list of retry config criteria.
(dict) --
Structure representing one retry config criteria.
FailureType (string) --
Over-the-air (OTA) retry criteria failure type.
MinNumberOfRetries (integer) --
The number of retries allowed for a failure type for the over-the-air (OTA) task.
Status (string) --
The status of the over-the-air (OTA) task.
Creates a notification configuration. A configuration is a connection between an event type and a destination that you have already created.
See also: AWS API Documentation
Request Syntax
client.create_notification_configuration(
EventType='DEVICE_COMMAND'|'DEVICE_COMMAND_REQUEST'|'DEVICE_EVENT'|'DEVICE_LIFE_CYCLE'|'DEVICE_STATE'|'DEVICE_OTA'|'CONNECTOR_ASSOCIATION'|'CONNECTOR_ERROR_REPORT',
DestinationName='string',
ClientToken='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The type of event triggering a device notification to the customer-managed destination.
string
[REQUIRED]
The name of the destination for the notification configuration.
string
An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
This field is autopopulated if not provided.
dict
A set of key/value pairs that are used to manage the notification configuration.
(string) --
(string) --
dict
Response Syntax
{
'EventType': 'DEVICE_COMMAND'|'DEVICE_COMMAND_REQUEST'|'DEVICE_EVENT'|'DEVICE_LIFE_CYCLE'|'DEVICE_STATE'|'DEVICE_OTA'|'CONNECTOR_ASSOCIATION'|'CONNECTOR_ERROR_REPORT'
}
Response Structure
(dict) --
EventType (string) --
The type of event triggering a device notification to the customer-managed destination.
Create a configuraiton for the over-the-air (OTA) task.
See also: AWS API Documentation
Request Syntax
client.create_ota_task_configuration(
Description='string',
Name='string',
PushConfig={
'AbortConfig': {
'AbortConfigCriteriaList': [
{
'Action': 'CANCEL',
'FailureType': 'FAILED'|'REJECTED'|'TIMED_OUT'|'ALL',
'MinNumberOfExecutedThings': 123,
'ThresholdPercentage': 123.0
},
]
},
'RolloutConfig': {
'ExponentialRolloutRate': {
'BaseRatePerMinute': 123,
'IncrementFactor': 123.0,
'RateIncreaseCriteria': {
'numberOfNotifiedThings': 123,
'numberOfSucceededThings': 123
}
},
'MaximumPerMinute': 123
},
'TimeoutConfig': {
'InProgressTimeoutInMinutes': 123
}
},
ClientToken='string'
)
string
A description of the over-the-air (OTA) task configuration.
string
The name of the over-the-air (OTA) task.
dict
Describes the type of configuration used for the over-the-air (OTA) task.
AbortConfig (dict) --
Structure representing one abort config.
AbortConfigCriteriaList (list) --
The list of criteria for the abort config.
(dict) --
Structure representing one abort config criteria.
Action (string) --
The action taken by the abort configuration.
FailureType (string) --
Over-the-air (OTA) task abort criteria failure type.
MinNumberOfExecutedThings (integer) --
The minimum number of things that must receive task execution notifications before the task can be aborted.
ThresholdPercentage (float) --
The minimum percentage of over-the-air (OTA) task execution failures that must occur to initiate the last abort.
RolloutConfig (dict) --
Structure representing one rollout config.
ExponentialRolloutRate (dict) --
Structure representing exponential rate of rollout for an over-the-air (OTA) task.
BaseRatePerMinute (integer) --
The base rate per minute for the rollout of an over-the-air (OTA) task.
IncrementFactor (float) --
The incremental factor for increasing the rollout rate of an over-the-air (OTA) task.
RateIncreaseCriteria (dict) --
The criteria for increasing the rollout rate of an over-the-air (OTA) task.
numberOfNotifiedThings (integer) --
The threshold for number of notified things that will initiate the increase in rate of rollout.
numberOfSucceededThings (integer) --
The threshold for number of succeeded things that will initiate the increase in rate of rollout.
MaximumPerMinute (integer) --
The maximum number of things that will be notified of a pending task, per minute.
TimeoutConfig (dict) --
Structure representing one timeout config.
InProgressTimeoutInMinutes (integer) --
Specifies the amount of time the device has to finish execution of this task. The timeout interval can be anywhere between 1 minute and 7 days.
string
An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
This field is autopopulated if not provided.
dict
Response Syntax
{
'TaskConfigurationId': 'string'
}
Response Structure
(dict) --
TaskConfigurationId (string) --
The identifier of the over-the-air (OTA) task configuration.
Get the attributes and capabilities associated with a managed thing.
See also: AWS API Documentation
Request Syntax
client.get_managed_thing(
Identifier='string'
)
string
[REQUIRED]
The id of the managed thing.
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string',
'Owner': 'string',
'CredentialLockerId': 'string',
'AdvertisedProductId': 'string',
'Role': 'CONTROLLER'|'DEVICE',
'ProvisioningStatus': 'UNASSOCIATED'|'PRE_ASSOCIATED'|'DISCOVERED'|'ACTIVATED'|'DELETION_FAILED'|'DELETE_IN_PROGRESS'|'ISOLATED'|'DELETED',
'Name': 'string',
'Model': 'string',
'Brand': 'string',
'SerialNumber': 'string',
'UniversalProductCode': 'string',
'InternationalArticleNumber': 'string',
'ConnectorPolicyId': 'string',
'ConnectorDeviceId': 'string',
'DeviceSpecificKey': 'string',
'MacAddress': 'string',
'ParentControllerId': 'string',
'Classification': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'ActivatedAt': datetime(2015, 1, 1),
'HubNetworkMode': 'STANDARD'|'NETWORK_WIDE_EXCLUSION',
'MetaData': {
'string': 'string'
},
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Id (string) --
The id of the managed thing.
Arn (string) --
The Amazon Resource Name (ARN) of the managed thing.
Owner (string) --
Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.
CredentialLockerId (string) --
The identifier of the credential locker for the managed thing.
AdvertisedProductId (string) --
The id of the advertised product.
Role (string) --
The type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT device.
ProvisioningStatus (string) --
The provisioning status of the device in the provisioning workflow for onboarding to IoT managed integrations.
Name (string) --
The name of the managed thing representing the physical device.
Model (string) --
The model of the device.
Brand (string) --
The brand of the device.
SerialNumber (string) --
The serial number of the device.
UniversalProductCode (string) --
The universal product code (UPC) of the device model. The UPC is typically used in the United States of America and Canada.
InternationalArticleNumber (string) --
The unique 13 digit number that identifies the managed thing.
ConnectorPolicyId (string) --
The id of the connector policy.
ConnectorDeviceId (string) --
The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII).
DeviceSpecificKey (string) --
A Zwave device-specific key used during device activation.
MacAddress (string) --
The media access control (MAC) address for the device represented by the managed thing.
ParentControllerId (string) --
Id of the controller device used for the discovery job.
Classification (string) --
The classification of the managed thing such as light bulb or thermostat.
CreatedAt (datetime) --
The timestamp value of when the device creation request occurred.
UpdatedAt (datetime) --
The timestamp value of when the managed thing was last updated at.
ActivatedAt (datetime) --
The timestampe value of when the device was activated.
HubNetworkMode (string) --
The network mode for the hub-connected device.
MetaData (dict) --
The metadata for the managed thing.
(string) --
(string) --
Tags (dict) --
A set of key/value pairs that are used to manage the managed thing.
(string) --
(string) --
Get information on an existing credential locker
See also: AWS API Documentation
Request Syntax
client.get_credential_locker(
Identifier='string'
)
string
[REQUIRED]
The identifier of the credential locker.
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'CreatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Id (string) --
The identifier of the credential locker.
Arn (string) --
The Amazon Resource Name (ARN) of the credential locker.
Name (string) --
The name of the credential locker.
CreatedAt (datetime) --
The timestamp value of when the credential locker requset occurred.
Tags (dict) --
A set of key/value pairs that are used to manage the credential locker.
(string) --
(string) --
List all notification configurations.
See also: AWS API Documentation
Request Syntax
client.list_notification_configurations(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of results to return at one time.
string
A token that can be used to retrieve the next set of results.
dict
Response Syntax
{
'NotificationConfigurationList': [
{
'EventType': 'DEVICE_COMMAND'|'DEVICE_COMMAND_REQUEST'|'DEVICE_EVENT'|'DEVICE_LIFE_CYCLE'|'DEVICE_STATE'|'DEVICE_OTA'|'CONNECTOR_ASSOCIATION'|'CONNECTOR_ERROR_REPORT',
'DestinationName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
NotificationConfigurationList (list) --
The list of notification configurations.
(dict) --
Structure describing a notification configuration.
EventType (string) --
The type of event triggering a device notification to the customer-managed destination.
DestinationName (string) --
The name of the destination for the notification configuration.
NextToken (string) --
A token that can be used to retrieve the next set of results.
Delete a provisioning profile.
See also: AWS API Documentation
Request Syntax
client.delete_provisioning_profile(
Identifier='string'
)
string
[REQUIRED]
The name of the provisioning template.
None
Get a hub configuration.
See also: AWS API Documentation
Request Syntax
client.get_hub_configuration()
dict
Response Syntax
{
'HubTokenTimerExpirySettingInSeconds': 123,
'UpdatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
HubTokenTimerExpirySettingInSeconds (integer) --
A user-defined integer value that represents the hub token timer expiry setting in seconds.
UpdatedAt (datetime) --
The timestamp value of when the hub configuration was updated.
Get the capabilities for a managed thing using the device ID.
See also: AWS API Documentation
Request Syntax
client.get_managed_thing_capabilities(
Identifier='string'
)
string
[REQUIRED]
The id of the device.
dict
Response Syntax
{
'ManagedThingId': 'string',
'Capabilities': 'string',
'CapabilityReport': {
'version': 'string',
'nodeId': 'string',
'endpoints': [
{
'id': 'string',
'deviceTypes': [
'string',
],
'capabilities': [
{
'id': 'string',
'name': 'string',
'version': 'string',
'properties': [
'string',
],
'actions': [
'string',
],
'events': [
'string',
]
},
]
},
]
}
}
Response Structure
(dict) --
ManagedThingId (string) --
The id of the device.
Capabilities (string) --
The capabilities of the device such as light bulb.
CapabilityReport (dict) --
A report of the capabilities for the managed thing.
version (string) --
The version of the capability report.
nodeId (string) --
The numeric identifier of the node.
endpoints (list) --
The endpoints used in the capability report.
(dict) --
The endpoint used in the capability report.
id (string) --
The id of the endpoint used in the capability report.
deviceTypes (list) --
The type of device.
(string) --
capabilities (list) --
The capabilities used in the capability report.
(dict) --
The capability used in capability report.
id (string) --
The id of the schema version.
name (string) --
The name of the capability.
version (string) --
The version of the capability.
properties (list) --
The capability properties used in the capability report.
(string) --
actions (list) --
The capability actions used in the capability report.
(string) --
events (list) --
The capability events used in the capability report.
(string) --
Get an event log configuration.
See also: AWS API Documentation
Request Syntax
client.get_event_log_configuration(
Id='string'
)
string
[REQUIRED]
The identifier of the event log configuration.
dict
Response Syntax
{
'Id': 'string',
'ResourceType': 'string',
'ResourceId': 'string',
'EventLogLevel': 'DEBUG'|'ERROR'|'INFO'|'WARN'
}
Response Structure
(dict) --
Id (string) --
The identifier of the event log configuration.
ResourceType (string) --
The type of resource for the event log configuration.
ResourceId (string) --
The identifier of the resource for the event log configuration.
EventLogLevel (string) --
The logging level for the event log configuration.
Get a provisioning profile by template name.
See also: AWS API Documentation
Request Syntax
client.get_provisioning_profile(
Identifier='string'
)
string
[REQUIRED]
The provisioning template the device uses for the provisioning process.
dict
Response Syntax
{
'Arn': 'string',
'Name': 'string',
'ProvisioningType': 'FLEET_PROVISIONING'|'JITR',
'Id': 'string',
'ClaimCertificate': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the provisioning template used in the provisioning profile.
Name (string) --
The name of the provisioning template.
ProvisioningType (string) --
The type of provisioning workflow the device uses for onboarding to IoT managed integrations.
Id (string) --
The provisioning profile id..
ClaimCertificate (string) --
The id of the claim certificate.
Tags (dict) --
A set of key/value pairs that are used to manage the provisioning profile.
(string) --
(string) --
Set the event log configuration for the account, resource type, or specific resource.
See also: AWS API Documentation
Request Syntax
client.create_event_log_configuration(
ResourceType='string',
ResourceId='string',
EventLogLevel='DEBUG'|'ERROR'|'INFO'|'WARN',
ClientToken='string'
)
string
[REQUIRED]
The type of resource for the event log configuration.
string
The identifier of the resource for the event log configuration.
string
[REQUIRED]
The logging level for the event log configuration.
string
An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Id': 'string'
}
Response Structure
(dict) --
Id (string) --
The identifier of the event log configuration request.
Delete an event log configuration.
See also: AWS API Documentation
Request Syntax
client.delete_event_log_configuration(
Id='string'
)
string
[REQUIRED]
The identifier of the event log configuration.
None
Delete a managed thing. If a controller is deleted, all of the devices connected to it will have their status changed to PENDING. It is not possible to remove a cloud device.
See also: AWS API Documentation
Request Syntax
client.delete_managed_thing(
Identifier='string',
Force=True|False
)
string
[REQUIRED]
The id of the managed thing.
boolean
When set to TRUE, a forceful deteletion of the managed thing will occur. When set to FALSE, a non-forceful deletion of the managed thing will occur.
None
Create a destination. IoT managed integrations uses the destination to determine where to deliver notifications for a device.
See also: AWS API Documentation
Request Syntax
client.create_destination(
DeliveryDestinationArn='string',
DeliveryDestinationType='KINESIS',
Name='string',
RoleArn='string',
ClientToken='string',
Description='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the customer-managed destination.
string
[REQUIRED]
The destination type for the customer-managed destination.
string
[REQUIRED]
The name of the customer-managed destination.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the delivery destination role.
string
An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
This field is autopopulated if not provided.
string
The description of the customer-managed destination.
dict
A set of key/value pairs that are used to manage the destination.
(string) --
(string) --
dict
Response Syntax
{
'Name': 'string'
}
Response Structure
(dict) --
Name (string) --
The name of the customer-managed destination.
Gets a destination by ID.
See also: AWS API Documentation
Request Syntax
client.get_destination(
Name='string'
)
string
[REQUIRED]
The name of the customer-managed destination.
dict
Response Syntax
{
'Description': 'string',
'DeliveryDestinationArn': 'string',
'DeliveryDestinationType': 'KINESIS',
'Name': 'string',
'RoleArn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Description (string) --
The description of the customer-managed destination.
DeliveryDestinationArn (string) --
The Amazon Resource Name (ARN) of the customer-managed destination.
DeliveryDestinationType (string) --
The destination type for the customer-managed destination.
Name (string) --
The name of the customer-managed destination.
RoleArn (string) --
The Amazon Resource Name (ARN) of the delivery destination role.
CreatedAt (datetime) --
The timestamp value of when the destination creation requset occurred.
UpdatedAt (datetime) --
The timestamp value of when the destination update requset occurred.
Tags (dict) --
A set of key/value pairs that are used to manage the customer-managed destination.
(string) --
(string) --
Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the AWS IoT SiteWise User Guide.
See also: AWS API Documentation
Request Syntax
client.put_default_encryption_configuration(
encryptionType='MANAGED_INTEGRATIONS_DEFAULT_ENCRYPTION'|'CUSTOMER_KEY_ENCRYPTION',
kmsKeyArn='string'
)
string
[REQUIRED]
The type of encryption used for the encryption configuration.
string
The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption if you use KMS_BASED_ENCRYPTION.
dict
Response Syntax
{
'configurationStatus': {
'error': {
'code': 'string',
'message': 'string'
},
'state': 'ENABLED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'
},
'encryptionType': 'MANAGED_INTEGRATIONS_DEFAULT_ENCRYPTION'|'CUSTOMER_KEY_ENCRYPTION',
'kmsKeyArn': 'string'
}
Response Structure
(dict) --
configurationStatus (dict) --
Provides the status of the default encryption configuration for an Amazon Web Services account.
error (dict) --
The error details describing a failed default encryption configuration update.
code (string) --
The error code returned when the default encryption configuration update fails.
message (string) --
The error message returned when the default encryption configuration update fails.
state (string) --
The status state describing the default encryption configuration update.
encryptionType (string) --
The type of encryption used for the encryption configuration.
kmsKeyArn (string) --
The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption if you use KMS_BASED_ENCRYPTION.
Get the connectivity status of a managed thing.
See also: AWS API Documentation
Request Syntax
client.get_managed_thing_connectivity_data(
Identifier='string'
)
string
[REQUIRED]
The identifier of a managed thing.
dict
Response Syntax
{
'ManagedThingId': 'string',
'Connected': True|False,
'Timestamp': datetime(2015, 1, 1),
'DisconnectReason': 'AUTH_ERROR'|'CLIENT_INITIATED_DISCONNECT'|'CLIENT_ERROR'|'CONNECTION_LOST'|'DUPLICATE_CLIENTID'|'FORBIDDEN_ACCESS'|'MQTT_KEEP_ALIVE_TIMEOUT'|'SERVER_ERROR'|'SERVER_INITIATED_DISCONNECT'|'THROTTLED'|'WEBSOCKET_TTL_EXPIRATION'|'CUSTOMAUTH_TTL_EXPIRATION'|'UNKNOWN'|'NONE'
}
Response Structure
(dict) --
ManagedThingId (string) --
The id of a managed thing.
Connected (boolean) --
The connectivity status for a managed thing.
Timestamp (datetime) --
The timestamp value of when the connectivity status for a managed thing was last taken.
DisconnectReason (string) --
The reason for the connectivity disconnect with the managed thing.
Lists schema versions with the provided information.
See also: AWS API Documentation
Request Syntax
client.list_schema_versions(
Type='capability'|'definition',
MaxResults=123,
NextToken='string',
SchemaId='string',
Namespace='string',
Visibility='PUBLIC'|'PRIVATE',
SemanticVersion='string'
)
string
[REQUIRED]
Filter on the type of schema version.
integer
The maximum number of results to return at one time.
string
A token that can be used to retrieve the next set of results.
string
Filter on the id of the schema version.
string
Filter on the name of the schema version.
string
The visibility of the schema version.
string
The schema version. If this is left blank, it defaults to the latest version.
dict
Response Syntax
{
'Items': [
{
'SchemaId': 'string',
'Type': 'capability'|'definition',
'Description': 'string',
'Namespace': 'string',
'SemanticVersion': 'string',
'Visibility': 'PUBLIC'|'PRIVATE'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of schema versions.
(dict) --
List item describing a schema version.
SchemaId (string) --
The identifier of the schema version.
Type (string) --
The type of schema version.
Description (string) --
A description of the schema version.
Namespace (string) --
The name of the schema version.
SemanticVersion (string) --
The schema version. If this is left blank, it defaults to the latest version.
Visibility (string) --
The visibility of the schema version.
NextToken (string) --
A token that can be used to retrieve the next set of results.
Set the runtime log configuration for a specific managed thing or for all managed things as a group.
See also: AWS API Documentation
Request Syntax
client.put_runtime_log_configuration(
ManagedThingId='string',
RuntimeLogConfigurations={
'LogLevel': 'DEBUG'|'ERROR'|'INFO'|'WARN',
'LogFlushLevel': 'DEBUG'|'ERROR'|'INFO'|'WARN',
'LocalStoreLocation': 'string',
'LocalStoreFileRotationMaxFiles': 123,
'LocalStoreFileRotationMaxBytes': 123,
'UploadLog': True|False,
'UploadPeriodMinutes': 123,
'DeleteLocalStoreAfterUpload': True|False
}
)
string
[REQUIRED]
The id for a managed thing.
dict
[REQUIRED]
The runtime log configuration for a managed thing.
LogLevel (string) --
The different log levels available for configuration.
LogFlushLevel (string) --
The different log levels available for configuration.
LocalStoreLocation (string) --
Configuration of where to store runtime logs in the device.
LocalStoreFileRotationMaxFiles (integer) --
Configuration to set the maximum number of runtime log files that can be stored on the device before the oldest files are deleted or overwritten.
LocalStoreFileRotationMaxBytes (integer) --
Configuration to set the maximum bytes of runtime logs that can be stored on the device before the oldest logs are deleted or overwritten.
UploadLog (boolean) --
Configuration to enable or disable uploading of runtime logs to the cloud.
UploadPeriodMinutes (integer) --
Configuration to set the time interval in minutes between each batch of runtime logs that the device uploads to the cloud.
DeleteLocalStoreAfterUpload (boolean) --
Configuration to enable or disable deleting of runtime logs in the device once uploaded to the cloud.
None
Get a configuraiton for the over-the-air (OTA) task.
See also: AWS API Documentation
Request Syntax
client.get_ota_task_configuration(
Identifier='string'
)
string
[REQUIRED]
The over-the-air (OTA) task configuration id.
dict
Response Syntax
{
'TaskConfigurationId': 'string',
'Name': 'string',
'PushConfig': {
'AbortConfig': {
'AbortConfigCriteriaList': [
{
'Action': 'CANCEL',
'FailureType': 'FAILED'|'REJECTED'|'TIMED_OUT'|'ALL',
'MinNumberOfExecutedThings': 123,
'ThresholdPercentage': 123.0
},
]
},
'RolloutConfig': {
'ExponentialRolloutRate': {
'BaseRatePerMinute': 123,
'IncrementFactor': 123.0,
'RateIncreaseCriteria': {
'numberOfNotifiedThings': 123,
'numberOfSucceededThings': 123
}
},
'MaximumPerMinute': 123
},
'TimeoutConfig': {
'InProgressTimeoutInMinutes': 123
}
},
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
TaskConfigurationId (string) --
The over-the-air (OTA) task configuration id.
Name (string) --
The name of the over-the-air (OTA) task configuration.
PushConfig (dict) --
Describes the type of configuration used for the over-the-air (OTA) task.
AbortConfig (dict) --
Structure representing one abort config.
AbortConfigCriteriaList (list) --
The list of criteria for the abort config.
(dict) --
Structure representing one abort config criteria.
Action (string) --
The action taken by the abort configuration.
FailureType (string) --
Over-the-air (OTA) task abort criteria failure type.
MinNumberOfExecutedThings (integer) --
The minimum number of things that must receive task execution notifications before the task can be aborted.
ThresholdPercentage (float) --
The minimum percentage of over-the-air (OTA) task execution failures that must occur to initiate the last abort.
RolloutConfig (dict) --
Structure representing one rollout config.
ExponentialRolloutRate (dict) --
Structure representing exponential rate of rollout for an over-the-air (OTA) task.
BaseRatePerMinute (integer) --
The base rate per minute for the rollout of an over-the-air (OTA) task.
IncrementFactor (float) --
The incremental factor for increasing the rollout rate of an over-the-air (OTA) task.
RateIncreaseCriteria (dict) --
The criteria for increasing the rollout rate of an over-the-air (OTA) task.
numberOfNotifiedThings (integer) --
The threshold for number of notified things that will initiate the increase in rate of rollout.
numberOfSucceededThings (integer) --
The threshold for number of succeeded things that will initiate the increase in rate of rollout.
MaximumPerMinute (integer) --
The maximum number of things that will be notified of a pending task, per minute.
TimeoutConfig (dict) --
Structure representing one timeout config.
InProgressTimeoutInMinutes (integer) --
Specifies the amount of time the device has to finish execution of this task. The timeout interval can be anywhere between 1 minute and 7 days.
Description (string) --
A description of the over-the-air (OTA) task configuration.
CreatedAt (datetime) --
The timestamp value of when the over-the-air (OTA) task configuration was created at.
List all destination names under one Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.list_destinations(
NextToken='string',
MaxResults=123
)
string
A token that can be used to retrieve the next set of results.
integer
The maximum number of results to return at one time.
dict
Response Syntax
{
'DestinationList': [
{
'Description': 'string',
'DeliveryDestinationArn': 'string',
'DeliveryDestinationType': 'KINESIS',
'Name': 'string',
'RoleArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DestinationList (list) --
The list of destinations.
(dict) --
Structure describing a destination for IoT managed integrations to deliver notifications for a device.
Description (string) --
The description of the customer-managed destination.
DeliveryDestinationArn (string) --
The Amazon Resource Name (ARN) of the customer-managed destination.
DeliveryDestinationType (string) --
The destination type for the customer-managed destination.
Name (string) --
The name of the customer-managed destination.
RoleArn (string) --
The Amazon Resource Name (ARN) of the delivery destination.
NextToken (string) --
A token that can be used to retrieve the next set of results.
List all event log configurations for an account.
See also: AWS API Documentation
Request Syntax
client.list_event_log_configurations(
NextToken='string',
MaxResults=123
)
string
A token that can be used to retrieve the next set of results.
integer
The maximum number of results to return at one time.
dict
Response Syntax
{
'EventLogConfigurationList': [
{
'Id': 'string',
'ResourceType': 'string',
'ResourceId': 'string',
'EventLogLevel': 'DEBUG'|'ERROR'|'INFO'|'WARN'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EventLogConfigurationList (list) --
A list of each event log configuration and pertinent information.
(dict) --
List of event log configurations.
Id (string) --
The identifier of the event log configuration.
ResourceType (string) --
The type of resource for the event log configuration.
ResourceId (string) --
The identifier of the resource for the event log configuration.
EventLogLevel (string) --
The logging level for the event log configuration.
NextToken (string) --
A token that can be used to retrieve the next set of results.
Delete the over-the-air (OTA) task.
See also: AWS API Documentation
Request Syntax
client.delete_ota_task(
Identifier='string'
)
string
[REQUIRED]
The identifier of the over-the-air (OTA) task.
None
Creates a managed thing. A managed thing contains the device identifier, protocol supported, and capabilities of the device in a protocol-specific format.
See also: AWS API Documentation
Request Syntax
client.create_managed_thing(
Role='CONTROLLER'|'DEVICE',
Owner='string',
CredentialLockerId='string',
AuthenticationMaterial='string',
AuthenticationMaterialType='WIFI_SETUP_QR_BAR_CODE'|'ZWAVE_QR_BAR_CODE'|'ZIGBEE_QR_BAR_CODE',
SerialNumber='string',
Brand='string',
Model='string',
Name='string',
CapabilityReport={
'version': 'string',
'nodeId': 'string',
'endpoints': [
{
'id': 'string',
'deviceTypes': [
'string',
],
'capabilities': [
{
'id': 'string',
'name': 'string',
'version': 'string',
'properties': [
'string',
],
'actions': [
'string',
],
'events': [
'string',
]
},
]
},
]
},
Capabilities='string',
ClientToken='string',
Classification='string',
Tags={
'string': 'string'
},
MetaData={
'string': 'string'
}
)
string
[REQUIRED]
The type of device used. This will be the hub controller, cloud device, or AWS IoT device.
string
Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.
string
The identifier of the credential for the managed thing.
string
[REQUIRED]
The authentication material defining the device connectivity setup requests. The authentication materials used are the device bar code.
string
[REQUIRED]
The type of authentication material used for device connectivity setup requests.
string
The serial number of the device.
string
The brand of the device.
string
The model of the device.
string
The name of the managed thing representing the physical device.
dict
A report of the capabilities for the managed thing.
version (string) -- [REQUIRED]
The version of the capability report.
nodeId (string) --
The numeric identifier of the node.
endpoints (list) -- [REQUIRED]
The endpoints used in the capability report.
(dict) --
The endpoint used in the capability report.
id (string) -- [REQUIRED]
The id of the endpoint used in the capability report.
deviceTypes (list) -- [REQUIRED]
The type of device.
(string) --
capabilities (list) -- [REQUIRED]
The capabilities used in the capability report.
(dict) --
The capability used in capability report.
id (string) -- [REQUIRED]
The id of the schema version.
name (string) -- [REQUIRED]
The name of the capability.
version (string) -- [REQUIRED]
The version of the capability.
properties (list) -- [REQUIRED]
The capability properties used in the capability report.
(string) --
actions (list) -- [REQUIRED]
The capability actions used in the capability report.
(string) --
events (list) -- [REQUIRED]
The capability events used in the capability report.
(string) --
string
The capabilities of the device such as light bulb.
string
An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
This field is autopopulated if not provided.
string
The classification of the managed thing such as light bulb or thermostat.
dict
A set of key/value pairs that are used to manage the managed thing.
(string) --
(string) --
dict
The metadata for the managed thing.
(string) --
(string) --
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Id (string) --
The id of the managed thing.
Arn (string) --
The Amazon Resource Name (ARN) of the managed thing.
CreatedAt (datetime) --
The timestamp value of when the device creation request occurred.
Send the command to the device represented by the managed thing.
See also: AWS API Documentation
Request Syntax
client.send_managed_thing_command(
ManagedThingId='string',
Endpoints=[
{
'endpointId': 'string',
'capabilities': [
{
'id': 'string',
'name': 'string',
'version': 'string',
'actions': [
{
'name': 'string',
'ref': 'string',
'actionTraceId': 'string',
'parameters': {...}|[...]|123|123.4|'string'|True|None
},
]
},
]
},
],
ConnectorAssociationId='string'
)
string
[REQUIRED]
The id of the device.
list
[REQUIRED]
The device endpoint.
(dict) --
The endpoint for a managed thing when sending a command.
endpointId (string) -- [REQUIRED]
The id of the endpoint for a managed thing.
capabilities (list) -- [REQUIRED]
Describe the endpoint with an id, a name, and the relevant capabilities for sending commands.
(dict) --
The command capabilities added for the managed thing
id (string) -- [REQUIRED]
Describe the capability with an id.
name (string) -- [REQUIRED]
Describe the capability with an name.
version (string) -- [REQUIRED]
Describe the capability with a version.
actions (list) -- [REQUIRED]
Describe the command capability with the actions it supports.
(dict) --
Action for an Amazon Web Services capability, containing the action parameters for control.
name (string) -- [REQUIRED]
Describe a capability action with a name.
ref (string) --
Describe a capability action with an reference.
actionTraceId (string) --
Describe a capability action with an actionTraceId for a response command.
parameters (:ref:`document<document>`) --
Describe a capability action with a capability property.
string
The ID tracking the current discovery process for one connector association.
dict
Response Syntax
{
'TraceId': 'string'
}
Response Structure
(dict) --
TraceId (string) --
The trace request identifier. This is specified by the device owner, but will be generated by IoT managed integrations if not provided by the device owner.
Returns the managed thing state for the given device Id.
See also: AWS API Documentation
Request Syntax
client.get_managed_thing_state(
ManagedThingId='string'
)
string
[REQUIRED]
The id of the device.
dict
Response Syntax
{
'Endpoints': [
{
'endpointId': 'string',
'capabilities': [
{
'id': 'string',
'name': 'string',
'version': 'string',
'properties': {...}|[...]|123|123.4|'string'|True|None
},
]
},
]
}
Response Structure
(dict) --
Endpoints (list) --
The device endpoint.
(dict) --
Describe the endpoint with an Id, a name, and the relevant capabilities for reporting state
endpointId (string) --
Numeric identifier of the endpoint
capabilities (list) --
Describe the endpoint with an id, a name, and the relevant capabilities for the reporting state.
(dict) --
State capabilities added for the managed thing.
id (string) --
The id of the managed thing in the capability report.
name (string) --
Name for the Amazon Web Services capability.
version (string) --
Version for the Amazon Web Services capability.
properties (:ref:`document<document>`) --
Describe the command capability with the properties it supports.
Get a notification configuration.
See also: AWS API Documentation
Request Syntax
client.get_notification_configuration(
EventType='DEVICE_COMMAND'|'DEVICE_COMMAND_REQUEST'|'DEVICE_EVENT'|'DEVICE_LIFE_CYCLE'|'DEVICE_STATE'|'DEVICE_OTA'|'CONNECTOR_ASSOCIATION'|'CONNECTOR_ERROR_REPORT'
)
string
[REQUIRED]
The type of event triggering a device notification to the customer-managed destination.
dict
Response Syntax
{
'EventType': 'DEVICE_COMMAND'|'DEVICE_COMMAND_REQUEST'|'DEVICE_EVENT'|'DEVICE_LIFE_CYCLE'|'DEVICE_STATE'|'DEVICE_OTA'|'CONNECTOR_ASSOCIATION'|'CONNECTOR_ERROR_REPORT',
'DestinationName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
EventType (string) --
The type of event triggering a device notification to the customer-managed destination.
DestinationName (string) --
The name of the destination for the notification configuration.
CreatedAt (datetime) --
The timestamp value of when the notification configuration was created.
UpdatedAt (datetime) --
The timestamp value of when the notification configuration was last updated.
Tags (dict) --
A set of key/value pairs that are used to manage the notification configuration.
(string) --
(string) --
Get the metadata information for a managed thing.
See also: AWS API Documentation
Request Syntax
client.get_managed_thing_meta_data(
Identifier='string'
)
string
[REQUIRED]
The managed thing id.
dict
Response Syntax
{
'ManagedThingId': 'string',
'MetaData': {
'string': 'string'
}
}
Response Structure
(dict) --
ManagedThingId (string) --
The managed thing id.
MetaData (dict) --
The metadata for the managed thing.
(string) --
(string) --
Reset a runtime log configuration for a specific managed thing or for all managed things as a group.
See also: AWS API Documentation
Request Syntax
client.reset_runtime_log_configuration(
ManagedThingId='string'
)
string
[REQUIRED]
The id of a managed thing.
None
Deletes a notification configuration.
See also: AWS API Documentation
Request Syntax
client.delete_notification_configuration(
EventType='DEVICE_COMMAND'|'DEVICE_COMMAND_REQUEST'|'DEVICE_EVENT'|'DEVICE_LIFE_CYCLE'|'DEVICE_STATE'|'DEVICE_OTA'|'CONNECTOR_ASSOCIATION'|'CONNECTOR_ERROR_REPORT'
)
string
[REQUIRED]
The type of event triggering a device notification to the customer-managed destination.
None
Delete the over-the-air (OTA) task configuration.
See also: AWS API Documentation
Request Syntax
client.delete_ota_task_configuration(
Identifier='string'
)
string
[REQUIRED]
The identifier of the over-the-air (OTA) task configuration.
None
List all of the over-the-air (OTA) task executions.
See also: AWS API Documentation
Request Syntax
client.list_ota_task_executions(
Identifier='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The over-the-air (OTA) task id.
string
A token that can be used to retrieve the next set of results.
integer
The maximum number of results to return at one time.
dict
Response Syntax
{
'ExecutionSummaries': [
{
'TaskExecutionSummary': {
'ExecutionNumber': 123,
'LastUpdatedAt': datetime(2015, 1, 1),
'QueuedAt': datetime(2015, 1, 1),
'RetryAttempt': 123,
'StartedAt': datetime(2015, 1, 1),
'Status': 'QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'REJECTED'|'REMOVED'|'CANCELED'
},
'ManagedThingId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ExecutionSummaries (list) --
A list of all of the over-the-air (OTA) task executions.
(dict) --
Structure representing one execution summary.
TaskExecutionSummary (dict) --
Structure representing one over-the-air (OTA) task execution summary
ExecutionNumber (integer) --
The execution number of the over-the-air (OTA) task execution summary.
LastUpdatedAt (datetime) --
The timestamp value of when the over-the-air (OTA) task execution summary was last updated.
QueuedAt (datetime) --
The timestamp value of when the over-the-air (OTA) task execution summary is targeted to start.
RetryAttempt (integer) --
The number of retry attempts for starting the over-the-air (OTA) task execution summary after a failed attempt.
StartedAt (datetime) --
The timestamp value of when the over-the-air (OTA) task execution summary started.
Status (string) --
The status of the over-the-air (OTA) task execution summary.
ManagedThingId (string) --
The id of a managed thing.
NextToken (string) --
A token that can be used to retrieve the next set of results.
Customers can request IoT managed integrations to manage the server trust for them or bring their own external server trusts for the custom domain. Returns an IoT managed integrations endpoint.
See also: AWS API Documentation
Request Syntax
client.register_custom_endpoint()
dict
Response Syntax
{
'EndpointAddress': 'string'
}
Response Structure
(dict) --
EndpointAddress (string) --
The IoT managed integrations dedicated, custom endpoint for the device to route traffic through.
Delete a credential locker.
See also: AWS API Documentation
Request Syntax
client.delete_credential_locker(
Identifier='string'
)
string
[REQUIRED]
The identifier of the credential locker.
None
Update an event log configuration by log configuration ID.
See also: AWS API Documentation
Request Syntax
client.update_event_log_configuration(
Id='string',
EventLogLevel='DEBUG'|'ERROR'|'INFO'|'WARN'
)
string
[REQUIRED]
The log configuration id.
string
[REQUIRED]
The log level for the event in terms of severity.
None
List information on an existing credential locker.
See also: AWS API Documentation
Request Syntax
client.list_credential_lockers(
NextToken='string',
MaxResults=123
)
string
A token that can be used to retrieve the next set of results.
integer
The maximum number of results to return at one time.
dict
Response Syntax
{
'Items': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'CreatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of credential lockers.
(dict) --
Structure describing one Credential Locker.
Id (string) --
The id of the credential locker.
Arn (string) --
The Amazon Resource Name (ARN) of the credential locker.
Name (string) --
The name of the credential locker.
CreatedAt (datetime) --
The timestampe value of when the credential locker was created at.
NextToken (string) --
A token that can be used to retrieve the next set of results.
Update the attributes and capabilities associated with a managed thing.
See also: AWS API Documentation
Request Syntax
client.update_managed_thing(
Identifier='string',
Owner='string',
CredentialLockerId='string',
SerialNumber='string',
Brand='string',
Model='string',
Name='string',
CapabilityReport={
'version': 'string',
'nodeId': 'string',
'endpoints': [
{
'id': 'string',
'deviceTypes': [
'string',
],
'capabilities': [
{
'id': 'string',
'name': 'string',
'version': 'string',
'properties': [
'string',
],
'actions': [
'string',
],
'events': [
'string',
]
},
]
},
]
},
Capabilities='string',
Classification='string',
HubNetworkMode='STANDARD'|'NETWORK_WIDE_EXCLUSION',
MetaData={
'string': 'string'
}
)
string
[REQUIRED]
The id of the managed thing.
string
Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.
string
The identifier of the credential for the managed thing.
string
The serial number of the device.
string
The brand of the device.
string
The model of the device.
string
The name of the managed thing representing the physical device.
dict
A report of the capabilities for the managed thing.
version (string) -- [REQUIRED]
The version of the capability report.
nodeId (string) --
The numeric identifier of the node.
endpoints (list) -- [REQUIRED]
The endpoints used in the capability report.
(dict) --
The endpoint used in the capability report.
id (string) -- [REQUIRED]
The id of the endpoint used in the capability report.
deviceTypes (list) -- [REQUIRED]
The type of device.
(string) --
capabilities (list) -- [REQUIRED]
The capabilities used in the capability report.
(dict) --
The capability used in capability report.
id (string) -- [REQUIRED]
The id of the schema version.
name (string) -- [REQUIRED]
The name of the capability.
version (string) -- [REQUIRED]
The version of the capability.
properties (list) -- [REQUIRED]
The capability properties used in the capability report.
(string) --
actions (list) -- [REQUIRED]
The capability actions used in the capability report.
(string) --
events (list) -- [REQUIRED]
The capability events used in the capability report.
(string) --
string
The capabilities of the device such as light bulb.
string
The classification of the managed thing such as light bulb or thermostat.
string
The network mode for the hub-connected device.
dict
The metadata for the managed thing.
(string) --
(string) --
None
Update a notification configuration.
See also: AWS API Documentation
Request Syntax
client.update_notification_configuration(
EventType='DEVICE_COMMAND'|'DEVICE_COMMAND_REQUEST'|'DEVICE_EVENT'|'DEVICE_LIFE_CYCLE'|'DEVICE_STATE'|'DEVICE_OTA'|'CONNECTOR_ASSOCIATION'|'CONNECTOR_ERROR_REPORT',
DestinationName='string'
)
string
[REQUIRED]
The type of event triggering a device notification to the customer-managed destination.
string
[REQUIRED]
The name of the destination for the notification configuration.
None
Gets a schema version with the provided information.
See also: AWS API Documentation
Request Syntax
client.get_schema_version(
Type='capability'|'definition',
SchemaVersionedId='string',
Format='AWS'|'ZCL'|'CONNECTOR'
)
string
[REQUIRED]
The type of schema version.
string
[REQUIRED]
Schema id with a version specified. If the version is missing, it defaults to latest version.
string
The format of the schema version.
dict
Response Syntax
{
'SchemaId': 'string',
'Type': 'capability'|'definition',
'Description': 'string',
'Namespace': 'string',
'SemanticVersion': 'string',
'Visibility': 'PUBLIC'|'PRIVATE',
'Schema': {...}|[...]|123|123.4|'string'|True|None
}
Response Structure
(dict) --
SchemaId (string) --
The id of the schema version.
Type (string) --
The type of schema version.
Description (string) --
The description of the schema version.
Namespace (string) --
The name of the schema version.
SemanticVersion (string) --
The schema version. If this is left blank, it defaults to the latest version.
Visibility (string) --
The visibility of the schema version.
Schema (:ref:`document<document>`) --
The schema of the schema version.
Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified region. For more information, see Key management in the AWS IoT SiteWise User Guide.
See also: AWS API Documentation
Request Syntax
client.get_default_encryption_configuration()
dict
Response Syntax
{
'configurationStatus': {
'error': {
'code': 'string',
'message': 'string'
},
'state': 'ENABLED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'
},
'encryptionType': 'MANAGED_INTEGRATIONS_DEFAULT_ENCRYPTION'|'CUSTOMER_KEY_ENCRYPTION',
'kmsKeyArn': 'string'
}
Response Structure
(dict) --
configurationStatus (dict) --
Provides the status of the default encryption configuration for an Amazon Web Services account.
error (dict) --
The error details describing a failed default encryption configuration update.
code (string) --
The error code returned when the default encryption configuration update fails.
message (string) --
The error message returned when the default encryption configuration update fails.
state (string) --
The status state describing the default encryption configuration update.
encryptionType (string) --
The type of encryption used for the encryption configuration.
kmsKeyArn (string) --
The Key Amazon Resource Name (ARN) of the AWS KMS key used for KMS encryption if you use KMS_BASED_ENCRYPTION.
Update a destination specified by id.
See also: AWS API Documentation
Request Syntax
client.update_destination(
Name='string',
DeliveryDestinationArn='string',
DeliveryDestinationType='KINESIS',
RoleArn='string',
Description='string'
)
string
[REQUIRED]
The name of the customer-managed destination.
string
The Amazon Resource Name (ARN) of the customer-managed destination.
string
The destination type for the customer-managed destination.
string
The Amazon Resource Name (ARN) of the delivery destination role.
string
The description of the customer-managed destination.
None
During user-guided setup, this is used to start device discovery. The authentication material (install code) is passed as a message to the controller telling it to start the discovery.
See also: AWS API Documentation
Request Syntax
client.start_device_discovery(
DiscoveryType='ZWAVE'|'ZIGBEE'|'CLOUD',
ControllerIdentifier='string',
ConnectorAssociationIdentifier='string',
AuthenticationMaterial='string',
AuthenticationMaterialType='ZWAVE_INSTALL_CODE',
ClientToken='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The discovery type supporting the type of device to be discovered in the device discovery job request.
string
The id of the end-user's IoT hub.
string
The id of the connector association.
string
The authentication material required to start the local device discovery job request.
string
The type of authentication material used for device discovery jobs.
string
An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
dict
A set of key/value pairs that are used to manage the device discovery request.
(string) --
(string) --
dict
Response Syntax
{
'Id': 'string',
'StartedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Id (string) --
The id of the device discovery job request.
StartedAt (datetime) --
The timestamp value for the start time of the device discovery.
Deletes a customer-managed destination specified by id.
See also: AWS API Documentation
Request Syntax
client.delete_destination(
Name='string'
)
string
[REQUIRED]
The id of the customer-managed destination.
None
Returns the IoT managed integrations custom endpoint.
See also: AWS API Documentation
Request Syntax
client.get_custom_endpoint()
dict
Response Syntax
{
'EndpointAddress': 'string'
}
Response Structure
(dict) --
EndpointAddress (string) --
The IoT managed integrations dedicated, custom endpoint for the device to route traffic through.
List schemas associated with a managed thing.
See also: AWS API Documentation
Request Syntax
client.list_managed_thing_schemas(
Identifier='string',
EndpointIdFilter='string',
CapabilityIdFilter='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The managed thing id.
string
Filter on an endpoint id.
string
Filter on a capability id.
string
A token that can be used to retrieve the next set of results.
integer
The maximum number of results to return at one time.
dict
Response Syntax
{
'Items': [
{
'EndpointId': 'string',
'CapabilityId': 'string',
'Schema': {...}|[...]|123|123.4|'string'|True|None
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of managed thing schemas.
(dict) --
Structure representing one schema item associated with a managed thing.
EndpointId (string) --
The id of the endpoint for a managed thing.
CapabilityId (string) --
The id of the capability for a managed thing.
Schema (:ref:`document<document>`) --
The validation schema for one schema item associated with a managed thing.
NextToken (string) --
A token that can be used to retrieve the next set of results.
List all of the associations and statuses for a managed thing by its owner.
See also: AWS API Documentation
Request Syntax
client.list_managed_things(
OwnerFilter='string',
CredentialLockerFilter='string',
RoleFilter='CONTROLLER'|'DEVICE',
ParentControllerIdentifierFilter='string',
ConnectorPolicyIdFilter='string',
SerialNumberFilter='string',
ProvisioningStatusFilter='UNASSOCIATED'|'PRE_ASSOCIATED'|'DISCOVERED'|'ACTIVATED'|'DELETION_FAILED'|'DELETE_IN_PROGRESS'|'ISOLATED'|'DELETED',
NextToken='string',
MaxResults=123
)
string
Filter on device owners when listing managed things.
string
Filter on a credential locker for a managed thing.
string
Filter on the type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT device.
string
Filter on a parent controller id for a managed thing.
string
Filter on a connector policy id for a managed thing.
string
Filter on the serial number of the device.
string
Filter on the status of the device.
string
A token that can be used to retrieve the next set of results.
integer
The maximum number of results to return at one time.
dict
Response Syntax
{
'Items': [
{
'Id': 'string',
'Arn': 'string',
'AdvertisedProductId': 'string',
'Brand': 'string',
'Classification': 'string',
'ConnectorDeviceId': 'string',
'ConnectorPolicyId': 'string',
'Model': 'string',
'Name': 'string',
'Owner': 'string',
'CredentialLockerId': 'string',
'ParentControllerId': 'string',
'ProvisioningStatus': 'UNASSOCIATED'|'PRE_ASSOCIATED'|'DISCOVERED'|'ACTIVATED'|'DELETION_FAILED'|'DELETE_IN_PROGRESS'|'ISOLATED'|'DELETED',
'Role': 'CONTROLLER'|'DEVICE',
'SerialNumber': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'ActivatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of managed things.
(dict) --
Structure representing one managed thing.
Id (string) --
The id of the device.
Arn (string) --
The Amazon Resource Name (ARN) of the managed thing.
AdvertisedProductId (string) --
The id of the advertised product.
Brand (string) --
The brand of the device.
Classification (string) --
The classification of the managed thing such as light bulb or thermostat.
ConnectorDeviceId (string) --
The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII).
ConnectorPolicyId (string) --
The id of the connector policy.
Model (string) --
The model of the device.
Name (string) --
The name of the managed thing representing the physical device.
Owner (string) --
Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.
CredentialLockerId (string) --
The identifier of the credential locker for the managed thing.
ParentControllerId (string) --
Id of the controller device used for the discovery job.
ProvisioningStatus (string) --
The provisioning status of the device in the provisioning workflow for onboarding to IoT managed integrations.
Role (string) --
The type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT device.
SerialNumber (string) --
The serial number of the device.
CreatedAt (datetime) --
The timestamp value of when the device creation request occurred.
UpdatedAt (datetime) --
The timestamp value of when the managed thing was last updated at.
ActivatedAt (datetime) --
The timestampe value of when the managed thing was activated at.
NextToken (string) --
A token that can be used to retrieve the next set of results.
Update an over-the-air (OTA) task.
See also: AWS API Documentation
Request Syntax
client.update_ota_task(
Identifier='string',
Description='string',
TaskConfigurationId='string'
)
string
[REQUIRED]
The over-the-air (OTA) task id.
string
The description of the over-the-air (OTA) task.
string
The identifier for the over-the-air (OTA) task configuration.
None
Create a product credential locker. This operation will trigger the creation of all the manufacturing resources including the Wi-Fi setup key pair and device certificate.
See also: AWS API Documentation
Request Syntax
client.create_credential_locker(
Name='string',
ClientToken='string',
Tags={
'string': 'string'
}
)
string
The name of the credential locker.
string
An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
This field is autopopulated if not provided.
dict
A set of key/value pairs that are used to manage the credential locker.
(string) --
(string) --
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Id (string) --
The identifier of the credential locker creation request.
Arn (string) --
The Amazon Resource Name (ARN) of the credential locker.
CreatedAt (datetime) --
The timestamp value of when the credential locker request occurred.
Create an over-the-air (OTA) task to update a device.
See also: AWS API Documentation
Request Syntax
client.create_ota_task(
Description='string',
S3Url='string',
Protocol='HTTP',
Target=[
'string',
],
TaskConfigurationId='string',
OtaMechanism='PUSH',
OtaType='ONE_TIME'|'CONTINUOUS',
OtaTargetQueryString='string',
ClientToken='string',
OtaSchedulingConfig={
'EndBehavior': 'STOP_ROLLOUT'|'CANCEL'|'FORCE_CANCEL',
'EndTime': 'string',
'MaintenanceWindows': [
{
'DurationInMinutes': 123,
'StartTime': 'string'
},
],
'StartTime': 'string'
},
OtaTaskExecutionRetryConfig={
'RetryConfigCriteria': [
{
'FailureType': 'FAILED'|'TIMED_OUT'|'ALL',
'MinNumberOfRetries': 123
},
]
},
Tags={
'string': 'string'
}
)
string
The description of the over-the-air (OTA) task.
string
[REQUIRED]
The URL to the Amazon S3 bucket where the over-the-air (OTA) task is stored.
string
The connection protocol the over-the-air (OTA) task uses to update the device.
list
The device targeted for the over-the-air (OTA) task.
(string) --
string
The identifier for the over-the-air (OTA) task configuration.
string
The deployment mechanism for the over-the-air (OTA) task.
string
[REQUIRED]
The frequency type for the over-the-air (OTA) task.
string
The query string to add things to the thing group.
string
An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
This field is autopopulated if not provided.
dict
Over-the-air (OTA) task scheduling config.
EndBehavior (string) --
Specifies the end behavior for all task executions after a task reaches the selected endTime. If endTime is not selected when creating the task, then endBehavior does not apply.
EndTime (string) --
The time an over-the-air (OTA) task will stop.
MaintenanceWindows (list) --
Maintenance window list for over-the-air (OTA) task scheduling config.
(dict) --
Structure representing scheduling maintenance window.
DurationInMinutes (integer) --
Displays the duration of the next maintenance window.
StartTime (string) --
Displays the start time of the next maintenance window.
StartTime (string) --
The time an over-the-air (OTA) task will start.
dict
Over-the-air (OTA) task retry config.
RetryConfigCriteria (list) --
The list of retry config criteria.
(dict) --
Structure representing one retry config criteria.
FailureType (string) --
Over-the-air (OTA) retry criteria failure type.
MinNumberOfRetries (integer) --
The number of retries allowed for a failure type for the over-the-air (OTA) task.
dict
A set of key/value pairs that are used to manage the over-the-air (OTA) task.
(string) --
(string) --
dict
Response Syntax
{
'TaskId': 'string',
'TaskArn': 'string',
'Description': 'string'
}
Response Structure
(dict) --
TaskId (string) --
The identifier of the over-the-air (OTA) task.
TaskArn (string) --
The Amazon Resource Name (ARN) of the over-the-air (OTA) task.
Description (string) --
A description of the over-the-air (OTA) task.
Create a provisioning profile for a device to execute the provisioning flows using a provisioning template. The provisioning template is a document that defines the set of resources and policies applied to a device during the provisioning process.
See also: AWS API Documentation
Request Syntax
client.create_provisioning_profile(
ProvisioningType='FLEET_PROVISIONING'|'JITR',
CaCertificate='string',
Name='string',
ClientToken='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The type of provisioning workflow the device uses for onboarding to IoT managed integrations.
string
The id of the certificate authority (CA) certificate.
string
The name of the provisioning template.
string
An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
This field is autopopulated if not provided.
dict
A set of key/value pairs that are used to manage the provisioning profile.
(string) --
(string) --
dict
Response Syntax
{
'Arn': 'string',
'Name': 'string',
'ProvisioningType': 'FLEET_PROVISIONING'|'JITR',
'Id': 'string',
'ClaimCertificate': 'string',
'ClaimCertificatePrivateKey': 'string'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the provisioning template used in the provisioning profile.
Name (string) --
The name of the provisioning template.
ProvisioningType (string) --
The type of provisioning workflow the device uses for onboarding to IoT managed integrations.
Id (string) --
The identifier of the provisioning profile.
ClaimCertificate (string) --
The id of the claim certificate.
ClaimCertificatePrivateKey (string) --
The private key of the claim certificate. This is stored securely on the device for validating the connection endpoint with IoT managed integrations using the public key.
List the provisioning profiles within the Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.list_provisioning_profiles(
NextToken='string',
MaxResults=123
)
string
A token that can be used to retrieve the next set of results.
integer
The maximum number of results to return at one time.
dict
Response Syntax
{
'Items': [
{
'Name': 'string',
'Id': 'string',
'Arn': 'string',
'ProvisioningType': 'FLEET_PROVISIONING'|'JITR'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of provisioning profiles.
(dict) --
Structure describing a provisioning profile.
Name (string) --
The name of the provisioning template.
Id (string) --
The identifier of the provisioning profile.
Arn (string) --
The Amazon Resource Name (ARN) of the provisioning template used in the provisioning profile.
ProvisioningType (string) --
The type of provisioning workflow the device uses for onboarding to IoT managed integrations.
NextToken (string) --
A token that can be used to retrieve the next set of results.
Get the runtime log configuration for a specific managed thing or for all managed things as a group.
See also: AWS API Documentation
Request Syntax
client.get_runtime_log_configuration(
ManagedThingId='string'
)
string
[REQUIRED]
The id for a managed thing.
dict
Response Syntax
{
'ManagedThingId': 'string',
'RuntimeLogConfigurations': {
'LogLevel': 'DEBUG'|'ERROR'|'INFO'|'WARN',
'LogFlushLevel': 'DEBUG'|'ERROR'|'INFO'|'WARN',
'LocalStoreLocation': 'string',
'LocalStoreFileRotationMaxFiles': 123,
'LocalStoreFileRotationMaxBytes': 123,
'UploadLog': True|False,
'UploadPeriodMinutes': 123,
'DeleteLocalStoreAfterUpload': True|False
}
}
Response Structure
(dict) --
ManagedThingId (string) --
The id for a managed thing.
RuntimeLogConfigurations (dict) --
The runtime log configuration for a managed thing.
LogLevel (string) --
The different log levels available for configuration.
LogFlushLevel (string) --
The different log levels available for configuration.
LocalStoreLocation (string) --
Configuration of where to store runtime logs in the device.
LocalStoreFileRotationMaxFiles (integer) --
Configuration to set the maximum number of runtime log files that can be stored on the device before the oldest files are deleted or overwritten.
LocalStoreFileRotationMaxBytes (integer) --
Configuration to set the maximum bytes of runtime logs that can be stored on the device before the oldest logs are deleted or overwritten.
UploadLog (boolean) --
Configuration to enable or disable uploading of runtime logs to the cloud.
UploadPeriodMinutes (integer) --
Configuration to set the time interval in minutes between each batch of runtime logs that the device uploads to the cloud.
DeleteLocalStoreAfterUpload (boolean) --
Configuration to enable or disable deleting of runtime logs in the device once uploaded to the cloud.
Update a hub configuration.
See also: AWS API Documentation
Request Syntax
client.put_hub_configuration(
HubTokenTimerExpirySettingInSeconds=123
)
integer
[REQUIRED]
A user-defined integer value that represents the hub token timer expiry setting in seconds.
dict
Response Syntax
{
'HubTokenTimerExpirySettingInSeconds': 123
}
Response Structure
(dict) --
HubTokenTimerExpirySettingInSeconds (integer) --
A user-defined integer value that represents the hub token timer expiry setting in seconds.
List all of the over-the-air (OTA) tasks.
See also: AWS API Documentation
Request Syntax
client.list_ota_tasks(
NextToken='string',
MaxResults=123
)
string
A token that can be used to retrieve the next set of results.
integer
The maximum number of results to return at one time.
dict
Response Syntax
{
'Tasks': [
{
'TaskId': 'string',
'TaskArn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'TaskConfigurationId': 'string',
'Status': 'IN_PROGRESS'|'CANCELED'|'COMPLETED'|'DELETION_IN_PROGRESS'|'SCHEDULED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Tasks (list) --
A list of all of the over-the-air (OTA) tasks.
(dict) --
Structure representing one over-the-air (OTA) task.
TaskId (string) --
The id of the over-the-air (OTA) task.
TaskArn (string) --
The Amazon Resource Name (ARN) of the over-the-air (OTA) task.
CreatedAt (datetime) --
The timestamp value of when the over-the-air (OTA) task was created at.
LastUpdatedAt (datetime) --
The timestamp value of when the over-the-air (OTA) task was last updated at.
TaskConfigurationId (string) --
The identifier for the over-the-air (OTA) task configuration.
Status (string) --
The status of the over-the-air (OTA) task summary.
NextToken (string) --
A token that can be used to retrieve the next set of results.
Get the current state of a device discovery.
See also: AWS API Documentation
Request Syntax
client.get_device_discovery(
Identifier='string'
)
string
[REQUIRED]
The id of the device discovery job request.
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string',
'DiscoveryType': 'ZWAVE'|'ZIGBEE'|'CLOUD',
'Status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT',
'StartedAt': datetime(2015, 1, 1),
'ControllerId': 'string',
'ConnectorAssociationId': 'string',
'FinishedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Id (string) --
The id of the device discovery job request.
Arn (string) --
The Amazon Resource Name (ARN) of the device discovery job request.
DiscoveryType (string) --
The discovery type supporting the type of device to be discovered in the device discovery job request.
Status (string) --
The status of the device discovery job request.
StartedAt (datetime) --
The timestamp value for the start time of the device discovery.
ControllerId (string) --
The id of the end-user's IoT hub.
ConnectorAssociationId (string) --
The ID tracking the current discovery process for one connector association.
FinishedAt (datetime) --
The timestamp value for the completion time of the device discovery.
Tags (dict) --
A set of key/value pairs that are used to manage the device discovery request.
(string) --
(string) --
List all of the over-the-air (OTA) task configurations.
See also: AWS API Documentation
Request Syntax
client.list_ota_task_configurations(
NextToken='string',
MaxResults=123
)
string
A token that can be used to retrieve the next set of results.
integer
The maximum number of results to return at one time.
dict
Response Syntax
{
'Items': [
{
'TaskConfigurationId': 'string',
'Name': 'string',
'CreatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of the over-the-air (OTA) task configurations.
(dict) --
Structure representing one over-the-air (OTA) task configuration.
TaskConfigurationId (string) --
The id of the over-the-air (OTA) task configuration
Name (string) --
The name of the over-the-air (OTA) task configuration.
CreatedAt (datetime) --
The timestamp value of when the over-the-air (OTA) task configuration was created at.
NextToken (string) --
A token that can be used to retrieve the next set of results.