AWS API Changes

2019/12/03 - AWS Network Manager - 28 new api methods

Changes Update networkmanager client to latest version

DeleteDevice (new)

Link ¶

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

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',
        '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.
  - 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.

DeleteSite (new)

Link ¶

Deletes an existing site. The site cannot be associated with any device or link.

See also: AWS API Documentation

Request Syntax

client.delete_site(
    GlobalNetworkId='string',
    SiteId='string'
)

type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

type SiteId:

string

param SiteId:

[REQUIRED]

The ID of the site.

rtype:

dict

returns:

Response Syntax

{
    'Site': {
        'SiteId': 'string',
        'SiteArn': 'string',
        'GlobalNetworkId': 'string',
        'Description': 'string',
        'Location': {
            'Address': 'string',
            'Latitude': 'string',
            'Longitude': 'string'
        },
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- Site (dict) --
  
  Information about the site.
  - SiteId (string) --
    
    The ID of the site.
  - SiteArn (string) --
    
    The Amazon Resource Name (ARN) of the site.
  - GlobalNetworkId (string) --
    
    The ID of the global network.
  - Description (string) --
    
    The description of the site.
  - Location (dict) --
    
    The location of the site.
    - Address (string) --
      
      The physical address.
    - Latitude (string) --
      
      The latitude.
    - Longitude (string) --
      
      The longitude.
  - CreatedAt (datetime) --
    
    The date and time that the site was created.
  - State (string) --
    
    The state of the site.
  - Tags (list) --
    
    The tags for the site.
    - (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.

CreateSite (new)

Link ¶

Creates a new site in a global network.

See also: AWS API Documentation

Request Syntax

client.create_site(
    GlobalNetworkId='string',
    Description='string',
    Location={
        'Address': 'string',
        'Latitude': 'string',
        'Longitude': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

type Description:

string

param Description:

A description of your site.

Length Constraints: Maximum length of 256 characters.

type Location:

dict

param Location:

The site location. This information is used for visualization in the Network Manager console. If you specify the address, the latitude and longitude are automatically calculated.

Address: The physical address of the site.
Latitude: The latitude of the site.
Longitude: The longitude of the site.

Address (string) --

The physical address.
Latitude (string) --

The latitude.
Longitude (string) --

The longitude.

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

{
    'Site': {
        'SiteId': 'string',
        'SiteArn': 'string',
        'GlobalNetworkId': 'string',
        'Description': 'string',
        'Location': {
            'Address': 'string',
            'Latitude': 'string',
            'Longitude': 'string'
        },
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- Site (dict) --
  
  Information about the site.
  - SiteId (string) --
    
    The ID of the site.
  - SiteArn (string) --
    
    The Amazon Resource Name (ARN) of the site.
  - GlobalNetworkId (string) --
    
    The ID of the global network.
  - Description (string) --
    
    The description of the site.
  - Location (dict) --
    
    The location of the site.
    - Address (string) --
      
      The physical address.
    - Latitude (string) --
      
      The latitude.
    - Longitude (string) --
      
      The longitude.
  - CreatedAt (datetime) --
    
    The date and time that the site was created.
  - State (string) --
    
    The state of the site.
  - Tags (list) --
    
    The tags for the site.
    - (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.

DeregisterTransitGateway (new)

Link ¶

Deregisters a transit gateway from your global network. This action does not delete your transit gateway, or modify any of its attachments. This action removes any customer gateway associations.

See also: AWS API Documentation

Request Syntax

client.deregister_transit_gateway(
    GlobalNetworkId='string',
    TransitGatewayArn='string'
)

type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

type TransitGatewayArn:

string

param TransitGatewayArn:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'TransitGatewayRegistration': {
        'GlobalNetworkId': 'string',
        'TransitGatewayArn': 'string',
        'State': {
            'Code': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'|'FAILED',
            'Message': 'string'
        }
    }
}

Response Structure

(dict) --
- TransitGatewayRegistration (dict) --
  
  The transit gateway registration information.
  - GlobalNetworkId (string) --
    
    The ID of the global network.
  - TransitGatewayArn (string) --
    
    The Amazon Resource Name (ARN) of the transit gateway.
  - State (dict) --
    
    The state of the transit gateway registration.
    - Code (string) --
      
      The code for the state reason.
    - Message (string) --
      
      The message for the state reason.

CreateLink (new)

Link ¶

Creates a new link for a specified site.

See also: AWS API Documentation

Request Syntax

client.create_link(
    GlobalNetworkId='string',
    Description='string',
    Type='string',
    Bandwidth={
        'UploadSpeed': 123,
        'DownloadSpeed': 123
    },
    Provider='string',
    SiteId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

type Description:

string

param Description:

A description of the link.

Length Constraints: Maximum length of 256 characters.

type Type:

string

param Type:

The type of the link.

Constraints: Cannot include the following characters: | ^

Length Constraints: Maximum length of 128 characters.

type Bandwidth:

dict

param Bandwidth:

[REQUIRED]

The upload speed and download speed in Mbps.

UploadSpeed (integer) --

Upload speed in Mbps.
DownloadSpeed (integer) --

Download speed in Mbps.

type Provider:

string

param Provider:

The provider of the link.

Constraints: Cannot include the following characters: | ^

Length Constraints: Maximum length of 128 characters.

type SiteId:

string

param SiteId:

[REQUIRED]

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

{
    'Link': {
        'LinkId': 'string',
        'LinkArn': 'string',
        'GlobalNetworkId': 'string',
        'SiteId': 'string',
        'Description': 'string',
        'Type': 'string',
        'Bandwidth': {
            'UploadSpeed': 123,
            'DownloadSpeed': 123
        },
        'Provider': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- Link (dict) --
  
  Information about the link.
  - LinkId (string) --
    
    The ID of the link.
  - LinkArn (string) --
    
    The Amazon Resource Name (ARN) of the link.
  - GlobalNetworkId (string) --
    
    The ID of the global network.
  - SiteId (string) --
    
    The ID of the site.
  - Description (string) --
    
    The description of the link.
  - Type (string) --
    
    The type of the link.
  - Bandwidth (dict) --
    
    The bandwidth for the link.
    - UploadSpeed (integer) --
      
      Upload speed in Mbps.
    - DownloadSpeed (integer) --
      
      Download speed in Mbps.
  - Provider (string) --
    
    The provider of the link.
  - CreatedAt (datetime) --
    
    The date and time that the link was created.
  - State (string) --
    
    The state of the link.
  - Tags (list) --
    
    The tags for the link.
    - (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.

DeleteLink (new)

Link ¶

Deletes an existing link. You must first disassociate the link from any devices and customer gateways.

See also: AWS API Documentation

Request Syntax

client.delete_link(
    GlobalNetworkId='string',
    LinkId='string'
)

type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

type LinkId:

string

param LinkId:

[REQUIRED]

The ID of the link.

rtype:

dict

returns:

Response Syntax

{
    'Link': {
        'LinkId': 'string',
        'LinkArn': 'string',
        'GlobalNetworkId': 'string',
        'SiteId': 'string',
        'Description': 'string',
        'Type': 'string',
        'Bandwidth': {
            'UploadSpeed': 123,
            'DownloadSpeed': 123
        },
        'Provider': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- Link (dict) --
  
  Information about the link.
  - LinkId (string) --
    
    The ID of the link.
  - LinkArn (string) --
    
    The Amazon Resource Name (ARN) of the link.
  - GlobalNetworkId (string) --
    
    The ID of the global network.
  - SiteId (string) --
    
    The ID of the site.
  - Description (string) --
    
    The description of the link.
  - Type (string) --
    
    The type of the link.
  - Bandwidth (dict) --
    
    The bandwidth for the link.
    - UploadSpeed (integer) --
      
      Upload speed in Mbps.
    - DownloadSpeed (integer) --
      
      Download speed in Mbps.
  - Provider (string) --
    
    The provider of the link.
  - CreatedAt (datetime) --
    
    The date and time that the link was created.
  - State (string) --
    
    The state of the link.
  - Tags (list) --
    
    The tags for the link.
    - (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 (new)

Link ¶

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',
            '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.
    - 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.

RegisterTransitGateway (new)

Link ¶

Registers a transit gateway in your global network. The transit gateway can be in any AWS Region, but it must be owned by the same AWS account that owns the global network. You cannot register a transit gateway in more than one global network.

See also: AWS API Documentation

Request Syntax

client.register_transit_gateway(
    GlobalNetworkId='string',
    TransitGatewayArn='string'
)

type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

type TransitGatewayArn:

string

param TransitGatewayArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the transit gateway. For more information, see Resources Defined by Amazon EC2.

rtype:

dict

returns:

Response Syntax

{
    'TransitGatewayRegistration': {
        'GlobalNetworkId': 'string',
        'TransitGatewayArn': 'string',
        'State': {
            'Code': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'|'FAILED',
            'Message': 'string'
        }
    }
}

Response Structure

(dict) --
- TransitGatewayRegistration (dict) --
  
  Information about the transit gateway registration.
  - GlobalNetworkId (string) --
    
    The ID of the global network.
  - TransitGatewayArn (string) --
    
    The Amazon Resource Name (ARN) of the transit gateway.
  - State (dict) --
    
    The state of the transit gateway registration.
    - Code (string) --
      
      The code for the state reason.
    - Message (string) --
      
      The message for the state reason.

AssociateLink (new)

Link ¶

Associates a link to a device. A device can be associated to multiple links and a link can be associated to multiple devices. The device and link must be in the same global network and the same site.

See also: AWS API Documentation

Request Syntax

client.associate_link(
    GlobalNetworkId='string',
    DeviceId='string',
    LinkId='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 LinkId:

string

param LinkId:

[REQUIRED]

The ID of the link.

rtype:

dict

returns:

Response Syntax

{
    'LinkAssociation': {
        'GlobalNetworkId': 'string',
        'DeviceId': 'string',
        'LinkId': 'string',
        'LinkAssociationState': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
    }
}

Response Structure

(dict) --
- LinkAssociation (dict) --
  
  The link association.
  - GlobalNetworkId (string) --
    
    The ID of the global network.
  - DeviceId (string) --
    
    The device ID for the link association.
  - LinkId (string) --
    
    The ID of the link.
  - LinkAssociationState (string) --
    
    The state of the association.

UpdateGlobalNetwork (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.update_global_network(
    GlobalNetworkId='string',
    Description='string'
)

type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of your global network.

type Description:

string

param Description:

A description of the global network.

Length Constraints: Maximum length of 256 characters.

rtype:

dict

returns:

Response Syntax

{
    'GlobalNetwork': {
        'GlobalNetworkId': 'string',
        'GlobalNetworkArn': 'string',
        'Description': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- GlobalNetwork (dict) --
  
  Information about the global network object.
  - GlobalNetworkId (string) --
    
    The ID of the global network.
  - GlobalNetworkArn (string) --
    
    The Amazon Resource Name (ARN) of the global network.
  - Description (string) --
    
    The description of the global network.
  - CreatedAt (datetime) --
    
    The date and time that the global network was created.
  - State (string) --
    
    The state of the global network.
  - Tags (list) --
    
    The tags for the global network.
    - (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.

AssociateCustomerGateway (new)

Link ¶

Associates a customer gateway 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 customer gateways that are connected to a VPN attachment on a transit gateway. The transit gateway must be registered in your global network. When you register a transit gateway, customer gateways that are connected to the transit gateway are automatically included in the global network. To list customer gateways that are connected to a transit gateway, use the DescribeVpnConnections EC2 API and filter by transit-gateway-id.

You cannot associate a customer gateway with more than one device and link.

See also: AWS API Documentation

Request Syntax

client.associate_customer_gateway(
    CustomerGatewayArn='string',
    GlobalNetworkId='string',
    DeviceId='string',
    LinkId='string'
)

type CustomerGatewayArn:

string

param CustomerGatewayArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the customer gateway. For more information, see Resources Defined by Amazon EC2.

type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

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

{
    'CustomerGatewayAssociation': {
        'CustomerGatewayArn': 'string',
        'GlobalNetworkId': 'string',
        'DeviceId': 'string',
        'LinkId': 'string',
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
    }
}

Response Structure

(dict) --
- CustomerGatewayAssociation (dict) --
  
  The customer gateway association.
  - CustomerGatewayArn (string) --
    
    The Amazon Resource Name (ARN) of the customer gateway.
  - 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 association state.

DisassociateLink (new)

Link ¶

Disassociates an existing device from a link. You must first disassociate any customer gateways that are associated with the link.

See also: AWS API Documentation

Request Syntax

client.disassociate_link(
    GlobalNetworkId='string',
    DeviceId='string',
    LinkId='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 LinkId:

string

param LinkId:

[REQUIRED]

The ID of the link.

rtype:

dict

returns:

Response Syntax

{
    'LinkAssociation': {
        'GlobalNetworkId': 'string',
        'DeviceId': 'string',
        'LinkId': 'string',
        'LinkAssociationState': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
    }
}

Response Structure

(dict) --
- LinkAssociation (dict) --
  
  Information about the link association.
  - GlobalNetworkId (string) --
    
    The ID of the global network.
  - DeviceId (string) --
    
    The device ID for the link association.
  - LinkId (string) --
    
    The ID of the link.
  - LinkAssociationState (string) --
    
    The state of the association.

UpdateLink (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.update_link(
    GlobalNetworkId='string',
    LinkId='string',
    Description='string',
    Type='string',
    Bandwidth={
        'UploadSpeed': 123,
        'DownloadSpeed': 123
    },
    Provider='string'
)

type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

type LinkId:

string

param LinkId:

[REQUIRED]

The ID of the link.

type Description:

string

param Description:

A description of the link.

Length Constraints: Maximum length of 256 characters.

type Type:

string

param Type:

The type of the link.

Length Constraints: Maximum length of 128 characters.

type Bandwidth:

dict

param Bandwidth:

The upload and download speed in Mbps.

UploadSpeed (integer) --

Upload speed in Mbps.
DownloadSpeed (integer) --

Download speed in Mbps.

type Provider:

string

param Provider:

The provider of the link.

Length Constraints: Maximum length of 128 characters.

rtype:

dict

returns:

Response Syntax

{
    'Link': {
        'LinkId': 'string',
        'LinkArn': 'string',
        'GlobalNetworkId': 'string',
        'SiteId': 'string',
        'Description': 'string',
        'Type': 'string',
        'Bandwidth': {
            'UploadSpeed': 123,
            'DownloadSpeed': 123
        },
        'Provider': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- Link (dict) --
  
  Information about the link.
  - LinkId (string) --
    
    The ID of the link.
  - LinkArn (string) --
    
    The Amazon Resource Name (ARN) of the link.
  - GlobalNetworkId (string) --
    
    The ID of the global network.
  - SiteId (string) --
    
    The ID of the site.
  - Description (string) --
    
    The description of the link.
  - Type (string) --
    
    The type of the link.
  - Bandwidth (dict) --
    
    The bandwidth for the link.
    - UploadSpeed (integer) --
      
      Upload speed in Mbps.
    - DownloadSpeed (integer) --
      
      Download speed in Mbps.
  - Provider (string) --
    
    The provider of the link.
  - CreatedAt (datetime) --
    
    The date and time that the link was created.
  - State (string) --
    
    The state of the link.
  - Tags (list) --
    
    The tags for the link.
    - (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.

GetTransitGatewayRegistrations (new)

Link ¶

Gets information about the transit gateway registrations in a specified global network.

See also: AWS API Documentation

Request Syntax

client.get_transit_gateway_registrations(
    GlobalNetworkId='string',
    TransitGatewayArns=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)

type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

type TransitGatewayArns:

list

param TransitGatewayArns:

The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is 10.

(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

{
    'TransitGatewayRegistrations': [
        {
            'GlobalNetworkId': 'string',
            'TransitGatewayArn': 'string',
            'State': {
                'Code': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'|'FAILED',
                'Message': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- TransitGatewayRegistrations (list) --
  
  The transit gateway registrations.
  - (dict) --
    
    Describes the registration of a transit gateway to a global network.
    - GlobalNetworkId (string) --
      
      The ID of the global network.
    - TransitGatewayArn (string) --
      
      The Amazon Resource Name (ARN) of the transit gateway.
    - State (dict) --
      
      The state of the transit gateway registration.
      - Code (string) --
        
        The code for the state reason.
      - Message (string) --
        
        The message for the state reason.
- NextToken (string) --
  
  The token for the next page of results.

DisassociateCustomerGateway (new)

Link ¶

Disassociates a customer gateway from a device and a link.

See also: AWS API Documentation

Request Syntax

client.disassociate_customer_gateway(
    GlobalNetworkId='string',
    CustomerGatewayArn='string'
)

type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

type CustomerGatewayArn:

string

param CustomerGatewayArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the customer gateway. For more information, see Resources Defined by Amazon EC2.

rtype:

dict

returns:

Response Syntax

{
    'CustomerGatewayAssociation': {
        'CustomerGatewayArn': 'string',
        'GlobalNetworkId': 'string',
        'DeviceId': 'string',
        'LinkId': 'string',
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
    }
}

Response Structure

(dict) --
- CustomerGatewayAssociation (dict) --
  
  Information about the customer gateway association.
  - CustomerGatewayArn (string) --
    
    The Amazon Resource Name (ARN) of the customer gateway.
  - 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 association state.

GetLinkAssociations (new)

Link ¶

Gets the link associations for a device or a link. Either the device ID or the link ID must be specified.

See also: AWS API Documentation

Request Syntax

client.get_link_associations(
    GlobalNetworkId='string',
    DeviceId='string',
    LinkId='string',
    MaxResults=123,
    NextToken='string'
)

type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

type DeviceId:

string

param DeviceId:

The ID of the device.

type LinkId:

string

param LinkId:

The ID of the link.

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

{
    'LinkAssociations': [
        {
            'GlobalNetworkId': 'string',
            'DeviceId': 'string',
            'LinkId': 'string',
            'LinkAssociationState': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- LinkAssociations (list) --
  
  The link associations.
  - (dict) --
    
    Describes the association between a device and a link.
    - GlobalNetworkId (string) --
      
      The ID of the global network.
    - DeviceId (string) --
      
      The device ID for the link association.
    - LinkId (string) --
      
      The ID of the link.
    - LinkAssociationState (string) --
      
      The state of the association.
- NextToken (string) --
  
  The token for the next page of results.

CreateDevice (new)

Link ¶

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',
    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 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',
        '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.
  - 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.

DescribeGlobalNetworks (new)

Link ¶

Describes one or more global networks. By default, all global networks are described. To describe the objects in your global network, you must use the appropriate Get* action. For example, to list the transit gateways in your global network, use GetTransitGatewayRegistrations.

See also: AWS API Documentation

Request Syntax

client.describe_global_networks(
    GlobalNetworkIds=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)

type GlobalNetworkIds:

list

param GlobalNetworkIds:

The IDs of one or more global networks. The maximum is 10.

(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

{
    'GlobalNetworks': [
        {
            'GlobalNetworkId': 'string',
            'GlobalNetworkArn': 'string',
            'Description': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- GlobalNetworks (list) --
  
  Information about the global networks.
  - (dict) --
    
    Describes a global network.
    - GlobalNetworkId (string) --
      
      The ID of the global network.
    - GlobalNetworkArn (string) --
      
      The Amazon Resource Name (ARN) of the global network.
    - Description (string) --
      
      The description of the global network.
    - CreatedAt (datetime) --
      
      The date and time that the global network was created.
    - State (string) --
      
      The state of the global network.
    - Tags (list) --
      
      The tags for the global network.
      - (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.

DeleteGlobalNetwork (new)

Link ¶

Deletes an existing global network. You must first delete all global network objects (devices, links, and sites) and deregister all transit gateways.

See also: AWS API Documentation

Request Syntax

client.delete_global_network(
    GlobalNetworkId='string'
)

type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

rtype:

dict

returns:

Response Syntax

{
    'GlobalNetwork': {
        'GlobalNetworkId': 'string',
        'GlobalNetworkArn': 'string',
        'Description': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- GlobalNetwork (dict) --
  
  Information about the global network.
  - GlobalNetworkId (string) --
    
    The ID of the global network.
  - GlobalNetworkArn (string) --
    
    The Amazon Resource Name (ARN) of the global network.
  - Description (string) --
    
    The description of the global network.
  - CreatedAt (datetime) --
    
    The date and time that the global network was created.
  - State (string) --
    
    The state of the global network.
  - Tags (list) --
    
    The tags for the global network.
    - (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.

TagResource (new)

Link ¶

Tags a specified resource.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    ResourceArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type ResourceArn:

string

param ResourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

type Tags:

list

param Tags:

[REQUIRED]

The tags to apply to the specified resource.

(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

{}

Response Structure

(dict) --

ListTagsForResource (new)

Link ¶

Lists the tags for a specified resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    ResourceArn='string'
)

type ResourceArn:

string

param ResourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

rtype:

dict

returns:

Response Syntax

{
    'TagList': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) --
- TagList (list) --
  
  The list of tags.
  - (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.

CreateGlobalNetwork (new)

Link ¶

Creates a new, empty global network.

See also: AWS API Documentation

Request Syntax

client.create_global_network(
    Description='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type Description:

string

param Description:

A description of the global network.

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

{
    'GlobalNetwork': {
        'GlobalNetworkId': 'string',
        'GlobalNetworkArn': 'string',
        'Description': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- GlobalNetwork (dict) --
  
  Information about the global network object.
  - GlobalNetworkId (string) --
    
    The ID of the global network.
  - GlobalNetworkArn (string) --
    
    The Amazon Resource Name (ARN) of the global network.
  - Description (string) --
    
    The description of the global network.
  - CreatedAt (datetime) --
    
    The date and time that the global network was created.
  - State (string) --
    
    The state of the global network.
  - Tags (list) --
    
    The tags for the global network.
    - (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.

UpdateDevice (new)

Link ¶

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',
    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 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',
        '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.
  - 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.

GetLinks (new)

Link ¶

Gets information about one or more links in a specified global network.

If you specify the site ID, you cannot specify the type or provider in the same request. You can specify the type and provider in the same request.

See also: AWS API Documentation

Request Syntax

client.get_links(
    GlobalNetworkId='string',
    LinkIds=[
        'string',
    ],
    SiteId='string',
    Type='string',
    Provider='string',
    MaxResults=123,
    NextToken='string'
)

type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

type LinkIds:

list

param LinkIds:

One or more link IDs. The maximum is 10.

(string) --

type SiteId:

string

param SiteId:

The ID of the site.

type Type:

string

param Type:

The link type.

type Provider:

string

param Provider:

The link provider.

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

{
    'Links': [
        {
            'LinkId': 'string',
            'LinkArn': 'string',
            'GlobalNetworkId': 'string',
            'SiteId': 'string',
            'Description': 'string',
            'Type': 'string',
            'Bandwidth': {
                'UploadSpeed': 123,
                'DownloadSpeed': 123
            },
            'Provider': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Links (list) --
  
  The links.
  - (dict) --
    
    Describes a link.
    - LinkId (string) --
      
      The ID of the link.
    - LinkArn (string) --
      
      The Amazon Resource Name (ARN) of the link.
    - GlobalNetworkId (string) --
      
      The ID of the global network.
    - SiteId (string) --
      
      The ID of the site.
    - Description (string) --
      
      The description of the link.
    - Type (string) --
      
      The type of the link.
    - Bandwidth (dict) --
      
      The bandwidth for the link.
      - UploadSpeed (integer) --
        
        Upload speed in Mbps.
      - DownloadSpeed (integer) --
        
        Download speed in Mbps.
    - Provider (string) --
      
      The provider of the link.
    - CreatedAt (datetime) --
      
      The date and time that the link was created.
    - State (string) --
      
      The state of the link.
    - Tags (list) --
      
      The tags for the link.
      - (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.

GetCustomerGatewayAssociations (new)

Link ¶

Gets the association information for customer gateways that are associated with devices and links in your global network.

See also: AWS API Documentation

Request Syntax

client.get_customer_gateway_associations(
    GlobalNetworkId='string',
    CustomerGatewayArns=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)

type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

type CustomerGatewayArns:

list

param CustomerGatewayArns:

One or more customer gateway Amazon Resource Names (ARNs). For more information, see Resources Defined by Amazon EC2. The maximum is 10.

(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

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

Response Structure

(dict) --
- CustomerGatewayAssociations (list) --
  
  The customer gateway associations.
  - (dict) --
    
    Describes the association between a customer gateway, a device, and a link.
    - CustomerGatewayArn (string) --
      
      The Amazon Resource Name (ARN) of the customer gateway.
    - 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 association state.
- NextToken (string) --
  
  The token for the next page of results.

UpdateSite (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.update_site(
    GlobalNetworkId='string',
    SiteId='string',
    Description='string',
    Location={
        'Address': 'string',
        'Latitude': 'string',
        'Longitude': 'string'
    }
)

type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

type SiteId:

string

param SiteId:

[REQUIRED]

The ID of your site.

type Description:

string

param Description:

A description of your site.

Length Constraints: Maximum length of 256 characters.

type Location:

dict

param Location:

The site location:

Address: The physical address of the site.
Latitude: The latitude of the site.
Longitude: The longitude of the site.

Address (string) --

The physical address.
Latitude (string) --

The latitude.
Longitude (string) --

The longitude.

rtype:

dict

returns:

Response Syntax

{
    'Site': {
        'SiteId': 'string',
        'SiteArn': 'string',
        'GlobalNetworkId': 'string',
        'Description': 'string',
        'Location': {
            'Address': 'string',
            'Latitude': 'string',
            'Longitude': 'string'
        },
        'CreatedAt': datetime(2015, 1, 1),
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- Site (dict) --
  
  Information about the site.
  - SiteId (string) --
    
    The ID of the site.
  - SiteArn (string) --
    
    The Amazon Resource Name (ARN) of the site.
  - GlobalNetworkId (string) --
    
    The ID of the global network.
  - Description (string) --
    
    The description of the site.
  - Location (dict) --
    
    The location of the site.
    - Address (string) --
      
      The physical address.
    - Latitude (string) --
      
      The latitude.
    - Longitude (string) --
      
      The longitude.
  - CreatedAt (datetime) --
    
    The date and time that the site was created.
  - State (string) --
    
    The state of the site.
  - Tags (list) --
    
    The tags for the site.
    - (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.

GetSites (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.get_sites(
    GlobalNetworkId='string',
    SiteIds=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)

type GlobalNetworkId:

string

param GlobalNetworkId:

[REQUIRED]

The ID of the global network.

type SiteIds:

list

param SiteIds:

One or more site IDs. The maximum is 10.

(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

{
    'Sites': [
        {
            'SiteId': 'string',
            'SiteArn': 'string',
            'GlobalNetworkId': 'string',
            'Description': 'string',
            'Location': {
                'Address': 'string',
                'Latitude': 'string',
                'Longitude': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Sites (list) --
  
  The sites.
  - (dict) --
    
    Describes a site.
    - SiteId (string) --
      
      The ID of the site.
    - SiteArn (string) --
      
      The Amazon Resource Name (ARN) of the site.
    - GlobalNetworkId (string) --
      
      The ID of the global network.
    - Description (string) --
      
      The description of the site.
    - Location (dict) --
      
      The location of the site.
      - Address (string) --
        
        The physical address.
      - Latitude (string) --
        
        The latitude.
      - Longitude (string) --
        
        The longitude.
    - CreatedAt (datetime) --
      
      The date and time that the site was created.
    - State (string) --
      
      The state of the site.
    - Tags (list) --
      
      The tags for the site.
      - (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.

UntagResource (new)

Link ¶

Removes tags from a specified resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)

type ResourceArn:

string

param ResourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

type TagKeys:

list

param TagKeys:

[REQUIRED]

The tag keys to remove from the specified resource.

(string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --