AWS Network Manager 2019-07-05
- Client: Aws\NetworkManager\NetworkManagerClient
- Service ID: networkmanager
- Version: 2019-07-05
This page describes the parameters and results for the operations of the AWS Network Manager (2019-07-05), and shows how to use the Aws\NetworkManager\NetworkManagerClient object to call the described operations. This documentation is specific to the 2019-07-05 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AssociateCustomerGateway ( array $params = [] )
Associates a customer gateway with a device and optionally, with a link.
- AssociateLink ( array $params = [] )
Associates a link to a device.
- AssociateTransitGatewayConnectPeer ( array $params = [] )
Associates a transit gateway Connect peer with a device, and optionally, with a link.
- CreateConnection ( array $params = [] )
Creates a connection between two devices.
- CreateDevice ( array $params = [] )
Creates a new device in a global network.
- CreateGlobalNetwork ( array $params = [] )
Creates a new, empty global network.
- CreateLink ( array $params = [] )
Creates a new link for a specified site.
- CreateSite ( array $params = [] )
Creates a new site in a global network.
- DeleteConnection ( array $params = [] )
Deletes the specified connection in your global network.
- DeleteDevice ( array $params = [] )
Deletes an existing device.
- DeleteGlobalNetwork ( array $params = [] )
Deletes an existing global network.
- DeleteLink ( array $params = [] )
Deletes an existing link.
- DeleteSite ( array $params = [] )
Deletes an existing site.
- DeregisterTransitGateway ( array $params = [] )
Deregisters a transit gateway from your global network.
- DescribeGlobalNetworks ( array $params = [] )
Describes one or more global networks.
- DisassociateCustomerGateway ( array $params = [] )
Disassociates a customer gateway from a device and a link.
- DisassociateLink ( array $params = [] )
Disassociates an existing device from a link.
- DisassociateTransitGatewayConnectPeer ( array $params = [] )
Disassociates a transit gateway Connect peer from a device and link.
- GetConnections ( array $params = [] )
Gets information about one or more of your connections in a global network.
- GetCustomerGatewayAssociations ( array $params = [] )
Gets the association information for customer gateways that are associated with devices and links in your global network.
- GetDevices ( array $params = [] )
Gets information about one or more of your devices in a global network.
- GetLinkAssociations ( array $params = [] )
Gets the link associations for a device or a link.
- GetLinks ( array $params = [] )
Gets information about one or more links in a specified global network.
- GetSites ( array $params = [] )
Gets information about one or more of your sites in a global network.
- GetTransitGatewayConnectPeerAssociations ( array $params = [] )
Gets information about one or more of your transit gateway Connect peer associations in a global network.
- GetTransitGatewayRegistrations ( array $params = [] )
Gets information about the transit gateway registrations in a specified global network.
- ListTagsForResource ( array $params = [] )
Lists the tags for a specified resource.
- RegisterTransitGateway ( array $params = [] )
Registers a transit gateway in your global network.
- TagResource ( array $params = [] )
Tags a specified resource.
- UntagResource ( array $params = [] )
Removes tags from a specified resource.
- UpdateConnection ( array $params = [] )
Updates the information for an existing connection.
- UpdateDevice ( array $params = [] )
Updates the details for an existing device.
- UpdateGlobalNetwork ( array $params = [] )
Updates an existing global network.
- UpdateLink ( array $params = [] )
Updates the details for an existing link.
- UpdateSite ( array $params = [] )
Updates the information for an existing site.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
AssociateCustomerGateway
$result = $client->associateCustomerGateway([/* ... */]); $promise = $client->associateCustomerGatewayAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->associateCustomerGateway([
'CustomerGatewayArn' => '<string>', // REQUIRED
'DeviceId' => '<string>', // REQUIRED
'GlobalNetworkId' => '<string>', // REQUIRED
'LinkId' => '<string>',
]);
Parameter Details
Members
- CustomerGatewayArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the customer gateway. For more information, see Resources Defined by Amazon EC2.
- DeviceId
-
- Required: Yes
- Type: string
The ID of the device.
- GlobalNetworkId
-
- Required: Yes
- Type: string
The ID of the global network.
- LinkId
-
- Type: string
The ID of the link.
Result Syntax
[
'CustomerGatewayAssociation' => [
'CustomerGatewayArn' => '<string>',
'DeviceId' => '<string>',
'GlobalNetworkId' => '<string>',
'LinkId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|DELETED',
],
]
Result Details
Members
- CustomerGatewayAssociation
-
- Type: CustomerGatewayAssociation structure
The customer gateway association.
Errors
-
The input fails to satisfy the constraints.
-
ServiceQuotaExceededException:
A service limit was exceeded.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
AssociateLink
$result = $client->associateLink([/* ... */]); $promise = $client->associateLinkAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->associateLink([
'DeviceId' => '<string>', // REQUIRED
'GlobalNetworkId' => '<string>', // REQUIRED
'LinkId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'LinkAssociation' => [
'DeviceId' => '<string>',
'GlobalNetworkId' => '<string>',
'LinkAssociationState' => 'PENDING|AVAILABLE|DELETING|DELETED',
'LinkId' => '<string>',
],
]
Result Details
Members
- LinkAssociation
-
- Type: LinkAssociation structure
The link association.
Errors
-
The input fails to satisfy the constraints.
-
ServiceQuotaExceededException:
A service limit was exceeded.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
AssociateTransitGatewayConnectPeer
$result = $client->associateTransitGatewayConnectPeer([/* ... */]); $promise = $client->associateTransitGatewayConnectPeerAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->associateTransitGatewayConnectPeer([
'DeviceId' => '<string>', // REQUIRED
'GlobalNetworkId' => '<string>', // REQUIRED
'LinkId' => '<string>',
'TransitGatewayConnectPeerArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'TransitGatewayConnectPeerAssociation' => [
'DeviceId' => '<string>',
'GlobalNetworkId' => '<string>',
'LinkId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|DELETED',
'TransitGatewayConnectPeerArn' => '<string>',
],
]
Result Details
Members
- TransitGatewayConnectPeerAssociation
-
- Type: TransitGatewayConnectPeerAssociation structure
The transit gateway Connect peer association.
Errors
-
The input fails to satisfy the constraints.
-
ServiceQuotaExceededException:
A service limit was exceeded.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
CreateConnection
$result = $client->createConnection([/* ... */]); $promise = $client->createConnectionAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->createConnection([
'ConnectedDeviceId' => '<string>', // REQUIRED
'ConnectedLinkId' => '<string>',
'Description' => '<string>',
'DeviceId' => '<string>', // REQUIRED
'GlobalNetworkId' => '<string>', // REQUIRED
'LinkId' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- ConnectedDeviceId
-
- Required: Yes
- Type: string
The ID of the second device in the connection.
- ConnectedLinkId
-
- Type: string
The ID of the link for the second device.
- Description
-
- Type: string
A description of the connection.
Length Constraints: Maximum length of 256 characters.
- DeviceId
-
- Required: Yes
- Type: string
The ID of the first device in the connection.
- GlobalNetworkId
-
- Required: Yes
- Type: string
The ID of the global network.
- LinkId
-
- Type: string
The ID of the link for the first device.
- Tags
-
- Type: Array of Tag structures
The tags to apply to the resource during creation.
Result Syntax
[
'Connection' => [
'ConnectedDeviceId' => '<string>',
'ConnectedLinkId' => '<string>',
'ConnectionArn' => '<string>',
'ConnectionId' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'DeviceId' => '<string>',
'GlobalNetworkId' => '<string>',
'LinkId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
]
Result Details
Members
- Connection
-
- Type: Connection structure
Information about the connection.
Errors
-
The input fails to satisfy the constraints.
-
ServiceQuotaExceededException:
A service limit was exceeded.
-
You do not have sufficient access to perform this action.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
CreateDevice
$result = $client->createDevice([/* ... */]); $promise = $client->createDeviceAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->createDevice([
'AWSLocation' => [
'SubnetArn' => '<string>',
'Zone' => '<string>',
],
'Description' => '<string>',
'GlobalNetworkId' => '<string>', // REQUIRED
'Location' => [
'Address' => '<string>',
'Latitude' => '<string>',
'Longitude' => '<string>',
],
'Model' => '<string>',
'SerialNumber' => '<string>',
'SiteId' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'Type' => '<string>',
'Vendor' => '<string>',
]);
Parameter Details
Members
- AWSLocation
-
- Type: AWSLocation structure
The AWS location of the device.
- Description
-
- Type: string
A description of the device.
Length Constraints: Maximum length of 256 characters.
- GlobalNetworkId
-
- Required: Yes
- Type: string
The ID of the global network.
- Location
-
- Type: Location structure
The location of the device.
- Model
-
- Type: string
The model of the device.
Length Constraints: Maximum length of 128 characters.
- SerialNumber
-
- Type: string
The serial number of the device.
Length Constraints: Maximum length of 128 characters.
- SiteId
-
- Type: string
The ID of the site.
- Tags
-
- Type: Array of Tag structures
The tags to apply to the resource during creation.
- Type
-
- Type: string
The type of the device.
- Vendor
-
- Type: string
The vendor of the device.
Length Constraints: Maximum length of 128 characters.
Result Syntax
[
'Device' => [
'AWSLocation' => [
'SubnetArn' => '<string>',
'Zone' => '<string>',
],
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'DeviceArn' => '<string>',
'DeviceId' => '<string>',
'GlobalNetworkId' => '<string>',
'Location' => [
'Address' => '<string>',
'Latitude' => '<string>',
'Longitude' => '<string>',
],
'Model' => '<string>',
'SerialNumber' => '<string>',
'SiteId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'Type' => '<string>',
'Vendor' => '<string>',
],
]
Result Details
Members
- Device
-
- Type: Device structure
Information about the device.
Errors
-
The input fails to satisfy the constraints.
-
ServiceQuotaExceededException:
A service limit was exceeded.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
CreateGlobalNetwork
$result = $client->createGlobalNetwork([/* ... */]); $promise = $client->createGlobalNetworkAsync([/* ... */]);
Creates a new, empty global network.
Parameter Syntax
$result = $client->createGlobalNetwork([
'Description' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- Description
-
- Type: string
A description of the global network.
Length Constraints: Maximum length of 256 characters.
- Tags
-
- Type: Array of Tag structures
The tags to apply to the resource during creation.
Result Syntax
[
'GlobalNetwork' => [
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'GlobalNetworkArn' => '<string>',
'GlobalNetworkId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
]
Result Details
Members
- GlobalNetwork
-
- Type: GlobalNetwork structure
Information about the global network object.
Errors
-
The input fails to satisfy the constraints.
-
ServiceQuotaExceededException:
A service limit was exceeded.
-
You do not have sufficient access to perform this action.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
CreateLink
$result = $client->createLink([/* ... */]); $promise = $client->createLinkAsync([/* ... */]);
Creates a new link for a specified site.
Parameter Syntax
$result = $client->createLink([
'Bandwidth' => [ // REQUIRED
'DownloadSpeed' => <integer>,
'UploadSpeed' => <integer>,
],
'Description' => '<string>',
'GlobalNetworkId' => '<string>', // REQUIRED
'Provider' => '<string>',
'SiteId' => '<string>', // REQUIRED
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'Type' => '<string>',
]);
Parameter Details
Members
- Bandwidth
-
- Required: Yes
- Type: Bandwidth structure
The upload speed and download speed in Mbps.
- Description
-
- Type: string
A description of the link.
Length Constraints: Maximum length of 256 characters.
- GlobalNetworkId
-
- Required: Yes
- Type: string
The ID of the global network.
- Provider
-
- Type: string
The provider of the link.
Constraints: Cannot include the following characters: | \ ^
Length Constraints: Maximum length of 128 characters.
- SiteId
-
- Required: Yes
- Type: string
The ID of the site.
- Tags
-
- Type: Array of Tag structures
The tags to apply to the resource during creation.
- Type
-
- Type: string
The type of the link.
Constraints: Cannot include the following characters: | \ ^
Length Constraints: Maximum length of 128 characters.
Result Syntax
[
'Link' => [
'Bandwidth' => [
'DownloadSpeed' => <integer>,
'UploadSpeed' => <integer>,
],
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'GlobalNetworkId' => '<string>',
'LinkArn' => '<string>',
'LinkId' => '<string>',
'Provider' => '<string>',
'SiteId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'Type' => '<string>',
],
]
Result Details
Members
- Link
-
- Type: Link structure
Information about the link.
Errors
-
The input fails to satisfy the constraints.
-
ServiceQuotaExceededException:
A service limit was exceeded.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
CreateSite
$result = $client->createSite([/* ... */]); $promise = $client->createSiteAsync([/* ... */]);
Creates a new site in a global network.
Parameter Syntax
$result = $client->createSite([
'Description' => '<string>',
'GlobalNetworkId' => '<string>', // REQUIRED
'Location' => [
'Address' => '<string>',
'Latitude' => '<string>',
'Longitude' => '<string>',
],
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- Description
-
- Type: string
A description of your site.
Length Constraints: Maximum length of 256 characters.
- GlobalNetworkId
-
- Required: Yes
- Type: string
The ID of the global network.
- Location
-
- Type: Location structure
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.
- Tags
-
- Type: Array of Tag structures
The tags to apply to the resource during creation.
Result Syntax
[
'Site' => [
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'GlobalNetworkId' => '<string>',
'Location' => [
'Address' => '<string>',
'Latitude' => '<string>',
'Longitude' => '<string>',
],
'SiteArn' => '<string>',
'SiteId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
]
Result Details
Members
- Site
-
- Type: Site structure
Information about the site.
Errors
-
The input fails to satisfy the constraints.
-
ServiceQuotaExceededException:
A service limit was exceeded.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
DeleteConnection
$result = $client->deleteConnection([/* ... */]); $promise = $client->deleteConnectionAsync([/* ... */]);
Deletes the specified connection in your global network.
Parameter Syntax
$result = $client->deleteConnection([
'ConnectionId' => '<string>', // REQUIRED
'GlobalNetworkId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Connection' => [
'ConnectedDeviceId' => '<string>',
'ConnectedLinkId' => '<string>',
'ConnectionArn' => '<string>',
'ConnectionId' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'DeviceId' => '<string>',
'GlobalNetworkId' => '<string>',
'LinkId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
]
Result Details
Members
- Connection
-
- Type: Connection structure
Information about the connection.
Errors
-
The input fails to satisfy the constraints.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
DeleteDevice
$result = $client->deleteDevice([/* ... */]); $promise = $client->deleteDeviceAsync([/* ... */]);
Deletes an existing device. You must first disassociate the device from any links and customer gateways.
Parameter Syntax
$result = $client->deleteDevice([
'DeviceId' => '<string>', // REQUIRED
'GlobalNetworkId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Device' => [
'AWSLocation' => [
'SubnetArn' => '<string>',
'Zone' => '<string>',
],
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'DeviceArn' => '<string>',
'DeviceId' => '<string>',
'GlobalNetworkId' => '<string>',
'Location' => [
'Address' => '<string>',
'Latitude' => '<string>',
'Longitude' => '<string>',
],
'Model' => '<string>',
'SerialNumber' => '<string>',
'SiteId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'Type' => '<string>',
'Vendor' => '<string>',
],
]
Result Details
Members
- Device
-
- Type: Device structure
Information about the device.
Errors
-
The input fails to satisfy the constraints.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
DeleteGlobalNetwork
$result = $client->deleteGlobalNetwork([/* ... */]); $promise = $client->deleteGlobalNetworkAsync([/* ... */]);
Deletes an existing global network. You must first delete all global network objects (devices, links, and sites) and deregister all transit gateways.
Parameter Syntax
$result = $client->deleteGlobalNetwork([
'GlobalNetworkId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'GlobalNetwork' => [
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'GlobalNetworkArn' => '<string>',
'GlobalNetworkId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
]
Result Details
Members
- GlobalNetwork
-
- Type: GlobalNetwork structure
Information about the global network.
Errors
-
The input fails to satisfy the constraints.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
DeleteLink
$result = $client->deleteLink([/* ... */]); $promise = $client->deleteLinkAsync([/* ... */]);
Deletes an existing link. You must first disassociate the link from any devices and customer gateways.
Parameter Syntax
$result = $client->deleteLink([
'GlobalNetworkId' => '<string>', // REQUIRED
'LinkId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Link' => [
'Bandwidth' => [
'DownloadSpeed' => <integer>,
'UploadSpeed' => <integer>,
],
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'GlobalNetworkId' => '<string>',
'LinkArn' => '<string>',
'LinkId' => '<string>',
'Provider' => '<string>',
'SiteId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'Type' => '<string>',
],
]
Result Details
Members
- Link
-
- Type: Link structure
Information about the link.
Errors
-
The input fails to satisfy the constraints.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
DeleteSite
$result = $client->deleteSite([/* ... */]); $promise = $client->deleteSiteAsync([/* ... */]);
Deletes an existing site. The site cannot be associated with any device or link.
Parameter Syntax
$result = $client->deleteSite([
'GlobalNetworkId' => '<string>', // REQUIRED
'SiteId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Site' => [
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'GlobalNetworkId' => '<string>',
'Location' => [
'Address' => '<string>',
'Latitude' => '<string>',
'Longitude' => '<string>',
],
'SiteArn' => '<string>',
'SiteId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
]
Result Details
Members
- Site
-
- Type: Site structure
Information about the site.
Errors
-
The input fails to satisfy the constraints.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
DeregisterTransitGateway
$result = $client->deregisterTransitGateway([/* ... */]); $promise = $client->deregisterTransitGatewayAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deregisterTransitGateway([
'GlobalNetworkId' => '<string>', // REQUIRED
'TransitGatewayArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'TransitGatewayRegistration' => [
'GlobalNetworkId' => '<string>',
'State' => [
'Code' => 'PENDING|AVAILABLE|DELETING|DELETED|FAILED',
'Message' => '<string>',
],
'TransitGatewayArn' => '<string>',
],
]
Result Details
Members
- TransitGatewayRegistration
-
- Type: TransitGatewayRegistration structure
The transit gateway registration information.
Errors
-
The input fails to satisfy the constraints.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
DescribeGlobalNetworks
$result = $client->describeGlobalNetworks([/* ... */]); $promise = $client->describeGlobalNetworksAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->describeGlobalNetworks([
'GlobalNetworkIds' => ['<string>', ...],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'GlobalNetworks' => [
[
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'GlobalNetworkArn' => '<string>',
'GlobalNetworkId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- GlobalNetworks
-
- Type: Array of GlobalNetwork structures
Information about the global networks.
- NextToken
-
- Type: string
The token for the next page of results.
Errors
-
The input fails to satisfy the constraints.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
DisassociateCustomerGateway
$result = $client->disassociateCustomerGateway([/* ... */]); $promise = $client->disassociateCustomerGatewayAsync([/* ... */]);
Disassociates a customer gateway from a device and a link.
Parameter Syntax
$result = $client->disassociateCustomerGateway([
'CustomerGatewayArn' => '<string>', // REQUIRED
'GlobalNetworkId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- CustomerGatewayArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the customer gateway. For more information, see Resources Defined by Amazon EC2.
- GlobalNetworkId
-
- Required: Yes
- Type: string
The ID of the global network.
Result Syntax
[
'CustomerGatewayAssociation' => [
'CustomerGatewayArn' => '<string>',
'DeviceId' => '<string>',
'GlobalNetworkId' => '<string>',
'LinkId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|DELETED',
],
]
Result Details
Members
- CustomerGatewayAssociation
-
- Type: CustomerGatewayAssociation structure
Information about the customer gateway association.
Errors
-
The input fails to satisfy the constraints.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
DisassociateLink
$result = $client->disassociateLink([/* ... */]); $promise = $client->disassociateLinkAsync([/* ... */]);
Disassociates an existing device from a link. You must first disassociate any customer gateways that are associated with the link.
Parameter Syntax
$result = $client->disassociateLink([
'DeviceId' => '<string>', // REQUIRED
'GlobalNetworkId' => '<string>', // REQUIRED
'LinkId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'LinkAssociation' => [
'DeviceId' => '<string>',
'GlobalNetworkId' => '<string>',
'LinkAssociationState' => 'PENDING|AVAILABLE|DELETING|DELETED',
'LinkId' => '<string>',
],
]
Result Details
Members
- LinkAssociation
-
- Type: LinkAssociation structure
Information about the link association.
Errors
-
The input fails to satisfy the constraints.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
DisassociateTransitGatewayConnectPeer
$result = $client->disassociateTransitGatewayConnectPeer([/* ... */]); $promise = $client->disassociateTransitGatewayConnectPeerAsync([/* ... */]);
Disassociates a transit gateway Connect peer from a device and link.
Parameter Syntax
$result = $client->disassociateTransitGatewayConnectPeer([
'GlobalNetworkId' => '<string>', // REQUIRED
'TransitGatewayConnectPeerArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'TransitGatewayConnectPeerAssociation' => [
'DeviceId' => '<string>',
'GlobalNetworkId' => '<string>',
'LinkId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|DELETED',
'TransitGatewayConnectPeerArn' => '<string>',
],
]
Result Details
Members
- TransitGatewayConnectPeerAssociation
-
- Type: TransitGatewayConnectPeerAssociation structure
The transit gateway Connect peer association.
Errors
-
The input fails to satisfy the constraints.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
GetConnections
$result = $client->getConnections([/* ... */]); $promise = $client->getConnectionsAsync([/* ... */]);
Gets information about one or more of your connections in a global network.
Parameter Syntax
$result = $client->getConnections([
'ConnectionIds' => ['<string>', ...],
'DeviceId' => '<string>',
'GlobalNetworkId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- ConnectionIds
-
- Type: Array of strings
One or more connection IDs.
- DeviceId
-
- Type: string
The ID of the device.
- GlobalNetworkId
-
- Required: Yes
- Type: string
The ID of the global network.
- MaxResults
-
- Type: int
The maximum number of results to return.
- NextToken
-
- Type: string
The token for the next page of results.
Result Syntax
[
'Connections' => [
[
'ConnectedDeviceId' => '<string>',
'ConnectedLinkId' => '<string>',
'ConnectionArn' => '<string>',
'ConnectionId' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'DeviceId' => '<string>',
'GlobalNetworkId' => '<string>',
'LinkId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Connections
-
- Type: Array of Connection structures
Information about the connections.
- NextToken
-
- Type: string
The token to use for the next page of results.
Errors
-
The input fails to satisfy the constraints.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
GetCustomerGatewayAssociations
$result = $client->getCustomerGatewayAssociations([/* ... */]); $promise = $client->getCustomerGatewayAssociationsAsync([/* ... */]);
Gets the association information for customer gateways that are associated with devices and links in your global network.
Parameter Syntax
$result = $client->getCustomerGatewayAssociations([
'CustomerGatewayArns' => ['<string>', ...],
'GlobalNetworkId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- CustomerGatewayArns
-
- Type: Array of strings
One or more customer gateway Amazon Resource Names (ARNs). For more information, see Resources Defined by Amazon EC2. The maximum is 10.
- GlobalNetworkId
-
- Required: Yes
- Type: string
The ID of the global network.
- MaxResults
-
- Type: int
The maximum number of results to return.
- NextToken
-
- Type: string
The token for the next page of results.
Result Syntax
[
'CustomerGatewayAssociations' => [
[
'CustomerGatewayArn' => '<string>',
'DeviceId' => '<string>',
'GlobalNetworkId' => '<string>',
'LinkId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|DELETED',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- CustomerGatewayAssociations
-
- Type: Array of CustomerGatewayAssociation structures
The customer gateway associations.
- NextToken
-
- Type: string
The token for the next page of results.
Errors
-
The input fails to satisfy the constraints.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
GetDevices
$result = $client->getDevices([/* ... */]); $promise = $client->getDevicesAsync([/* ... */]);
Gets information about one or more of your devices in a global network.
Parameter Syntax
$result = $client->getDevices([
'DeviceIds' => ['<string>', ...],
'GlobalNetworkId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'SiteId' => '<string>',
]);
Parameter Details
Members
- DeviceIds
-
- Type: Array of strings
One or more device IDs. The maximum is 10.
- GlobalNetworkId
-
- Required: Yes
- Type: string
The ID of the global network.
- MaxResults
-
- Type: int
The maximum number of results to return.
- NextToken
-
- Type: string
The token for the next page of results.
- SiteId
-
- Type: string
The ID of the site.
Result Syntax
[
'Devices' => [
[
'AWSLocation' => [
'SubnetArn' => '<string>',
'Zone' => '<string>',
],
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'DeviceArn' => '<string>',
'DeviceId' => '<string>',
'GlobalNetworkId' => '<string>',
'Location' => [
'Address' => '<string>',
'Latitude' => '<string>',
'Longitude' => '<string>',
],
'Model' => '<string>',
'SerialNumber' => '<string>',
'SiteId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'Type' => '<string>',
'Vendor' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Devices
-
- Type: Array of Device structures
The devices.
- NextToken
-
- Type: string
The token for the next page of results.
Errors
-
The input fails to satisfy the constraints.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
GetLinkAssociations
$result = $client->getLinkAssociations([/* ... */]); $promise = $client->getLinkAssociationsAsync([/* ... */]);
Gets the link associations for a device or a link. Either the device ID or the link ID must be specified.
Parameter Syntax
$result = $client->getLinkAssociations([
'DeviceId' => '<string>',
'GlobalNetworkId' => '<string>', // REQUIRED
'LinkId' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'LinkAssociations' => [
[
'DeviceId' => '<string>',
'GlobalNetworkId' => '<string>',
'LinkAssociationState' => 'PENDING|AVAILABLE|DELETING|DELETED',
'LinkId' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- LinkAssociations
-
- Type: Array of LinkAssociation structures
The link associations.
- NextToken
-
- Type: string
The token for the next page of results.
Errors
-
The input fails to satisfy the constraints.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
GetLinks
$result = $client->getLinks([/* ... */]); $promise = $client->getLinksAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->getLinks([
'GlobalNetworkId' => '<string>', // REQUIRED
'LinkIds' => ['<string>', ...],
'MaxResults' => <integer>,
'NextToken' => '<string>',
'Provider' => '<string>',
'SiteId' => '<string>',
'Type' => '<string>',
]);
Parameter Details
Members
- GlobalNetworkId
-
- Required: Yes
- Type: string
The ID of the global network.
- LinkIds
-
- Type: Array of strings
One or more link IDs. The maximum is 10.
- MaxResults
-
- Type: int
The maximum number of results to return.
- NextToken
-
- Type: string
The token for the next page of results.
- Provider
-
- Type: string
The link provider.
- SiteId
-
- Type: string
The ID of the site.
- Type
-
- Type: string
The link type.
Result Syntax
[
'Links' => [
[
'Bandwidth' => [
'DownloadSpeed' => <integer>,
'UploadSpeed' => <integer>,
],
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'GlobalNetworkId' => '<string>',
'LinkArn' => '<string>',
'LinkId' => '<string>',
'Provider' => '<string>',
'SiteId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'Type' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Links
-
- Type: Array of Link structures
The links.
- NextToken
-
- Type: string
The token for the next page of results.
Errors
-
The input fails to satisfy the constraints.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
GetSites
$result = $client->getSites([/* ... */]); $promise = $client->getSitesAsync([/* ... */]);
Gets information about one or more of your sites in a global network.
Parameter Syntax
$result = $client->getSites([
'GlobalNetworkId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'SiteIds' => ['<string>', ...],
]);
Parameter Details
Members
Result Syntax
[
'NextToken' => '<string>',
'Sites' => [
[
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'GlobalNetworkId' => '<string>',
'Location' => [
'Address' => '<string>',
'Latitude' => '<string>',
'Longitude' => '<string>',
],
'SiteArn' => '<string>',
'SiteId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token for the next page of results.
- Sites
-
- Type: Array of Site structures
The sites.
Errors
-
The input fails to satisfy the constraints.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
GetTransitGatewayConnectPeerAssociations
$result = $client->getTransitGatewayConnectPeerAssociations([/* ... */]); $promise = $client->getTransitGatewayConnectPeerAssociationsAsync([/* ... */]);
Gets information about one or more of your transit gateway Connect peer associations in a global network.
Parameter Syntax
$result = $client->getTransitGatewayConnectPeerAssociations([
'GlobalNetworkId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'TransitGatewayConnectPeerArns' => ['<string>', ...],
]);
Parameter Details
Members
- GlobalNetworkId
-
- Required: Yes
- Type: string
The ID of the global network.
- MaxResults
-
- Type: int
The maximum number of results to return.
- NextToken
-
- Type: string
The token for the next page of results.
- TransitGatewayConnectPeerArns
-
- Type: Array of strings
One or more transit gateway Connect peer Amazon Resource Names (ARNs).
Result Syntax
[
'NextToken' => '<string>',
'TransitGatewayConnectPeerAssociations' => [
[
'DeviceId' => '<string>',
'GlobalNetworkId' => '<string>',
'LinkId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|DELETED',
'TransitGatewayConnectPeerArn' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token to use for the next page of results.
- TransitGatewayConnectPeerAssociations
-
- Type: Array of TransitGatewayConnectPeerAssociation structures
Information about the transit gateway Connect peer associations.
Errors
-
The input fails to satisfy the constraints.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
GetTransitGatewayRegistrations
$result = $client->getTransitGatewayRegistrations([/* ... */]); $promise = $client->getTransitGatewayRegistrationsAsync([/* ... */]);
Gets information about the transit gateway registrations in a specified global network.
Parameter Syntax
$result = $client->getTransitGatewayRegistrations([
'GlobalNetworkId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'TransitGatewayArns' => ['<string>', ...],
]);
Parameter Details
Members
- GlobalNetworkId
-
- Required: Yes
- Type: string
The ID of the global network.
- MaxResults
-
- Type: int
The maximum number of results to return.
- NextToken
-
- Type: string
The token for the next page of results.
- TransitGatewayArns
-
- Type: Array of strings
The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is 10.
Result Syntax
[
'NextToken' => '<string>',
'TransitGatewayRegistrations' => [
[
'GlobalNetworkId' => '<string>',
'State' => [
'Code' => 'PENDING|AVAILABLE|DELETING|DELETED|FAILED',
'Message' => '<string>',
],
'TransitGatewayArn' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token for the next page of results.
- TransitGatewayRegistrations
-
- Type: Array of TransitGatewayRegistration structures
The transit gateway registrations.
Errors
-
The input fails to satisfy the constraints.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Lists the tags for a specified resource.
Parameter Syntax
$result = $client->listTagsForResource([
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'TagList' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- TagList
-
- Type: Array of Tag structures
The list of tags.
Errors
-
The input fails to satisfy the constraints.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
RegisterTransitGateway
$result = $client->registerTransitGateway([/* ... */]); $promise = $client->registerTransitGatewayAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->registerTransitGateway([
'GlobalNetworkId' => '<string>', // REQUIRED
'TransitGatewayArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- GlobalNetworkId
-
- Required: Yes
- Type: string
The ID of the global network.
- TransitGatewayArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the transit gateway. For more information, see Resources Defined by Amazon EC2.
Result Syntax
[
'TransitGatewayRegistration' => [
'GlobalNetworkId' => '<string>',
'State' => [
'Code' => 'PENDING|AVAILABLE|DELETING|DELETED|FAILED',
'Message' => '<string>',
],
'TransitGatewayArn' => '<string>',
],
]
Result Details
Members
- TransitGatewayRegistration
-
- Type: TransitGatewayRegistration structure
Information about the transit gateway registration.
Errors
-
The input fails to satisfy the constraints.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Tags a specified resource.
Parameter Syntax
$result = $client->tagResource([
'ResourceArn' => '<string>', // REQUIRED
'Tags' => [ // REQUIRED
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource.
- Tags
-
- Required: Yes
- Type: Array of Tag structures
The tags to apply to the specified resource.
Result Syntax
[]
Result Details
Errors
-
The input fails to satisfy the constraints.
-
ServiceQuotaExceededException:
A service limit was exceeded.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes tags from a specified resource.
Parameter Syntax
$result = $client->untagResource([
'ResourceArn' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The input fails to satisfy the constraints.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
UpdateConnection
$result = $client->updateConnection([/* ... */]); $promise = $client->updateConnectionAsync([/* ... */]);
Updates the information for an existing connection. To remove information for any of the parameters, specify an empty string.
Parameter Syntax
$result = $client->updateConnection([
'ConnectedLinkId' => '<string>',
'ConnectionId' => '<string>', // REQUIRED
'Description' => '<string>',
'GlobalNetworkId' => '<string>', // REQUIRED
'LinkId' => '<string>',
]);
Parameter Details
Members
- ConnectedLinkId
-
- Type: string
The ID of the link for the second device in the connection.
- ConnectionId
-
- Required: Yes
- Type: string
The ID of the connection.
- Description
-
- Type: string
A description of the connection.
Length Constraints: Maximum length of 256 characters.
- GlobalNetworkId
-
- Required: Yes
- Type: string
The ID of the global network.
- LinkId
-
- Type: string
The ID of the link for the first device in the connection.
Result Syntax
[
'Connection' => [
'ConnectedDeviceId' => '<string>',
'ConnectedLinkId' => '<string>',
'ConnectionArn' => '<string>',
'ConnectionId' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'DeviceId' => '<string>',
'GlobalNetworkId' => '<string>',
'LinkId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
]
Result Details
Members
- Connection
-
- Type: Connection structure
Information about the connection.
Errors
-
The input fails to satisfy the constraints.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
UpdateDevice
$result = $client->updateDevice([/* ... */]); $promise = $client->updateDeviceAsync([/* ... */]);
Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.
Parameter Syntax
$result = $client->updateDevice([
'AWSLocation' => [
'SubnetArn' => '<string>',
'Zone' => '<string>',
],
'Description' => '<string>',
'DeviceId' => '<string>', // REQUIRED
'GlobalNetworkId' => '<string>', // REQUIRED
'Location' => [
'Address' => '<string>',
'Latitude' => '<string>',
'Longitude' => '<string>',
],
'Model' => '<string>',
'SerialNumber' => '<string>',
'SiteId' => '<string>',
'Type' => '<string>',
'Vendor' => '<string>',
]);
Parameter Details
Members
- AWSLocation
-
- Type: AWSLocation structure
The AWS location of the device.
- Description
-
- Type: string
A description of the device.
Length Constraints: Maximum length of 256 characters.
- DeviceId
-
- Required: Yes
- Type: string
The ID of the device.
- GlobalNetworkId
-
- Required: Yes
- Type: string
The ID of the global network.
- Location
-
- Type: Location structure
Describes a location.
- Model
-
- Type: string
The model of the device.
Length Constraints: Maximum length of 128 characters.
- SerialNumber
-
- Type: string
The serial number of the device.
Length Constraints: Maximum length of 128 characters.
- SiteId
-
- Type: string
The ID of the site.
- Type
-
- Type: string
The type of the device.
- Vendor
-
- Type: string
The vendor of the device.
Length Constraints: Maximum length of 128 characters.
Result Syntax
[
'Device' => [
'AWSLocation' => [
'SubnetArn' => '<string>',
'Zone' => '<string>',
],
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'DeviceArn' => '<string>',
'DeviceId' => '<string>',
'GlobalNetworkId' => '<string>',
'Location' => [
'Address' => '<string>',
'Latitude' => '<string>',
'Longitude' => '<string>',
],
'Model' => '<string>',
'SerialNumber' => '<string>',
'SiteId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'Type' => '<string>',
'Vendor' => '<string>',
],
]
Result Details
Members
- Device
-
- Type: Device structure
Information about the device.
Errors
-
The input fails to satisfy the constraints.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
UpdateGlobalNetwork
$result = $client->updateGlobalNetwork([/* ... */]); $promise = $client->updateGlobalNetworkAsync([/* ... */]);
Updates an existing global network. To remove information for any of the parameters, specify an empty string.
Parameter Syntax
$result = $client->updateGlobalNetwork([
'Description' => '<string>',
'GlobalNetworkId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'GlobalNetwork' => [
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'GlobalNetworkArn' => '<string>',
'GlobalNetworkId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
]
Result Details
Members
- GlobalNetwork
-
- Type: GlobalNetwork structure
Information about the global network object.
Errors
-
The input fails to satisfy the constraints.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
UpdateLink
$result = $client->updateLink([/* ... */]); $promise = $client->updateLinkAsync([/* ... */]);
Updates the details for an existing link. To remove information for any of the parameters, specify an empty string.
Parameter Syntax
$result = $client->updateLink([
'Bandwidth' => [
'DownloadSpeed' => <integer>,
'UploadSpeed' => <integer>,
],
'Description' => '<string>',
'GlobalNetworkId' => '<string>', // REQUIRED
'LinkId' => '<string>', // REQUIRED
'Provider' => '<string>',
'Type' => '<string>',
]);
Parameter Details
Members
- Bandwidth
-
- Type: Bandwidth structure
The upload and download speed in Mbps.
- Description
-
- Type: string
A description of the link.
Length Constraints: Maximum length of 256 characters.
- GlobalNetworkId
-
- Required: Yes
- Type: string
The ID of the global network.
- LinkId
-
- Required: Yes
- Type: string
The ID of the link.
- Provider
-
- Type: string
The provider of the link.
Length Constraints: Maximum length of 128 characters.
- Type
-
- Type: string
The type of the link.
Length Constraints: Maximum length of 128 characters.
Result Syntax
[
'Link' => [
'Bandwidth' => [
'DownloadSpeed' => <integer>,
'UploadSpeed' => <integer>,
],
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'GlobalNetworkId' => '<string>',
'LinkArn' => '<string>',
'LinkId' => '<string>',
'Provider' => '<string>',
'SiteId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'Type' => '<string>',
],
]
Result Details
Members
- Link
-
- Type: Link structure
Information about the link.
Errors
-
The input fails to satisfy the constraints.
-
ServiceQuotaExceededException:
A service limit was exceeded.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
UpdateSite
$result = $client->updateSite([/* ... */]); $promise = $client->updateSiteAsync([/* ... */]);
Updates the information for an existing site. To remove information for any of the parameters, specify an empty string.
Parameter Syntax
$result = $client->updateSite([
'Description' => '<string>',
'GlobalNetworkId' => '<string>', // REQUIRED
'Location' => [
'Address' => '<string>',
'Latitude' => '<string>',
'Longitude' => '<string>',
],
'SiteId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Description
-
- Type: string
A description of your site.
Length Constraints: Maximum length of 256 characters.
- GlobalNetworkId
-
- Required: Yes
- Type: string
The ID of the global network.
- Location
-
- Type: Location structure
The site location:
-
Address: The physical address of the site. -
Latitude: The latitude of the site. -
Longitude: The longitude of the site.
- SiteId
-
- Required: Yes
- Type: string
The ID of your site.
Result Syntax
[
'Site' => [
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'GlobalNetworkId' => '<string>',
'Location' => [
'Address' => '<string>',
'Latitude' => '<string>',
'Longitude' => '<string>',
],
'SiteArn' => '<string>',
'SiteId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
]
Result Details
Members
- Site
-
- Type: Site structure
Information about the site.
Errors
-
The input fails to satisfy the constraints.
-
You do not have sufficient access to perform this action.
-
The specified resource could not be found.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
Shapes
AWSLocation
Description
Specifies a location in AWS.
Members
AccessDeniedException
Description
You do not have sufficient access to perform this action.
Members
Bandwidth
Description
Describes bandwidth information.
Members
ConflictException
Description
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
Members
Connection
Description
Describes a connection.
Members
- ConnectedDeviceId
-
- Type: string
The ID of the second device in the connection.
- ConnectedLinkId
-
- Type: string
The ID of the link for the second device in the connection.
- ConnectionArn
-
- Type: string
The Amazon Resource Name (ARN) of the connection.
- ConnectionId
-
- Type: string
The ID of the connection.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the connection was created.
- Description
-
- Type: string
The description of the connection.
- DeviceId
-
- Type: string
The ID of the first device in the connection.
- GlobalNetworkId
-
- Type: string
The ID of the global network.
- LinkId
-
- Type: string
The ID of the link for the first device in the connection.
- State
-
- Type: string
The state of the connection.
- Tags
-
- Type: Array of Tag structures
The tags for the connection.
CustomerGatewayAssociation
Description
Describes the association between a customer gateway, a device, and a link.
Members
Device
Description
Describes a device.
Members
- AWSLocation
-
- Type: AWSLocation structure
The AWS location of the device.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the site was created.
- Description
-
- Type: string
The description of the device.
- DeviceArn
-
- Type: string
The Amazon Resource Name (ARN) of the device.
- DeviceId
-
- Type: string
The ID of the device.
- GlobalNetworkId
-
- Type: string
The ID of the global network.
- Location
-
- Type: Location structure
The site location.
- Model
-
- Type: string
The device model.
- SerialNumber
-
- Type: string
The device serial number.
- SiteId
-
- Type: string
The site ID.
- State
-
- Type: string
The device state.
- Tags
-
- Type: Array of Tag structures
The tags for the device.
- Type
-
- Type: string
The device type.
- Vendor
-
- Type: string
The device vendor.
GlobalNetwork
Description
Describes a global network.
Members
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the global network was created.
- Description
-
- Type: string
The description of the global network.
- GlobalNetworkArn
-
- Type: string
The Amazon Resource Name (ARN) of the global network.
- GlobalNetworkId
-
- Type: string
The ID of the global network.
- State
-
- Type: string
The state of the global network.
- Tags
-
- Type: Array of Tag structures
The tags for the global network.
InternalServerException
Description
The request has failed due to an internal error.
Members
Link
Description
Describes a link.
Members
- Bandwidth
-
- Type: Bandwidth structure
The bandwidth for the link.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the link was created.
- Description
-
- Type: string
The description of the link.
- GlobalNetworkId
-
- Type: string
The ID of the global network.
- LinkArn
-
- Type: string
The Amazon Resource Name (ARN) of the link.
- LinkId
-
- Type: string
The ID of the link.
- Provider
-
- Type: string
The provider of the link.
- SiteId
-
- Type: string
The ID of the site.
- State
-
- Type: string
The state of the link.
- Tags
-
- Type: Array of Tag structures
The tags for the link.
- Type
-
- Type: string
The type of the link.
LinkAssociation
Description
Describes the association between a device and a link.
Members
Location
Description
Describes a location.
Members
ResourceNotFoundException
Description
The specified resource could not be found.
Members
ServiceQuotaExceededException
Description
A service limit was exceeded.
Members
Site
Description
Describes a site.
Members
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the site was created.
- Description
-
- Type: string
The description of the site.
- GlobalNetworkId
-
- Type: string
The ID of the global network.
- Location
-
- Type: Location structure
The location of the site.
- SiteArn
-
- Type: string
The Amazon Resource Name (ARN) of the site.
- SiteId
-
- Type: string
The ID of the site.
- State
-
- Type: string
The state of the site.
- Tags
-
- Type: Array of Tag structures
The tags for the site.
Tag
Description
Describes a tag.
Members
ThrottlingException
Description
The request was denied due to request throttling.
Members
TransitGatewayConnectPeerAssociation
Description
Describes a transit gateway Connect peer association.
Members
- DeviceId
-
- Type: string
The ID of the device.
- GlobalNetworkId
-
- Type: string
The ID of the global network.
- LinkId
-
- Type: string
The ID of the link.
- State
-
- Type: string
The state of the association.
- TransitGatewayConnectPeerArn
-
- Type: string
The Amazon Resource Name (ARN) of the transit gateway Connect peer.
TransitGatewayRegistration
Description
Describes the registration of a transit gateway to a global network.
Members
- GlobalNetworkId
-
- Type: string
The ID of the global network.
- State
-
- Type: TransitGatewayRegistrationStateReason structure
The state of the transit gateway registration.
- TransitGatewayArn
-
- Type: string
The Amazon Resource Name (ARN) of the transit gateway.
TransitGatewayRegistrationStateReason
Description
Describes the status of a transit gateway registration.
Members
ValidationException
Description
The input fails to satisfy the constraints.
Members
- Fields
-
- Type: Array of ValidationExceptionField structures
The fields that caused the error, if applicable.
- Message
-
- Required: Yes
- Type: string
- Reason
-
- Type: string
The reason for the error.