2025/06/26 - Managed integrations for AWS IoT Device Management - 25 new13 updated api methods
Changes Adding managed integrations APIs for IoT Device Management to onboard and control devices across different manufacturers, connectivity protocols and third party vendor clouds. APIs include managed thing operations, provisioning profile management, and cloud connector operations.
Creates a C2C (cloud-to-cloud) connector.
See also: AWS API Documentation
Request Syntax
client.create_cloud_connector(
Name='string',
EndpointConfig={
'lambda': {
'arn': 'string'
}
},
Description='string',
EndpointType='LAMBDA',
ClientToken='string'
)
string
[REQUIRED]
The display name of the C2C connector.
dict
[REQUIRED]
The configuration details for the cloud connector endpoint, including connection parameters and authentication requirements.
lambda (dict) --
The Lambda function configuration for the endpoint, used when the endpoint communicates through an AWS Lambda function.
arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Lambda function used as an endpoint.
string
A description of the C2C connector.
string
The type of endpoint used for the cloud connector, which defines how the connector communicates with external services.
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 unique identifier assigned to the newly created cloud connector.
Deregisters an account association, removing the connection between a managed thing and a third-party account.
See also: AWS API Documentation
Request Syntax
client.deregister_account_association(
ManagedThingId='string',
AccountAssociationId='string'
)
string
[REQUIRED]
The identifier of the managed thing to be deregistered from the account association.
string
[REQUIRED]
The unique identifier of the account association to be deregistered.
None
Lists all account associations for a specific managed thing.
See also: AWS API Documentation
Request Syntax
client.list_managed_thing_account_associations(
ManagedThingId='string',
AccountAssociationId='string',
MaxResults=123,
NextToken='string'
)
string
The identifier of the managed thing to list account associations for.
string
The identifier of the account association to filter results by. When specified, only associations with this account association ID will be returned.
integer
The maximum number of account associations to return in a single response.
string
A token used for pagination of results.
dict
Response Syntax
{
'Items': [
{
'ManagedThingId': 'string',
'AccountAssociationId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of managed thing associations that match the specified criteria, including the managed thing ID and account association ID for each association.
(dict) --
Structure representing an association between a managed thing and an account association, which connects a device to a third-party account.
ManagedThingId (string) --
The identifier of the managed thing in the association.
AccountAssociationId (string) --
The identifier of the account association in the association.
NextToken (string) --
A token used for pagination of results when there are more account associations than can be returned in a single response.
Updates the properties of an existing account association.
See also: AWS API Documentation
Request Syntax
client.update_account_association(
AccountAssociationId='string',
Name='string',
Description='string'
)
string
[REQUIRED]
The unique identifier of the account association to update.
string
The new name to assign to the account association.
string
The new description to assign to the account association.
None
Gets all the information about a connector for a connector developer.
See also: AWS API Documentation
Request Syntax
client.get_cloud_connector(
Identifier='string'
)
string
[REQUIRED]
The identifier of the C2C connector.
dict
Response Syntax
{
'Name': 'string',
'EndpointConfig': {
'lambda': {
'arn': 'string'
}
},
'Description': 'string',
'EndpointType': 'LAMBDA',
'Id': 'string',
'Type': 'LISTED'|'UNLISTED'
}
Response Structure
(dict) --
Name (string) --
The display name of the C2C connector.
EndpointConfig (dict) --
The configuration details for the cloud connector endpoint, including connection parameters and authentication requirements.
lambda (dict) --
The Lambda function configuration for the endpoint, used when the endpoint communicates through an AWS Lambda function.
arn (string) --
The Amazon Resource Name (ARN) of the Lambda function used as an endpoint.
Description (string) --
A description of the C2C connector.
EndpointType (string) --
The type of endpoint used for the cloud connector, which defines how the connector communicates with external services.
Id (string) --
The unique identifier of the cloud connector.
Type (string) --
The type of cloud connector created.
Get an account association for an Amazon Web Services account linked to a customer-managed destination.
See also: AWS API Documentation
Request Syntax
client.get_account_association(
AccountAssociationId='string'
)
string
[REQUIRED]
The unique identifier of the account association to retrieve.
dict
Response Syntax
{
'AccountAssociationId': 'string',
'AssociationState': 'ASSOCIATION_IN_PROGRESS'|'ASSOCIATION_FAILED'|'ASSOCIATION_SUCCEEDED'|'ASSOCIATION_DELETING'|'REFRESH_TOKEN_EXPIRED',
'ErrorMessage': 'string',
'ConnectorDestinationId': 'string',
'Name': 'string',
'Description': 'string',
'Arn': 'string',
'OAuthAuthorizationUrl': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
AccountAssociationId (string) --
The unique identifier of the retrieved account association.
AssociationState (string) --
The current status state for the account association.
ErrorMessage (string) --
The error message explaining the current account association error.
ConnectorDestinationId (string) --
The identifier of the connector destination associated with this account association.
Name (string) --
The name of the account association.
Description (string) --
The description of the account association.
Arn (string) --
The Amazon Resource Name (ARN) of the account association.
OAuthAuthorizationUrl (string) --
Third party IoT platform OAuth authorization server URL backed with all the required parameters to perform end-user authentication.
Tags (dict) --
A set of key/value pairs that are used to manage the account association.
(string) --
(string) --
Returns a list of connectors based on permissions.
See also: AWS API Documentation
Request Syntax
client.list_cloud_connectors(
Type='LISTED'|'UNLISTED',
LambdaArn='string',
MaxResults=123,
NextToken='string'
)
string
The type of cloud connectors to filter by when listing available connectors.
string
The Amazon Resource Name (ARN) of the Lambda function to filter cloud connectors by.
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
{
'Items': [
{
'Name': 'string',
'EndpointConfig': {
'lambda': {
'arn': 'string'
}
},
'Description': 'string',
'EndpointType': 'LAMBDA',
'Id': 'string',
'Type': 'LISTED'|'UNLISTED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of connectors.
(dict) --
Structure describing a connector.
Name (string) --
The display name of the C2C connector.
EndpointConfig (dict) --
The configuration details for the cloud connector endpoint, including connection parameters and authentication requirements.
lambda (dict) --
The Lambda function configuration for the endpoint, used when the endpoint communicates through an AWS Lambda function.
arn (string) --
The Amazon Resource Name (ARN) of the Lambda function used as an endpoint.
Description (string) --
A description of the C2C connector.
EndpointType (string) --
The type of endpoint used for the C2C connector.
Id (string) --
The identifier of the C2C connector.
Type (string) --
The type of cloud connector created.
NextToken (string) --
A token that can be used to retrieve the next set of results.
Initiates a refresh of an existing account association to update its authorization and connection status.
See also: AWS API Documentation
Request Syntax
client.start_account_association_refresh(
AccountAssociationId='string'
)
string
[REQUIRED]
The unique identifier of the account association to refresh.
dict
Response Syntax
{
'OAuthAuthorizationUrl': 'string'
}
Response Structure
(dict) --
OAuthAuthorizationUrl (string) --
Third-party IoT platform OAuth authorization server URL with all required parameters to perform end-user authentication during the refresh process.
Registers an account association with a managed thing, establishing a connection between a device and a third-party account.
See also: AWS API Documentation
Request Syntax
client.register_account_association(
ManagedThingId='string',
AccountAssociationId='string',
DeviceDiscoveryId='string'
)
string
[REQUIRED]
The identifier of the managed thing to register with the account association.
string
[REQUIRED]
The identifier of the account association to register with the managed thing.
string
[REQUIRED]
The identifier of the device discovery job associated with this registration.
dict
Response Syntax
{
'AccountAssociationId': 'string',
'DeviceDiscoveryId': 'string',
'ManagedThingId': 'string'
}
Response Structure
(dict) --
AccountAssociationId (string) --
The identifier of the account association that was registered.
DeviceDiscoveryId (string) --
The identifier of the device discovery job associated with this registration.
ManagedThingId (string) --
The identifier of the managed thing that was registered with the account association.
Create a connector destination for connecting a cloud-to-cloud (C2C) connector to the customer's Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.create_connector_destination(
Name='string',
Description='string',
CloudConnectorId='string',
AuthType='OAUTH',
AuthConfig={
'oAuth': {
'authUrl': 'string',
'tokenUrl': 'string',
'scope': 'string',
'tokenEndpointAuthenticationScheme': 'HTTP_BASIC'|'REQUEST_BODY_CREDENTIALS',
'oAuthCompleteRedirectUrl': 'string',
'proactiveRefreshTokenRenewal': {
'enabled': True|False,
'DaysBeforeRenewal': 123
}
}
},
SecretsManager={
'arn': 'string',
'versionId': 'string'
},
ClientToken='string'
)
string
The display name of the connector destination.
string
A description of the connector destination.
string
[REQUIRED]
The identifier of the C2C connector.
string
[REQUIRED]
The authentication type used for the connector destination, which determines how credentials and access are managed.
dict
[REQUIRED]
The authentication configuration details for the connector destination, including OAuth settings and other authentication parameters.
oAuth (dict) --
The OAuth configuration settings used for authentication with the third-party service.
authUrl (string) -- [REQUIRED]
The authorization URL for the OAuth service, where users are directed to authenticate and authorize access.
tokenUrl (string) -- [REQUIRED]
The token URL for the OAuth service, where authorization codes are exchanged for access tokens.
scope (string) --
The OAuth scopes requested during authorization, which define the permissions granted to the application.
tokenEndpointAuthenticationScheme (string) -- [REQUIRED]
The authentication scheme used when requesting tokens from the token endpoint.
oAuthCompleteRedirectUrl (string) --
The URL where users are redirected after completing the OAuth authorization process.
proactiveRefreshTokenRenewal (dict) --
Configuration for proactively refreshing OAuth tokens before they expire.
enabled (boolean) --
Indicates whether proactive refresh token renewal is enabled.
DaysBeforeRenewal (integer) --
The days before token expiration when the system should attempt to renew the token, specified in days.
dict
[REQUIRED]
The AWS Secrets Manager configuration used to securely store and manage sensitive information for the connector destination.
arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the AWS Secrets Manager secret.
versionId (string) -- [REQUIRED]
The version ID of the AWS Secrets Manager secret.
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 C2C connector destination creation request.
List tags for the specified resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceArn='string'
)
string
[REQUIRED]
The ARN of the resource for which to list tags.
dict
Response Syntax
{
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
tags (dict) --
A set of key/value pairs that are used to manage the resource.
(string) --
(string) --
Delete a cloud connector.
See also: AWS API Documentation
Request Syntax
client.delete_cloud_connector(
Identifier='string'
)
string
[REQUIRED]
The identifier of the cloud connector.
None
Remove tags for the specified resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The ARN of the resource to which to add tags.
list
[REQUIRED]
A list of tag keys to remove from the resource.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Updates the properties of an existing connector destination.
See also: AWS API Documentation
Request Syntax
client.update_connector_destination(
Identifier='string',
Description='string',
Name='string',
AuthType='OAUTH',
AuthConfig={
'oAuthUpdate': {
'oAuthCompleteRedirectUrl': 'string',
'proactiveRefreshTokenRenewal': {
'enabled': True|False,
'DaysBeforeRenewal': 123
}
}
},
SecretsManager={
'arn': 'string',
'versionId': 'string'
}
)
string
[REQUIRED]
The unique identifier of the connector destination to update.
string
The new description to assign to the connector destination.
string
The new display name to assign to the connector destination.
string
The new authentication type to use for the connector destination.
dict
The updated authentication configuration details for the connector destination.
oAuthUpdate (dict) --
The updated OAuth configuration settings for the authentication configuration.
oAuthCompleteRedirectUrl (string) --
The updated URL where users are redirected after completing the OAuth authorization process.
proactiveRefreshTokenRenewal (dict) --
Updated configuration for proactively refreshing OAuth tokens before they expire.
enabled (boolean) --
Indicates whether proactive refresh token renewal is enabled.
DaysBeforeRenewal (integer) --
The days before token expiration when the system should attempt to renew the token, specified in days.
dict
The updated AWS Secrets Manager configuration for the connector destination.
arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the AWS Secrets Manager secret.
versionId (string) -- [REQUIRED]
The version ID of the AWS Secrets Manager secret.
None
Get a connector destination of a cloud-to-cloud (C2C) connector connecting to a customer's Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.get_connector_destination(
Identifier='string'
)
string
[REQUIRED]
The identifier of the C2C connector destination.
dict
Response Syntax
{
'Name': 'string',
'Description': 'string',
'CloudConnectorId': 'string',
'Id': 'string',
'AuthType': 'OAUTH',
'AuthConfig': {
'oAuth': {
'authUrl': 'string',
'tokenUrl': 'string',
'scope': 'string',
'tokenEndpointAuthenticationScheme': 'HTTP_BASIC'|'REQUEST_BODY_CREDENTIALS',
'oAuthCompleteRedirectUrl': 'string',
'proactiveRefreshTokenRenewal': {
'enabled': True|False,
'DaysBeforeRenewal': 123
}
}
},
'SecretsManager': {
'arn': 'string',
'versionId': 'string'
},
'OAuthCompleteRedirectUrl': 'string'
}
Response Structure
(dict) --
Name (string) --
The display name of the connector destination.
Description (string) --
A description of the connector destination.
CloudConnectorId (string) --
The identifier of the C2C connector.
Id (string) --
The unique identifier of the connector destination.
AuthType (string) --
The authentication type used for the connector destination, which determines how credentials and access are managed.
AuthConfig (dict) --
The authentication configuration details for the connector destination, including OAuth settings and other authentication parameters.
oAuth (dict) --
The OAuth configuration settings used for authentication with the third-party service.
authUrl (string) --
The authorization URL for the OAuth service, where users are directed to authenticate and authorize access.
tokenUrl (string) --
The token URL for the OAuth service, where authorization codes are exchanged for access tokens.
scope (string) --
The OAuth scopes requested during authorization, which define the permissions granted to the application.
tokenEndpointAuthenticationScheme (string) --
The authentication scheme used when requesting tokens from the token endpoint.
oAuthCompleteRedirectUrl (string) --
The URL where users are redirected after completing the OAuth authorization process.
proactiveRefreshTokenRenewal (dict) --
Configuration for proactively refreshing OAuth tokens before they expire.
enabled (boolean) --
Indicates whether proactive refresh token renewal is enabled.
DaysBeforeRenewal (integer) --
The days before token expiration when the system should attempt to renew the token, specified in days.
SecretsManager (dict) --
The AWS Secrets Manager configuration used to securely store and manage sensitive information for the connector destination.
arn (string) --
The Amazon Resource Name (ARN) of the AWS Secrets Manager secret.
versionId (string) --
The version ID of the AWS Secrets Manager secret.
OAuthCompleteRedirectUrl (string) --
The URL where users are redirected after completing the OAuth authorization process for the connector destination.
Delete a connector destination for connecting a cloud-to-cloud (C2C) connector to the customer's Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.delete_connector_destination(
Identifier='string'
)
string
[REQUIRED]
The identifier of the connector destination.
None
Lists all connector destinations, with optional filtering by cloud connector ID.
See also: AWS API Documentation
Request Syntax
client.list_connector_destinations(
CloudConnectorId='string',
NextToken='string',
MaxResults=123
)
string
The identifier of the cloud connector to filter connector destinations by.
string
A token used for pagination of results.
integer
The maximum number of connector destinations to return in a single response.
dict
Response Syntax
{
'ConnectorDestinationList': [
{
'Name': 'string',
'Description': 'string',
'CloudConnectorId': 'string',
'Id': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ConnectorDestinationList (list) --
The list of connector destinations that match the specified criteria.
(dict) --
Structure containing summary information about a connector destination, which defines how a cloud-to-cloud connector connects to a customer's AWS account.
Name (string) --
The display name of the connector destination.
Description (string) --
A description of the connector destination.
CloudConnectorId (string) --
The identifier of the cloud connector associated with this connector destination.
Id (string) --
The unique identifier of the connector destination.
NextToken (string) --
A token used for pagination of results when there are more connector destinations than can be returned in a single response.
Lists all account associations, with optional filtering by connector destination ID.
See also: AWS API Documentation
Request Syntax
client.list_account_associations(
ConnectorDestinationId='string',
MaxResults=123,
NextToken='string'
)
string
The identifier of the connector destination to filter account associations by.
integer
The maximum number of account associations to return in a single response.
string
A token used for pagination of results.
dict
Response Syntax
{
'Items': [
{
'AccountAssociationId': 'string',
'AssociationState': 'ASSOCIATION_IN_PROGRESS'|'ASSOCIATION_FAILED'|'ASSOCIATION_SUCCEEDED'|'ASSOCIATION_DELETING'|'REFRESH_TOKEN_EXPIRED',
'ErrorMessage': 'string',
'ConnectorDestinationId': 'string',
'Name': 'string',
'Description': 'string',
'Arn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of account associations that match the specified criteria.
(dict) --
Structure containing information about an account association, including its identifier, state, and related metadata.
AccountAssociationId (string) --
The unique identifier of the account association.
AssociationState (string) --
The current state of the account association, indicating its status in the association lifecycle.
ErrorMessage (string) --
The error message explaining any issues with the account association, if applicable.
ConnectorDestinationId (string) --
The identifier of the connector destination associated with this account association.
Name (string) --
The name of the account association.
Description (string) --
A description of the account association.
Arn (string) --
The Amazon Resource Name (ARN) of the account association.
NextToken (string) --
A token used for pagination of results when there are more account associations than can be returned in a single response.
Creates a new account association via the destination id.
See also: AWS API Documentation
Request Syntax
client.create_account_association(
ClientToken='string',
ConnectorDestinationId='string',
Name='string',
Description='string',
Tags={
'string': 'string'
}
)
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
[REQUIRED]
The identifier of the connector destination.
string
The name of the destination for the new account association.
string
A description of the account association request.
dict
A set of key/value pairs that are used to manage the account association.
(string) --
(string) --
dict
Response Syntax
{
'OAuthAuthorizationUrl': 'string',
'AccountAssociationId': 'string',
'AssociationState': 'ASSOCIATION_IN_PROGRESS'|'ASSOCIATION_FAILED'|'ASSOCIATION_SUCCEEDED'|'ASSOCIATION_DELETING'|'REFRESH_TOKEN_EXPIRED',
'Arn': 'string'
}
Response Structure
(dict) --
OAuthAuthorizationUrl (string) --
Third-party IoT platform OAuth authorization server URL backed with all the required parameters to perform end-user authentication.
AccountAssociationId (string) --
The identifier for the account association request.
AssociationState (string) --
The current state of the account association request.
Arn (string) --
The Amazon Resource Name (ARN) of the account association.
Update an existing cloud connector.
See also: AWS API Documentation
Request Syntax
client.update_cloud_connector(
Identifier='string',
Name='string',
Description='string'
)
string
[REQUIRED]
The unique identifier of the cloud connector to update.
string
The new display name to assign to the cloud connector.
string
The new description to assign to the cloud connector.
None
Lists all device discovery tasks, with optional filtering by type and status.
See also: AWS API Documentation
Request Syntax
client.list_device_discoveries(
NextToken='string',
MaxResults=123,
TypeFilter='ZWAVE'|'ZIGBEE'|'CLOUD'|'CUSTOM',
StatusFilter='RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'
)
string
A token used for pagination of results.
integer
The maximum number of device discovery jobs to return in a single response.
string
The discovery type to filter device discovery jobs by.
string
The status to filter device discovery jobs by.
dict
Response Syntax
{
'Items': [
{
'Id': 'string',
'DiscoveryType': 'ZWAVE'|'ZIGBEE'|'CLOUD'|'CUSTOM',
'Status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of device discovery jobs that match the specified criteria.
(dict) --
Structure containing summary information about a device discovery job, including its identifier, type, and status.
Id (string) --
The unique identifier of the device discovery job.
DiscoveryType (string) --
The type of discovery process used to find devices.
Status (string) --
The current status of the device discovery job.
NextToken (string) --
A token used for pagination of results when there are more device discovery jobs than can be returned in a single response.
Lists all devices discovered during a specific device discovery task.
See also: AWS API Documentation
Request Syntax
client.list_discovered_devices(
Identifier='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The identifier of the device discovery job to list discovered devices for.
string
A token used for pagination of results.
integer
The maximum number of discovered devices to return in a single response.
dict
Response Syntax
{
'Items': [
{
'ConnectorDeviceId': 'string',
'ConnectorDeviceName': 'string',
'DeviceTypes': [
'string',
],
'ManagedThingId': 'string',
'Modification': 'DISCOVERED'|'UPDATED'|'NO_CHANGE',
'DiscoveredAt': datetime(2015, 1, 1),
'Brand': 'string',
'Model': 'string',
'AuthenticationMaterial': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The list of discovered devices that match the specified criteria.
(dict) --
Structure containing summary information about a device discovered during a device discovery job.
ConnectorDeviceId (string) --
The third-party device identifier as defined by the connector. This identifier must not contain personal identifiable information (PII).
ConnectorDeviceName (string) --
The name of the device as defined by the connector or third-party system.
DeviceTypes (list) --
The list of device types or categories that the discovered device belongs to.
(string) --
ManagedThingId (string) --
The identifier of the managed thing created for this discovered device, if one exists.
Modification (string) --
The status of the discovered device, indicating whether it has been added, removed, or modified since the last discovery.
DiscoveredAt (datetime) --
The timestamp indicating when the device was discovered.
Brand (string) --
The brand of the discovered device.
Model (string) --
The model of the discovered device.
AuthenticationMaterial (string) --
The authentication material required for connecting to the discovered device, such as credentials or tokens.
NextToken (string) --
A token used for pagination of results when there are more discovered devices than can be returned in a single response.
Remove a third party account and related devices from an end user.
See also: AWS API Documentation
Request Syntax
client.delete_account_association(
AccountAssociationId='string'
)
string
[REQUIRED]
The unique identifier of the account association to be deleted.
None
Add tags for the specified resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The ARN of the resource to which to add tags.
dict
[REQUIRED]
A set of key/value pairs that are used to manage the resource
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Relays third-party device events for a connector such as a new device or a device state change event.
See also: AWS API Documentation
Request Syntax
client.send_connector_event(
ConnectorId='string',
UserId='string',
Operation='DEVICE_COMMAND_RESPONSE'|'DEVICE_DISCOVERY'|'DEVICE_EVENT'|'DEVICE_COMMAND_REQUEST',
OperationVersion='string',
StatusCode=123,
Message='string',
DeviceDiscoveryId='string',
ConnectorDeviceId='string',
TraceId='string',
Devices=[
{
'ConnectorDeviceId': 'string',
'ConnectorDeviceName': 'string',
'CapabilityReport': {
'version': 'string',
'nodeId': 'string',
'endpoints': [
{
'id': 'string',
'deviceTypes': [
'string',
],
'clusters': [
{
'id': 'string',
'revision': 123,
'publicId': 'string',
'name': 'string',
'specVersion': 'string',
'attributes': [
{
'id': 'string',
'name': 'string',
'value': {...}|[...]|123|123.4|'string'|True|None
},
],
'commands': [
'string',
],
'events': [
'string',
],
'featureMap': 123,
'generatedCommands': [
'string',
],
'fabricIndex': 123
},
],
'parts': [
'string',
],
'semanticTags': [
'string',
],
'clientClusters': [
'string',
]
},
]
},
'CapabilitySchemas': [
{
'Format': 'AWS'|'ZCL'|'CONNECTOR',
'CapabilityId': 'string',
'ExtrinsicId': 'string',
'ExtrinsicVersion': 123,
'Schema': {...}|[...]|123|123.4|'string'|True|None
},
],
'DeviceMetadata': {...}|[...]|123|123.4|'string'|True|None
},
],
MatterEndpoint={
'id': 'string',
'clusters': [
{
'id': 'string',
'attributes': {...}|[...]|123|123.4|'string'|True|None,
'commands': {
'string': {...}|[...]|123|123.4|'string'|True|None
},
'events': {
'string': {...}|[...]|123|123.4|'string'|True|None
}
},
]
}
)
string
[REQUIRED]
The id of the connector between the third-party cloud provider and IoT managed integrations.
string
The id of the third-party cloud provider.
string
[REQUIRED]
The Open Connectivity Foundation (OCF) operation requested to be performed on the managed thing.
string
The Open Connectivity Foundation (OCF) security specification version for the operation being requested on the managed thing. For more information, see OCF Security Specification.
integer
The status code of the Open Connectivity Foundation (OCF) operation being performed on the managed thing.
string
The device state change event payload.
This parameter will include the following three fields:
uri: schema auc://<PARTNER-DEVICE-ID>/ResourcePath (The Resourcepath corresponds to an OCF resource.)
op: For device state changes, this field must populate as n+d.
cn: The content depends on the OCF resource referenced in ResourcePath.
string
The id for the device discovery job.
string
The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII).
string
The trace request identifier used to correlate a command request and response. This is specified by the device owner, but will be generated by IoT managed integrations if not provided by the device owner.
list
The list of devices.
(dict) --
Describe the device using the relevant metadata and supported clusters for device discovery.
ConnectorDeviceId (string) -- [REQUIRED]
The device id as defined by the connector.
ConnectorDeviceName (string) --
The name of the device as defined by the connector.
CapabilityReport (dict) -- [REQUIRED]
The capability report for the device.
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) --
Matter endpoint used in capability report.
id (string) -- [REQUIRED]
The id of the Amazon Web Services Matter capability report endpoint.
deviceTypes (list) -- [REQUIRED]
The type of device.
(string) --
clusters (list) -- [REQUIRED]
Matter clusters used in capability report.
(dict) --
Capability used in Matter capability report.
id (string) -- [REQUIRED]
The id of the Amazon Web Services Matter capability report cluster.
revision (integer) -- [REQUIRED]
The id of the revision for the Amazon Web Services Matter capability report.
publicId (string) --
The id of the schema version.
name (string) --
The capability name used in the Amazon Web Services Matter capability report.
specVersion (string) --
The spec version used in the Amazon Web Services Matter capability report.
attributes (list) --
The attributes of the Amazon Web Services Matter capability report.
(dict) --
Matter attribute used in capability report.
id (string) --
The id of the Matter attribute.
name (string) --
Name for the Amazon Web Services Matter capability report attribute.
value (:ref:`document<document>`) --
Value for the Amazon Web Services Matter capability report attribute.
commands (list) --
The commands used with the Amazon Web Services Matter capability report.
(string) --
events (list) --
The events used with the Amazon Web Services Matter capability report.
(string) --
featureMap (integer) --
32 bit-map used to indicate which features a cluster supports.
generatedCommands (list) --
Matter clusters used in capability report.
(string) --
fabricIndex (integer) --
The fabric index for the Amazon Web Services Matter capability report.
parts (list) --
Heirachy of child endpoints contained in the given endpoint.
(string) --
semanticTags (list) --
Semantic information related to endpoint.
(string) --
clientClusters (list) --
Semantic information related to endpoint.
(string) --
CapabilitySchemas (list) --
Report of all capabilities supported by the device.
(dict) --
Structure representing a capability schema item that defines the functionality and features supported by a managed thing.
Format (string) -- [REQUIRED]
The format of the capability schema, which defines how the schema is structured and interpreted.
CapabilityId (string) -- [REQUIRED]
The unique identifier of the capability defined in the schema.
ExtrinsicId (string) -- [REQUIRED]
The external identifier for the capability, used when referencing the capability outside of the AWS ecosystem.
ExtrinsicVersion (integer) -- [REQUIRED]
The version of the external capability definition, used to track compatibility with external systems.
Schema (:ref:`document<document>`) -- [REQUIRED]
The actual schema definition that describes the capability's properties, actions, and events.
DeviceMetadata (:ref:`document<document>`) --
The metadata attributes for a device.
dict
The device endpoint.
id (string) --
The Matter endpoint id.
clusters (list) --
A list of Matter clusters for a managed thing.
(dict) --
Describe a Matter cluster with an id, and the relevant attributes, commands, and events.
id (string) --
The cluster id.
attributes (:ref:`document<document>`) --
The Matter attributes.
commands (dict) --
Describe the Matter commands with the Matter command identifier mapped to the command fields.
(string) --
(:ref:`document<document>`) --
events (dict) --
Describe the Matter events with the Matter event identifier mapped to the event fields.
(string) --
(:ref:`document<document>`) --
dict
Response Syntax
{
'ConnectorId': 'string'
}
Response Structure
(dict) --
ConnectorId (string) --
The id of the connector between the third-party cloud provider and IoT managed integrations.
{'AuthenticationMaterialType': {'CUSTOM_PROTOCOL_QR_BAR_CODE',
'DISCOVERED_DEVICE'},
'CapabilitySchemas': [{'CapabilityId': 'string',
'ExtrinsicId': 'string',
'ExtrinsicVersion': 'integer',
'Format': 'AWS | ZCL | CONNECTOR',
'Schema': {}}]}
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='CUSTOM_PROTOCOL_QR_BAR_CODE'|'WIFI_SETUP_QR_BAR_CODE'|'ZWAVE_QR_BAR_CODE'|'ZIGBEE_QR_BAR_CODE'|'DISCOVERED_DEVICE',
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',
]
},
]
},
]
},
CapabilitySchemas=[
{
'Format': 'AWS'|'ZCL'|'CONNECTOR',
'CapabilityId': 'string',
'ExtrinsicId': 'string',
'ExtrinsicVersion': 123,
'Schema': {...}|[...]|123|123.4|'string'|True|None
},
],
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) --
list
The capability schemas that define the functionality and features supported by the managed thing, including device capabilities and their associated properties.
(dict) --
Structure representing a capability schema item that defines the functionality and features supported by a managed thing.
Format (string) -- [REQUIRED]
The format of the capability schema, which defines how the schema is structured and interpreted.
CapabilityId (string) -- [REQUIRED]
The unique identifier of the capability defined in the schema.
ExtrinsicId (string) -- [REQUIRED]
The external identifier for the capability, used when referencing the capability outside of the AWS ecosystem.
ExtrinsicVersion (integer) -- [REQUIRED]
The version of the external capability definition, used to track compatibility with external systems.
Schema (:ref:`document<document>`) -- [REQUIRED]
The actual schema definition that describes the capability's properties, actions, and events.
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.
{'EventType': {'DEVICE_DISCOVERY_STATUS', 'ACCOUNT_ASSOCIATION'}}
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_DISCOVERY_STATUS'|'DEVICE_EVENT'|'DEVICE_LIFE_CYCLE'|'DEVICE_STATE'|'DEVICE_OTA'|'CONNECTOR_ASSOCIATION'|'ACCOUNT_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_DISCOVERY_STATUS'|'DEVICE_EVENT'|'DEVICE_LIFE_CYCLE'|'DEVICE_STATE'|'DEVICE_OTA'|'CONNECTOR_ASSOCIATION'|'ACCOUNT_ASSOCIATION'|'CONNECTOR_ERROR_REPORT'
}
Response Structure
(dict) --
EventType (string) --
The type of event triggering a device notification to the customer-managed destination.
{'EventType': {'DEVICE_DISCOVERY_STATUS', 'ACCOUNT_ASSOCIATION'}}
Deletes a notification configuration.
See also: AWS API Documentation
Request Syntax
client.delete_notification_configuration(
EventType='DEVICE_COMMAND'|'DEVICE_COMMAND_REQUEST'|'DEVICE_DISCOVERY_STATUS'|'DEVICE_EVENT'|'DEVICE_LIFE_CYCLE'|'DEVICE_STATE'|'DEVICE_OTA'|'CONNECTOR_ASSOCIATION'|'ACCOUNT_ASSOCIATION'|'CONNECTOR_ERROR_REPORT'
)
string
[REQUIRED]
The type of event triggering a device notification to the customer-managed destination.
None
{'AccountAssociationId': 'string', 'DiscoveryType': {'CUSTOM'}}
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'|'CUSTOM',
'Status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT',
'StartedAt': datetime(2015, 1, 1),
'ControllerId': 'string',
'ConnectorAssociationId': 'string',
'AccountAssociationId': '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.
AccountAssociationId (string) --
The identifier of the account association used for the device discovery.
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) --
{'ConnectorDestinationId': 'string'}
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',
'ConnectorDestinationId': '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.
ConnectorDestinationId (string) --
The identifier of the connector destination associated with this managed thing.
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) --
{'EventType': {'DEVICE_DISCOVERY_STATUS', 'ACCOUNT_ASSOCIATION'}}
Get a notification configuration.
See also: AWS API Documentation
Request Syntax
client.get_notification_configuration(
EventType='DEVICE_COMMAND'|'DEVICE_COMMAND_REQUEST'|'DEVICE_DISCOVERY_STATUS'|'DEVICE_EVENT'|'DEVICE_LIFE_CYCLE'|'DEVICE_STATE'|'DEVICE_OTA'|'CONNECTOR_ASSOCIATION'|'ACCOUNT_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_DISCOVERY_STATUS'|'DEVICE_EVENT'|'DEVICE_LIFE_CYCLE'|'DEVICE_STATE'|'DEVICE_OTA'|'CONNECTOR_ASSOCIATION'|'ACCOUNT_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) --
{'Tags': {'string': 'string'}}
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',
'Tags': {
'string': 'string'
}
}
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.
Tags (dict) --
A set of key/value pairs that are used to manage the over-the-air (OTA) task.
(string) --
(string) --
{'ConnectorDestinationIdFilter': 'string', 'ConnectorDeviceIdFilter': 'string'}
Response {'Items': {'ConnectorDestinationId': 'string'}}
Listing all managed things with provision for filters.
See also: AWS API Documentation
Request Syntax
client.list_managed_things(
OwnerFilter='string',
CredentialLockerFilter='string',
RoleFilter='CONTROLLER'|'DEVICE',
ParentControllerIdentifierFilter='string',
ConnectorPolicyIdFilter='string',
ConnectorDestinationIdFilter='string',
ConnectorDeviceIdFilter='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 managed things by the connector destination ID they are associated with.
string
Filter managed things by the connector device ID they are associated with. When specified, only managed things with this connector device ID will be returned.
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',
'ConnectorDestinationId': '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.
ConnectorDestinationId (string) --
The identifier of the connector destination associated with this managed thing, if applicable.
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.
{'NotificationConfigurationList': {'EventType': {'ACCOUNT_ASSOCIATION',
'DEVICE_DISCOVERY_STATUS'}}}
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_DISCOVERY_STATUS'|'DEVICE_EVENT'|'DEVICE_LIFE_CYCLE'|'DEVICE_STATE'|'DEVICE_OTA'|'CONNECTOR_ASSOCIATION'|'ACCOUNT_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.
{'AccountAssociationId': 'string'}
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',
AccountAssociationId='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.
string
The identifier of the account association to use when sending a command to a managed thing.
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.
{'AccountAssociationId': 'string',
'CustomProtocolDetail': {'string': 'string'},
'DiscoveryType': {'CUSTOM'}}
This API is used to start device discovery for hub-connected and third-party-connected devices. 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'|'CUSTOM',
CustomProtocolDetail={
'string': 'string'
},
ControllerIdentifier='string',
ConnectorAssociationIdentifier='string',
AccountAssociationId='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 task request.
dict
Additional protocol-specific details required for device discovery, which vary based on the discovery type.
(string) --
(string) --
string
The id of the end-user's IoT hub.
string
The id of the connector association.
string
The identifier of the cloud-to-cloud account association to use for discovery of third-party devices.
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.
{'CapabilitySchemas': [{'CapabilityId': 'string',
'ExtrinsicId': 'string',
'ExtrinsicVersion': 'integer',
'Format': 'AWS | ZCL | CONNECTOR',
'Schema': {}}]}
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',
]
},
]
},
]
},
CapabilitySchemas=[
{
'Format': 'AWS'|'ZCL'|'CONNECTOR',
'CapabilityId': 'string',
'ExtrinsicId': 'string',
'ExtrinsicVersion': 123,
'Schema': {...}|[...]|123|123.4|'string'|True|None
},
],
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) --
list
The updated capability schemas that define the functionality and features supported by the managed thing.
(dict) --
Structure representing a capability schema item that defines the functionality and features supported by a managed thing.
Format (string) -- [REQUIRED]
The format of the capability schema, which defines how the schema is structured and interpreted.
CapabilityId (string) -- [REQUIRED]
The unique identifier of the capability defined in the schema.
ExtrinsicId (string) -- [REQUIRED]
The external identifier for the capability, used when referencing the capability outside of the AWS ecosystem.
ExtrinsicVersion (integer) -- [REQUIRED]
The version of the external capability definition, used to track compatibility with external systems.
Schema (:ref:`document<document>`) -- [REQUIRED]
The actual schema definition that describes the capability's properties, actions, and events.
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
{'EventType': {'DEVICE_DISCOVERY_STATUS', 'ACCOUNT_ASSOCIATION'}}
Update a notification configuration.
See also: AWS API Documentation
Request Syntax
client.update_notification_configuration(
EventType='DEVICE_COMMAND'|'DEVICE_COMMAND_REQUEST'|'DEVICE_DISCOVERY_STATUS'|'DEVICE_EVENT'|'DEVICE_LIFE_CYCLE'|'DEVICE_STATE'|'DEVICE_OTA'|'CONNECTOR_ASSOCIATION'|'ACCOUNT_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