Table of Contents
NetworkManager.
Client
¶A low-level client representing AWS Network Manager (NetworkManager)
Transit Gateway Network Manager (Network Manager) enables you to create a global network, in which you can monitor your AWS and on-premises networks that are built around transit gateways.
The Network Manager APIs are supported in the US West (Oregon) Region only. You must specify the us-west-2
Region in all requests made to Network Manager.
client = session.create_client('networkmanager')
These are the available methods:
associate_customer_gateway
(**kwargs)¶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
response = client.associate_customer_gateway(
CustomerGatewayArn='string',
GlobalNetworkId='string',
DeviceId='string',
LinkId='string'
)
CustomerGatewayArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the customer gateway. For more information, see Resources Defined by Amazon EC2 .
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
DeviceId (string) –
[REQUIRED]
The ID of the device.
LinkId (string) – The ID of the link.
dict
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.
Exceptions
associate_link
(**kwargs)¶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
response = client.associate_link(
GlobalNetworkId='string',
DeviceId='string',
LinkId='string'
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
DeviceId (string) –
[REQUIRED]
The ID of the device.
LinkId (string) –
[REQUIRED]
The ID of the link.
dict
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.
Exceptions
associate_transit_gateway_connect_peer
(**kwargs)¶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
response = client.associate_transit_gateway_connect_peer(
GlobalNetworkId='string',
TransitGatewayConnectPeerArn='string',
DeviceId='string',
LinkId='string'
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
TransitGatewayConnectPeerArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the Connect peer.
DeviceId (string) –
[REQUIRED]
The ID of the device.
LinkId (string) – The ID of the link.
dict
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.
Exceptions
can_paginate
(operation_name)¶Check if an operation can be paginated.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
True
if the operation can be paginated,
False
otherwise.
create_connection
(**kwargs)¶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
response = client.create_connection(
GlobalNetworkId='string',
DeviceId='string',
ConnectedDeviceId='string',
LinkId='string',
ConnectedLinkId='string',
Description='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
DeviceId (string) –
[REQUIRED]
The ID of the first device in the connection.
ConnectedDeviceId (string) –
[REQUIRED]
The ID of the second device in the connection.
LinkId (string) – The ID of the link for the first device.
ConnectedLinkId (string) – The ID of the link for the second device.
Description (string) –
A description of the connection.
Length Constraints: Maximum length of 256 characters.
Tags (list) –
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.
dict
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.
Exceptions
create_device
(**kwargs)¶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
response = 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'
},
]
)
GlobalNetworkId (string) –
[REQUIRED]
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) –
A description of the device.
Length Constraints: Maximum length of 256 characters.
Type (string) – The type of the device.
Vendor (string) –
The vendor of the device.
Length Constraints: Maximum length of 128 characters.
Model (string) –
The model of the device.
Length Constraints: Maximum length of 128 characters.
SerialNumber (string) –
The serial number of the device.
Length Constraints: Maximum length of 128 characters.
Location (dict) –
The location of the device.
Address (string) –
The physical address.
Latitude (string) –
The latitude.
Longitude (string) –
The longitude.
SiteId (string) – The ID of the site.
Tags (list) –
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.
dict
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.
Exceptions
create_global_network
(**kwargs)¶Creates a new, empty global network.
See also: AWS API Documentation
Request Syntax
response = client.create_global_network(
Description='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
Description (string) –
A description of the global network.
Length Constraints: Maximum length of 256 characters.
Tags (list) –
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.
dict
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.
Exceptions
create_link
(**kwargs)¶Creates a new link for a specified site.
See also: AWS API Documentation
Request Syntax
response = client.create_link(
GlobalNetworkId='string',
Description='string',
Type='string',
Bandwidth={
'UploadSpeed': 123,
'DownloadSpeed': 123
},
Provider='string',
SiteId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
Description (string) –
A description of the link.
Length Constraints: Maximum length of 256 characters.
Type (string) –
The type of the link.
Constraints: Cannot include the following characters: | ^
Length Constraints: Maximum length of 128 characters.
Bandwidth (dict) –
[REQUIRED]
The upload speed and download speed in Mbps.
UploadSpeed (integer) –
Upload speed in Mbps.
DownloadSpeed (integer) –
Download speed in Mbps.
Provider (string) –
The provider of the link.
Constraints: Cannot include the following characters: | ^
Length Constraints: Maximum length of 128 characters.
SiteId (string) –
[REQUIRED]
The ID of the site.
Tags (list) –
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.
dict
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.
Exceptions
create_site
(**kwargs)¶Creates a new site in a global network.
See also: AWS API Documentation
Request Syntax
response = client.create_site(
GlobalNetworkId='string',
Description='string',
Location={
'Address': 'string',
'Latitude': 'string',
'Longitude': 'string'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
Description (string) –
A description of your site.
Length Constraints: Maximum length of 256 characters.
Location (dict) –
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.
Tags (list) –
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.
dict
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.
Exceptions
delete_connection
(**kwargs)¶Deletes the specified connection in your global network.
See also: AWS API Documentation
Request Syntax
response = client.delete_connection(
GlobalNetworkId='string',
ConnectionId='string'
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
ConnectionId (string) –
[REQUIRED]
The ID of the connection.
dict
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.
Exceptions
delete_device
(**kwargs)¶Deletes an existing device. You must first disassociate the device from any links and customer gateways.
See also: AWS API Documentation
Request Syntax
response = client.delete_device(
GlobalNetworkId='string',
DeviceId='string'
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
DeviceId (string) –
[REQUIRED]
The ID of the device.
dict
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.
Exceptions
delete_global_network
(**kwargs)¶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
response = client.delete_global_network(
GlobalNetworkId='string'
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
dict
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.
Exceptions
delete_link
(**kwargs)¶Deletes an existing link. You must first disassociate the link from any devices and customer gateways.
See also: AWS API Documentation
Request Syntax
response = client.delete_link(
GlobalNetworkId='string',
LinkId='string'
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
LinkId (string) –
[REQUIRED]
The ID of the link.
dict
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.
Exceptions
delete_site
(**kwargs)¶Deletes an existing site. The site cannot be associated with any device or link.
See also: AWS API Documentation
Request Syntax
response = client.delete_site(
GlobalNetworkId='string',
SiteId='string'
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
SiteId (string) –
[REQUIRED]
The ID of the site.
dict
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.
Exceptions
deregister_transit_gateway
(**kwargs)¶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
response = client.deregister_transit_gateway(
GlobalNetworkId='string',
TransitGatewayArn='string'
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
TransitGatewayArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the transit gateway.
dict
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.
Exceptions
describe_global_networks
(**kwargs)¶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
response = client.describe_global_networks(
GlobalNetworkIds=[
'string',
],
MaxResults=123,
NextToken='string'
)
GlobalNetworkIds (list) –
The IDs of one or more global networks. The maximum is 10.
(string) –
MaxResults (integer) – The maximum number of results to return.
NextToken (string) – The token for the next page of results.
dict
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.
Exceptions
disassociate_customer_gateway
(**kwargs)¶Disassociates a customer gateway from a device and a link.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_customer_gateway(
GlobalNetworkId='string',
CustomerGatewayArn='string'
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
CustomerGatewayArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the customer gateway. For more information, see Resources Defined by Amazon EC2 .
dict
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.
Exceptions
disassociate_link
(**kwargs)¶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
response = client.disassociate_link(
GlobalNetworkId='string',
DeviceId='string',
LinkId='string'
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
DeviceId (string) –
[REQUIRED]
The ID of the device.
LinkId (string) –
[REQUIRED]
The ID of the link.
dict
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.
Exceptions
disassociate_transit_gateway_connect_peer
(**kwargs)¶Disassociates a transit gateway Connect peer from a device and link.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_transit_gateway_connect_peer(
GlobalNetworkId='string',
TransitGatewayConnectPeerArn='string'
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
TransitGatewayConnectPeerArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the transit gateway Connect peer.
dict
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.
Exceptions
generate_presigned_url
(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶Generate a presigned url given a client, its method, and arguments
ClientMethod (string) – The client method to presign for
Params (dict) – The parameters normally passed to
ClientMethod
.
ExpiresIn (int) – The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
HttpMethod (string) – The http method to use on the generated url. By default, the http method is whatever is used in the method’s model.
The presigned url
get_connections
(**kwargs)¶Gets information about one or more of your connections in a global network.
See also: AWS API Documentation
Request Syntax
response = client.get_connections(
GlobalNetworkId='string',
ConnectionIds=[
'string',
],
DeviceId='string',
MaxResults=123,
NextToken='string'
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
ConnectionIds (list) –
One or more connection IDs.
(string) –
DeviceId (string) – The ID of the device.
MaxResults (integer) – The maximum number of results to return.
NextToken (string) – The token for the next page of results.
dict
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.
Exceptions
get_customer_gateway_associations
(**kwargs)¶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
response = client.get_customer_gateway_associations(
GlobalNetworkId='string',
CustomerGatewayArns=[
'string',
],
MaxResults=123,
NextToken='string'
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
CustomerGatewayArns (list) –
One or more customer gateway Amazon Resource Names (ARNs). For more information, see Resources Defined by Amazon EC2 . The maximum is 10.
(string) –
MaxResults (integer) – The maximum number of results to return.
NextToken (string) – The token for the next page of results.
dict
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.
Exceptions
get_devices
(**kwargs)¶Gets information about one or more of your devices in a global network.
See also: AWS API Documentation
Request Syntax
response = client.get_devices(
GlobalNetworkId='string',
DeviceIds=[
'string',
],
SiteId='string',
MaxResults=123,
NextToken='string'
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
DeviceIds (list) –
One or more device IDs. The maximum is 10.
(string) –
SiteId (string) – The ID of the site.
MaxResults (integer) – The maximum number of results to return.
NextToken (string) – The token for the next page of results.
dict
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.
Exceptions
get_link_associations
(**kwargs)¶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
response = client.get_link_associations(
GlobalNetworkId='string',
DeviceId='string',
LinkId='string',
MaxResults=123,
NextToken='string'
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
DeviceId (string) – The ID of the device.
LinkId (string) – The ID of the link.
MaxResults (integer) – The maximum number of results to return.
NextToken (string) – The token for the next page of results.
dict
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.
Exceptions
get_links
(**kwargs)¶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
response = client.get_links(
GlobalNetworkId='string',
LinkIds=[
'string',
],
SiteId='string',
Type='string',
Provider='string',
MaxResults=123,
NextToken='string'
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
LinkIds (list) –
One or more link IDs. The maximum is 10.
(string) –
SiteId (string) – The ID of the site.
Type (string) – The link type.
Provider (string) – The link provider.
MaxResults (integer) – The maximum number of results to return.
NextToken (string) – The token for the next page of results.
dict
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.
Exceptions
get_paginator
(operation_name)¶Create a paginator for an operation.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate
method to
check if an operation is pageable.
L{botocore.paginate.Paginator}
A paginator object.
get_sites
(**kwargs)¶Gets information about one or more of your sites in a global network.
See also: AWS API Documentation
Request Syntax
response = client.get_sites(
GlobalNetworkId='string',
SiteIds=[
'string',
],
MaxResults=123,
NextToken='string'
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
SiteIds (list) –
One or more site IDs. The maximum is 10.
(string) –
MaxResults (integer) – The maximum number of results to return.
NextToken (string) – The token for the next page of results.
dict
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.
Exceptions
get_transit_gateway_connect_peer_associations
(**kwargs)¶Gets information about one or more of your transit gateway Connect peer associations in a global network.
See also: AWS API Documentation
Request Syntax
response = client.get_transit_gateway_connect_peer_associations(
GlobalNetworkId='string',
TransitGatewayConnectPeerArns=[
'string',
],
MaxResults=123,
NextToken='string'
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
TransitGatewayConnectPeerArns (list) –
One or more transit gateway Connect peer Amazon Resource Names (ARNs).
(string) –
MaxResults (integer) – The maximum number of results to return.
NextToken (string) – The token for the next page of results.
dict
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.
Exceptions
get_transit_gateway_registrations
(**kwargs)¶Gets information about the transit gateway registrations in a specified global network.
See also: AWS API Documentation
Request Syntax
response = client.get_transit_gateway_registrations(
GlobalNetworkId='string',
TransitGatewayArns=[
'string',
],
MaxResults=123,
NextToken='string'
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
TransitGatewayArns (list) –
The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is 10.
(string) –
MaxResults (integer) – The maximum number of results to return.
NextToken (string) – The token for the next page of results.
dict
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.
Exceptions
get_waiter
(waiter_name)¶Returns an object that can wait for some condition.
waiter_name (str) – The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
The specified waiter object.
botocore.waiter.Waiter
Lists the tags for a specified resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
ResourceArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
dict
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.
Exceptions
register_transit_gateway
(**kwargs)¶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
response = client.register_transit_gateway(
GlobalNetworkId='string',
TransitGatewayArn='string'
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
TransitGatewayArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the transit gateway. For more information, see Resources Defined by Amazon EC2 .
dict
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.
Exceptions
tag_resource
(**kwargs)¶Tags a specified resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
ResourceArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
Tags (list) –
[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.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
untag_resource
(**kwargs)¶Removes tags from a specified resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
ResourceArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
TagKeys (list) –
[REQUIRED]
The tag keys to remove from the specified resource.
(string) –
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
update_connection
(**kwargs)¶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
response = client.update_connection(
GlobalNetworkId='string',
ConnectionId='string',
LinkId='string',
ConnectedLinkId='string',
Description='string'
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
ConnectionId (string) –
[REQUIRED]
The ID of 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) –
A description of the connection.
Length Constraints: Maximum length of 256 characters.
dict
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.
Exceptions
update_device
(**kwargs)¶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
response = 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'
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
DeviceId (string) –
[REQUIRED]
The ID of the device.
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) –
A description of the device.
Length Constraints: Maximum length of 256 characters.
Type (string) – The type of the device.
Vendor (string) –
The vendor of the device.
Length Constraints: Maximum length of 128 characters.
Model (string) –
The model of the device.
Length Constraints: Maximum length of 128 characters.
SerialNumber (string) –
The serial number of the device.
Length Constraints: Maximum length of 128 characters.
Location (dict) –
Describes a location.
Address (string) –
The physical address.
Latitude (string) –
The latitude.
Longitude (string) –
The longitude.
SiteId (string) – The ID of the site.
dict
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.
Exceptions
update_global_network
(**kwargs)¶Updates an existing global network. To remove information for any of the parameters, specify an empty string.
See also: AWS API Documentation
Request Syntax
response = client.update_global_network(
GlobalNetworkId='string',
Description='string'
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of your global network.
Description (string) –
A description of the global network.
Length Constraints: Maximum length of 256 characters.
dict
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.
Exceptions
update_link
(**kwargs)¶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
response = client.update_link(
GlobalNetworkId='string',
LinkId='string',
Description='string',
Type='string',
Bandwidth={
'UploadSpeed': 123,
'DownloadSpeed': 123
},
Provider='string'
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
LinkId (string) –
[REQUIRED]
The ID of the link.
Description (string) –
A description of the link.
Length Constraints: Maximum length of 256 characters.
Type (string) –
The type of the link.
Length Constraints: Maximum length of 128 characters.
Bandwidth (dict) –
The upload and download speed in Mbps.
UploadSpeed (integer) –
Upload speed in Mbps.
DownloadSpeed (integer) –
Download speed in Mbps.
Provider (string) –
The provider of the link.
Length Constraints: Maximum length of 128 characters.
dict
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.
Exceptions
update_site
(**kwargs)¶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
response = client.update_site(
GlobalNetworkId='string',
SiteId='string',
Description='string',
Location={
'Address': 'string',
'Latitude': 'string',
'Longitude': 'string'
}
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
SiteId (string) –
[REQUIRED]
The ID of your site.
Description (string) –
A description of your site.
Length Constraints: Maximum length of 256 characters.
Location (dict) –
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.
dict
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.
Exceptions
Client exceptions are available on a client instance via the exceptions
property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
NetworkManager.Client.exceptions.
AccessDeniedException
¶You do not have sufficient access to perform this action.
Example
try:
...
except client.exceptions.AccessDeniedException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
You do not have sufficient access to perform this action.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
NetworkManager.Client.exceptions.
ConflictException
¶There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
Example
try:
...
except client.exceptions.ConflictException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'ResourceId': 'string',
'ResourceType': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
Message (string) –
ResourceId (string) –
The ID of the resource.
ResourceType (string) –
The resource type.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
NetworkManager.Client.exceptions.
InternalServerException
¶The request has failed due to an internal error.
Example
try:
...
except client.exceptions.InternalServerException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'RetryAfterSeconds': 123,
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The request has failed due to an internal error.
Message (string) –
RetryAfterSeconds (integer) –
Indicates when to retry the request.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
NetworkManager.Client.exceptions.
ResourceNotFoundException
¶The specified resource could not be found.
Example
try:
...
except client.exceptions.ResourceNotFoundException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'ResourceId': 'string',
'ResourceType': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The specified resource could not be found.
Message (string) –
ResourceId (string) –
The ID of the resource.
ResourceType (string) –
The resource type.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
NetworkManager.Client.exceptions.
ServiceQuotaExceededException
¶A service limit was exceeded.
Example
try:
...
except client.exceptions.ServiceQuotaExceededException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'ResourceId': 'string',
'ResourceType': 'string',
'LimitCode': 'string',
'ServiceCode': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
A service limit was exceeded.
Message (string) –
The error message.
ResourceId (string) –
The ID of the resource.
ResourceType (string) –
The resource type.
LimitCode (string) –
The limit code.
ServiceCode (string) –
The service code.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
NetworkManager.Client.exceptions.
ThrottlingException
¶The request was denied due to request throttling.
Example
try:
...
except client.exceptions.ThrottlingException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'RetryAfterSeconds': 123,
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The request was denied due to request throttling.
Message (string) –
RetryAfterSeconds (integer) –
Indicates when to retry the request.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
NetworkManager.Client.exceptions.
ValidationException
¶The input fails to satisfy the constraints.
Example
try:
...
except client.exceptions.ValidationException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Reason': 'UnknownOperation'|'CannotParse'|'FieldValidationFailed'|'Other',
'Fields': [
{
'Name': 'string',
'Message': 'string'
},
],
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The input fails to satisfy the constraints.
Message (string) –
Reason (string) –
The reason for the error.
Fields (list) –
The fields that caused the error, if applicable.
(dict) –
Describes a validation exception for a field.
Name (string) –
The name of the field.
Message (string) –
The message for the field.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The available paginators are:
NetworkManager.Paginator.
DescribeGlobalNetworks
¶paginator = client.get_paginator('describe_global_networks')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from NetworkManager.Client.describe_global_networks()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GlobalNetworkIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
GlobalNetworkIds (list) –
The IDs of one or more global networks. The maximum is 10.
(string) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'GlobalNetworks': [
{
'GlobalNetworkId': 'string',
'GlobalNetworkArn': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
'Tags': [
{
'Key': 'string',
'Value': '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.
NetworkManager.Paginator.
GetConnections
¶paginator = client.get_paginator('get_connections')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from NetworkManager.Client.get_connections()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GlobalNetworkId='string',
ConnectionIds=[
'string',
],
DeviceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
ConnectionIds (list) –
One or more connection IDs.
(string) –
DeviceId (string) – The ID of the device.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
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'
},
]
},
],
}
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.
NetworkManager.Paginator.
GetCustomerGatewayAssociations
¶paginator = client.get_paginator('get_customer_gateway_associations')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from NetworkManager.Client.get_customer_gateway_associations()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GlobalNetworkId='string',
CustomerGatewayArns=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
CustomerGatewayArns (list) –
One or more customer gateway Amazon Resource Names (ARNs). For more information, see Resources Defined by Amazon EC2 . The maximum is 10.
(string) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'CustomerGatewayAssociations': [
{
'CustomerGatewayArn': 'string',
'GlobalNetworkId': 'string',
'DeviceId': 'string',
'LinkId': 'string',
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
},
],
}
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.
NetworkManager.Paginator.
GetDevices
¶paginator = client.get_paginator('get_devices')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from NetworkManager.Client.get_devices()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GlobalNetworkId='string',
DeviceIds=[
'string',
],
SiteId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
DeviceIds (list) –
One or more device IDs. The maximum is 10.
(string) –
SiteId (string) – The ID of the site.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
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'
},
]
},
],
}
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.
NetworkManager.Paginator.
GetLinkAssociations
¶paginator = client.get_paginator('get_link_associations')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from NetworkManager.Client.get_link_associations()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GlobalNetworkId='string',
DeviceId='string',
LinkId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
DeviceId (string) – The ID of the device.
LinkId (string) – The ID of the link.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'LinkAssociations': [
{
'GlobalNetworkId': 'string',
'DeviceId': 'string',
'LinkId': 'string',
'LinkAssociationState': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
},
],
}
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.
NetworkManager.Paginator.
GetLinks
¶paginator = client.get_paginator('get_links')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from NetworkManager.Client.get_links()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GlobalNetworkId='string',
LinkIds=[
'string',
],
SiteId='string',
Type='string',
Provider='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
LinkIds (list) –
One or more link IDs. The maximum is 10.
(string) –
SiteId (string) – The ID of the site.
Type (string) – The link type.
Provider (string) – The link provider.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
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'
},
]
},
],
}
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.
NetworkManager.Paginator.
GetSites
¶paginator = client.get_paginator('get_sites')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from NetworkManager.Client.get_sites()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GlobalNetworkId='string',
SiteIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
SiteIds (list) –
One or more site IDs. The maximum is 10.
(string) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
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'
},
]
},
],
}
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.
NetworkManager.Paginator.
GetTransitGatewayConnectPeerAssociations
¶paginator = client.get_paginator('get_transit_gateway_connect_peer_associations')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from NetworkManager.Client.get_transit_gateway_connect_peer_associations()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GlobalNetworkId='string',
TransitGatewayConnectPeerArns=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
TransitGatewayConnectPeerArns (list) –
One or more transit gateway Connect peer Amazon Resource Names (ARNs).
(string) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'TransitGatewayConnectPeerAssociations': [
{
'TransitGatewayConnectPeerArn': 'string',
'GlobalNetworkId': 'string',
'DeviceId': 'string',
'LinkId': 'string',
'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
},
],
}
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.
NetworkManager.Paginator.
GetTransitGatewayRegistrations
¶paginator = client.get_paginator('get_transit_gateway_registrations')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from NetworkManager.Client.get_transit_gateway_registrations()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GlobalNetworkId='string',
TransitGatewayArns=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
GlobalNetworkId (string) –
[REQUIRED]
The ID of the global network.
TransitGatewayArns (list) –
The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is 10.
(string) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'TransitGatewayRegistrations': [
{
'GlobalNetworkId': 'string',
'TransitGatewayArn': 'string',
'State': {
'Code': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'|'FAILED',
'Message': '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.