AWS API Changes

2026/01/12 - Managed integrations for AWS IoT Device Management - 11 updated api methods

Changes This release introduces WiFi Simple Setup (WSS) enabling device provisioning via barcode scanning with automated network discovery, authentication, and credential provisioning. Additionally, it introduces 2P Device Capability Rediscovery for updating hub-managed device capabilities post-onboarding.

CreateManagedThing (updated)

Link ¶
Changes (request)

{'WiFiSimpleSetupConfiguration': {'EnableAsProvisionee': 'boolean',
                                  'EnableAsProvisioner': 'boolean',
                                  'TimeoutInMinutes': 'integer'}}

Creates a managed thing. A managed thing contains the device identifier, protocol supported, and capabilities of the device in a data model format defined by Managed integrations.

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',
    WiFiSimpleSetupConfiguration={
        'EnableAsProvisioner': True|False,
        'EnableAsProvisionee': True|False,
        'TimeoutInMinutes': 123
    },
    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'
    }
)

type Role:

string

param Role:

[REQUIRED]

The type of device used. This will be the hub controller, cloud device, or AWS IoT device.

type Owner:

string

param Owner:

Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.

type CredentialLockerId:

string

param CredentialLockerId:

The identifier of the credential for the managed thing.

type AuthenticationMaterial:

string

param AuthenticationMaterial:

[REQUIRED]

The authentication material defining the device connectivity setup requests. The authentication materials used are the device bar code.

type AuthenticationMaterialType:

string

param AuthenticationMaterialType:

[REQUIRED]

The type of authentication material used for device connectivity setup requests.

type WiFiSimpleSetupConfiguration:

dict

param WiFiSimpleSetupConfiguration:

The Wi-Fi Simple Setup configuration for the managed thing, which defines provisioning capabilities and timeout settings.

EnableAsProvisioner (boolean) --

Indicates whether the device can act as a provisioner in Wi-Fi Simple Setup, allowing it to configure other devices.
EnableAsProvisionee (boolean) --

Indicates whether the device can act as a provisionee in Wi-Fi Simple Setup, allowing it to be configured by other devices.
TimeoutInMinutes (integer) --

The timeout duration in minutes for Wi-Fi Simple Setup. Valid range is 5 to 15 minutes.

type SerialNumber:

string

param SerialNumber:

The serial number of the device.

type Brand:

string

param Brand:

The brand of the device.

type Model:

string

param Model:

The model of the device.

type Name:

string

param Name:

The name of the managed thing representing the physical device.

type CapabilityReport:

dict

param CapabilityReport:

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) --

type CapabilitySchemas:

list

param CapabilitySchemas:

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.

type Capabilities:

string

param Capabilities:

The capabilities of the device such as light bulb.

type ClientToken:

string

param ClientToken:

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.

type Classification:

string

param Classification:

The classification of the managed thing such as light bulb or thermostat.

type Tags:

dict

param Tags:

A set of key/value pairs that are used to manage the managed thing.

(string) --
- (string) --

type MetaData:

dict

param MetaData:

The metadata for the managed thing.

(string) --
- (string) --

rtype:

dict

returns:

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.

CreateNotificationConfiguration (updated)

Link ¶
Changes (both)

{'EventType': {'DEVICE_WSS'}}

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'|'DEVICE_WSS'|'CONNECTOR_ASSOCIATION'|'ACCOUNT_ASSOCIATION'|'CONNECTOR_ERROR_REPORT',
    DestinationName='string',
    ClientToken='string',
    Tags={
        'string': 'string'
    }
)

type EventType:

string

param EventType:

[REQUIRED]

The type of event triggering a device notification to the customer-managed destination.

type DestinationName:

string

param DestinationName:

[REQUIRED]

The name of the destination for the notification configuration.

type ClientToken:

string

param ClientToken:

This field is autopopulated if not provided.

type Tags:

dict

param Tags:

A set of key/value pairs that are used to manage the notification configuration.

