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|TRANSIT_GATEWAY_ROUTE_TABLE',
        'CoreNetworkArn' => '<string>',
        'CoreNetworkId' => '<string>',
        'CreatedAt' => <DateTime>,
        'EdgeLocation' => '<string>',
        'LastModificationErrors' => [
            [
                'Code' => 'VPC_NOT_FOUND|SUBNET_NOT_FOUND|SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE|SUBNET_NO_FREE_ADDRESSES|SUBNET_UNSUPPORTED_AVAILABILITY_ZONE|SUBNET_NO_IPV6_CIDRS|VPN_CONNECTION_NOT_FOUND|MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
                'Message' => '<string>',
                'RequestId' => '<string>',
                'ResourceArn' => '<string>',
            ],
            // ...
        ],
        'NetworkFunctionGroupName' => '<string>',
        'OwnerAccountId' => '<string>',
        'ProposedNetworkFunctionGroupChange' => [
            'AttachmentPolicyRuleNumber' => <integer>,
            'NetworkFunctionGroupName' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<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

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

Result Syntax

[
    'ConnectPeerAssociation' => [
        'ConnectPeerId' => '<string>',
        'DeviceId' => '<string>',
        'GlobalNetworkId' => '<string>',
        'LinkId' => '<string>',
        'State' => 'PENDING|AVAILABLE|DELETING|DELETED',
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

ServiceQuotaExceededException:

A service limit was exceeded.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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 or core network registered in your global network. When you register a transit gateway or core network, 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

Result Syntax

[
    'CustomerGatewayAssociation' => [
        'CustomerGatewayArn' => '<string>',
        'DeviceId' => '<string>',
        'GlobalNetworkId' => '<string>',
        'LinkId' => '<string>',
        'State' => 'PENDING|AVAILABLE|DELETING|DELETED',
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

ServiceQuotaExceededException:

A service limit was exceeded.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

Result Syntax

[
    'LinkAssociation' => [
        'DeviceId' => '<string>',
        'GlobalNetworkId' => '<string>',
        'LinkAssociationState' => 'PENDING|AVAILABLE|DELETING|DELETED',
        'LinkId' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

ServiceQuotaExceededException:

A service limit was exceeded.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

Result Syntax

[
    'TransitGatewayConnectPeerAssociation' => [
        'DeviceId' => '<string>',
        'GlobalNetworkId' => '<string>',
        'LinkId' => '<string>',
        'State' => 'PENDING|AVAILABLE|DELETING|DELETED',
        'TransitGatewayConnectPeerArn' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

ServiceQuotaExceededException:

A service limit was exceeded.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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|NO_ENCAP',
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TransportAttachmentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ConnectAttachment' => [
        'Attachment' => [
            'AttachmentId' => '<string>',
            'AttachmentPolicyRuleNumber' => <integer>,
            'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC|TRANSIT_GATEWAY_ROUTE_TABLE',
            'CoreNetworkArn' => '<string>',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'EdgeLocation' => '<string>',
            'LastModificationErrors' => [
                [
                    'Code' => 'VPC_NOT_FOUND|SUBNET_NOT_FOUND|SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE|SUBNET_NO_FREE_ADDRESSES|SUBNET_UNSUPPORTED_AVAILABILITY_ZONE|SUBNET_NO_IPV6_CIDRS|VPN_CONNECTION_NOT_FOUND|MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
                    'Message' => '<string>',
                    'RequestId' => '<string>',
                    'ResourceArn' => '<string>',
                ],
                // ...
            ],
            'NetworkFunctionGroupName' => '<string>',
            'OwnerAccountId' => '<string>',
            'ProposedNetworkFunctionGroupChange' => [
                'AttachmentPolicyRuleNumber' => <integer>,
                'NetworkFunctionGroupName' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<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|NO_ENCAP',
        ],
        'TransportAttachmentId' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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>', ...],
    'PeerAddress' => '<string>', // REQUIRED
    'SubnetArn' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ConnectPeer' => [
        'Configuration' => [
            'BgpConfigurations' => [
                [
                    'CoreNetworkAddress' => '<string>',
                    'CoreNetworkAsn' => <integer>,
                    'PeerAddress' => '<string>',
                    'PeerAsn' => <integer>,
                ],
                // ...
            ],
            'CoreNetworkAddress' => '<string>',
            'InsideCidrBlocks' => ['<string>', ...],
            'PeerAddress' => '<string>',
            'Protocol' => 'GRE|NO_ENCAP',
        ],
        'ConnectAttachmentId' => '<string>',
        'ConnectPeerId' => '<string>',
        'CoreNetworkId' => '<string>',
        'CreatedAt' => <DateTime>,
        'EdgeLocation' => '<string>',
        'LastModificationErrors' => [
            [
                'Code' => 'EDGE_LOCATION_NO_FREE_IPS|EDGE_LOCATION_PEER_DUPLICATE|SUBNET_NOT_FOUND|IP_OUTSIDE_SUBNET_CIDR_RANGE|INVALID_INSIDE_CIDR_BLOCK|NO_ASSOCIATED_CIDR_BLOCK',
                'Message' => '<string>',
                'RequestId' => '<string>',
                'ResourceArn' => '<string>',
            ],
            // ...
        ],
        'State' => 'CREATING|FAILED|AVAILABLE|DELETING',
        'SubnetArn' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

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

Errors

ValidationException:

The input fails to satisfy the constraints.

ServiceQuotaExceededException:

A service limit was exceeded.

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

Result Syntax

[
    'CoreNetwork' => [
        'CoreNetworkArn' => '<string>',
        'CoreNetworkId' => '<string>',
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'Edges' => [
            [
                'Asn' => <integer>,
                'EdgeLocation' => '<string>',
                'InsideCidrBlocks' => ['<string>', ...],
            ],
            // ...
        ],
        'GlobalNetworkId' => '<string>',
        'NetworkFunctionGroups' => [
            [
                'EdgeLocations' => ['<string>', ...],
                'Name' => '<string>',
                'Segments' => [
                    'SendTo' => ['<string>', ...],
                    'SendVia' => ['<string>', ...],
                ],
            ],
            // ...
        ],
        'Segments' => [
            [
                'EdgeLocations' => ['<string>', ...],
                'Name' => '<string>',
                'SharedSegments' => ['<string>', ...],
            ],
            // ...
        ],
        'State' => 'CREATING|UPDATING|AVAILABLE|DELETING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

CoreNetworkPolicyException:

Describes a core network policy exception.

ValidationException:

The input fails to satisfy the constraints.

ServiceQuotaExceededException:

A service limit was exceeded.

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

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

Errors

ValidationException:

The input fails to satisfy the constraints.

ServiceQuotaExceededException:

A service limit was exceeded.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

Result Syntax

[
    'GlobalNetwork' => [
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'GlobalNetworkArn' => '<string>',
        'GlobalNetworkId' => '<string>',
        'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

ServiceQuotaExceededException:

A service limit was exceeded.

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

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

Errors

ValidationException:

The input fails to satisfy the constraints.

ServiceQuotaExceededException:

A service limit was exceeded.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

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

Errors

ValidationException:

The input fails to satisfy the constraints.

ServiceQuotaExceededException:

A service limit was exceeded.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

The request has failed due to an internal error.

CreateSiteToSiteVpnAttachment

$result = $client->createSiteToSiteVpnAttachment([/* ... */]);
$promise = $client->createSiteToSiteVpnAttachmentAsync([/* ... */]);

Creates an Amazon Web Services 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

Result Syntax

[
    'SiteToSiteVpnAttachment' => [
        'Attachment' => [
            'AttachmentId' => '<string>',
            'AttachmentPolicyRuleNumber' => <integer>,
            'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC|TRANSIT_GATEWAY_ROUTE_TABLE',
            'CoreNetworkArn' => '<string>',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'EdgeLocation' => '<string>',
            'LastModificationErrors' => [
                [
                    'Code' => 'VPC_NOT_FOUND|SUBNET_NOT_FOUND|SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE|SUBNET_NO_FREE_ADDRESSES|SUBNET_UNSUPPORTED_AVAILABILITY_ZONE|SUBNET_NO_IPV6_CIDRS|VPN_CONNECTION_NOT_FOUND|MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
                    'Message' => '<string>',
                    'RequestId' => '<string>',
                    'ResourceArn' => '<string>',
                ],
                // ...
            ],
            'NetworkFunctionGroupName' => '<string>',
            'OwnerAccountId' => '<string>',
            'ProposedNetworkFunctionGroupChange' => [
                'AttachmentPolicyRuleNumber' => <integer>,
                'NetworkFunctionGroupName' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<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

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

The request has failed due to an internal error.

CreateTransitGatewayPeering

$result = $client->createTransitGatewayPeering([/* ... */]);
$promise = $client->createTransitGatewayPeeringAsync([/* ... */]);

Creates a transit gateway peering connection.

Parameter Syntax

$result = $client->createTransitGatewayPeering([
    'ClientToken' => '<string>',
    'CoreNetworkId' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TransitGatewayArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TransitGatewayPeering' => [
        'Peering' => [
            'CoreNetworkArn' => '<string>',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'EdgeLocation' => '<string>',
            'LastModificationErrors' => [
                [
                    'Code' => 'TRANSIT_GATEWAY_NOT_FOUND|TRANSIT_GATEWAY_PEERS_LIMIT_EXCEEDED|MISSING_PERMISSIONS|INTERNAL_ERROR|EDGE_LOCATION_PEER_DUPLICATE|INVALID_TRANSIT_GATEWAY_STATE',
                    'Message' => '<string>',
                    'MissingPermissionsContext' => [
                        'MissingPermission' => '<string>',
                    ],
                    'RequestId' => '<string>',
                    'ResourceArn' => '<string>',
                ],
                // ...
            ],
            'OwnerAccountId' => '<string>',
            'PeeringId' => '<string>',
            'PeeringType' => 'TRANSIT_GATEWAY',
            'ResourceArn' => '<string>',
            'State' => 'CREATING|FAILED|AVAILABLE|DELETING',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        'TransitGatewayArn' => '<string>',
        'TransitGatewayPeeringAttachmentId' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

The request has failed due to an internal error.

CreateTransitGatewayRouteTableAttachment

$result = $client->createTransitGatewayRouteTableAttachment([/* ... */]);
$promise = $client->createTransitGatewayRouteTableAttachmentAsync([/* ... */]);

Creates a transit gateway route table attachment.

Parameter Syntax

$result = $client->createTransitGatewayRouteTableAttachment([
    'ClientToken' => '<string>',
    'PeeringId' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TransitGatewayRouteTableArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TransitGatewayRouteTableAttachment' => [
        'Attachment' => [
            'AttachmentId' => '<string>',
            'AttachmentPolicyRuleNumber' => <integer>,
            'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC|TRANSIT_GATEWAY_ROUTE_TABLE',
            'CoreNetworkArn' => '<string>',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'EdgeLocation' => '<string>',
            'LastModificationErrors' => [
                [
                    'Code' => 'VPC_NOT_FOUND|SUBNET_NOT_FOUND|SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE|SUBNET_NO_FREE_ADDRESSES|SUBNET_UNSUPPORTED_AVAILABILITY_ZONE|SUBNET_NO_IPV6_CIDRS|VPN_CONNECTION_NOT_FOUND|MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
                    'Message' => '<string>',
                    'RequestId' => '<string>',
                    'ResourceArn' => '<string>',
                ],
                // ...
            ],
            'NetworkFunctionGroupName' => '<string>',
            'OwnerAccountId' => '<string>',
            'ProposedNetworkFunctionGroupChange' => [
                'AttachmentPolicyRuleNumber' => <integer>,
                'NetworkFunctionGroupName' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<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>,
        ],
        'PeeringId' => '<string>',
        'TransitGatewayRouteTableArn' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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' => [
        'ApplianceModeSupport' => true || false,
        'Ipv6Support' => true || false,
    ],
    'SubnetArns' => ['<string>', ...], // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'VpcArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'VpcAttachment' => [
        'Attachment' => [
            'AttachmentId' => '<string>',
            'AttachmentPolicyRuleNumber' => <integer>,
            'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC|TRANSIT_GATEWAY_ROUTE_TABLE',
            'CoreNetworkArn' => '<string>',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'EdgeLocation' => '<string>',
            'LastModificationErrors' => [
                [
                    'Code' => 'VPC_NOT_FOUND|SUBNET_NOT_FOUND|SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE|SUBNET_NO_FREE_ADDRESSES|SUBNET_UNSUPPORTED_AVAILABILITY_ZONE|SUBNET_NO_IPV6_CIDRS|VPN_CONNECTION_NOT_FOUND|MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
                    'Message' => '<string>',
                    'RequestId' => '<string>',
                    'ResourceArn' => '<string>',
                ],
                // ...
            ],
            'NetworkFunctionGroupName' => '<string>',
            'OwnerAccountId' => '<string>',
            'ProposedNetworkFunctionGroupChange' => [
                'AttachmentPolicyRuleNumber' => <integer>,
                'NetworkFunctionGroupName' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<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' => [
            'ApplianceModeSupport' => true || false,
            'Ipv6Support' => true || false,
        ],
        'SubnetArns' => ['<string>', ...],
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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|TRANSIT_GATEWAY_ROUTE_TABLE',
        'CoreNetworkArn' => '<string>',
        'CoreNetworkId' => '<string>',
        'CreatedAt' => <DateTime>,
        'EdgeLocation' => '<string>',
        'LastModificationErrors' => [
            [
                'Code' => 'VPC_NOT_FOUND|SUBNET_NOT_FOUND|SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE|SUBNET_NO_FREE_ADDRESSES|SUBNET_UNSUPPORTED_AVAILABILITY_ZONE|SUBNET_NO_IPV6_CIDRS|VPN_CONNECTION_NOT_FOUND|MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
                'Message' => '<string>',
                'RequestId' => '<string>',
                'ResourceArn' => '<string>',
            ],
            // ...
        ],
        'NetworkFunctionGroupName' => '<string>',
        'OwnerAccountId' => '<string>',
        'ProposedNetworkFunctionGroupChange' => [
            'AttachmentPolicyRuleNumber' => <integer>,
            'NetworkFunctionGroupName' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<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

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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|NO_ENCAP',
        ],
        'ConnectAttachmentId' => '<string>',
        'ConnectPeerId' => '<string>',
        'CoreNetworkId' => '<string>',
        'CreatedAt' => <DateTime>,
        'EdgeLocation' => '<string>',
        'LastModificationErrors' => [
            [
                'Code' => 'EDGE_LOCATION_NO_FREE_IPS|EDGE_LOCATION_PEER_DUPLICATE|SUBNET_NOT_FOUND|IP_OUTSIDE_SUBNET_CIDR_RANGE|INVALID_INSIDE_CIDR_BLOCK|NO_ASSOCIATED_CIDR_BLOCK',
                'Message' => '<string>',
                'RequestId' => '<string>',
                'ResourceArn' => '<string>',
            ],
            // ...
        ],
        'State' => 'CREATING|FAILED|AVAILABLE|DELETING',
        'SubnetArn' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

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

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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>',
        'NetworkFunctionGroups' => [
            [
                'EdgeLocations' => ['<string>', ...],
                'Name' => '<string>',
                'Segments' => [
                    'SendTo' => ['<string>', ...],
                    'SendVia' => ['<string>', ...],
                ],
            ],
            // ...
        ],
        'Segments' => [
            [
                'EdgeLocations' => ['<string>', ...],
                'Name' => '<string>',
                'SharedSegments' => ['<string>', ...],
            ],
            // ...
        ],
        'State' => 'CREATING|UPDATING|AVAILABLE|DELETING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

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

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

The request has failed due to an internal error.

ConflictException:

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

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

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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), deregister all transit gateways, and delete any core networks.

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

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

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

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

The request has failed due to an internal error.

DeletePeering

$result = $client->deletePeering([/* ... */]);
$promise = $client->deletePeeringAsync([/* ... */]);

Deletes an existing peering connection.

Parameter Syntax

$result = $client->deletePeering([
    'PeeringId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Peering' => [
        'CoreNetworkArn' => '<string>',
        'CoreNetworkId' => '<string>',
        'CreatedAt' => <DateTime>,
        'EdgeLocation' => '<string>',
        'LastModificationErrors' => [
            [
                'Code' => 'TRANSIT_GATEWAY_NOT_FOUND|TRANSIT_GATEWAY_PEERS_LIMIT_EXCEEDED|MISSING_PERMISSIONS|INTERNAL_ERROR|EDGE_LOCATION_PEER_DUPLICATE|INVALID_TRANSIT_GATEWAY_STATE',
                'Message' => '<string>',
                'MissingPermissionsContext' => [
                    'MissingPermission' => '<string>',
                ],
                'RequestId' => '<string>',
                'ResourceArn' => '<string>',
            ],
            // ...
        ],
        'OwnerAccountId' => '<string>',
        'PeeringId' => '<string>',
        'PeeringType' => 'TRANSIT_GATEWAY',
        'ResourceArn' => '<string>',
        'State' => 'CREATING|FAILED|AVAILABLE|DELETING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

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

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

Result Syntax

[
    'TransitGatewayRegistration' => [
        'GlobalNetworkId' => '<string>',
        'State' => [
            'Code' => 'PENDING|AVAILABLE|DELETING|DELETED|FAILED',
            'Message' => '<string>',
        ],
        'TransitGatewayArn' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

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

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

Result Syntax

[
    'ConnectPeerAssociation' => [
        'ConnectPeerId' => '<string>',
        'DeviceId' => '<string>',
        'GlobalNetworkId' => '<string>',
        'LinkId' => '<string>',
        'State' => 'PENDING|AVAILABLE|DELETING|DELETED',
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

Result Syntax

[
    'CustomerGatewayAssociation' => [
        'CustomerGatewayArn' => '<string>',
        'DeviceId' => '<string>',
        'GlobalNetworkId' => '<string>',
        'LinkId' => '<string>',
        'State' => 'PENDING|AVAILABLE|DELETING|DELETED',
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

Result Syntax

[
    'LinkAssociation' => [
        'DeviceId' => '<string>',
        'GlobalNetworkId' => '<string>',
        'LinkAssociationState' => 'PENDING|AVAILABLE|DELETING|DELETED',
        'LinkId' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

Result Syntax

[
    'TransitGatewayConnectPeerAssociation' => [
        'DeviceId' => '<string>',
        'GlobalNetworkId' => '<string>',
        'LinkId' => '<string>',
        'State' => 'PENDING|AVAILABLE|DELETING|DELETED',
        'TransitGatewayConnectPeerArn' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

Result Syntax

[]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

The request has failed due to an internal error.

ConflictException:

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|TRANSIT_GATEWAY_ROUTE_TABLE',
            'CoreNetworkArn' => '<string>',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'EdgeLocation' => '<string>',
            'LastModificationErrors' => [
                [
                    'Code' => 'VPC_NOT_FOUND|SUBNET_NOT_FOUND|SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE|SUBNET_NO_FREE_ADDRESSES|SUBNET_UNSUPPORTED_AVAILABILITY_ZONE|SUBNET_NO_IPV6_CIDRS|VPN_CONNECTION_NOT_FOUND|MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
                    'Message' => '<string>',
                    'RequestId' => '<string>',
                    'ResourceArn' => '<string>',
                ],
                // ...
            ],
            'NetworkFunctionGroupName' => '<string>',
            'OwnerAccountId' => '<string>',
            'ProposedNetworkFunctionGroupChange' => [
                'AttachmentPolicyRuleNumber' => <integer>,
                'NetworkFunctionGroupName' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<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|NO_ENCAP',
        ],
        'TransportAttachmentId' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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|NO_ENCAP',
        ],
        'ConnectAttachmentId' => '<string>',
        'ConnectPeerId' => '<string>',
        'CoreNetworkId' => '<string>',
        'CreatedAt' => <DateTime>,
        'EdgeLocation' => '<string>',
        'LastModificationErrors' => [
            [
                'Code' => 'EDGE_LOCATION_NO_FREE_IPS|EDGE_LOCATION_PEER_DUPLICATE|SUBNET_NOT_FOUND|IP_OUTSIDE_SUBNET_CIDR_RANGE|INVALID_INSIDE_CIDR_BLOCK|NO_ASSOCIATED_CIDR_BLOCK',
                'Message' => '<string>',
                'RequestId' => '<string>',
                'ResourceArn' => '<string>',
            ],
            // ...
        ],
        'State' => 'CREATING|FAILED|AVAILABLE|DELETING',
        'SubnetArn' => '<string>',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

Result Syntax

[
    'ConnectPeerAssociations' => [
        [
            'ConnectPeerId' => '<string>',
            'DeviceId' => '<string>',
            'GlobalNetworkId' => '<string>',
            'LinkId' => '<string>',
            'State' => 'PENDING|AVAILABLE|DELETING|DELETED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

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

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

The request has failed due to an internal error.

GetCoreNetwork

$result = $client->getCoreNetwork([/* ... */]);
$promise = $client->getCoreNetworkAsync([/* ... */]);

Returns information about the LIVE policy for a core network.

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>',
        'NetworkFunctionGroups' => [
            [
                'EdgeLocations' => ['<string>', ...],
                'Name' => '<string>',
                'Segments' => [
                    'SendTo' => ['<string>', ...],
                    'SendVia' => ['<string>', ...],
                ],
            ],
            // ...
        ],
        'Segments' => [
            [
                'EdgeLocations' => ['<string>', ...],
                'Name' => '<string>',
                'SharedSegments' => ['<string>', ...],
            ],
            // ...
        ],
        'State' => 'CREATING|UPDATING|AVAILABLE|DELETING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

The request has failed due to an internal error.

GetCoreNetworkChangeEvents

$result = $client->getCoreNetworkChangeEvents([/* ... */]);
$promise = $client->getCoreNetworkChangeEventsAsync([/* ... */]);

Returns information about a core network change event.

Parameter Syntax

$result = $client->getCoreNetworkChangeEvents([
    'CoreNetworkId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PolicyVersionId' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CoreNetworkChangeEvents' => [
        [
            'Action' => 'ADD|MODIFY|REMOVE',
            'EventTime' => <DateTime>,
            'IdentifierPath' => '<string>',
            'Status' => 'NOT_STARTED|IN_PROGRESS|COMPLETE|FAILED',
            'Type' => 'CORE_NETWORK_SEGMENT|NETWORK_FUNCTION_GROUP|CORE_NETWORK_EDGE|ATTACHMENT_MAPPING|ATTACHMENT_ROUTE_PROPAGATION|ATTACHMENT_ROUTE_STATIC|CORE_NETWORK_CONFIGURATION|SEGMENTS_CONFIGURATION|SEGMENT_ACTIONS_CONFIGURATION|ATTACHMENT_POLICIES_CONFIGURATION',
            'Values' => [
                'AttachmentId' => '<string>',
                'Cidr' => '<string>',
                'EdgeLocation' => '<string>',
                'NetworkFunctionGroupName' => '<string>',
                'SegmentName' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

Result Syntax

[
    'CoreNetworkChanges' => [
        [
            'Action' => 'ADD|MODIFY|REMOVE',
            'Identifier' => '<string>',
            'IdentifierPath' => '<string>',
            'NewValues' => [
                'Asn' => <integer>,
                'Cidr' => '<string>',
                'DestinationIdentifier' => '<string>',
                'EdgeLocations' => ['<string>', ...],
                'InsideCidrBlocks' => ['<string>', ...],
                'NetworkFunctionGroupName' => '<string>',
                'SegmentName' => '<string>',
                'ServiceInsertionActions' => [
                    [
                        'Action' => 'send-via|send-to',
                        'Mode' => 'dual-hop|single-hop',
                        'Via' => [
                            'NetworkFunctionGroups' => [
                                [
                                    'Name' => '<string>',
                                ],
                                // ...
                            ],
                            'WithEdgeOverrides' => [
                                [
                                    'EdgeSets' => [
                                        ['<string>', ...],
                                        // ...
                                    ],
                                    'UseEdge' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'WhenSentTo' => [
                            'WhenSentToSegmentsList' => ['<string>', ...],
                        ],
                    ],
                    // ...
                ],
                'SharedSegments' => ['<string>', ...],
            ],
            'PreviousValues' => [
                'Asn' => <integer>,
                'Cidr' => '<string>',
                'DestinationIdentifier' => '<string>',
                'EdgeLocations' => ['<string>', ...],
                'InsideCidrBlocks' => ['<string>', ...],
                'NetworkFunctionGroupName' => '<string>',
                'SegmentName' => '<string>',
                'ServiceInsertionActions' => [
                    [
                        'Action' => 'send-via|send-to',
                        'Mode' => 'dual-hop|single-hop',
                        'Via' => [
                            'NetworkFunctionGroups' => [
                                [
                                    'Name' => '<string>',
                                ],
                                // ...
                            ],
                            'WithEdgeOverrides' => [
                                [
                                    'EdgeSets' => [
                                        ['<string>', ...],
                                        // ...
                                    ],
                                    'UseEdge' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'WhenSentTo' => [
                            'WhenSentToSegmentsList' => ['<string>', ...],
                        ],
                    ],
                    // ...
                ],
                'SharedSegments' => ['<string>', ...],
            ],
            'Type' => 'CORE_NETWORK_SEGMENT|NETWORK_FUNCTION_GROUP|CORE_NETWORK_EDGE|ATTACHMENT_MAPPING|ATTACHMENT_ROUTE_PROPAGATION|ATTACHMENT_ROUTE_STATIC|CORE_NETWORK_CONFIGURATION|SEGMENTS_CONFIGURATION|SEGMENT_ACTIONS_CONFIGURATION|ATTACHMENT_POLICIES_CONFIGURATION',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

The request has failed due to an internal error.

GetCoreNetworkPolicy

$result = $client->getCoreNetworkPolicy([/* ... */]);
$promise = $client->getCoreNetworkPolicyAsync([/* ... */]);

Returns 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

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

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

Result Syntax

[
    'CustomerGatewayAssociations' => [
        [
            'CustomerGatewayArn' => '<string>',
            'DeviceId' => '<string>',
            'GlobalNetworkId' => '<string>',
            'LinkId' => '<string>',
            'State' => 'PENDING|AVAILABLE|DELETING|DELETED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

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

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

Result Syntax

[
    'LinkAssociations' => [
        [
            'DeviceId' => '<string>',
            'GlobalNetworkId' => '<string>',
            'LinkAssociationState' => 'PENDING|AVAILABLE|DELETING|DELETED',
            'LinkId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

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

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

Result Syntax

[
    'NetworkResourceCounts' => [
        [
            'Count' => <integer>,
            'ResourceType' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

Result Syntax

[
    'NextToken' => '<string>',
    'Relationships' => [
        [
            'From' => '<string>',
            'To' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

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

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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
        'CoreNetworkNetworkFunctionGroup' => [
            'CoreNetworkId' => '<string>',
            'EdgeLocation' => '<string>',
            'NetworkFunctionGroupName' => '<string>',
        ],
        'CoreNetworkSegmentEdge' => [
            'CoreNetworkId' => '<string>',
            'EdgeLocation' => '<string>',
            'SegmentName' => '<string>',
        ],
        'TransitGatewayRouteTableArn' => '<string>',
    ],
    'States' => ['<string>', ...],
    'SubnetOfMatches' => ['<string>', ...],
    'SupernetOfMatches' => ['<string>', ...],
    'Types' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'CoreNetworkSegmentEdge' => [
        'CoreNetworkId' => '<string>',
        'EdgeLocation' => '<string>',
        'SegmentName' => '<string>',
    ],
    'NetworkRoutes' => [
        [
            'DestinationCidrBlock' => '<string>',
            'Destinations' => [
                [
                    'CoreNetworkAttachmentId' => '<string>',
                    'EdgeLocation' => '<string>',
                    'NetworkFunctionGroupName' => '<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|NETWORK_FUNCTION_GROUP',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

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

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

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

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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|TRANSIT_GATEWAY_ROUTE_TABLE',
            'CoreNetworkArn' => '<string>',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'EdgeLocation' => '<string>',
            'LastModificationErrors' => [
                [
                    'Code' => 'VPC_NOT_FOUND|SUBNET_NOT_FOUND|SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE|SUBNET_NO_FREE_ADDRESSES|SUBNET_UNSUPPORTED_AVAILABILITY_ZONE|SUBNET_NO_IPV6_CIDRS|VPN_CONNECTION_NOT_FOUND|MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
                    'Message' => '<string>',
                    'RequestId' => '<string>',
                    'ResourceArn' => '<string>',
                ],
                // ...
            ],
            'NetworkFunctionGroupName' => '<string>',
            'OwnerAccountId' => '<string>',
            'ProposedNetworkFunctionGroupChange' => [
                'AttachmentPolicyRuleNumber' => <integer>,
                'NetworkFunctionGroupName' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<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

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

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

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

Result Syntax

[
    'NextToken' => '<string>',
    'TransitGatewayConnectPeerAssociations' => [
        [
            'DeviceId' => '<string>',
            'GlobalNetworkId' => '<string>',
            'LinkId' => '<string>',
            'State' => 'PENDING|AVAILABLE|DELETING|DELETED',
            'TransitGatewayConnectPeerArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ConflictException:

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

The request has failed due to an internal error.

GetTransitGatewayPeering

$result = $client->getTransitGatewayPeering([/* ... */]);
$promise = $client->getTransitGatewayPeeringAsync([/* ... */]);

Returns information about a transit gateway peer.

Parameter Syntax

$result = $client->getTransitGatewayPeering([
    'PeeringId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TransitGatewayPeering' => [
        'Peering' => [
            'CoreNetworkArn' => '<string>',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'EdgeLocation' => '<string>',
            'LastModificationErrors' => [
                [
                    'Code' => 'TRANSIT_GATEWAY_NOT_FOUND|TRANSIT_GATEWAY_PEERS_LIMIT_EXCEEDED|MISSING_PERMISSIONS|INTERNAL_ERROR|EDGE_LOCATION_PEER_DUPLICATE|INVALID_TRANSIT_GATEWAY_STATE',
                    'Message' => '<string>',
                    'MissingPermissionsContext' => [
                        'MissingPermission' => '<string>',
                    ],
                    'RequestId' => '<string>',
                    'ResourceArn' => '<string>',
                ],
                // ...
            ],
            'OwnerAccountId' => '<string>',
            'PeeringId' => '<string>',
            'PeeringType' => 'TRANSIT_GATEWAY',
            'ResourceArn' => '<string>',
            'State' => 'CREATING|FAILED|AVAILABLE|DELETING',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        'TransitGatewayArn' => '<string>',
        'TransitGatewayPeeringAttachmentId' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

Result Syntax

[
    'NextToken' => '<string>',
    'TransitGatewayRegistrations' => [
        [
            'GlobalNetworkId' => '<string>',
            'State' => [
                'Code' => 'PENDING|AVAILABLE|DELETING|DELETED|FAILED',
                'Message' => '<string>',
            ],
            'TransitGatewayArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

The request has failed due to an internal error.

GetTransitGatewayRouteTableAttachment

$result = $client->getTransitGatewayRouteTableAttachment([/* ... */]);
$promise = $client->getTransitGatewayRouteTableAttachmentAsync([/* ... */]);

Returns information about a transit gateway route table attachment.

Parameter Syntax

$result = $client->getTransitGatewayRouteTableAttachment([
    'AttachmentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TransitGatewayRouteTableAttachment' => [
        'Attachment' => [
            'AttachmentId' => '<string>',
            'AttachmentPolicyRuleNumber' => <integer>,
            'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC|TRANSIT_GATEWAY_ROUTE_TABLE',
            'CoreNetworkArn' => '<string>',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'EdgeLocation' => '<string>',
            'LastModificationErrors' => [
                [
                    'Code' => 'VPC_NOT_FOUND|SUBNET_NOT_FOUND|SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE|SUBNET_NO_FREE_ADDRESSES|SUBNET_UNSUPPORTED_AVAILABILITY_ZONE|SUBNET_NO_IPV6_CIDRS|VPN_CONNECTION_NOT_FOUND|MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
                    'Message' => '<string>',
                    'RequestId' => '<string>',
                    'ResourceArn' => '<string>',
                ],
                // ...
            ],
            'NetworkFunctionGroupName' => '<string>',
            'OwnerAccountId' => '<string>',
            'ProposedNetworkFunctionGroupChange' => [
                'AttachmentPolicyRuleNumber' => <integer>,
                'NetworkFunctionGroupName' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<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>,
        ],
        'PeeringId' => '<string>',
        'TransitGatewayRouteTableArn' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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|TRANSIT_GATEWAY_ROUTE_TABLE',
            'CoreNetworkArn' => '<string>',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'EdgeLocation' => '<string>',
            'LastModificationErrors' => [
                [
                    'Code' => 'VPC_NOT_FOUND|SUBNET_NOT_FOUND|SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE|SUBNET_NO_FREE_ADDRESSES|SUBNET_UNSUPPORTED_AVAILABILITY_ZONE|SUBNET_NO_IPV6_CIDRS|VPN_CONNECTION_NOT_FOUND|MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
                    'Message' => '<string>',
                    'RequestId' => '<string>',
                    'ResourceArn' => '<string>',
                ],
                // ...
            ],
            'NetworkFunctionGroupName' => '<string>',
            'OwnerAccountId' => '<string>',
            'ProposedNetworkFunctionGroupChange' => [
                'AttachmentPolicyRuleNumber' => <integer>,
                'NetworkFunctionGroupName' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<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' => [
            'ApplianceModeSupport' => true || false,
            'Ipv6Support' => true || false,
        ],
        'SubnetArns' => ['<string>', ...],
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

Result Syntax

[
    'Attachments' => [
        [
            'AttachmentId' => '<string>',
            'AttachmentPolicyRuleNumber' => <integer>,
            'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC|TRANSIT_GATEWAY_ROUTE_TABLE',
            'CoreNetworkArn' => '<string>',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'EdgeLocation' => '<string>',
            'LastModificationErrors' => [
                [
                    'Code' => 'VPC_NOT_FOUND|SUBNET_NOT_FOUND|SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE|SUBNET_NO_FREE_ADDRESSES|SUBNET_UNSUPPORTED_AVAILABILITY_ZONE|SUBNET_NO_IPV6_CIDRS|VPN_CONNECTION_NOT_FOUND|MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED',
                    'Message' => '<string>',
                    'RequestId' => '<string>',
                    'ResourceArn' => '<string>',
                ],
                // ...
            ],
            'NetworkFunctionGroupName' => '<string>',
            'OwnerAccountId' => '<string>',
            'ProposedNetworkFunctionGroupChange' => [
                'AttachmentPolicyRuleNumber' => <integer>,
                'NetworkFunctionGroupName' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<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

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

Result Syntax

[
    'ConnectPeers' => [
        [
            'ConnectAttachmentId' => '<string>',
            'ConnectPeerId' => '<string>',
            'ConnectPeerState' => 'CREATING|FAILED|AVAILABLE|DELETING',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'EdgeLocation' => '<string>',
            'SubnetArn' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

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

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

Errors

ValidationException:

The input fails to satisfy the constraints.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource could not be found.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

The request has failed due to an internal error.