NetworkManager / Client / get_devices

get_devices#

NetworkManager.Client.get_devices(**kwargs)#

Gets information about one or more of your devices in a global network.

See also: AWS API Documentation

Request Syntax

response = client.get_devices(
    GlobalNetworkId='string',
    DeviceIds=[
        'string',
    ],
    SiteId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • GlobalNetworkId (string) –

    [REQUIRED]

    The ID of the global network.

  • DeviceIds (list) –

    One or more device IDs. The maximum is 10.

    • (string) –

  • SiteId (string) – The ID of the site.

  • MaxResults (integer) – The maximum number of results to return.

  • NextToken (string) – The token for the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'Devices': [
        {
            'DeviceId': 'string',
            'DeviceArn': 'string',
            'GlobalNetworkId': 'string',
            'AWSLocation': {
                'Zone': 'string',
                'SubnetArn': 'string'
            },
            'Description': 'string',
            'Type': 'string',
            'Vendor': 'string',
            'Model': 'string',
            'SerialNumber': 'string',
            'Location': {
                'Address': 'string',
                'Latitude': 'string',
                'Longitude': 'string'
            },
            'SiteId': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Devices (list) –

      The devices.

      • (dict) –

        Describes a device.

        • DeviceId (string) –

          The ID of the device.

        • DeviceArn (string) –

          The Amazon Resource Name (ARN) of the device.

        • GlobalNetworkId (string) –

          The ID of the global network.

        • AWSLocation (dict) –

          The Amazon Web Services location of the device.

          • Zone (string) –

            The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

          • SubnetArn (string) –

            The Amazon Resource Name (ARN) of the subnet that the device is located in.

        • Description (string) –

          The description of the device.

        • Type (string) –

          The device type.

        • Vendor (string) –

          The device vendor.

        • Model (string) –

          The device model.

        • SerialNumber (string) –

          The device serial number.

        • Location (dict) –

          The site location.

          • Address (string) –

            The physical address.

          • Latitude (string) –

            The latitude.

          • Longitude (string) –

            The longitude.

        • SiteId (string) –

          The site ID.

        • CreatedAt (datetime) –

          The date and time that the site was created.

        • State (string) –

          The device state.

        • Tags (list) –

          The tags for the device.

          • (dict) –

            Describes a tag.

            • Key (string) –

              The tag key.

              Constraints: Maximum length of 128 characters.

            • Value (string) –

              The tag value.

              Constraints: Maximum length of 256 characters.

    • NextToken (string) –

      The token for the next page of results.

Exceptions