ManagedintegrationsforIoTDeviceManagement / Client / get_device_discovery

get_device_discovery

ManagedintegrationsforIoTDeviceManagement.Client.get_device_discovery(**kwargs)

Get the current state of a device discovery.

See also: AWS API Documentation

Request Syntax

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

Identifier (string) –

[REQUIRED]

The id of the device discovery job request.

Return type:

dict

Returns:

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

Exceptions