AWS Network Manager

2020/12/10 - AWS Network Manager - 7 new4 updated api methods

Changes  Update networkmanager client to latest version

GetConnections (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.get_connections(
    GlobalNetworkId='string',
    ConnectionIds=[
        'string',
    ],
    DeviceId='string',
    MaxResults=123,
    NextToken='string'
)
type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

type ConnectionIds:

list

param ConnectionIds:

One or more connection IDs.

  • (string) --

type DeviceId:

string

param DeviceId:

The ID of the device.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return.

type NextToken:

string

param NextToken:

The token for the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'Connections': [
        {
            'ConnectionId': 'string',
            'ConnectionArn': 'string',
            'GlobalNetworkId': 'string',
            'DeviceId': 'string',
            'ConnectedDeviceId': 'string',
            'LinkId': 'string',
            'ConnectedLinkId': 'string',
            'Description': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Connections (list) --

      Information about the connections.

      • (dict) --

        Describes a connection.

        • ConnectionId (string) --

          The ID of the connection.

        • ConnectionArn (string) --

          The Amazon Resource Name (ARN) of the connection.

        • GlobalNetworkId (string) --

          The ID of the global network.

        • DeviceId (string) --

          The ID of the first device in the connection.

        • ConnectedDeviceId (string) --

          The ID of the second device in the connection.

        • LinkId (string) --

          The ID of the link for the first device in the connection.

        • ConnectedLinkId (string) --

          The ID of the link for the second device in the connection.

        • Description (string) --

          The description of the connection.

        • CreatedAt (datetime) --

          The date and time that the connection was created.

        • State (string) --

          The state of the connection.

        • Tags (list) --

          The tags for the connection.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The tag key.

              Length Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Length Constraints: Maximum length of 256 characters.

    • NextToken (string) --

      The token to use for the next page of results.

CreateConnection (new) Link ¶

Creates a connection between two devices. The devices can be a physical or virtual appliance that connects to a third-party appliance in a VPC, or a physical appliance that connects to another physical appliance in an on-premises network.

See also: AWS API Documentation

Request Syntax

client.create_connection(
    GlobalNetworkId='string',
    DeviceId='string',
    ConnectedDeviceId='string',
    LinkId='string',
    ConnectedLinkId='string',
    Description='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

type DeviceId:

string

param DeviceId:

[REQUIRED]

The ID of the first device in the connection.

type ConnectedDeviceId:

string

param ConnectedDeviceId:

[REQUIRED]

The ID of the second device in the connection.

type LinkId:

string

param LinkId:

The ID of the link for the first device.

type ConnectedLinkId:

string

param ConnectedLinkId:

The ID of the link for the second device.

type Description:

string

param Description:

A description of the connection.

Length Constraints: Maximum length of 256 characters.

type Tags:

list

param Tags:

The tags to apply to the resource during creation.

  • (dict) --

    Describes a tag.

    • Key (string) --

      The tag key.

      Length Constraints: Maximum length of 128 characters.

    • Value (string) --

      The tag value.

      Length Constraints: Maximum length of 256 characters.

rtype:

dict

returns:

Response Syntax

{
    'Connection': {
        'ConnectionId': 'string',
        'ConnectionArn': 'string',
        'GlobalNetworkId': 'string',
        'DeviceId': 'string',
        'ConnectedDeviceId': 'string',
        'LinkId': 'string',
        'ConnectedLinkId': 'string',
        'Description': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • Connection (dict) --

      Information about the connection.

      • ConnectionId (string) --

        The ID of the connection.

      • ConnectionArn (string) --

        The Amazon Resource Name (ARN) of the connection.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • DeviceId (string) --

        The ID of the first device in the connection.

      • ConnectedDeviceId (string) --

        The ID of the second device in the connection.

      • LinkId (string) --

        The ID of the link for the first device in the connection.

      • ConnectedLinkId (string) --

        The ID of the link for the second device in the connection.

      • Description (string) --

        The description of the connection.

      • CreatedAt (datetime) --

        The date and time that the connection was created.

      • State (string) --

        The state of the connection.

      • Tags (list) --

        The tags for the connection.

        • (dict) --

          Describes a tag.

          • Key (string) --

            The tag key.

            Length Constraints: Maximum length of 128 characters.

          • Value (string) --

            The tag value.

            Length Constraints: Maximum length of 256 characters.

DeleteConnection (new) Link ¶

Deletes the specified connection in your global network.

See also: AWS API Documentation

Request Syntax

client.delete_connection(
    GlobalNetworkId='string',
    ConnectionId='string'
)
type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

type ConnectionId:

string

param ConnectionId:

[REQUIRED]

The ID of the connection.

rtype:

dict

returns:

Response Syntax

{
    'Connection': {
        'ConnectionId': 'string',
        'ConnectionArn': 'string',
        'GlobalNetworkId': 'string',
        'DeviceId': 'string',
        'ConnectedDeviceId': 'string',
        'LinkId': 'string',
        'ConnectedLinkId': 'string',
        'Description': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • Connection (dict) --

      Information about the connection.

      • ConnectionId (string) --

        The ID of the connection.

      • ConnectionArn (string) --

        The Amazon Resource Name (ARN) of the connection.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • DeviceId (string) --

        The ID of the first device in the connection.

      • ConnectedDeviceId (string) --

        The ID of the second device in the connection.

      • LinkId (string) --

        The ID of the link for the first device in the connection.

      • ConnectedLinkId (string) --

        The ID of the link for the second device in the connection.

      • Description (string) --

        The description of the connection.

      • CreatedAt (datetime) --

        The date and time that the connection was created.

      • State (string) --

        The state of the connection.

      • Tags (list) --

        The tags for the connection.

        • (dict) --

          Describes a tag.

          • Key (string) --

            The tag key.

            Length Constraints: Maximum length of 128 characters.

          • Value (string) --

            The tag value.

            Length Constraints: Maximum length of 256 characters.

DisassociateTransitGatewayConnectPeer (new) Link ¶

Disassociates a transit gateway Connect peer from a device and link.

See also: AWS API Documentation

Request Syntax

client.disassociate_transit_gateway_connect_peer(
    GlobalNetworkId='string',
    TransitGatewayConnectPeerArn='string'
)
type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

type TransitGatewayConnectPeerArn:

string

param TransitGatewayConnectPeerArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the transit gateway Connect peer.

rtype:

dict

returns:

Response Syntax

{
    'TransitGatewayConnectPeerAssociation': {
        'TransitGatewayConnectPeerArn': 'string',
        'GlobalNetworkId': 'string',
        'DeviceId': 'string',
        'LinkId': 'string',
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
    }
}

Response Structure

  • (dict) --

    • TransitGatewayConnectPeerAssociation (dict) --

      The transit gateway Connect peer association.

      • TransitGatewayConnectPeerArn (string) --

        The Amazon Resource Name (ARN) of the transit gateway Connect peer.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • DeviceId (string) --

        The ID of the device.

      • LinkId (string) --

        The ID of the link.

      • State (string) --

        The state of the association.

UpdateConnection (new) Link ¶

Updates the information for an existing connection. To remove information for any of the parameters, specify an empty string.

See also: AWS API Documentation

Request Syntax

client.update_connection(
    GlobalNetworkId='string',
    ConnectionId='string',
    LinkId='string',
    ConnectedLinkId='string',
    Description='string'
)
type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

type ConnectionId:

string

param ConnectionId:

[REQUIRED]

The ID of the connection.

type LinkId:

string

param LinkId:

The ID of the link for the first device in the connection.

type ConnectedLinkId:

string

param ConnectedLinkId:

The ID of the link for the second device in the connection.

type Description:

string

param Description:

A description of the connection.

Length Constraints: Maximum length of 256 characters.

rtype:

dict

returns:

Response Syntax

{
    'Connection': {
        'ConnectionId': 'string',
        'ConnectionArn': 'string',
        'GlobalNetworkId': 'string',
        'DeviceId': 'string',
        'ConnectedDeviceId': 'string',
        'LinkId': 'string',
        'ConnectedLinkId': 'string',
        'Description': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • Connection (dict) --

      Information about the connection.

      • ConnectionId (string) --

        The ID of the connection.

      • ConnectionArn (string) --

        The Amazon Resource Name (ARN) of the connection.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • DeviceId (string) --

        The ID of the first device in the connection.

      • ConnectedDeviceId (string) --

        The ID of the second device in the connection.

      • LinkId (string) --

        The ID of the link for the first device in the connection.

      • ConnectedLinkId (string) --

        The ID of the link for the second device in the connection.

      • Description (string) --

        The description of the connection.

      • CreatedAt (datetime) --

        The date and time that the connection was created.

      • State (string) --

        The state of the connection.

      • Tags (list) --

        The tags for the connection.

        • (dict) --

          Describes a tag.

          • Key (string) --

            The tag key.

            Length Constraints: Maximum length of 128 characters.

          • Value (string) --

            The tag value.

            Length Constraints: Maximum length of 256 characters.

AssociateTransitGatewayConnectPeer (new) Link ¶

Associates a transit gateway Connect peer with a device, and optionally, with a link. If you specify a link, it must be associated with the specified device.

You can only associate transit gateway Connect peers that have been created on a transit gateway that's registered in your global network.

You cannot associate a transit gateway Connect peer with more than one device and link.

See also: AWS API Documentation

Request Syntax

client.associate_transit_gateway_connect_peer(
    GlobalNetworkId='string',
    TransitGatewayConnectPeerArn='string',
    DeviceId='string',
    LinkId='string'
)
type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

type TransitGatewayConnectPeerArn:

string

param TransitGatewayConnectPeerArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the Connect peer.

type DeviceId:

string

param DeviceId:

[REQUIRED]

The ID of the device.

type LinkId:

string

param LinkId:

The ID of the link.

rtype:

dict

returns:

Response Syntax

{
    'TransitGatewayConnectPeerAssociation': {
        'TransitGatewayConnectPeerArn': 'string',
        'GlobalNetworkId': 'string',
        'DeviceId': 'string',
        'LinkId': 'string',
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
    }
}

Response Structure

  • (dict) --

    • TransitGatewayConnectPeerAssociation (dict) --

      The transit gateway Connect peer association.

      • TransitGatewayConnectPeerArn (string) --

        The Amazon Resource Name (ARN) of the transit gateway Connect peer.

      • GlobalNetworkId (string) --

        The ID of the global network.

      • DeviceId (string) --

        The ID of the device.

      • LinkId (string) --

        The ID of the link.

      • State (string) --

        The state of the association.

GetTransitGatewayConnectPeerAssociations (new) Link ¶

Gets information about one or more of your transit gateway Connect peer associations in a global network.

See also: AWS API Documentation

Request Syntax

client.get_transit_gateway_connect_peer_associations(
    GlobalNetworkId='string',
    TransitGatewayConnectPeerArns=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)
type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

type TransitGatewayConnectPeerArns:

list

param TransitGatewayConnectPeerArns:

One or more transit gateway Connect peer Amazon Resource Names (ARNs).

  • (string) --

type MaxResults:

integer

param MaxResults:

The maximum number of results to return.

type NextToken:

string

param NextToken:

The token for the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'TransitGatewayConnectPeerAssociations': [
        {
            'TransitGatewayConnectPeerArn': 'string',
            'GlobalNetworkId': 'string',
            'DeviceId': 'string',
            'LinkId': 'string',
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • TransitGatewayConnectPeerAssociations (list) --

      Information about the transit gateway Connect peer associations.

      • (dict) --

        Describes a transit gateway Connect peer association.

        • TransitGatewayConnectPeerArn (string) --

          The Amazon Resource Name (ARN) of the transit gateway Connect peer.

        • GlobalNetworkId (string) --

          The ID of the global network.

        • DeviceId (string) --

          The ID of the device.

        • LinkId (string) --

          The ID of the link.

        • State (string) --

          The state of the association.

    • NextToken (string) --

      The token to use for the next page of results.

CreateDevice (updated) Link ¶
Changes (request, response)
Request 
{'AWSLocation': {'SubnetArn': 'string', 'Zone': 'string'}}
Response 
{'Device': {'AWSLocation': {'SubnetArn': 'string', 'Zone': 'string'}}}

Creates a new device in a global network. If you specify both a site ID and a location, the location of the site is used for visualization in the Network Manager console.

See also: AWS API Documentation

Request Syntax

client.create_device(
    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',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

type AWSLocation:

dict

param AWSLocation:

The AWS location of the device.

  • Zone (string) --

    The Zone the device is located in. This can be the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

  • SubnetArn (string) --

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

type Description:

string

param Description:

A description of the device.

Length Constraints: Maximum length of 256 characters.

type Type:

string

param Type:

The type of the device.

type Vendor:

string

param Vendor:

The vendor of the device.

Length Constraints: Maximum length of 128 characters.

type Model:

string

param Model:

The model of the device.

Length Constraints: Maximum length of 128 characters.

type SerialNumber:

string

param SerialNumber:

The serial number of the device.

Length Constraints: Maximum length of 128 characters.

type Location:

dict

param Location:

The location of the device.

  • Address (string) --

    The physical address.

  • Latitude (string) --

    The latitude.

  • Longitude (string) --

    The longitude.

type SiteId:

string

param SiteId:

The ID of the site.

type Tags:

list

param Tags:

The tags to apply to the resource during creation.

  • (dict) --

    Describes a tag.

    • Key (string) --

      The tag key.

      Length Constraints: Maximum length of 128 characters.

    • Value (string) --

      The tag value.

      Length Constraints: Maximum length of 256 characters.

rtype:

dict

returns:

Response Syntax

{
    'Device': {
        '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'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • Device (dict) --

      Information about the 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 AWS location of the device.

        • Zone (string) --

          The Zone the device is located in. This can be the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

        • SubnetArn (string) --

          The Amazon Resource Name (ARN) of the subnet 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.

            Length Constraints: Maximum length of 128 characters.

          • Value (string) --

            The tag value.

            Length Constraints: Maximum length of 256 characters.

DeleteDevice (updated) Link ¶
Changes (response) 
{'Device': {'AWSLocation': {'SubnetArn': 'string', 'Zone': 'string'}}}

Deletes an existing device. You must first disassociate the device from any links and customer gateways.

See also: AWS API Documentation

Request Syntax

client.delete_device(
    GlobalNetworkId='string',
    DeviceId='string'
)
type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

type DeviceId:

string

param DeviceId:

[REQUIRED]

The ID of the device.

rtype:

dict

returns:

Response Syntax

{
    'Device': {
        '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'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • Device (dict) --

      Information about the 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 AWS location of the device.

        • Zone (string) --

          The Zone the device is located in. This can be the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

        • SubnetArn (string) --

          The Amazon Resource Name (ARN) of the subnet 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.

            Length Constraints: Maximum length of 128 characters.

          • Value (string) --

            The tag value.

            Length Constraints: Maximum length of 256 characters.

GetDevices (updated) Link ¶
Changes (response) 
{'Devices': {'AWSLocation': {'SubnetArn': 'string', 'Zone': 'string'}}}

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

See also: AWS API Documentation

Request Syntax

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

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

type DeviceIds:

list

param DeviceIds:

One or more device IDs. The maximum is 10.

  • (string) --

type SiteId:

string

param SiteId:

The ID of the site.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return.

type NextToken:

string

param NextToken:

The token for the next page of results.

rtype:

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 AWS location of the device.

          • Zone (string) --

            The Zone the device is located in. This can be the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

          • SubnetArn (string) --

            The Amazon Resource Name (ARN) of the subnet 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.

              Length Constraints: Maximum length of 128 characters.

            • Value (string) --

              The tag value.

              Length Constraints: Maximum length of 256 characters.

    • NextToken (string) --

      The token for the next page of results.

UpdateDevice (updated) Link ¶
Changes (request, response)
Request 
{'AWSLocation': {'SubnetArn': 'string', 'Zone': 'string'}}
Response 
{'Device': {'AWSLocation': {'SubnetArn': 'string', 'Zone': 'string'}}}

Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.

See also: AWS API Documentation

Request Syntax

client.update_device(
    GlobalNetworkId='string',
    DeviceId='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'
)
type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

type DeviceId:

string

param DeviceId:

[REQUIRED]

The ID of the device.

type AWSLocation:

dict

param AWSLocation:

The AWS location of the device.

  • Zone (string) --

    The Zone the device is located in. This can be the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

  • SubnetArn (string) --

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

type Description:

string

param Description:

A description of the device.

Length Constraints: Maximum length of 256 characters.

type Type:

string

param Type:

The type of the device.

type Vendor:

string

param Vendor:

The vendor of the device.

Length Constraints: Maximum length of 128 characters.

type Model:

string

param Model:

The model of the device.

Length Constraints: Maximum length of 128 characters.

type SerialNumber:

string

param SerialNumber:

The serial number of the device.

Length Constraints: Maximum length of 128 characters.

type Location:

dict

param Location:

Describes a location.

  • Address (string) --

    The physical address.

  • Latitude (string) --

    The latitude.

  • Longitude (string) --

    The longitude.

type SiteId:

string

param SiteId:

The ID of the site.

rtype:

dict

returns:

Response Syntax

{
    'Device': {
        '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'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • Device (dict) --

      Information about the 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 AWS location of the device.

        • Zone (string) --

          The Zone the device is located in. This can be the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

        • SubnetArn (string) --

          The Amazon Resource Name (ARN) of the subnet 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.

            Length Constraints: Maximum length of 128 characters.

          • Value (string) --

            The tag value.

            Length Constraints: Maximum length of 256 characters.