(string) --
- (string) --

rtype:

dict

returns:

Response Syntax

{
    'EventType': 'DEVICE_COMMAND'|'DEVICE_COMMAND_REQUEST'|'DEVICE_DISCOVERY_STATUS'|'DEVICE_EVENT'|'DEVICE_LIFE_CYCLE'|'DEVICE_STATE'|'DEVICE_OTA'|'DEVICE_WSS'|'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.

DeleteNotificationConfiguration (updated)

Link ¶
Changes (request)

{'EventType': {'DEVICE_WSS'}}

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'|'DEVICE_WSS'|'CONNECTOR_ASSOCIATION'|'ACCOUNT_ASSOCIATION'|'CONNECTOR_ERROR_REPORT'
)

type EventType:

string

param EventType:

[REQUIRED]

The type of event triggering a device notification to the customer-managed destination.

returns:

None

GetDeviceDiscovery (updated)

Link ¶
Changes (response)

{'DiscoveryType': {'CONTROLLER_CAPABILITY_REDISCOVERY'}}

Get the current state of a device discovery.

See also: AWS API Documentation

Request Syntax

client.get_device_discovery(
    Identifier='string'
)

type Identifier:

string

param Identifier:

[REQUIRED]

The id of the device discovery job request.

rtype:

dict

returns:

Response Syntax

{
    'Id': 'string',
    'Arn': 'string',
    'DiscoveryType': 'ZWAVE'|'ZIGBEE'|'CLOUD'|'CUSTOM'|'CONTROLLER_CAPABILITY_REDISCOVERY',
    '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) --

GetManagedThing (updated)

Link ¶
Changes (response)

{'WiFiSimpleSetupConfiguration': {'EnableAsProvisionee': 'boolean',
                                  'EnableAsProvisioner': 'boolean',
                                  'TimeoutInMinutes': 'integer'}}

Get details of a managed thing including its attributes and capabilities.

See also: AWS API Documentation

Request Syntax

client.get_managed_thing(
    Identifier='string'
)

type Identifier:

string

param Identifier:

[REQUIRED]

The id of the managed thing.

rtype:

dict

returns:

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'
    },
    'WiFiSimpleSetupConfiguration': {
        'EnableAsProvisioner': True|False,
        'EnableAsProvisionee': True|False,
        'TimeoutInMinutes': 123
    }
}

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. For more information, see Device Provisioning.
- 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.
  
  Note
  
  This parameter is used for cloud-to-cloud devices only.
- 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).
  
  Note
  
  This parameter is used for cloud-to-cloud devices only.
- DeviceSpecificKey (string) --
  
  A Zwave device-specific key used during device activation.
  
  Note
  
  This parameter is used for Zwave devices only.
- MacAddress (string) --
  
  The media access control (MAC) address for the device represented by the managed thing.
  
  Note
  
  This parameter is used for Zigbee devices only.
- 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) --
- WiFiSimpleSetupConfiguration (dict) --
  
  The Wi-Fi Simple Setup configuration for the managed thing, which defines provisioning capabilities and timeout settings.
  - EnableAsProvisioner (boolean) --
    
    Indicates whether the device can act as a provisioner in Wi-Fi Simple Setup, allowing it to configure other devices.
  - EnableAsProvisionee (boolean) --
    
    Indicates whether the device can act as a provisionee in Wi-Fi Simple Setup, allowing it to be configured by other devices.
  - TimeoutInMinutes (integer) --
    
    The timeout duration in minutes for Wi-Fi Simple Setup. Valid range is 5 to 15 minutes.

GetNotificationConfiguration (updated)

Link ¶
Changes (both)

{'EventType': {'DEVICE_WSS'}}

Get a notification configuration for a specified event type.

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'|'DEVICE_WSS'|'CONNECTOR_ASSOCIATION'|'ACCOUNT_ASSOCIATION'|'CONNECTOR_ERROR_REPORT'
)

