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 */).
- AcceptAttachment ( array $params = [] )
Accepts a core network attachment request.
- AssociateConnectPeer ( array $params = [] )
Associates a core network Connect peer with a device and optionally, with a link.
- 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.
- CreateConnectAttachment ( array $params = [] )
Creates a core network Connect attachment from a specified core network attachment.
- CreateConnectPeer ( array $params = [] )
Creates a core network connect peer for a specified core network connect attachment between a core network and an appliance.
- CreateConnection ( array $params = [] )
Creates a connection between two devices.
- CreateCoreNetwork ( array $params = [] )
Creates a core network as part of your global network, and optionally, with a core network policy.
- 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.
- CreateSiteToSiteVpnAttachment ( array $params = [] )
Creates a site-to-site VPN attachment on an edge location of a core network.
- CreateVpcAttachment ( array $params = [] )
Creates a VPC attachment on an edge location of a core network.
- DeleteAttachment ( array $params = [] )
Deletes an attachment.
- DeleteConnectPeer ( array $params = [] )
Deletes a Connect peer.
- DeleteConnection ( array $params = [] )
Deletes the specified connection in your global network.
- DeleteCoreNetwork ( array $params = [] )
Deletes a core network along with all core network policies.
- DeleteCoreNetworkPolicyVersion ( array $params = [] )
Deletes a policy version from a core network.
- DeleteDevice ( array $params = [] )
Deletes an existing device.
- DeleteGlobalNetwork ( array $params = [] )
Deletes an existing global network.
- DeleteLink ( array $params = [] )
Deletes an existing link.
- DeleteResourcePolicy ( array $params = [] )
Deletes a resource policy for the specified resource.
- 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.
- DisassociateConnectPeer ( array $params = [] )
Disassociates a core network Connect peer from a device and a link.
- 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.
- ExecuteCoreNetworkChangeSet ( array $params = [] )
Executes a change set on your core network.
- GetConnectAttachment ( array $params = [] )
Returns information about a core network Connect attachment.
- GetConnectPeer ( array $params = [] )
Returns information about a core network Connect peer.
- GetConnectPeerAssociations ( array $params = [] )
Returns information about a core network Connect peer associations.
- GetConnections ( array $params = [] )
Gets information about one or more of your connections in a global network.
- GetCoreNetwork ( array $params = [] )
Returns information about a core network.
- GetCoreNetworkChangeSet ( array $params = [] )
Returns a change set between the LIVE core network policy and a submitted policy.
- GetCoreNetworkPolicy ( array $params = [] )
Gets details about a core network policy.
- 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.
- GetNetworkResourceCounts ( array $params = [] )
Gets the count of network resources, by resource type, for the specified global network.
- GetNetworkResourceRelationships ( array $params = [] )
Gets the network resource relationships for the specified global network.
- GetNetworkResources ( array $params = [] )
Describes the network resources for the specified global network.
- GetNetworkRoutes ( array $params = [] )
Gets the network routes of the specified global network.
- GetNetworkTelemetry ( array $params = [] )
Gets the network telemetry of the specified global network.
- GetResourcePolicy ( array $params = [] )
Returns information about a resource policy.
- GetRouteAnalysis ( array $params = [] )
Gets information about the specified route analysis.
- GetSiteToSiteVpnAttachment ( array $params = [] )
Returns information about a site-to-site VPN attachment.
- 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.
- GetVpcAttachment ( array $params = [] )
Returns information about a VPC attachment.
- ListAttachments ( array $params = [] )
Returns a list of core network attachments.
- ListConnectPeers ( array $params = [] )
Returns a list of core network Connect peers.
- ListCoreNetworkPolicyVersions ( array $params = [] )
Returns a list of core network policy versions.
- ListCoreNetworks ( array $params = [] )
Returns a list of owned and shared core networks.
- ListTagsForResource ( array $params = [] )
Lists the tags for a specified resource.
- PutCoreNetworkPolicy ( array $params = [] )
Creates a new, immutable version of a core network policy.
- PutResourcePolicy ( array $params = [] )
Creates or updates a resource policy.
- RegisterTransitGateway ( array $params = [] )
Registers a transit gateway in your global network.
- RejectAttachment ( array $params = [] )
Rejects a core network attachment request.
- RestoreCoreNetworkPolicyVersion ( array $params = [] )
Restores a previous policy version as a new, immutable version of a core network policy.
- StartRouteAnalysis ( array $params = [] )
Starts analyzing the routing path between the specified source and destination.
- 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.
- UpdateCoreNetwork ( array $params = [] )
Updates the description of a core network.
- 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.
- UpdateNetworkResourceMetadata ( array $params = [] )
Updates the resource metadata for the specified global network.
- UpdateSite ( array $params = [] )
Updates the information for an existing site.
- UpdateVpcAttachment ( array $params = [] )
Updates a VPC attachment.
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:
- DescribeGlobalNetworks
- GetConnectPeerAssociations
- GetConnections
- GetCoreNetworkChangeSet
- GetCustomerGatewayAssociations
- GetDevices
- GetLinkAssociations
- GetLinks
- GetNetworkResourceCounts
- GetNetworkResourceRelationships
- GetNetworkResources
- GetNetworkTelemetry
- GetSites
- GetTransitGatewayConnectPeerAssociations
- GetTransitGatewayRegistrations
- ListAttachments
- ListConnectPeers
- ListCoreNetworkPolicyVersions
- ListCoreNetworks
Operations
AcceptAttachment
$result = $client->acceptAttachment([/* ... */]); $promise = $client->acceptAttachmentAsync([/* ... */]);
Accepts a core network attachment request.
Once the attachment request is accepted by a core network owner, the attachment is created and connected to a core network.
Parameter Syntax
$result = $client->acceptAttachment([
'AttachmentId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Attachment' => [
'AttachmentId' => '<string>',
'AttachmentPolicyRuleNumber' => <integer>,
'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC',
'CoreNetworkArn' => '<string>',
'CoreNetworkId' => '<string>',
'CreatedAt' => <DateTime>,
'EdgeLocation' => '<string>',
'OwnerAccountId' => '<string>',
'ProposedSegmentChange' => [
'AttachmentPolicyRuleNumber' => <integer>,
'SegmentName' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
'ResourceArn' => '<string>',
'SegmentName' => '<string>',
'State' => 'REJECTED|PENDING_ATTACHMENT_ACCEPTANCE|CREATING|FAILED|AVAILABLE|UPDATING|PENDING_NETWORK_UPDATE|PENDING_TAG_ACCEPTANCE|DELETING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'UpdatedAt' => <DateTime>,
],
]
Result Details
Members
- Attachment
-
- Type: Attachment structure
The response to the attachment request.
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.
AssociateConnectPeer
$result = $client->associateConnectPeer([/* ... */]); $promise = $client->associateConnectPeerAsync([/* ... */]);
Associates a core network 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 core network Connect peers that have been created on a core network Connect attachment on a core network.
Parameter Syntax
$result = $client->associateConnectPeer([
'ConnectPeerId' => '<string>', // REQUIRED
'DeviceId' => '<string>', // REQUIRED
'GlobalNetworkId' => '<string>', // REQUIRED
'LinkId' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'ConnectPeerAssociation' => [
'ConnectPeerId' => '<string>',
'DeviceId' => '<string>',
'GlobalNetworkId' => '<string>',
'LinkId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|DELETED',
],
]
Result Details
Members
- ConnectPeerAssociation
-
- Type: ConnectPeerAssociation structure
The response to the Connect peer request.
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.
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
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.
CreateConnectAttachment
$result = $client->createConnectAttachment([/* ... */]); $promise = $client->createConnectAttachmentAsync([/* ... */]);
Creates a core network Connect attachment from a specified core network attachment.
A core network Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a core network and an appliance. A core network Connect attachment uses an existing VPC attachment as the underlying transport mechanism.
Parameter Syntax
$result = $client->createConnectAttachment([
'ClientToken' => '<string>',
'CoreNetworkId' => '<string>', // REQUIRED
'EdgeLocation' => '<string>', // REQUIRED
'Options' => [ // REQUIRED
'Protocol' => 'GRE',
],
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'TransportAttachmentId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ClientToken
-
- Type: string
The client token associated with the request.
- CoreNetworkId
-
- Required: Yes
- Type: string
The ID of a core network where you want to create the attachment.
- EdgeLocation
-
- Required: Yes
- Type: string
The Region where the edge is located.
- Options
-
- Required: Yes
- Type: ConnectAttachmentOptions structure
Options for creating an attachment.
- Tags
-
- Type: Array of Tag structures
The list of key-value tags associated with the request.
- TransportAttachmentId
-
- Required: Yes
- Type: string
The ID of the attachment between the two connections.
Result Syntax
[
'ConnectAttachment' => [
'Attachment' => [
'AttachmentId' => '<string>',
'AttachmentPolicyRuleNumber' => <integer>,
'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC',
'CoreNetworkArn' => '<string>',
'CoreNetworkId' => '<string>',
'CreatedAt' => <DateTime>,
'EdgeLocation' => '<string>',
'OwnerAccountId' => '<string>',
'ProposedSegmentChange' => [
'AttachmentPolicyRuleNumber' => <integer>,
'SegmentName' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
'ResourceArn' => '<string>',
'SegmentName' => '<string>',
'State' => 'REJECTED|PENDING_ATTACHMENT_ACCEPTANCE|CREATING|FAILED|AVAILABLE|UPDATING|PENDING_NETWORK_UPDATE|PENDING_TAG_ACCEPTANCE|DELETING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'UpdatedAt' => <DateTime>,
],
'Options' => [
'Protocol' => 'GRE',
],
'TransportAttachmentId' => '<string>',
],
]
Result Details
Members
- ConnectAttachment
-
- Type: ConnectAttachment structure
The response to a Connect attachment request.
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.
CreateConnectPeer
$result = $client->createConnectPeer([/* ... */]); $promise = $client->createConnectPeerAsync([/* ... */]);
Creates a core network connect peer for a specified core network connect attachment between a core network and an appliance. The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).
Parameter Syntax
$result = $client->createConnectPeer([
'BgpOptions' => [
'PeerAsn' => <integer>,
],
'ClientToken' => '<string>',
'ConnectAttachmentId' => '<string>', // REQUIRED
'CoreNetworkAddress' => '<string>',
'InsideCidrBlocks' => ['<string>', ...], // REQUIRED
'PeerAddress' => '<string>', // REQUIRED
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- BgpOptions
-
- Type: BgpOptions structure
The Connect peer BGP options.
- ClientToken
-
- Type: string
The client token associated with the request.
- ConnectAttachmentId
-
- Required: Yes
- Type: string
The ID of the connection attachment.
- CoreNetworkAddress
-
- Type: string
A Connect peer core network address.
- InsideCidrBlocks
-
- Required: Yes
- Type: Array of strings
The inside IP addresses used for BGP peering.
- PeerAddress
-
- Required: Yes
- Type: string
The Connect peer address.
- Tags
-
- Type: Array of Tag structures
The tags associated with the peer request.
Result Syntax
[
'ConnectPeer' => [
'Configuration' => [
'BgpConfigurations' => [
[
'CoreNetworkAddress' => '<string>',
'CoreNetworkAsn' => <integer>,
'PeerAddress' => '<string>',
'PeerAsn' => <integer>,
],
// ...
],
'CoreNetworkAddress' => '<string>',
'InsideCidrBlocks' => ['<string>', ...],
'PeerAddress' => '<string>',
'Protocol' => 'GRE',
],
'ConnectAttachmentId' => '<string>',
'ConnectPeerId' => '<string>',
'CoreNetworkId' => '<string>',
'CreatedAt' => <DateTime>,
'EdgeLocation' => '<string>',
'State' => 'CREATING|FAILED|AVAILABLE|DELETING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
]
Result Details
Members
- ConnectPeer
-
- Type: ConnectPeer structure
The response to the request.
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.
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.
CreateCoreNetwork
$result = $client->createCoreNetwork([/* ... */]); $promise = $client->createCoreNetworkAsync([/* ... */]);
Creates a core network as part of your global network, and optionally, with a core network policy.
Parameter Syntax
$result = $client->createCoreNetwork([
'ClientToken' => '<string>',
'Description' => '<string>',
'GlobalNetworkId' => '<string>', // REQUIRED
'PolicyDocument' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- ClientToken
-
- Type: string
The client token associated with a core network request.
- Description
-
- Type: string
The description of a core network.
- GlobalNetworkId
-
- Required: Yes
- Type: string
The ID of the global network that a core network will be a part of.
- PolicyDocument
-
- Type: string
The policy document for creating a core network.
- Tags
-
- Type: Array of Tag structures
Key-value tags associated with a core network request.
Result Syntax
[
'CoreNetwork' => [
'CoreNetworkArn' => '<string>',
'CoreNetworkId' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'Edges' => [
[
'Asn' => <integer>,
'EdgeLocation' => '<string>',
'InsideCidrBlocks' => ['<string>', ...],
],
// ...
],
'GlobalNetworkId' => '<string>',
'Segments' => [
[
'EdgeLocations' => ['<string>', ...],
'Name' => '<string>',
'SharedSegments' => ['<string>', ...],
],
// ...
],
'State' => 'CREATING|UPDATING|AVAILABLE|DELETING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
]
Result Details
Members
- CoreNetwork
-
- Type: CoreNetwork structure
Returns details about a core network.
Errors
-
Describes a core network policy exception.
-
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 Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.
- Description
-
- Type: string
A description of the device.
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.
Constraints: Maximum length of 128 characters.
- SerialNumber
-
- Type: string
The serial number of the device.
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.
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.
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.
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: Maximum length of 128 characters. Cannot include the following 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: Maximum length of 128 characters. Cannot include the following 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.
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.
CreateSiteToSiteVpnAttachment
$result = $client->createSiteToSiteVpnAttachment([/* ... */]); $promise = $client->createSiteToSiteVpnAttachmentAsync([/* ... */]);
Creates a site-to-site VPN attachment on an edge location of a core network.
Parameter Syntax
$result = $client->createSiteToSiteVpnAttachment([
'ClientToken' => '<string>',
'CoreNetworkId' => '<string>', // REQUIRED
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'VpnConnectionArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ClientToken
-
- Type: string
The client token associated with the request.
- CoreNetworkId
-
- Required: Yes
- Type: string
The ID of a core network where you're creating a site-to-site VPN attachment.
- Tags
-
- Type: Array of Tag structures
The tags associated with the request.
- VpnConnectionArn
-
- Required: Yes
- Type: string
The ARN identifying the VPN attachment.
Result Syntax
[
'SiteToSiteVpnAttachment' => [
'Attachment' => [
'AttachmentId' => '<string>',
'AttachmentPolicyRuleNumber' => <integer>,
'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC',
'CoreNetworkArn' => '<string>',
'CoreNetworkId' => '<string>',
'CreatedAt' => <DateTime>,
'EdgeLocation' => '<string>',
'OwnerAccountId' => '<string>',
'ProposedSegmentChange' => [
'AttachmentPolicyRuleNumber' => <integer>,
'SegmentName' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
'ResourceArn' => '<string>',
'SegmentName' => '<string>',
'State' => 'REJECTED|PENDING_ATTACHMENT_ACCEPTANCE|CREATING|FAILED|AVAILABLE|UPDATING|PENDING_NETWORK_UPDATE|PENDING_TAG_ACCEPTANCE|DELETING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'UpdatedAt' => <DateTime>,
],
'VpnConnectionArn' => '<string>',
],
]
Result Details
Members
- SiteToSiteVpnAttachment
-
- Type: SiteToSiteVpnAttachment structure
Details about a site-to-site VPN attachment.
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.
CreateVpcAttachment
$result = $client->createVpcAttachment([/* ... */]); $promise = $client->createVpcAttachmentAsync([/* ... */]);
Creates a VPC attachment on an edge location of a core network.
Parameter Syntax
$result = $client->createVpcAttachment([
'ClientToken' => '<string>',
'CoreNetworkId' => '<string>', // REQUIRED
'Options' => [
'Ipv6Support' => true || false,
],
'SubnetArns' => ['<string>', ...], // REQUIRED
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'VpcArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ClientToken
-
- Type: string
The client token associated with the request.
- CoreNetworkId
-
- Required: Yes
- Type: string
The ID of a core network for the VPC attachment.
- Options
-
- Type: VpcOptions structure
Options for the VPC attachment.
- SubnetArns
-
- Required: Yes
- Type: Array of strings
The subnet ARN of the VPC attachment.
- Tags
-
- Type: Array of Tag structures
The key-value tags associated with the request.
- VpcArn
-
- Required: Yes
- Type: string
The ARN of the VPC.
Result Syntax
[
'VpcAttachment' => [
'Attachment' => [
'AttachmentId' => '<string>',
'AttachmentPolicyRuleNumber' => <integer>,
'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC',
'CoreNetworkArn' => '<string>',
'CoreNetworkId' => '<string>',
'CreatedAt' => <DateTime>,
'EdgeLocation' => '<string>',
'OwnerAccountId' => '<string>',
'ProposedSegmentChange' => [
'AttachmentPolicyRuleNumber' => <integer>,
'SegmentName' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
'ResourceArn' => '<string>',
'SegmentName' => '<string>',
'State' => 'REJECTED|PENDING_ATTACHMENT_ACCEPTANCE|CREATING|FAILED|AVAILABLE|UPDATING|PENDING_NETWORK_UPDATE|PENDING_TAG_ACCEPTANCE|DELETING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'UpdatedAt' => <DateTime>,
],
'Options' => [
'Ipv6Support' => true || false,
],
'SubnetArns' => ['<string>', ...],
],
]
Result Details
Members
- VpcAttachment
-
- Type: VpcAttachment structure
Provides details about the VPC attachment.
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.
DeleteAttachment
$result = $client->deleteAttachment([/* ... */]); $promise = $client->deleteAttachmentAsync([/* ... */]);
Deletes an attachment. Supports all attachment types.
Parameter Syntax
$result = $client->deleteAttachment([
'AttachmentId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Attachment' => [
'AttachmentId' => '<string>',
'AttachmentPolicyRuleNumber' => <integer>,
'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC',
'CoreNetworkArn' => '<string>',
'CoreNetworkId' => '<string>',
'CreatedAt' => <DateTime>,
'EdgeLocation' => '<string>',
'OwnerAccountId' => '<string>',
'ProposedSegmentChange' => [
'AttachmentPolicyRuleNumber' => <integer>,
'SegmentName' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
'ResourceArn' => '<string>',
'SegmentName' => '<string>',
'State' => 'REJECTED|PENDING_ATTACHMENT_ACCEPTANCE|CREATING|FAILED|AVAILABLE|UPDATING|PENDING_NETWORK_UPDATE|PENDING_TAG_ACCEPTANCE|DELETING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'UpdatedAt' => <DateTime>,
],
]
Result Details
Members
- Attachment
-
- Type: Attachment structure
Information about the deleted attachment.
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.
DeleteConnectPeer
$result = $client->deleteConnectPeer([/* ... */]); $promise = $client->deleteConnectPeerAsync([/* ... */]);
Deletes a Connect peer.
Parameter Syntax
$result = $client->deleteConnectPeer([
'ConnectPeerId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'ConnectPeer' => [
'Configuration' => [
'BgpConfigurations' => [
[
'CoreNetworkAddress' => '<string>',
'CoreNetworkAsn' => <integer>,
'PeerAddress' => '<string>',
'PeerAsn' => <integer>,
],
// ...
],
'CoreNetworkAddress' => '<string>',
'InsideCidrBlocks' => ['<string>', ...],
'PeerAddress' => '<string>',
'Protocol' => 'GRE',
],
'ConnectAttachmentId' => '<string>',
'ConnectPeerId' => '<string>',
'CoreNetworkId' => '<string>',
'CreatedAt' => <DateTime>,
'EdgeLocation' => '<string>',
'State' => 'CREATING|FAILED|AVAILABLE|DELETING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
]
Result Details
Members
- ConnectPeer
-
- Type: ConnectPeer structure
Information about the deleted Connect peer.
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.
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.
DeleteCoreNetwork
$result = $client->deleteCoreNetwork([/* ... */]); $promise = $client->deleteCoreNetworkAsync([/* ... */]);
Deletes a core network along with all core network policies. This can only be done if there are no attachments on a core network.
Parameter Syntax
$result = $client->deleteCoreNetwork([
'CoreNetworkId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'CoreNetwork' => [
'CoreNetworkArn' => '<string>',
'CoreNetworkId' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'Edges' => [
[
'Asn' => <integer>,
'EdgeLocation' => '<string>',
'InsideCidrBlocks' => ['<string>', ...],
],
// ...
],
'GlobalNetworkId' => '<string>',
'Segments' => [
[
'EdgeLocations' => ['<string>', ...],
'Name' => '<string>',
'SharedSegments' => ['<string>', ...],
],
// ...
],
'State' => 'CREATING|UPDATING|AVAILABLE|DELETING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
]
Result Details
Members
- CoreNetwork
-
- Type: CoreNetwork structure
Information about the deleted core 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.
DeleteCoreNetworkPolicyVersion
$result = $client->deleteCoreNetworkPolicyVersion([/* ... */]); $promise = $client->deleteCoreNetworkPolicyVersionAsync([/* ... */]);
Deletes a policy version from a core network. You can't delete the current LIVE policy.
Parameter Syntax
$result = $client->deleteCoreNetworkPolicyVersion([
'CoreNetworkId' => '<string>', // REQUIRED
'PolicyVersionId' => <integer>, // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'CoreNetworkPolicy' => [
'Alias' => 'LIVE|LATEST',
'ChangeSetState' => 'PENDING_GENERATION|FAILED_GENERATION|READY_TO_EXECUTE|EXECUTING|EXECUTION_SUCCEEDED|OUT_OF_DATE',
'CoreNetworkId' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'PolicyDocument' => '<string>',
'PolicyErrors' => [
[
'ErrorCode' => '<string>',
'Message' => '<string>',
'Path' => '<string>',
],
// ...
],
'PolicyVersionId' => <integer>,
],
]
Result Details
Members
- CoreNetworkPolicy
-
- Type: CoreNetworkPolicy structure
Returns information about the deleted policy version.
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.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
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.
DeleteResourcePolicy
$result = $client->deleteResourcePolicy([/* ... */]); $promise = $client->deleteResourcePolicyAsync([/* ... */]);
Deletes a resource policy for the specified resource. This revokes the access of the principals specified in the resource policy.
Parameter Syntax
$result = $client->deleteResourcePolicy([
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The input fails to satisfy the constraints.
-
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.
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.
DisassociateConnectPeer
$result = $client->disassociateConnectPeer([/* ... */]); $promise = $client->disassociateConnectPeerAsync([/* ... */]);
Disassociates a core network Connect peer from a device and a link.
Parameter Syntax
$result = $client->disassociateConnectPeer([
'ConnectPeerId' => '<string>', // REQUIRED
'GlobalNetworkId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ConnectPeerAssociation' => [
'ConnectPeerId' => '<string>',
'DeviceId' => '<string>',
'GlobalNetworkId' => '<string>',
'LinkId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|DELETED',
],
]
Result Details
Members
- ConnectPeerAssociation
-
- Type: ConnectPeerAssociation structure
Describes the 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.
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
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.
ExecuteCoreNetworkChangeSet
$result = $client->executeCoreNetworkChangeSet([/* ... */]); $promise = $client->executeCoreNetworkChangeSetAsync([/* ... */]);
Executes a change set on your core network. Deploys changes globally based on the policy submitted..
Parameter Syntax
$result = $client->executeCoreNetworkChangeSet([
'CoreNetworkId' => '<string>', // REQUIRED
'PolicyVersionId' => <integer>, // 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.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
GetConnectAttachment
$result = $client->getConnectAttachment([/* ... */]); $promise = $client->getConnectAttachmentAsync([/* ... */]);
Returns information about a core network Connect attachment.
Parameter Syntax
$result = $client->getConnectAttachment([
'AttachmentId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'ConnectAttachment' => [
'Attachment' => [
'AttachmentId' => '<string>',
'AttachmentPolicyRuleNumber' => <integer>,
'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC',
'CoreNetworkArn' => '<string>',
'CoreNetworkId' => '<string>',
'CreatedAt' => <DateTime>,
'EdgeLocation' => '<string>',
'OwnerAccountId' => '<string>',
'ProposedSegmentChange' => [
'AttachmentPolicyRuleNumber' => <integer>,
'SegmentName' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
'ResourceArn' => '<string>',
'SegmentName' => '<string>',
'State' => 'REJECTED|PENDING_ATTACHMENT_ACCEPTANCE|CREATING|FAILED|AVAILABLE|UPDATING|PENDING_NETWORK_UPDATE|PENDING_TAG_ACCEPTANCE|DELETING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'UpdatedAt' => <DateTime>,
],
'Options' => [
'Protocol' => 'GRE',
],
'TransportAttachmentId' => '<string>',
],
]
Result Details
Members
- ConnectAttachment
-
- Type: ConnectAttachment structure
Details about the Connect attachment.
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.
GetConnectPeer
$result = $client->getConnectPeer([/* ... */]); $promise = $client->getConnectPeerAsync([/* ... */]);
Returns information about a core network Connect peer.
Parameter Syntax
$result = $client->getConnectPeer([
'ConnectPeerId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'ConnectPeer' => [
'Configuration' => [
'BgpConfigurations' => [
[
'CoreNetworkAddress' => '<string>',
'CoreNetworkAsn' => <integer>,
'PeerAddress' => '<string>',
'PeerAsn' => <integer>,
],
// ...
],
'CoreNetworkAddress' => '<string>',
'InsideCidrBlocks' => ['<string>', ...],
'PeerAddress' => '<string>',
'Protocol' => 'GRE',
],
'ConnectAttachmentId' => '<string>',
'ConnectPeerId' => '<string>',
'CoreNetworkId' => '<string>',
'CreatedAt' => <DateTime>,
'EdgeLocation' => '<string>',
'State' => 'CREATING|FAILED|AVAILABLE|DELETING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
]
Result Details
Members
- ConnectPeer
-
- Type: ConnectPeer structure
Returns information about a core network Connect peer.
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.
GetConnectPeerAssociations
$result = $client->getConnectPeerAssociations([/* ... */]); $promise = $client->getConnectPeerAssociationsAsync([/* ... */]);
Returns information about a core network Connect peer associations.
Parameter Syntax
$result = $client->getConnectPeerAssociations([
'ConnectPeerIds' => ['<string>', ...],
'GlobalNetworkId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'ConnectPeerAssociations' => [
[
'ConnectPeerId' => '<string>',
'DeviceId' => '<string>',
'GlobalNetworkId' => '<string>',
'LinkId' => '<string>',
'State' => 'PENDING|AVAILABLE|DELETING|DELETED',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- ConnectPeerAssociations
-
- Type: Array of ConnectPeerAssociation structures
Displays a list of Connect peer 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.
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.
GetCoreNetwork
$result = $client->getCoreNetwork([/* ... */]); $promise = $client->getCoreNetworkAsync([/* ... */]);
Returns information about a core network. By default it returns the LIVE policy.
Parameter Syntax
$result = $client->getCoreNetwork([
'CoreNetworkId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'CoreNetwork' => [
'CoreNetworkArn' => '<string>',
'CoreNetworkId' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'Edges' => [
[
'Asn' => <integer>,
'EdgeLocation' => '<string>',
'InsideCidrBlocks' => ['<string>', ...],
],
// ...
],
'GlobalNetworkId' => '<string>',
'Segments' => [
[
'EdgeLocations' => ['<string>', ...],
'Name' => '<string>',
'SharedSegments' => ['<string>', ...],
],
// ...
],
'State' => 'CREATING|UPDATING|AVAILABLE|DELETING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
]
Result Details
Members
- CoreNetwork
-
- Type: CoreNetwork structure
Details about a core 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.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
GetCoreNetworkChangeSet
$result = $client->getCoreNetworkChangeSet([/* ... */]); $promise = $client->getCoreNetworkChangeSetAsync([/* ... */]);
Returns a change set between the LIVE core network policy and a submitted policy.
Parameter Syntax
$result = $client->getCoreNetworkChangeSet([
'CoreNetworkId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'PolicyVersionId' => <integer>, // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'CoreNetworkChanges' => [
[
'Action' => 'ADD|MODIFY|REMOVE',
'Identifier' => '<string>',
'NewValues' => [
'Asn' => <integer>,
'Cidr' => '<string>',
'DestinationIdentifier' => '<string>',
'EdgeLocations' => ['<string>', ...],
'InsideCidrBlocks' => ['<string>', ...],
'SegmentName' => '<string>',
'SharedSegments' => ['<string>', ...],
],
'PreviousValues' => [
'Asn' => <integer>,
'Cidr' => '<string>',
'DestinationIdentifier' => '<string>',
'EdgeLocations' => ['<string>', ...],
'InsideCidrBlocks' => ['<string>', ...],
'SegmentName' => '<string>',
'SharedSegments' => ['<string>', ...],
],
'Type' => 'CORE_NETWORK_SEGMENT|CORE_NETWORK_EDGE|ATTACHMENT_MAPPING|ATTACHMENT_ROUTE_PROPAGATION|ATTACHMENT_ROUTE_STATIC',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- CoreNetworkChanges
-
- Type: Array of CoreNetworkChange structures
Describes a core network changes.
- 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.
GetCoreNetworkPolicy
$result = $client->getCoreNetworkPolicy([/* ... */]); $promise = $client->getCoreNetworkPolicyAsync([/* ... */]);
Gets details about a core network policy. You can get details about your current live policy or any previous policy version.
Parameter Syntax
$result = $client->getCoreNetworkPolicy([
'Alias' => 'LIVE|LATEST',
'CoreNetworkId' => '<string>', // REQUIRED
'PolicyVersionId' => <integer>,
]);
Parameter Details
Members
Result Syntax
[
'CoreNetworkPolicy' => [
'Alias' => 'LIVE|LATEST',
'ChangeSetState' => 'PENDING_GENERATION|FAILED_GENERATION|READY_TO_EXECUTE|EXECUTING|EXECUTION_SUCCEEDED|OUT_OF_DATE',
'CoreNetworkId' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'PolicyDocument' => '<string>',
'PolicyErrors' => [
[
'ErrorCode' => '<string>',
'Message' => '<string>',
'Path' => '<string>',
],
// ...
],
'PolicyVersionId' => <integer>,
],
]
Result Details
Members
- CoreNetworkPolicy
-
- Type: CoreNetworkPolicy structure
The details about a core network policy.
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). 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.
GetNetworkResourceCounts
$result = $client->getNetworkResourceCounts([/* ... */]); $promise = $client->getNetworkResourceCountsAsync([/* ... */]);
Gets the count of network resources, by resource type, for the specified global network.
Parameter Syntax
$result = $client->getNetworkResourceCounts([
'GlobalNetworkId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'ResourceType' => '<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.
- ResourceType
-
- Type: string
The resource type.
The following are the supported resource types for Direct Connect:
-
dxcon -
dx-gateway -
dx-vif
The following are the supported resource types for Network Manager:
-
connection -
device -
link -
site
The following are the supported resource types for Amazon VPC:
-
customer-gateway -
transit-gateway -
transit-gateway-attachment -
transit-gateway-connect-peer -
transit-gateway-route-table -
vpn-connection
Result Syntax
[
'NetworkResourceCounts' => [
[
'Count' => <integer>,
'ResourceType' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- NetworkResourceCounts
-
- Type: Array of NetworkResourceCount structures
The count of resources.
- 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 request was denied due to request throttling.
-
The request has failed due to an internal error.
GetNetworkResourceRelationships
$result = $client->getNetworkResourceRelationships([/* ... */]); $promise = $client->getNetworkResourceRelationshipsAsync([/* ... */]);
Gets the network resource relationships for the specified global network.
Parameter Syntax
$result = $client->getNetworkResourceRelationships([
'AccountId' => '<string>',
'AwsRegion' => '<string>',
'CoreNetworkId' => '<string>',
'GlobalNetworkId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'RegisteredGatewayArn' => '<string>',
'ResourceArn' => '<string>',
'ResourceType' => '<string>',
]);
Parameter Details
Members
- AccountId
-
- Type: string
The Amazon Web Services account ID.
- AwsRegion
-
- Type: string
The Amazon Web Services Region.
- CoreNetworkId
-
- Type: string
The ID of a core network.
- 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.
- RegisteredGatewayArn
-
- Type: string
The ARN of the registered gateway.
- ResourceArn
-
- Type: string
The ARN of the gateway.
- ResourceType
-
- Type: string
The resource type.
The following are the supported resource types for Direct Connect:
-
dxcon -
dx-gateway -
dx-vif
The following are the supported resource types for Network Manager:
-
connection -
device -
link -
site
The following are the supported resource types for Amazon VPC:
-
customer-gateway -
transit-gateway -
transit-gateway-attachment -
transit-gateway-connect-peer -
transit-gateway-route-table -
vpn-connection
Result Syntax
[
'NextToken' => '<string>',
'Relationships' => [
[
'From' => '<string>',
'To' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token for the next page of results.
- Relationships
-
- Type: Array of Relationship structures
The resource relationships.
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.
GetNetworkResources
$result = $client->getNetworkResources([/* ... */]); $promise = $client->getNetworkResourcesAsync([/* ... */]);
Describes the network resources for the specified global network.
The results include information from the corresponding Describe call for the resource, minus any sensitive information such as pre-shared keys.
Parameter Syntax
$result = $client->getNetworkResources([
'AccountId' => '<string>',
'AwsRegion' => '<string>',
'CoreNetworkId' => '<string>',
'GlobalNetworkId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'RegisteredGatewayArn' => '<string>',
'ResourceArn' => '<string>',
'ResourceType' => '<string>',
]);
Parameter Details
Members
- AccountId
-
- Type: string
The Amazon Web Services account ID.
- AwsRegion
-
- Type: string
The Amazon Web Services Region.
- CoreNetworkId
-
- Type: string
The ID of a core network.
- 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.
- RegisteredGatewayArn
-
- Type: string
The ARN of the gateway.
- ResourceArn
-
- Type: string
The ARN of the resource.
- ResourceType
-
- Type: string
The resource type.
The following are the supported resource types for Direct Connect:
-
dxcon- The definition model is Connection. -
dx-gateway- The definition model is DirectConnectGateway. -
dx-vif- The definition model is VirtualInterface.
The following are the supported resource types for Network Manager:
-
connection- The definition model is Connection. -
device- The definition model is Device. -
link- The definition model is Link. -
site- The definition model is Site.
The following are the supported resource types for Amazon VPC:
-
customer-gateway- The definition model is CustomerGateway. -
transit-gateway- The definition model is TransitGateway. -
transit-gateway-attachment- The definition model is TransitGatewayAttachment. -
transit-gateway-connect-peer- The definition model is TransitGatewayConnectPeer. -
transit-gateway-route-table- The definition model is TransitGatewayRouteTable. -
vpn-connection- The definition model is VpnConnection.
Result Syntax
[
'NetworkResources' => [
[
'AccountId' => '<string>',
'AwsRegion' => '<string>',
'CoreNetworkId' => '<string>',
'Definition' => '<string>',
'DefinitionTimestamp' => <DateTime>,
'Metadata' => ['<string>', ...],
'RegisteredGatewayArn' => '<string>',
'ResourceArn' => '<string>',
'ResourceId' => '<string>',
'ResourceType' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- NetworkResources
-
- Type: Array of NetworkResource structures
The network resources.
- 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.
GetNetworkRoutes
$result = $client->getNetworkRoutes([/* ... */]); $promise = $client->getNetworkRoutesAsync([/* ... */]);
Gets the network routes of the specified global network.
Parameter Syntax
$result = $client->getNetworkRoutes([
'DestinationFilters' => [
'<FilterName>' => ['<string>', ...],
// ...
],
'ExactCidrMatches' => ['<string>', ...],
'GlobalNetworkId' => '<string>', // REQUIRED
'LongestPrefixMatches' => ['<string>', ...],
'PrefixListIds' => ['<string>', ...],
'RouteTableIdentifier' => [ // REQUIRED
'CoreNetworkSegmentEdge' => [
'CoreNetworkId' => '<string>',
'EdgeLocation' => '<string>',
'SegmentName' => '<string>',
],
'TransitGatewayRouteTableArn' => '<string>',
],
'States' => ['<string>', ...],
'SubnetOfMatches' => ['<string>', ...],
'SupernetOfMatches' => ['<string>', ...],
'Types' => ['<string>', ...],
]);
Parameter Details
Members
- DestinationFilters
-
- Type: Associative array of custom strings keys (FilterName) to stringss
Filter by route table destination. Possible Values: TRANSIT_GATEWAY_ATTACHMENT_ID, RESOURCE_ID, or RESOURCE_TYPE.
- ExactCidrMatches
-
- Type: Array of strings
An exact CIDR block.
- GlobalNetworkId
-
- Required: Yes
- Type: string
The ID of the global network.
- LongestPrefixMatches
-
- Type: Array of strings
The most specific route that matches the traffic (longest prefix match).
- PrefixListIds
-
- Type: Array of strings
The IDs of the prefix lists.
- RouteTableIdentifier
-
- Required: Yes
- Type: RouteTableIdentifier structure
The ID of the route table.
- States
-
- Type: Array of strings
The route states.
- SubnetOfMatches
-
- Type: Array of strings
The routes with a subnet that match the specified CIDR filter.
- SupernetOfMatches
-
- Type: Array of strings
The routes with a CIDR that encompasses the CIDR filter. Example: If you specify 10.0.1.0/30, then the result returns 10.0.1.0/29.
- Types
-
- Type: Array of strings
The route types.
Result Syntax
[
'CoreNetworkSegmentEdge' => [
'CoreNetworkId' => '<string>',
'EdgeLocation' => '<string>',
'SegmentName' => '<string>',
],
'NetworkRoutes' => [
[
'DestinationCidrBlock' => '<string>',
'Destinations' => [
[
'CoreNetworkAttachmentId' => '<string>',
'EdgeLocation' => '<string>',
'ResourceId' => '<string>',
'ResourceType' => '<string>',
'SegmentName' => '<string>',
'TransitGatewayAttachmentId' => '<string>',
],
// ...
],
'PrefixListId' => '<string>',
'State' => 'ACTIVE|BLACKHOLE',
'Type' => 'PROPAGATED|STATIC',
],
// ...
],
'RouteTableArn' => '<string>',
'RouteTableTimestamp' => <DateTime>,
'RouteTableType' => 'TRANSIT_GATEWAY_ROUTE_TABLE|CORE_NETWORK_SEGMENT',
]
Result Details
Members
- CoreNetworkSegmentEdge
-
- Type: CoreNetworkSegmentEdgeIdentifier structure
Describes a core network segment edge.
- NetworkRoutes
-
- Type: Array of NetworkRoute structures
The network routes.
- RouteTableArn
-
- Type: string
The ARN of the route table.
- RouteTableTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The route table creation time.
- RouteTableType
-
- Type: string
The route table type.
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.
GetNetworkTelemetry
$result = $client->getNetworkTelemetry([/* ... */]); $promise = $client->getNetworkTelemetryAsync([/* ... */]);
Gets the network telemetry of the specified global network.
Parameter Syntax
$result = $client->getNetworkTelemetry([
'AccountId' => '<string>',
'AwsRegion' => '<string>',
'CoreNetworkId' => '<string>',
'GlobalNetworkId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'RegisteredGatewayArn' => '<string>',
'ResourceArn' => '<string>',
'ResourceType' => '<string>',
]);
Parameter Details
Members
- AccountId
-
- Type: string
The Amazon Web Services account ID.
- AwsRegion
-
- Type: string
The Amazon Web Services Region.
- CoreNetworkId
-
- Type: string
The ID of a core network.
- 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.
- RegisteredGatewayArn
-
- Type: string
The ARN of the gateway.
- ResourceArn
-
- Type: string
The ARN of the resource.
- ResourceType
-
- Type: string
The resource type.
The following are the supported resource types for Direct Connect:
-
dxcon -
dx-gateway -
dx-vif
The following are the supported resource types for Network Manager:
-
connection -
device -
link -
site
The following are the supported resource types for Amazon VPC:
-
customer-gateway -
transit-gateway -
transit-gateway-attachment -
transit-gateway-connect-peer -
transit-gateway-route-table -
vpn-connection
Result Syntax
[
'NetworkTelemetry' => [
[
'AccountId' => '<string>',
'Address' => '<string>',
'AwsRegion' => '<string>',
'CoreNetworkId' => '<string>',
'Health' => [
'Status' => 'UP|DOWN',
'Timestamp' => <DateTime>,
'Type' => 'BGP|IPSEC',
],
'RegisteredGatewayArn' => '<string>',
'ResourceArn' => '<string>',
'ResourceId' => '<string>',
'ResourceType' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- NetworkTelemetry
-
- Type: Array of NetworkTelemetry structures
The network telemetry.
- 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.
GetResourcePolicy
$result = $client->getResourcePolicy([/* ... */]); $promise = $client->getResourcePolicyAsync([/* ... */]);
Returns information about a resource policy.
Parameter Syntax
$result = $client->getResourcePolicy([
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'PolicyDocument' => '<string>',
]
Result Details
Members
Errors
-
The input fails to satisfy the constraints.
-
You do not have sufficient access to perform this action.
-
The request was denied due to request throttling.
-
The request has failed due to an internal error.
GetRouteAnalysis
$result = $client->getRouteAnalysis([/* ... */]); $promise = $client->getRouteAnalysisAsync([/* ... */]);
Gets information about the specified route analysis.
Parameter Syntax
$result = $client->getRouteAnalysis([
'GlobalNetworkId' => '<string>', // REQUIRED
'RouteAnalysisId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'RouteAnalysis' => [
'Destination' => [
'IpAddress' => '<string>',
'TransitGatewayArn' => '<string>',
'TransitGatewayAttachmentArn' => '<string>',
],
'ForwardPath' => [
'CompletionStatus' => [
'ReasonCode' => 'TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND|TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY|CYCLIC_PATH_DETECTED|TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND|ROUTE_NOT_FOUND|BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND|INACTIVE_ROUTE_FOR_DESTINATION_FOUND|TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH|MAX_HOPS_EXCEEDED|POSSIBLE_MIDDLEBOX|NO_DESTINATION_ARN_PROVIDED',
'ReasonContext' => ['<string>', ...],
'ResultCode' => 'CONNECTED|NOT_CONNECTED',
],
'Path' => [
[
'DestinationCidrBlock' => '<string>',
'Resource' => [
'Definition' => '<string>',
'IsMiddlebox' => true || false,
'NameTag' => '<string>',
'RegisteredGatewayArn' => '<string>',
'ResourceArn' => '<string>',
'ResourceType' => '<string>',
],
'Sequence' => <integer>,
],
// ...
],
],
'GlobalNetworkId' => '<string>',
'IncludeReturnPath' => true || false,
'OwnerAccountId' => '<string>',
'ReturnPath' => [
'CompletionStatus' => [
'ReasonCode' => 'TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND|TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY|CYCLIC_PATH_DETECTED|TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND|ROUTE_NOT_FOUND|BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND|INACTIVE_ROUTE_FOR_DESTINATION_FOUND|TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH|MAX_HOPS_EXCEEDED|POSSIBLE_MIDDLEBOX|NO_DESTINATION_ARN_PROVIDED',
'ReasonContext' => ['<string>', ...],
'ResultCode' => 'CONNECTED|NOT_CONNECTED',
],
'Path' => [
[
'DestinationCidrBlock' => '<string>',
'Resource' => [
'Definition' => '<string>',
'IsMiddlebox' => true || false,
'NameTag' => '<string>',
'RegisteredGatewayArn' => '<string>',
'ResourceArn' => '<string>',
'ResourceType' => '<string>',
],
'Sequence' => <integer>,
],
// ...
],
],
'RouteAnalysisId' => '<string>',
'Source' => [
'IpAddress' => '<string>',
'TransitGatewayArn' => '<string>',
'TransitGatewayAttachmentArn' => '<string>',
],
'StartTimestamp' => <DateTime>,
'Status' => 'RUNNING|COMPLETED|FAILED',
'UseMiddleboxes' => true || false,
],
]
Result Details
Members
- RouteAnalysis
-
- Type: RouteAnalysis structure
The route analysis.
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.
GetSiteToSiteVpnAttachment
$result = $client->getSiteToSiteVpnAttachment([/* ... */]); $promise = $client->getSiteToSiteVpnAttachmentAsync([/* ... */]);
Returns information about a site-to-site VPN attachment.
Parameter Syntax
$result = $client->getSiteToSiteVpnAttachment([
'AttachmentId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'SiteToSiteVpnAttachment' => [
'Attachment' => [
'AttachmentId' => '<string>',
'AttachmentPolicyRuleNumber' => <integer>,
'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC',
'CoreNetworkArn' => '<string>',
'CoreNetworkId' => '<string>',
'CreatedAt' => <DateTime>,
'EdgeLocation' => '<string>',
'OwnerAccountId' => '<string>',
'ProposedSegmentChange' => [
'AttachmentPolicyRuleNumber' => <integer>,
'SegmentName' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
'ResourceArn' => '<string>',
'SegmentName' => '<string>',
'State' => 'REJECTED|PENDING_ATTACHMENT_ACCEPTANCE|CREATING|FAILED|AVAILABLE|UPDATING|PENDING_NETWORK_UPDATE|PENDING_TAG_ACCEPTANCE|DELETING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'UpdatedAt' => <DateTime>,
],
'VpnConnectionArn' => '<string>',
],
]
Result Details
Members
- SiteToSiteVpnAttachment
-
- Type: SiteToSiteVpnAttachment structure
Describes the site-to-site attachment.
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.
GetVpcAttachment
$result = $client->getVpcAttachment([/* ... */]); $promise = $client->getVpcAttachmentAsync([/* ... */]);
Returns information about a VPC attachment.
Parameter Syntax
$result = $client->getVpcAttachment([
'AttachmentId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'VpcAttachment' => [
'Attachment' => [
'AttachmentId' => '<string>',
'AttachmentPolicyRuleNumber' => <integer>,
'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC',
'CoreNetworkArn' => '<string>',
'CoreNetworkId' => '<string>',
'CreatedAt' => <DateTime>,
'EdgeLocation' => '<string>',
'OwnerAccountId' => '<string>',
'ProposedSegmentChange' => [
'AttachmentPolicyRuleNumber' => <integer>,
'SegmentName' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
'ResourceArn' => '<string>',
'SegmentName' => '<string>',
'State' => 'REJECTED|PENDING_ATTACHMENT_ACCEPTANCE|CREATING|FAILED|AVAILABLE|UPDATING|PENDING_NETWORK_UPDATE|PENDING_TAG_ACCEPTANCE|DELETING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'UpdatedAt' => <DateTime>,
],
'Options' => [
'Ipv6Support' => true || false,
],
'SubnetArns' => ['<string>', ...],
],
]
Result Details
Members
- VpcAttachment
-
- Type: VpcAttachment structure
Returns details about a VPC attachment.
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.
ListAttachments
$result = $client->listAttachments([/* ... */]); $promise = $client->listAttachmentsAsync([/* ... */]);
Returns a list of core network attachments.
Parameter Syntax
$result = $client->listAttachments([
'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC',
'CoreNetworkId' => '<string>',
'EdgeLocation' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
'State' => 'REJECTED|PENDING_ATTACHMENT_ACCEPTANCE|CREATING|FAILED|AVAILABLE|UPDATING|PENDING_NETWORK_UPDATE|PENDING_TAG_ACCEPTANCE|DELETING',
]);
Parameter Details
Members
- AttachmentType
-
- Type: string
The type of attachment.
- CoreNetworkId
-
- Type: string
The ID of a core network.
- EdgeLocation
-
- Type: string
The Region where the edge is located.
- MaxResults
-
- Type: int
The maximum number of results to return.
- NextToken
-
- Type: string
The token for the next page of results.
- State
-
- Type: string
The state of the attachment.
Result Syntax
[
'Attachments' => [
[
'AttachmentId' => '<string>',
'AttachmentPolicyRuleNumber' => <integer>,
'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC',
'CoreNetworkArn' => '<string>',
'CoreNetworkId' => '<string>',
'CreatedAt' => <DateTime>,
'EdgeLocation' => '<string>',
'OwnerAccountId' => '<string>',
'ProposedSegmentChange' => [
'AttachmentPolicyRuleNumber' => <integer>,
'SegmentName' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
'ResourceArn' => '<string>',
'SegmentName' => '<string>',
'State' => 'REJECTED|PENDING_ATTACHMENT_ACCEPTANCE|CREATING|FAILED|AVAILABLE|UPDATING|PENDING_NETWORK_UPDATE|PENDING_TAG_ACCEPTANCE|DELETING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'UpdatedAt' => <DateTime>,
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Attachments
-
- Type: Array of Attachment structures
Describes the list of attachments.
- 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 request was denied due to request throttling.
-
The request has failed due to an internal error.
ListConnectPeers
$result = $client->listConnectPeers([/* ... */]); $promise = $client->listConnectPeersAsync([/* ... */]);
Returns a list of core network Connect peers.
Parameter Syntax
$result = $client->listConnectPeers([
'ConnectAttachmentId' => '<string>',
'CoreNetworkId' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'ConnectPeers' => [
[
'ConnectAttachmentId' => '<string>',
'ConnectPeerId' => '<string>',
'ConnectPeerState' => 'CREATING|FAILED|AVAILABLE|DELETING',
'CoreNetworkId' => '<string>',
'CreatedAt' => <DateTime>,
'EdgeLocation' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- ConnectPeers
-
- Type: Array of ConnectPeerSummary structures
Describes the Connect peers.
- 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 request was denied due to request throttling.
-
The request has failed due to an internal error.
ListCoreNetworkPolicyVersions
$result = $client->listCoreNetworkPolicyVersions([/* ... */]); $promise = $client->listCoreNetworkPolicyVersionsAsync([/* ... */]);
Returns a list of core network policy versions.
Parameter Syntax
$result = $client->listCoreNetworkPolicyVersions([
'CoreNetworkId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'CoreNetworkPolicyVersions' => [
[
'Alias' => 'LIVE|LATEST',
'ChangeSetState' => 'PENDING_GENERATION|FAILED_GENERATION|READY_TO_EXECUTE|EXECUTING|EXECUTION_SUCCEEDED|OUT_OF_DATE',
'CoreNetworkId' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'PolicyVersionId' => <integer>,
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- CoreNetworkPolicyVersions
-
- Type: Array of CoreNetworkPolicyVersion structures
Describes core network policy versions.
- 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.
ListCoreNetworks
$result = $client->listCoreNetworks([/* ... */]); $promise = $client->listCoreNetworksAsync([/* ... */]);
Returns a list of owned and shared core networks.
Parameter Syntax
$result = $client->listCoreNetworks([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'CoreNetworks' => [
[
'CoreNetworkArn' => '<string>',
'CoreNetworkId' => '<string>',
'Description' => '<string>',
'GlobalNetworkId' => '<string>',
'OwnerAccountId' => '<string>',
'State' => 'CREATING|UPDATING|AVAILABLE|DELETING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- CoreNetworks
-
- Type: Array of CoreNetworkSummary structures
Describes the list of core 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 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.
PutCoreNetworkPolicy
$result = $client->putCoreNetworkPolicy([/* ... */]); $promise = $client->putCoreNetworkPolicyAsync([/* ... */]);
Creates a new, immutable version of a core network policy. A subsequent change set is created showing the differences between the LIVE policy and the submitted policy.
Parameter Syntax
$result = $client->putCoreNetworkPolicy([
'ClientToken' => '<string>',
'CoreNetworkId' => '<string>', // REQUIRED
'Description' => '<string>',
'LatestVersionId' => <integer>,
'PolicyDocument' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ClientToken
-
- Type: string
The client token associated with the request.
- CoreNetworkId
-
- Required: Yes
- Type: string
The ID of a core network.
- Description
-
- Type: string
a core network policy description.
- LatestVersionId
-
- Type: int
The ID of a core network policy.
- PolicyDocument
-
- Required: Yes
- Type: string (string|number|array|map or anything parsable by json_encode)
The policy document.
Result Syntax
[
'CoreNetworkPolicy' => [
'Alias' => 'LIVE|LATEST',
'ChangeSetState' => 'PENDING_GENERATION|FAILED_GENERATION|READY_TO_EXECUTE|EXECUTING|EXECUTION_SUCCEEDED|OUT_OF_DATE',
'CoreNetworkId' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'PolicyDocument' => '<string>',
'PolicyErrors' => [
[
'ErrorCode' => '<string>',
'Message' => '<string>',
'Path' => '<string>',
],
// ...
],
'PolicyVersionId' => <integer>,
],
]
Result Details
Members
- CoreNetworkPolicy
-
- Type: CoreNetworkPolicy structure
Describes the changed core network policy.
Errors
-
Describes a core network policy exception.
-
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.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
PutResourcePolicy
$result = $client->putResourcePolicy([/* ... */]); $promise = $client->putResourcePolicyAsync([/* ... */]);
Creates or updates a resource policy.
Parameter Syntax
$result = $client->putResourcePolicy([
'PolicyDocument' => '<string>', // REQUIRED
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
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.
-
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.
RegisterTransitGateway
$result = $client->registerTransitGateway([/* ... */]); $promise = $client->registerTransitGatewayAsync([/* ... */]);
Registers a transit gateway in your global network. The transit gateway can be in any Amazon Web Services Region, but it must be owned by the same Amazon Web Services 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
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.
RejectAttachment
$result = $client->rejectAttachment([/* ... */]); $promise = $client->rejectAttachmentAsync([/* ... */]);
Rejects a core network attachment request.
Parameter Syntax
$result = $client->rejectAttachment([
'AttachmentId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Attachment' => [
'AttachmentId' => '<string>',
'AttachmentPolicyRuleNumber' => <integer>,
'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC',
'CoreNetworkArn' => '<string>',
'CoreNetworkId' => '<string>',
'CreatedAt' => <DateTime>,
'EdgeLocation' => '<string>',
'OwnerAccountId' => '<string>',
'ProposedSegmentChange' => [
'AttachmentPolicyRuleNumber' => <integer>,
'SegmentName' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
'ResourceArn' => '<string>',
'SegmentName' => '<string>',
'State' => 'REJECTED|PENDING_ATTACHMENT_ACCEPTANCE|CREATING|FAILED|AVAILABLE|UPDATING|PENDING_NETWORK_UPDATE|PENDING_TAG_ACCEPTANCE|DELETING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'UpdatedAt' => <DateTime>,
],
]
Result Details
Members
- Attachment
-
- Type: Attachment structure
Describes the rejected attachment request.
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.
RestoreCoreNetworkPolicyVersion
$result = $client->restoreCoreNetworkPolicyVersion([/* ... */]); $promise = $client->restoreCoreNetworkPolicyVersionAsync([/* ... */]);
Restores a previous policy version as a new, immutable version of a core network policy. A subsequent change set is created showing the differences between the LIVE policy and restored policy.
Parameter Syntax
$result = $client->restoreCoreNetworkPolicyVersion([
'CoreNetworkId' => '<string>', // REQUIRED
'PolicyVersionId' => <integer>, // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'CoreNetworkPolicy' => [
'Alias' => 'LIVE|LATEST',
'ChangeSetState' => 'PENDING_GENERATION|FAILED_GENERATION|READY_TO_EXECUTE|EXECUTING|EXECUTION_SUCCEEDED|OUT_OF_DATE',
'CoreNetworkId' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'PolicyDocument' => '<string>',
'PolicyErrors' => [
[
'ErrorCode' => '<string>',
'Message' => '<string>',
'Path' => '<string>',
],
// ...
],
'PolicyVersionId' => <integer>,
],
]
Result Details
Members
- CoreNetworkPolicy
-
- Type: CoreNetworkPolicy structure
Describes the restored core network policy.
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.
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
StartRouteAnalysis
$result = $client->startRouteAnalysis([/* ... */]); $promise = $client->startRouteAnalysisAsync([/* ... */]);
Starts analyzing the routing path between the specified source and destination. For more information, see Route Analyzer.
Parameter Syntax
$result = $client->startRouteAnalysis([
'Destination' => [ // REQUIRED
'IpAddress' => '<string>',
'TransitGatewayAttachmentArn' => '<string>',
],
'GlobalNetworkId' => '<string>', // REQUIRED
'IncludeReturnPath' => true || false,
'Source' => [ // REQUIRED
'IpAddress' => '<string>',
'TransitGatewayAttachmentArn' => '<string>',
],
'UseMiddleboxes' => true || false,
]);
Parameter Details
Members
- Destination
-
- Required: Yes
- Type: RouteAnalysisEndpointOptionsSpecification structure
The destination.
- GlobalNetworkId
-
- Required: Yes
- Type: string
The ID of the global network.
- IncludeReturnPath
-
- Type: boolean
Indicates whether to analyze the return path. The default is
false. - Source
-
- Required: Yes
- Type: RouteAnalysisEndpointOptionsSpecification structure
The source from which traffic originates.
- UseMiddleboxes
-
- Type: boolean
Indicates whether to include the location of middlebox appliances in the route analysis. The default is
false.
Result Syntax
[
'RouteAnalysis' => [
'Destination' => [
'IpAddress' => '<string>',
'TransitGatewayArn' => '<string>',
'TransitGatewayAttachmentArn' => '<string>',
],
'ForwardPath' => [
'CompletionStatus' => [
'ReasonCode' => 'TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND|TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY|CYCLIC_PATH_DETECTED|TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND|ROUTE_NOT_FOUND|BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND|INACTIVE_ROUTE_FOR_DESTINATION_FOUND|TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH|MAX_HOPS_EXCEEDED|POSSIBLE_MIDDLEBOX|NO_DESTINATION_ARN_PROVIDED',
'ReasonContext' => ['<string>', ...],
'ResultCode' => 'CONNECTED|NOT_CONNECTED',
],
'Path' => [
[
'DestinationCidrBlock' => '<string>',
'Resource' => [
'Definition' => '<string>',
'IsMiddlebox' => true || false,
'NameTag' => '<string>',
'RegisteredGatewayArn' => '<string>',
'ResourceArn' => '<string>',
'ResourceType' => '<string>',
],
'Sequence' => <integer>,
],
// ...
],
],
'GlobalNetworkId' => '<string>',
'IncludeReturnPath' => true || false,
'OwnerAccountId' => '<string>',
'ReturnPath' => [
'CompletionStatus' => [
'ReasonCode' => 'TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND|TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY|CYCLIC_PATH_DETECTED|TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND|ROUTE_NOT_FOUND|BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND|INACTIVE_ROUTE_FOR_DESTINATION_FOUND|TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH|MAX_HOPS_EXCEEDED|POSSIBLE_MIDDLEBOX|NO_DESTINATION_ARN_PROVIDED',
'ReasonContext' => ['<string>', ...],
'ResultCode' => 'CONNECTED|NOT_CONNECTED',
],
'Path' => [
[
'DestinationCidrBlock' => '<string>',
'Resource' => [
'Definition' => '<string>',
'IsMiddlebox' => true || false,
'NameTag' => '<string>',
'RegisteredGatewayArn' => '<string>',
'ResourceArn' => '<string>',
'ResourceType' => '<string>',
],
'Sequence' => <integer>,
],
// ...
],
],
'RouteAnalysisId' => '<string>',
'Source' => [
'IpAddress' => '<string>',
'TransitGatewayArn' => '<string>',
'TransitGatewayAttachmentArn' => '<string>',
],
'StartTimestamp' => <DateTime>,
'Status' => 'RUNNING|COMPLETED|FAILED',
'UseMiddleboxes' => true || false,
],
]
Result Details
Members
- RouteAnalysis
-
- Type: RouteAnalysis structure
The route analysis.
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.
UpdateCoreNetwork
$result = $client->updateCoreNetwork([/* ... */]); $promise = $client->updateCoreNetworkAsync([/* ... */]);
Updates the description of a core network.
Parameter Syntax
$result = $client->updateCoreNetwork([
'CoreNetworkId' => '<string>', // REQUIRED
'Description' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'CoreNetwork' => [
'CoreNetworkArn' => '<string>',
'CoreNetworkId' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'Edges' => [
[
'Asn' => <integer>,
'EdgeLocation' => '<string>',
'InsideCidrBlocks' => ['<string>', ...],
],
// ...
],
'GlobalNetworkId' => '<string>',
'Segments' => [
[
'EdgeLocations' => ['<string>', ...],
'Name' => '<string>',
'SharedSegments' => ['<string>', ...],
],
// ...
],
'State' => 'CREATING|UPDATING|AVAILABLE|DELETING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
]
Result Details
Members
- CoreNetwork
-
- Type: CoreNetwork structure
Returns information about a core network update.
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 Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.
- Description
-
- Type: string
A description of the device.
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.
Constraints: Maximum length of 128 characters.
- SerialNumber
-
- Type: string
The serial number of the device.
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.
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.
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.
Constraints: Maximum length of 128 characters.
- Type
-
- Type: string
The type of the link.
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.
UpdateNetworkResourceMetadata
$result = $client->updateNetworkResourceMetadata([/* ... */]); $promise = $client->updateNetworkResourceMetadataAsync([/* ... */]);
Updates the resource metadata for the specified global network.
Parameter Syntax
$result = $client->updateNetworkResourceMetadata([
'GlobalNetworkId' => '<string>', // REQUIRED
'Metadata' => ['<string>', ...], // REQUIRED
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Metadata' => ['<string>', ...],
'ResourceArn' => '<string>',
]
Result Details
Members
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.
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.
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.
UpdateVpcAttachment
$result = $client->updateVpcAttachment([/* ... */]); $promise = $client->updateVpcAttachmentAsync([/* ... */]);
Updates a VPC attachment.
Parameter Syntax
$result = $client->updateVpcAttachment([
'AddSubnetArns' => ['<string>', ...],
'AttachmentId' => '<string>', // REQUIRED
'Options' => [
'Ipv6Support' => true || false,
],
'RemoveSubnetArns' => ['<string>', ...],
]);
Parameter Details
Members
- AddSubnetArns
-
- Type: Array of strings
Adds a subnet ARN to the VPC attachment.
- AttachmentId
-
- Required: Yes
- Type: string
The ID of the attachment.
- Options
-
- Type: VpcOptions structure
Additional options for updating the VPC attachment.
- RemoveSubnetArns
-
- Type: Array of strings
Removes a subnet ARN from the attachment.
Result Syntax
[
'VpcAttachment' => [
'Attachment' => [
'AttachmentId' => '<string>',
'AttachmentPolicyRuleNumber' => <integer>,
'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC',
'CoreNetworkArn' => '<string>',
'CoreNetworkId' => '<string>',
'CreatedAt' => <DateTime>,
'EdgeLocation' => '<string>',
'OwnerAccountId' => '<string>',
'ProposedSegmentChange' => [
'AttachmentPolicyRuleNumber' => <integer>,
'SegmentName' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
'ResourceArn' => '<string>',
'SegmentName' => '<string>',
'State' => 'REJECTED|PENDING_ATTACHMENT_ACCEPTANCE|CREATING|FAILED|AVAILABLE|UPDATING|PENDING_NETWORK_UPDATE|PENDING_TAG_ACCEPTANCE|DELETING',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'UpdatedAt' => <DateTime>,
],
'Options' => [
'Ipv6Support' => true || false,
],
'SubnetArns' => ['<string>', ...],
],
]
Result Details
Members
- VpcAttachment
-
- Type: VpcAttachment structure
Describes the updated VPC attachment.
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 Amazon Web Services.
Members
AccessDeniedException
Description
You do not have sufficient access to perform this action.
Members
Attachment
Description
Describes a core network attachment.
Members
- AttachmentId
-
- Type: string
The ID of the attachment.
- AttachmentPolicyRuleNumber
-
- Type: int
The policy rule number associated with the attachment.
- AttachmentType
-
- Type: string
The type of attachment.
- CoreNetworkArn
-
- Type: string
The ARN of a core network.
- CoreNetworkId
-
- Type: string
A core network ID.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the attachment was created.
- EdgeLocation
-
- Type: string
The Region where the edge is located.
- OwnerAccountId
-
- Type: string
The ID of the attachment account owner.
- ProposedSegmentChange
-
- Type: ProposedSegmentChange structure
The attachment to move from one segment to another.
- ResourceArn
-
- Type: string
The attachment resource ARN.
- SegmentName
-
- Type: string
The name of the segment attachment.
- State
-
- Type: string
The state of the attachment.
- Tags
-
- Type: Array of Tag structures
The tags associated with the attachment.
- UpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the attachment was last updated.
Bandwidth
Description
Describes bandwidth information.
Members
BgpOptions
Description
Describes the BGP options.
Members
ConflictException
Description
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
Members
ConnectAttachment
Description
Describes a core network Connect attachment.
Members
- Attachment
-
- Type: Attachment structure
The attachment details.
- Options
-
- Type: ConnectAttachmentOptions structure
Options for connecting an attachment.
- TransportAttachmentId
-
- Type: string
The ID of the transport attachment.
ConnectAttachmentOptions
Description
Describes a core network Connect attachment options.
Members
ConnectPeer
Description
Describes a core network Connect peer.
Members
- Configuration
-
- Type: ConnectPeerConfiguration structure
The configuration of the Connect peer.
- ConnectAttachmentId
-
- Type: string
The ID of the attachment to connect.
- ConnectPeerId
-
- Type: string
The ID of the Connect peer.
- CoreNetworkId
-
- Type: string
The ID of a core network.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the Connect peer was created.
- EdgeLocation
-
- Type: string
The Connect peer Regions where edges are located.
- State
-
- Type: string
The state of the Connect peer.
- Tags
-
- Type: Array of Tag structures
The tags associated with the Connect peer.
ConnectPeerAssociation
Description
Describes a core network Connect peer association.
Members
ConnectPeerBgpConfiguration
Description
Describes a core network BGP configuration.
Members
ConnectPeerConfiguration
Description
Describes a core network Connect peer configuration.
Members
- BgpConfigurations
-
- Type: Array of ConnectPeerBgpConfiguration structures
The Connect peer BGP configurations.
- CoreNetworkAddress
-
- Type: string
The IP address of a core network.
- InsideCidrBlocks
-
- Type: Array of strings
The inside IP addresses used for a Connect peer configuration.
- PeerAddress
-
- Type: string
The IP address of the Connect peer.
- Protocol
-
- Type: string
The protocol used for a Connect peer configuration.
ConnectPeerSummary
Description
Summary description of a Connect peer.
Members
- ConnectAttachmentId
-
- Type: string
The ID of a Connect peer attachment.
- ConnectPeerId
-
- Type: string
The ID of a Connect peer.
- ConnectPeerState
-
- Type: string
The state of a Connect peer.
- CoreNetworkId
-
- Type: string
The ID of a core network.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when a Connect peer was created.
- EdgeLocation
-
- Type: string
The Region where the edge is located.
- Tags
-
- Type: Array of Tag structures
The tags associated with a Connect peer summary.
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.
ConnectionHealth
Description
Describes connection health.
Members
CoreNetwork
Description
Describes a core network.
Members
- CoreNetworkArn
-
- Type: string
The ARN of a core network.
- CoreNetworkId
-
- Type: string
The ID of a core network.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when a core network was created.
- Description
-
- Type: string
The description of a core network.
- Edges
-
- Type: Array of CoreNetworkEdge structures
The edges within a core network.
- GlobalNetworkId
-
- Type: string
The ID of the global network that your core network is a part of.
- Segments
-
- Type: Array of CoreNetworkSegment structures
The segments within a core network.
- State
-
- Type: string
The current state of a core network.
- Tags
-
- Type: Array of Tag structures
The tags associated with a core network.
CoreNetworkChange
Description
Details describing a core network change.
Members
- Action
-
- Type: string
The action to take for a core network.
- Identifier
-
- Type: string
The resource identifier.
- NewValues
-
- Type: CoreNetworkChangeValues structure
The new value for a core network
- PreviousValues
-
- Type: CoreNetworkChangeValues structure
The previous values for a core network.
- Type
-
- Type: string
The type of change.
CoreNetworkChangeValues
Description
Describes a core network change.
Members
- Asn
-
- Type: long (int|float)
The ASN of a core network.
- Cidr
-
- Type: string
The IP addresses used for a core network.
- DestinationIdentifier
-
- Type: string
The ID of the destination.
- EdgeLocations
-
- Type: Array of strings
The Regions where edges are located in a core network.
- InsideCidrBlocks
-
- Type: Array of strings
The inside IP addresses used for core network change values.
- SegmentName
-
- Type: string
The names of the segments in a core network.
- SharedSegments
-
- Type: Array of strings
The shared segments for a core network change value.
CoreNetworkEdge
Description
Describes a core network edge.
Members
CoreNetworkPolicy
Description
Describes a core network policy. You can have only one LIVE Core Policy.
Members
- Alias
-
- Type: string
Whether a core network policy is the current LIVE policy or the most recently submitted policy.
- ChangeSetState
-
- Type: string
The state of a core network policy.
- CoreNetworkId
-
- Type: string
The ID of a core network.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when a core network policy was created.
- Description
-
- Type: string
The description of a core network policy.
- PolicyDocument
-
- Type: string (string|number|array|map or anything parsable by json_encode)
Describes a core network policy.
- PolicyErrors
-
- Type: Array of CoreNetworkPolicyError structures
Describes any errors in a core network policy.
- PolicyVersionId
-
- Type: int
The ID of the policy version.
CoreNetworkPolicyError
Description
Provides details about an error in a core network policy.
Members
CoreNetworkPolicyException
Description
Describes a core network policy exception.
Members
- Errors
-
- Type: Array of CoreNetworkPolicyError structures
Describes a core network policy exception.
- Message
-
- Required: Yes
- Type: string
CoreNetworkPolicyVersion
Description
Describes a core network policy version.
Members
- Alias
-
- Type: string
Whether a core network policy is the current policy or the most recently submitted policy.
- ChangeSetState
-
- Type: string
The status of the policy version change set.
- CoreNetworkId
-
- Type: string
The ID of a core network.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when a core network policy version was created.
- Description
-
- Type: string
The description of a core network policy version.
- PolicyVersionId
-
- Type: int
The ID of the policy version.
CoreNetworkSegment
Description
Describes a core network segment, which are dedicated routes. Only attachments within this segment can communicate with each other.
Members
CoreNetworkSegmentEdgeIdentifier
Description
Returns details about a core network edge.
Members
CoreNetworkSummary
Description
Returns summary information about a core network.
Members
- CoreNetworkArn
-
- Type: string
a core network ARN.
- CoreNetworkId
-
- Type: string
The ID of a core network.
- Description
-
- Type: string
The description of a core network.
- GlobalNetworkId
-
- Type: string
The global network ID.
- OwnerAccountId
-
- Type: string
The ID of the account owner.
- State
-
- Type: string
The state of a core network.
- Tags
-
- Type: Array of Tag structures
The key-value tags associated with a core network summary.
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 Amazon Web Services 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. This is a single private network acting as a high-level container for your network objects, including an Amazon Web Services-manged Core 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
NetworkResource
Description
Describes a network resource.
Members
- AccountId
-
- Type: string
The Amazon Web Services account ID.
- AwsRegion
-
- Type: string
The Amazon Web Services Region.
- CoreNetworkId
-
- Type: string
a core network ID.
- Definition
-
- Type: string
Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.
- DefinitionTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the resource definition was retrieved.
- Metadata
-
- Type: Associative array of custom strings keys (ConstrainedString) to strings
The resource metadata.
- RegisteredGatewayArn
-
- Type: string
The ARN of the gateway.
- ResourceArn
-
- Type: string
The ARN of the resource.
- ResourceId
-
- Type: string
The ID of the resource.
- ResourceType
-
- Type: string
The resource type.
The following are the supported resource types for Direct Connect:
-
dxcon -
dx-gateway -
dx-vif
The following are the supported resource types for Network Manager:
-
connection -
device -
link -
site
The following are the supported resource types for Amazon VPC:
-
customer-gateway -
transit-gateway -
transit-gateway-attachment -
transit-gateway-connect-peer -
transit-gateway-route-table -
vpn-connection
- Tags
-
- Type: Array of Tag structures
The tags.
NetworkResourceCount
Description
Describes a resource count.
Members
NetworkResourceSummary
Description
Describes a network resource.
Members
- Definition
-
- Type: string
Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.
- IsMiddlebox
-
- Type: boolean
Indicates whether this is a middlebox appliance.
- NameTag
-
- Type: string
The value for the Name tag.
- RegisteredGatewayArn
-
- Type: string
The ARN of the gateway.
- ResourceArn
-
- Type: string
The ARN of the resource.
- ResourceType
-
- Type: string
The resource type.
NetworkRoute
Description
Describes a network route.
Members
- DestinationCidrBlock
-
- Type: string
A unique identifier for the route, such as a CIDR block.
- Destinations
-
- Type: Array of NetworkRouteDestination structures
The destinations.
- PrefixListId
-
- Type: string
The ID of the prefix list.
- State
-
- Type: string
The route state. The possible values are
activeandblackhole. - Type
-
- Type: string
The route type. The possible values are
propagatedandstatic.
NetworkRouteDestination
Description
Describes the destination of a network route.
Members
- CoreNetworkAttachmentId
-
- Type: string
The ID of a core network attachment.
- EdgeLocation
-
- Type: string
The edge location for the network destination.
- ResourceId
-
- Type: string
The ID of the resource.
- ResourceType
-
- Type: string
The resource type.
- SegmentName
-
- Type: string
The name of the segment.
- TransitGatewayAttachmentId
-
- Type: string
The ID of the transit gateway attachment.
NetworkTelemetry
Description
Describes the telemetry information for a resource.
Members
- AccountId
-
- Type: string
The Amazon Web Services account ID.
- Address
-
- Type: string
The address.
- AwsRegion
-
- Type: string
The Amazon Web Services Region.
- CoreNetworkId
-
- Type: string
The ID of a core network.
- Health
-
- Type: ConnectionHealth structure
The connection health.
- RegisteredGatewayArn
-
- Type: string
The ARN of the gateway.
- ResourceArn
-
- Type: string
The ARN of the resource.
- ResourceId
-
- Type: string
The ID of the resource.
- ResourceType
-
- Type: string
The resource type.
PathComponent
Description
Describes a path component.
Members
- DestinationCidrBlock
-
- Type: string
The destination CIDR block in the route table.
- Resource
-
- Type: NetworkResourceSummary structure
The resource.
- Sequence
-
- Type: int
The sequence number in the path. The destination is 0.
ProposedSegmentChange
Description
Describes a proposed segment change. In some cases, the segment change must first be evaluated and accepted.
Members
- AttachmentPolicyRuleNumber
-
- Type: int
The rule number in the policy document that applies to this change.
- SegmentName
-
- Type: string
The name of the segment to change.
- Tags
-
- Type: Array of Tag structures
The key-value tags that changed for the segment.
Relationship
Description
Describes a resource relationship.
Members
ResourceNotFoundException
Description
The specified resource could not be found.
Members
RouteAnalysis
Description
Describes a route analysis.
Members
- Destination
-
- Type: RouteAnalysisEndpointOptions structure
The destination.
- ForwardPath
-
- Type: RouteAnalysisPath structure
The forward path.
- GlobalNetworkId
-
- Type: string
The ID of the global network.
- IncludeReturnPath
-
- Type: boolean
Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.
- OwnerAccountId
-
- Type: string
The ID of the AWS account that created the route analysis.
- ReturnPath
-
- Type: RouteAnalysisPath structure
The return path.
- RouteAnalysisId
-
- Type: string
The ID of the route analysis.
- Source
-
- Type: RouteAnalysisEndpointOptions structure
The source.
- StartTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the analysis started.
- Status
-
- Type: string
The status of the route analysis.
- UseMiddleboxes
-
- Type: boolean
Indicates whether to include the location of middlebox appliances in the route analysis.
RouteAnalysisCompletion
Description
Describes the status of an analysis at completion.
Members
- ReasonCode
-
- Type: string
The reason code. Available only if a connection is not found.
-
BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND- Found a black hole route with the destination CIDR block. -
CYCLIC_PATH_DETECTED- Found the same resource multiple times while traversing the path. -
INACTIVE_ROUTE_FOR_DESTINATION_FOUND- Found an inactive route with the destination CIDR block. -
MAX_HOPS_EXCEEDED- Analysis exceeded 64 hops without finding the destination. -
ROUTE_NOT_FOUND- Cannot find a route table with the destination CIDR block. -
TGW_ATTACH_ARN_NO_MATCH- Found an attachment, but not with the correct destination ARN. -
TGW_ATTACH_NOT_FOUND- Cannot find an attachment. -
TGW_ATTACH_NOT_IN_TGW- Found an attachment, but not to the correct transit gateway. -
TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND- The state of the route table association is not associated.
- ReasonContext
-
- Type: Associative array of custom strings keys (ReasonContextKey) to strings
Additional information about the path. Available only if a connection is not found.
- ResultCode
-
- Type: string
The result of the analysis. If the status is
NOT_CONNECTED, check the reason code.
RouteAnalysisEndpointOptions
Description
Describes a source or a destination.
Members
RouteAnalysisEndpointOptionsSpecification
Description
Describes a source or a destination.
Members
RouteAnalysisPath
Description
Describes a route analysis path.
Members
- CompletionStatus
-
- Type: RouteAnalysisCompletion structure
The status of the analysis at completion.
- Path
-
- Type: Array of PathComponent structures
The route analysis path.
RouteTableIdentifier
Description
Describes a route table.
Members
- CoreNetworkSegmentEdge
-
- Type: CoreNetworkSegmentEdgeIdentifier structure
The segment edge in a core network.
- TransitGatewayRouteTableArn
-
- Type: string
The ARN of the transit gateway route table.
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.
SiteToSiteVpnAttachment
Description
Creates a site-to-site VPN attachment.
Members
- Attachment
-
- Type: Attachment structure
Provides details about a site-to-site VPN attachment.
- VpnConnectionArn
-
- Type: string
The ARN of the site-to-site VPN attachment.
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.
ValidationExceptionField
Description
Describes a validation exception for a field.
Members
VpcAttachment
Description
Describes a VPC attachment.
Members
- Attachment
-
- Type: Attachment structure
Provides details about the VPC attachment.
- Options
-
- Type: VpcOptions structure
Provides details about the VPC attachment.
- SubnetArns
-
- Type: Array of strings
The subnet ARNs.