ManagedintegrationsforIoTDeviceManagement / Client / get_managed_thing

get_managed_thing

ManagedintegrationsforIoTDeviceManagement.Client.get_managed_thing(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_managed_thing(
    Identifier='string'
)
Parameters:

Identifier (string) –

[REQUIRED]

The id of the managed thing.

Return type:

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'
    }
}

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.

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

Exceptions