type EventType:

string

param EventType:

[REQUIRED]

The type of event triggering a device notification to the customer-managed destination.

rtype:

dict

returns:

Response Syntax

{
    'EventType': 'DEVICE_COMMAND'|'DEVICE_COMMAND_REQUEST'|'DEVICE_DISCOVERY_STATUS'|'DEVICE_EVENT'|'DEVICE_LIFE_CYCLE'|'DEVICE_STATE'|'DEVICE_OTA'|'DEVICE_WSS'|'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) --

ListDeviceDiscoveries (updated)

Link ¶
Changes (request, response)
Request

{'TypeFilter': {'CONTROLLER_CAPABILITY_REDISCOVERY'}}

Response

{'Items': {'DiscoveryType': {'CONTROLLER_CAPABILITY_REDISCOVERY'}}}

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'|'CONTROLLER_CAPABILITY_REDISCOVERY',
    StatusFilter='RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'
)

type NextToken:

string

param NextToken:

A token used for pagination of results.

type MaxResults:

integer

param MaxResults:

The maximum number of device discovery jobs to return in a single response.

type TypeFilter:

string

param TypeFilter:

The discovery type to filter device discovery jobs by.

type StatusFilter:

string

param StatusFilter:

The status to filter device discovery jobs by.

rtype:

dict

returns:

Response Syntax

{
    'Items': [
        {
            'Id': 'string',
            'DiscoveryType': 'ZWAVE'|'ZIGBEE'|'CLOUD'|'CUSTOM'|'CONTROLLER_CAPABILITY_REDISCOVERY',
            '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.

ListNotificationConfigurations (updated)

Link ¶
Changes (response)

{'NotificationConfigurationList': {'EventType': {'DEVICE_WSS'}}}

List all notification configurations.

See also: AWS API Documentation

Request Syntax

client.list_notification_configurations(
    MaxResults=123,
    NextToken='string'
)

type MaxResults:

integer

param MaxResults:

The maximum number of results to return at one time.

type NextToken:

string

param NextToken:

A token that can be used to retrieve the next set of results.

rtype:

dict

returns:

Response Syntax

{
    'NotificationConfigurationList': [
        {
            'EventType': 'DEVICE_COMMAND'|'DEVICE_COMMAND_REQUEST'|'DEVICE_DISCOVERY_STATUS'|'DEVICE_EVENT'|'DEVICE_LIFE_CYCLE'|'DEVICE_STATE'|'DEVICE_OTA'|'DEVICE_WSS'|'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.

StartDeviceDiscovery (updated)

Link ¶
Changes (request)

{'DiscoveryType': {'CONTROLLER_CAPABILITY_REDISCOVERY'},
 'EndDeviceIdentifier': 'string',
 'Protocol': 'ZWAVE | ZIGBEE | CUSTOM'}

This API is used to start device discovery for hub-connected and third-party-connected devices. The authentication material (install code) is delivered as a message to the controller instructing it to start the discovery.

See also: AWS API Documentation

Request Syntax

client.start_device_discovery(
    DiscoveryType='ZWAVE'|'ZIGBEE'|'CLOUD'|'CUSTOM'|'CONTROLLER_CAPABILITY_REDISCOVERY',
    CustomProtocolDetail={
        'string': 'string'
    },
    ControllerIdentifier='string',
    ConnectorAssociationIdentifier='string',
    AccountAssociationId='string',
    AuthenticationMaterial='string',
    AuthenticationMaterialType='ZWAVE_INSTALL_CODE',
    ClientToken='string',
    Tags={
        'string': 'string'
    },
    Protocol='ZWAVE'|'ZIGBEE'|'CUSTOM',
    EndDeviceIdentifier='string'
)

type DiscoveryType:

string

param DiscoveryType:

[REQUIRED]

The discovery type supporting the type of device to be discovered in the device discovery task request.

type CustomProtocolDetail:

dict

param CustomProtocolDetail:

Additional protocol-specific details required for device discovery, which vary based on the discovery type.

(string) --
- (string) --

type ControllerIdentifier:

string

param ControllerIdentifier:

The id of the end-user's IoT hub.

type ConnectorAssociationIdentifier:

string

param ConnectorAssociationIdentifier:

The id of the connector association.

type AccountAssociationId:

string

param AccountAssociationId:

The identifier of the cloud-to-cloud account association to use for discovery of third-party devices.

type AuthenticationMaterial:

string

param AuthenticationMaterial:

The authentication material required to start the local device discovery job request.

type AuthenticationMaterialType:

string

param AuthenticationMaterialType:

The type of authentication material used for device discovery jobs.

type ClientToken:

string

param ClientToken:

type Tags:

dict

param Tags:

A set of key/value pairs that are used to manage the device discovery request.

(string) --
- (string) --

type Protocol:

string

param Protocol:

The protocol type for capability rediscovery (ZWAVE, ZIGBEE, or CUSTOM).

type EndDeviceIdentifier:

string

param EndDeviceIdentifier:

The unique id of the end device for capability rediscovery.

rtype:

dict

returns:

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.

UpdateManagedThing (updated)

Link ¶
Changes (request)

{'WiFiSimpleSetupConfiguration': {'EnableAsProvisionee': 'boolean',
                                  'EnableAsProvisioner': 'boolean',
                                  'TimeoutInMinutes': 'integer'}}

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',
    WiFiSimpleSetupConfiguration={
        'EnableAsProvisioner': True|False,
        'EnableAsProvisionee': True|False,
        'TimeoutInMinutes': 123
    },
    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'
    }
)

type Identifier:

string

param Identifier:

[REQUIRED]

The id of the managed thing.

type Owner:

string

param Owner:

Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.

type CredentialLockerId:

string

param CredentialLockerId:

The identifier of the credential for the managed thing.

type SerialNumber:

string

param SerialNumber:

The serial number of the device.

type WiFiSimpleSetupConfiguration:

dict

param WiFiSimpleSetupConfiguration:

The Wi-Fi Simple Setup configuration for the managed thing, which defines provisioning capabilities and timeout settings.

EnableAsProvisioner (boolean) --

Indicates whether the device can act as a provisioner in Wi-Fi Simple Setup, allowing it to configure other devices.
EnableAsProvisionee (boolean) --

Indicates whether the device can act as a provisionee in Wi-Fi Simple Setup, allowing it to be configured by other devices.
TimeoutInMinutes (integer) --

The timeout duration in minutes for Wi-Fi Simple Setup. Valid range is 5 to 15 minutes.

type Brand:

string

param Brand:

The brand of the device.

type Model:

string

param Model:

The model of the device.

type Name:

string

param Name:

The name of the managed thing representing the physical device.

type CapabilityReport:

dict

param CapabilityReport:

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) --

type CapabilitySchemas:

list

param CapabilitySchemas:

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.

type Capabilities:

string

param Capabilities:

The capabilities of the device such as light bulb.

type Classification:

string

param Classification:

The classification of the managed thing such as light bulb or thermostat.

type HubNetworkMode:

string

param HubNetworkMode:

The network mode for the hub-connected device.

type MetaData:

dict

param MetaData:

The metadata for the managed thing.

(string) --
- (string) --

returns:

None

UpdateNotificationConfiguration (updated)

Link ¶
Changes (request)

{'EventType': {'DEVICE_WSS'}}

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'|'DEVICE_WSS'|'CONNECTOR_ASSOCIATION'|'ACCOUNT_ASSOCIATION'|'CONNECTOR_ERROR_REPORT',
    DestinationName='string'
)

type EventType:

string

param EventType:

[REQUIRED]

The type of event triggering a device notification to the customer-managed destination.

type DestinationName:

string

param DestinationName:

[REQUIRED]

The name of the destination for the notification configuration.

returns:

None