AddCustomRoutingEndpoints

$result = $client->addCustomRoutingEndpoints([/* ... */]);
$promise = $client->addCustomRoutingEndpointsAsync([/* ... */]);

Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.

The listener port range must be large enough to support the number of IP addresses that can be specified in your subnet. The number of ports required is: subnet size times the number of ports per destination EC2 instances. For example, a subnet defined as /24 requires a listener port range of at least 255 ports.

Note: You must have enough remaining listener ports available to map to the subnet ports, or the call will fail with a LimitExceededException.

By default, all destinations in a subnet in a custom routing accelerator cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the AllowCustomRoutingTraffic operation.

Parameter Syntax

$result = $client->addCustomRoutingEndpoints([
    'EndpointConfigurations' => [ // REQUIRED
        [
            'AttachmentArn' => '<string>',
            'EndpointId' => '<string>',
        ],
        // ...
    ],
    'EndpointGroupArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EndpointDescriptions' => [
        [
            'EndpointId' => '<string>',
        ],
        // ...
    ],
    'EndpointGroupArn' => '<string>',
]

Result Details

Errors

EndpointAlreadyExistsException:

The endpoint that you specified doesn't exist.

EndpointGroupNotFoundException:

The endpoint group that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

LimitExceededException:

Processing your request would cause you to exceed an Global Accelerator limit.

AccessDeniedException:

You don't have access permission.

ConflictException:

You can't use both of those options.

AddEndpoints

$result = $client->addEndpoints([/* ... */]);
$promise = $client->addEndpointsAsync([/* ... */]);

Add endpoints to an endpoint group. The AddEndpoints API operation is the recommended option for adding endpoints. The alternative options are to add endpoints when you create an endpoint group (with the CreateEndpointGroup API) or when you update an endpoint group (with the UpdateEndpointGroup API).

There are two advantages to using AddEndpoints to add endpoints in Global Accelerator:

• It's faster, because Global Accelerator only has to resolve the new endpoints that you're adding, rather than resolving new and existing endpoints.

• It's more convenient, because you don't need to specify the current endpoints that are already in the endpoint group, in addition to the new endpoints that you want to add.

For information about endpoint types and requirements for endpoints that you can add to Global Accelerator, see Endpoints for standard accelerators in the Global Accelerator Developer Guide.

Parameter Syntax

$result = $client->addEndpoints([
    'EndpointConfigurations' => [ // REQUIRED
        [
            'AttachmentArn' => '<string>',
            'ClientIPPreservationEnabled' => true || false,
            'EndpointId' => '<string>',
            'Weight' => <integer>,
        ],
        // ...
    ],
    'EndpointGroupArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EndpointDescriptions' => [
        [
            'ClientIPPreservationEnabled' => true || false,
            'EndpointId' => '<string>',
            'HealthReason' => '<string>',
            'HealthState' => 'INITIAL|HEALTHY|UNHEALTHY',
            'Weight' => <integer>,
        ],
        // ...
    ],
    'EndpointGroupArn' => '<string>',
]

Result Details

Errors

TransactionInProgressException:

There's already a transaction in progress. Another transaction can't be processed.

EndpointGroupNotFoundException:

The endpoint group that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

LimitExceededException:

Processing your request would cause you to exceed an Global Accelerator limit.

AccessDeniedException:

You don't have access permission.

AdvertiseByoipCidr

$result = $client->advertiseByoipCidr([/* ... */]);
$promise = $client->advertiseByoipCidrAsync([/* ... */]);

Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP). It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of propagation delays.

To stop advertising the BYOIP address range, use WithdrawByoipCidr.

For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ByoipCidr' => [
        'Cidr' => '<string>',
        'Events' => [
            [
                'Message' => '<string>',
                'Timestamp' => <DateTime>,
            ],
            // ...
        ],
        'State' => 'PENDING_PROVISIONING|READY|PENDING_ADVERTISING|ADVERTISING|PENDING_WITHDRAWING|PENDING_DEPROVISIONING|DEPROVISIONED|FAILED_PROVISION|FAILED_ADVERTISING|FAILED_WITHDRAW|FAILED_DEPROVISION',
    ],
]

Result Details

Errors

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

AccessDeniedException:

You don't have access permission.

ByoipCidrNotFoundException:

The CIDR that you specified was not found or is incorrect.

IncorrectCidrStateException:

The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be incorrect for this action.

AllowCustomRoutingTraffic

$result = $client->allowCustomRoutingTraffic([/* ... */]);
$promise = $client->allowCustomRoutingTrafficAsync([/* ... */]);

Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic for a custom routing accelerator. You can allow traffic to all destinations in the subnet endpoint, or allow traffic to a specified list of destination IP addresses and ports in the subnet. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group.

After you make changes, you can verify that the updates are complete by checking the status of your accelerator: the status changes from IN_PROGRESS to DEPLOYED.

Parameter Syntax

$result = $client->allowCustomRoutingTraffic([
    'AllowAllTrafficToEndpoint' => true || false,
    'DestinationAddresses' => ['<string>', ...],
    'DestinationPorts' => [<integer>, ...],
    'EndpointGroupArn' => '<string>', // REQUIRED
    'EndpointId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EndpointGroupNotFoundException:

The endpoint group that you specified doesn't exist.

InvalidArgumentException:

An argument that you specified is invalid.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

CreateAccelerator

$result = $client->createAccelerator([/* ... */]);
$promise = $client->createAcceleratorAsync([/* ... */]);

Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers.

Parameter Syntax

$result = $client->createAccelerator([
    'Enabled' => true || false,
    'IdempotencyToken' => '<string>', // REQUIRED
    'IpAddressType' => 'IPV4|DUAL_STACK',
    'IpAddresses' => ['<string>', ...],
    'Name' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Accelerator' => [
        'AcceleratorArn' => '<string>',
        'CreatedTime' => <DateTime>,
        'DnsName' => '<string>',
        'DualStackDnsName' => '<string>',
        'Enabled' => true || false,
        'Events' => [
            [
                'Message' => '<string>',
                'Timestamp' => <DateTime>,
            ],
            // ...
        ],
        'IpAddressType' => 'IPV4|DUAL_STACK',
        'IpSets' => [
            [
                'IpAddressFamily' => 'IPv4|IPv6',
                'IpAddresses' => ['<string>', ...],
                'IpFamily' => '<string>',
            ],
            // ...
        ],
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'Status' => 'DEPLOYED|IN_PROGRESS',
    ],
]

Result Details

Errors

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

LimitExceededException:

Processing your request would cause you to exceed an Global Accelerator limit.

AccessDeniedException:

You don't have access permission.

TransactionInProgressException:

There's already a transaction in progress. Another transaction can't be processed.

CreateCrossAccountAttachment

$result = $client->createCrossAccountAttachment([/* ... */]);
$promise = $client->createCrossAccountAttachmentAsync([/* ... */]);

Create a cross-account attachment in Global Accelerator. You create a cross-account attachment to specify the principals who have permission to work with resources in accelerators in their own account. You specify, in the same attachment, the resources that are shared.

A principal can be an Amazon Web Services account number or the Amazon Resource Name (ARN) for an accelerator. For account numbers that are listed as principals, to work with a resource listed in the attachment, you must sign in to an account specified as a principal. Then, you can work with resources that are listed, with any of your accelerators. If an accelerator ARN is listed in the cross-account attachment as a principal, anyone with permission to make updates to the accelerator can work with resources that are listed in the attachment.

Specify each principal and resource separately. To specify two CIDR address pools, list them individually under Resources, and so on. For a command line operation, for example, you might use a statement like the following:

"Resources": [{"Cidr": "169.254.60.0/24"},{"Cidr": "169.254.59.0/24"}]

For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.

Parameter Syntax

$result = $client->createCrossAccountAttachment([
    'IdempotencyToken' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Principals' => ['<string>', ...],
    'Resources' => [
        [
            'Cidr' => '<string>',
            'EndpointId' => '<string>',
            'Region' => '<string>',
        ],
        // ...
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'CrossAccountAttachment' => [
        'AttachmentArn' => '<string>',
        'CreatedTime' => <DateTime>,
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'Principals' => ['<string>', ...],
        'Resources' => [
            [
                'Cidr' => '<string>',
                'EndpointId' => '<string>',
                'Region' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

LimitExceededException:

Processing your request would cause you to exceed an Global Accelerator limit.

AccessDeniedException:

You don't have access permission.

TransactionInProgressException:

There's already a transaction in progress. Another transaction can't be processed.

CreateCustomRoutingAccelerator

$result = $client->createCustomRoutingAccelerator([/* ... */]);
$promise = $client->createCustomRoutingAcceleratorAsync([/* ... */]);

Create a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands of Amazon EC2 instance destinations running in a single or multiple virtual private clouds (VPC) subnet endpoints.

Be aware that, by default, all destination EC2 instances in a VPC subnet endpoint cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the AllowCustomRoutingTraffic operation.

Parameter Syntax

$result = $client->createCustomRoutingAccelerator([
    'Enabled' => true || false,
    'IdempotencyToken' => '<string>', // REQUIRED
    'IpAddressType' => 'IPV4|DUAL_STACK',
    'IpAddresses' => ['<string>', ...],
    'Name' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Accelerator' => [
        'AcceleratorArn' => '<string>',
        'CreatedTime' => <DateTime>,
        'DnsName' => '<string>',
        'Enabled' => true || false,
        'IpAddressType' => 'IPV4|DUAL_STACK',
        'IpSets' => [
            [
                'IpAddressFamily' => 'IPv4|IPv6',
                'IpAddresses' => ['<string>', ...],
                'IpFamily' => '<string>',
            ],
            // ...
        ],
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'Status' => 'DEPLOYED|IN_PROGRESS',
    ],
]

Result Details

Errors

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

LimitExceededException:

Processing your request would cause you to exceed an Global Accelerator limit.

AccessDeniedException:

You don't have access permission.

TransactionInProgressException:

There's already a transaction in progress. Another transaction can't be processed.

CreateCustomRoutingEndpointGroup

$result = $client->createCustomRoutingEndpointGroup([/* ... */]);
$promise = $client->createCustomRoutingEndpointGroupAsync([/* ... */]);

Create an endpoint group for the specified listener for a custom routing accelerator. An endpoint group is a collection of endpoints in one Amazon Web Services Region.

Parameter Syntax

$result = $client->createCustomRoutingEndpointGroup([
    'DestinationConfigurations' => [ // REQUIRED
        [
            'FromPort' => <integer>, // REQUIRED
            'Protocols' => ['<string>', ...], // REQUIRED
            'ToPort' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'EndpointGroupRegion' => '<string>', // REQUIRED
    'IdempotencyToken' => '<string>', // REQUIRED
    'ListenerArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EndpointGroup' => [
        'DestinationDescriptions' => [
            [
                'FromPort' => <integer>,
                'Protocols' => ['<string>', ...],
                'ToPort' => <integer>,
            ],
            // ...
        ],
        'EndpointDescriptions' => [
            [
                'EndpointId' => '<string>',
            ],
            // ...
        ],
        'EndpointGroupArn' => '<string>',
        'EndpointGroupRegion' => '<string>',
    ],
]

Result Details

Errors

AcceleratorNotFoundException:

The accelerator that you specified doesn't exist.

EndpointGroupAlreadyExistsException:

The endpoint group that you specified already exists.

ListenerNotFoundException:

The listener that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

InvalidPortRangeException:

The port numbers that you specified are not valid numbers or are not unique for this accelerator.

LimitExceededException:

Processing your request would cause you to exceed an Global Accelerator limit.

AccessDeniedException:

You don't have access permission.

CreateCustomRoutingListener

$result = $client->createCustomRoutingListener([/* ... */]);
$promise = $client->createCustomRoutingListenerAsync([/* ... */]);

Create a listener to process inbound connections from clients to a custom routing accelerator. Connections arrive to assigned static IP addresses on the port range that you specify.

Parameter Syntax

$result = $client->createCustomRoutingListener([
    'AcceleratorArn' => '<string>', // REQUIRED
    'IdempotencyToken' => '<string>', // REQUIRED
    'PortRanges' => [ // REQUIRED
        [
            'FromPort' => <integer>,
            'ToPort' => <integer>,
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Listener' => [
        'ListenerArn' => '<string>',
        'PortRanges' => [
            [
                'FromPort' => <integer>,
                'ToPort' => <integer>,
            ],
            // ...
        ],
    ],
]

Result Details

Errors

InvalidArgumentException:

An argument that you specified is invalid.

AcceleratorNotFoundException:

The accelerator that you specified doesn't exist.

InvalidPortRangeException:

The port numbers that you specified are not valid numbers or are not unique for this accelerator.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

LimitExceededException:

Processing your request would cause you to exceed an Global Accelerator limit.

CreateEndpointGroup

$result = $client->createEndpointGroup([/* ... */]);
$promise = $client->createEndpointGroupAsync([/* ... */]);

Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one Amazon Web Services Region. A resource must be valid and active when you add it as an endpoint.

For more information about endpoint types and requirements for endpoints that you can add to Global Accelerator, see Endpoints for standard accelerators in the Global Accelerator Developer Guide.

Parameter Syntax

$result = $client->createEndpointGroup([
    'EndpointConfigurations' => [
        [
            'AttachmentArn' => '<string>',
            'ClientIPPreservationEnabled' => true || false,
            'EndpointId' => '<string>',
            'Weight' => <integer>,
        ],
        // ...
    ],
    'EndpointGroupRegion' => '<string>', // REQUIRED
    'HealthCheckIntervalSeconds' => <integer>,
    'HealthCheckPath' => '<string>',
    'HealthCheckPort' => <integer>,
    'HealthCheckProtocol' => 'TCP|HTTP|HTTPS',
    'IdempotencyToken' => '<string>', // REQUIRED
    'ListenerArn' => '<string>', // REQUIRED
    'PortOverrides' => [
        [
            'EndpointPort' => <integer>,
            'ListenerPort' => <integer>,
        ],
        // ...
    ],
    'ThresholdCount' => <integer>,
    'TrafficDialPercentage' => <float>,
]);

Parameter Details

Result Syntax

[
    'EndpointGroup' => [
        'EndpointDescriptions' => [
            [
                'ClientIPPreservationEnabled' => true || false,
                'EndpointId' => '<string>',
                'HealthReason' => '<string>',
                'HealthState' => 'INITIAL|HEALTHY|UNHEALTHY',
                'Weight' => <integer>,
            ],
            // ...
        ],
        'EndpointGroupArn' => '<string>',
        'EndpointGroupRegion' => '<string>',
        'HealthCheckIntervalSeconds' => <integer>,
        'HealthCheckPath' => '<string>',
        'HealthCheckPort' => <integer>,
        'HealthCheckProtocol' => 'TCP|HTTP|HTTPS',
        'PortOverrides' => [
            [
                'EndpointPort' => <integer>,
                'ListenerPort' => <integer>,
            ],
            // ...
        ],
        'ThresholdCount' => <integer>,
        'TrafficDialPercentage' => <float>,
    ],
]

Result Details

Errors

AcceleratorNotFoundException:

The accelerator that you specified doesn't exist.

EndpointGroupAlreadyExistsException:

The endpoint group that you specified already exists.

ListenerNotFoundException:

The listener that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

LimitExceededException:

Processing your request would cause you to exceed an Global Accelerator limit.

AccessDeniedException:

You don't have access permission.

CreateListener

$result = $client->createListener([/* ... */]);
$promise = $client->createListenerAsync([/* ... */]);

Create a listener to process inbound connections from clients to an accelerator. Connections arrive to assigned static IP addresses on a port, port range, or list of port ranges that you specify.

Parameter Syntax

$result = $client->createListener([
    'AcceleratorArn' => '<string>', // REQUIRED
    'ClientAffinity' => 'NONE|SOURCE_IP',
    'IdempotencyToken' => '<string>', // REQUIRED
    'PortRanges' => [ // REQUIRED
        [
            'FromPort' => <integer>,
            'ToPort' => <integer>,
        ],
        // ...
    ],
    'Protocol' => 'TCP|UDP', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Listener' => [
        'ClientAffinity' => 'NONE|SOURCE_IP',
        'ListenerArn' => '<string>',
        'PortRanges' => [
            [
                'FromPort' => <integer>,
                'ToPort' => <integer>,
            ],
            // ...
        ],
        'Protocol' => 'TCP|UDP',
    ],
]

Result Details

Errors

InvalidArgumentException:

An argument that you specified is invalid.

AcceleratorNotFoundException:

The accelerator that you specified doesn't exist.

InvalidPortRangeException:

The port numbers that you specified are not valid numbers or are not unique for this accelerator.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

LimitExceededException:

Processing your request would cause you to exceed an Global Accelerator limit.

DeleteAccelerator

$result = $client->deleteAccelerator([/* ... */]);
$promise = $client->deleteAcceleratorAsync([/* ... */]);

Delete an accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

AcceleratorNotFoundException:

The accelerator that you specified doesn't exist.

AcceleratorNotDisabledException:

The accelerator that you specified could not be disabled.

AssociatedListenerFoundException:

The accelerator that you specified has a listener associated with it. You must remove all dependent resources from an accelerator before you can delete it.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

TransactionInProgressException:

There's already a transaction in progress. Another transaction can't be processed.

DeleteCrossAccountAttachment

$result = $client->deleteCrossAccountAttachment([/* ... */]);
$promise = $client->deleteCrossAccountAttachmentAsync([/* ... */]);

Delete a cross-account attachment. When you delete an attachment, Global Accelerator revokes the permission to use the resources in the attachment from all principals in the list of principals. Global Accelerator revokes the permission for specific resources.

For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

AttachmentNotFoundException:

No cross-account attachment was found.

AccessDeniedException:

You don't have access permission.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

TransactionInProgressException:

There's already a transaction in progress. Another transaction can't be processed.

DeleteCustomRoutingAccelerator

$result = $client->deleteCustomRoutingAccelerator([/* ... */]);
$promise = $client->deleteCustomRoutingAcceleratorAsync([/* ... */]);

Delete a custom routing accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

AcceleratorNotFoundException:

The accelerator that you specified doesn't exist.

AcceleratorNotDisabledException:

The accelerator that you specified could not be disabled.

AssociatedListenerFoundException:

The accelerator that you specified has a listener associated with it. You must remove all dependent resources from an accelerator before you can delete it.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

TransactionInProgressException:

There's already a transaction in progress. Another transaction can't be processed.

DeleteCustomRoutingEndpointGroup

$result = $client->deleteCustomRoutingEndpointGroup([/* ... */]);
$promise = $client->deleteCustomRoutingEndpointGroupAsync([/* ... */]);

Delete an endpoint group from a listener for a custom routing accelerator.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidArgumentException:

An argument that you specified is invalid.

EndpointGroupNotFoundException:

The endpoint group that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

DeleteCustomRoutingListener

$result = $client->deleteCustomRoutingListener([/* ... */]);
$promise = $client->deleteCustomRoutingListenerAsync([/* ... */]);

Delete a listener for a custom routing accelerator.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidArgumentException:

An argument that you specified is invalid.

ListenerNotFoundException:

The listener that you specified doesn't exist.

AssociatedEndpointGroupFoundException:

The listener that you specified has an endpoint group associated with it. You must remove all dependent resources from a listener before you can delete it.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

DeleteEndpointGroup

$result = $client->deleteEndpointGroup([/* ... */]);
$promise = $client->deleteEndpointGroupAsync([/* ... */]);

Delete an endpoint group from a listener.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidArgumentException:

An argument that you specified is invalid.

EndpointGroupNotFoundException:

The endpoint group that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

DeleteListener

$result = $client->deleteListener([/* ... */]);
$promise = $client->deleteListenerAsync([/* ... */]);

Delete a listener from an accelerator.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidArgumentException:

An argument that you specified is invalid.

ListenerNotFoundException:

The listener that you specified doesn't exist.

AssociatedEndpointGroupFoundException:

The listener that you specified has an endpoint group associated with it. You must remove all dependent resources from a listener before you can delete it.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

DenyCustomRoutingTraffic

$result = $client->denyCustomRoutingTraffic([/* ... */]);
$promise = $client->denyCustomRoutingTrafficAsync([/* ... */]);

Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic for a custom routing accelerator. You can deny traffic to all destinations in the VPC endpoint, or deny traffic to a specified list of destination IP addresses and ports. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group.

After you make changes, you can verify that the updates are complete by checking the status of your accelerator: the status changes from IN_PROGRESS to DEPLOYED.

Parameter Syntax

$result = $client->denyCustomRoutingTraffic([
    'DenyAllTrafficToEndpoint' => true || false,
    'DestinationAddresses' => ['<string>', ...],
    'DestinationPorts' => [<integer>, ...],
    'EndpointGroupArn' => '<string>', // REQUIRED
    'EndpointId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EndpointGroupNotFoundException:

The endpoint group that you specified doesn't exist.

InvalidArgumentException:

An argument that you specified is invalid.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

DeprovisionByoipCidr

$result = $client->deprovisionByoipCidr([/* ... */]);
$promise = $client->deprovisionByoipCidrAsync([/* ... */]);

Releases the specified address range that you provisioned to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.

Before you can release an address range, you must stop advertising it by using WithdrawByoipCidr and you must not have any accelerators that are using static IP addresses allocated from its address range.

For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ByoipCidr' => [
        'Cidr' => '<string>',
        'Events' => [
            [
                'Message' => '<string>',
                'Timestamp' => <DateTime>,
            ],
            // ...
        ],
        'State' => 'PENDING_PROVISIONING|READY|PENDING_ADVERTISING|ADVERTISING|PENDING_WITHDRAWING|PENDING_DEPROVISIONING|DEPROVISIONED|FAILED_PROVISION|FAILED_ADVERTISING|FAILED_WITHDRAW|FAILED_DEPROVISION',
    ],
]

Result Details

Errors

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

AccessDeniedException:

You don't have access permission.

ByoipCidrNotFoundException:

The CIDR that you specified was not found or is incorrect.

IncorrectCidrStateException:

The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be incorrect for this action.

DescribeAccelerator

$result = $client->describeAccelerator([/* ... */]);
$promise = $client->describeAcceleratorAsync([/* ... */]);

Describe an accelerator.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Accelerator' => [
        'AcceleratorArn' => '<string>',
        'CreatedTime' => <DateTime>,
        'DnsName' => '<string>',
        'DualStackDnsName' => '<string>',
        'Enabled' => true || false,
        'Events' => [
            [
                'Message' => '<string>',
                'Timestamp' => <DateTime>,
            ],
            // ...
        ],
        'IpAddressType' => 'IPV4|DUAL_STACK',
        'IpSets' => [
            [
                'IpAddressFamily' => 'IPv4|IPv6',
                'IpAddresses' => ['<string>', ...],
                'IpFamily' => '<string>',
            ],
            // ...
        ],
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'Status' => 'DEPLOYED|IN_PROGRESS',
    ],
]

Result Details

Errors

AcceleratorNotFoundException:

The accelerator that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

DescribeAcceleratorAttributes

$result = $client->describeAcceleratorAttributes([/* ... */]);
$promise = $client->describeAcceleratorAttributesAsync([/* ... */]);

Describe the attributes of an accelerator.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AcceleratorAttributes' => [
        'FlowLogsEnabled' => true || false,
        'FlowLogsS3Bucket' => '<string>',
        'FlowLogsS3Prefix' => '<string>',
    ],
]

Result Details

Errors

AcceleratorNotFoundException:

The accelerator that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

DescribeCrossAccountAttachment

$result = $client->describeCrossAccountAttachment([/* ... */]);
$promise = $client->describeCrossAccountAttachmentAsync([/* ... */]);

Gets configuration information about a cross-account attachment.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CrossAccountAttachment' => [
        'AttachmentArn' => '<string>',
        'CreatedTime' => <DateTime>,
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'Principals' => ['<string>', ...],
        'Resources' => [
            [
                'Cidr' => '<string>',
                'EndpointId' => '<string>',
                'Region' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

AttachmentNotFoundException:

No cross-account attachment was found.

AccessDeniedException:

You don't have access permission.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

DescribeCustomRoutingAccelerator

$result = $client->describeCustomRoutingAccelerator([/* ... */]);
$promise = $client->describeCustomRoutingAcceleratorAsync([/* ... */]);

Describe a custom routing accelerator.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Accelerator' => [
        'AcceleratorArn' => '<string>',
        'CreatedTime' => <DateTime>,
        'DnsName' => '<string>',
        'Enabled' => true || false,
        'IpAddressType' => 'IPV4|DUAL_STACK',
        'IpSets' => [
            [
                'IpAddressFamily' => 'IPv4|IPv6',
                'IpAddresses' => ['<string>', ...],
                'IpFamily' => '<string>',
            ],
            // ...
        ],
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'Status' => 'DEPLOYED|IN_PROGRESS',
    ],
]

Result Details

Errors

AcceleratorNotFoundException:

The accelerator that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

DescribeCustomRoutingAcceleratorAttributes

$result = $client->describeCustomRoutingAcceleratorAttributes([/* ... */]);
$promise = $client->describeCustomRoutingAcceleratorAttributesAsync([/* ... */]);

Describe the attributes of a custom routing accelerator.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AcceleratorAttributes' => [
        'FlowLogsEnabled' => true || false,
        'FlowLogsS3Bucket' => '<string>',
        'FlowLogsS3Prefix' => '<string>',
    ],
]

Result Details

Errors

AcceleratorNotFoundException:

The accelerator that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

DescribeCustomRoutingEndpointGroup

$result = $client->describeCustomRoutingEndpointGroup([/* ... */]);
$promise = $client->describeCustomRoutingEndpointGroupAsync([/* ... */]);

Describe an endpoint group for a custom routing accelerator.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'EndpointGroup' => [
        'DestinationDescriptions' => [
            [
                'FromPort' => <integer>,
                'Protocols' => ['<string>', ...],
                'ToPort' => <integer>,
            ],
            // ...
        ],
        'EndpointDescriptions' => [
            [
                'EndpointId' => '<string>',
            ],
            // ...
        ],
        'EndpointGroupArn' => '<string>',
        'EndpointGroupRegion' => '<string>',
    ],
]

Result Details

Errors

InvalidArgumentException:

An argument that you specified is invalid.

EndpointGroupNotFoundException:

The endpoint group that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

DescribeCustomRoutingListener

$result = $client->describeCustomRoutingListener([/* ... */]);
$promise = $client->describeCustomRoutingListenerAsync([/* ... */]);

The description of a listener for a custom routing accelerator.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Listener' => [
        'ListenerArn' => '<string>',
        'PortRanges' => [
            [
                'FromPort' => <integer>,
                'ToPort' => <integer>,
            ],
            // ...
        ],
    ],
]

Result Details

Errors

InvalidArgumentException:

An argument that you specified is invalid.

ListenerNotFoundException:

The listener that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

DescribeEndpointGroup

$result = $client->describeEndpointGroup([/* ... */]);
$promise = $client->describeEndpointGroupAsync([/* ... */]);

Describe an endpoint group.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'EndpointGroup' => [
        'EndpointDescriptions' => [
            [
                'ClientIPPreservationEnabled' => true || false,
                'EndpointId' => '<string>',
                'HealthReason' => '<string>',
                'HealthState' => 'INITIAL|HEALTHY|UNHEALTHY',
                'Weight' => <integer>,
            ],
            // ...
        ],
        'EndpointGroupArn' => '<string>',
        'EndpointGroupRegion' => '<string>',
        'HealthCheckIntervalSeconds' => <integer>,
        'HealthCheckPath' => '<string>',
        'HealthCheckPort' => <integer>,
        'HealthCheckProtocol' => 'TCP|HTTP|HTTPS',
        'PortOverrides' => [
            [
                'EndpointPort' => <integer>,
                'ListenerPort' => <integer>,
            ],
            // ...
        ],
        'ThresholdCount' => <integer>,
        'TrafficDialPercentage' => <float>,
    ],
]

Result Details

Errors

InvalidArgumentException:

An argument that you specified is invalid.

EndpointGroupNotFoundException:

The endpoint group that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

DescribeListener

$result = $client->describeListener([/* ... */]);
$promise = $client->describeListenerAsync([/* ... */]);

Describe a listener.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Listener' => [
        'ClientAffinity' => 'NONE|SOURCE_IP',
        'ListenerArn' => '<string>',
        'PortRanges' => [
            [
                'FromPort' => <integer>,
                'ToPort' => <integer>,
            ],
            // ...
        ],
        'Protocol' => 'TCP|UDP',
    ],
]

Result Details

Errors

InvalidArgumentException:

An argument that you specified is invalid.

ListenerNotFoundException:

The listener that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

ListAccelerators

$result = $client->listAccelerators([/* ... */]);
$promise = $client->listAcceleratorsAsync([/* ... */]);

List the accelerators for an Amazon Web Services account.

Parameter Syntax

$result = $client->listAccelerators([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Accelerators' => [
        [
            'AcceleratorArn' => '<string>',
            'CreatedTime' => <DateTime>,
            'DnsName' => '<string>',
            'DualStackDnsName' => '<string>',
            'Enabled' => true || false,
            'Events' => [
                [
                    'Message' => '<string>',
                    'Timestamp' => <DateTime>,
                ],
                // ...
            ],
            'IpAddressType' => 'IPV4|DUAL_STACK',
            'IpSets' => [
                [
                    'IpAddressFamily' => 'IPv4|IPv6',
                    'IpAddresses' => ['<string>', ...],
                    'IpFamily' => '<string>',
                ],
                // ...
            ],
            'LastModifiedTime' => <DateTime>,
            'Name' => '<string>',
            'Status' => 'DEPLOYED|IN_PROGRESS',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidArgumentException:

An argument that you specified is invalid.

InvalidNextTokenException:

There isn't another item to return.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

ListByoipCidrs

$result = $client->listByoipCidrs([/* ... */]);
$promise = $client->listByoipCidrsAsync([/* ... */]);

Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including the current state and a history of state changes.

Parameter Syntax

$result = $client->listByoipCidrs([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ByoipCidrs' => [
        [
            'Cidr' => '<string>',
            'Events' => [
                [
                    'Message' => '<string>',
                    'Timestamp' => <DateTime>,
                ],
                // ...
            ],
            'State' => 'PENDING_PROVISIONING|READY|PENDING_ADVERTISING|ADVERTISING|PENDING_WITHDRAWING|PENDING_DEPROVISIONING|DEPROVISIONED|FAILED_PROVISION|FAILED_ADVERTISING|FAILED_WITHDRAW|FAILED_DEPROVISION',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

AccessDeniedException:

You don't have access permission.

InvalidNextTokenException:

There isn't another item to return.

ListCrossAccountAttachments

$result = $client->listCrossAccountAttachments([/* ... */]);
$promise = $client->listCrossAccountAttachmentsAsync([/* ... */]);

List the cross-account attachments that have been created in Global Accelerator.

Parameter Syntax

$result = $client->listCrossAccountAttachments([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'CrossAccountAttachments' => [
        [
            'AttachmentArn' => '<string>',
            'CreatedTime' => <DateTime>,
            'LastModifiedTime' => <DateTime>,
            'Name' => '<string>',
            'Principals' => ['<string>', ...],
            'Resources' => [
                [
                    'Cidr' => '<string>',
                    'EndpointId' => '<string>',
                    'Region' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You don't have access permission.

InvalidArgumentException:

An argument that you specified is invalid.

InvalidNextTokenException:

There isn't another item to return.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

ListCrossAccountResourceAccounts

$result = $client->listCrossAccountResourceAccounts([/* ... */]);
$promise = $client->listCrossAccountResourceAccountsAsync([/* ... */]);

List the accounts that have cross-account resources.

For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.

Parameter Syntax

$result = $client->listCrossAccountResourceAccounts([
]);

Parameter Details

Result Syntax

[
    'ResourceOwnerAwsAccountIds' => ['<string>', ...],
]

Result Details

Errors

AccessDeniedException:

You don't have access permission.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

ListCrossAccountResources

$result = $client->listCrossAccountResources([/* ... */]);
$promise = $client->listCrossAccountResourcesAsync([/* ... */]);

List the cross-account resources available to work with.

Parameter Syntax

$result = $client->listCrossAccountResources([
    'AcceleratorArn' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceOwnerAwsAccountId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CrossAccountResources' => [
        [
            'AttachmentArn' => '<string>',
            'Cidr' => '<string>',
            'EndpointId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

InvalidNextTokenException:

There isn't another item to return.

AccessDeniedException:

You don't have access permission.

AcceleratorNotFoundException:

The accelerator that you specified doesn't exist.

ListCustomRoutingAccelerators

$result = $client->listCustomRoutingAccelerators([/* ... */]);
$promise = $client->listCustomRoutingAcceleratorsAsync([/* ... */]);

List the custom routing accelerators for an Amazon Web Services account.

Parameter Syntax

$result = $client->listCustomRoutingAccelerators([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Accelerators' => [
        [
            'AcceleratorArn' => '<string>',
            'CreatedTime' => <DateTime>,
            'DnsName' => '<string>',
            'Enabled' => true || false,
            'IpAddressType' => 'IPV4|DUAL_STACK',
            'IpSets' => [
                [
                    'IpAddressFamily' => 'IPv4|IPv6',
                    'IpAddresses' => ['<string>', ...],
                    'IpFamily' => '<string>',
                ],
                // ...
            ],
            'LastModifiedTime' => <DateTime>,
            'Name' => '<string>',
            'Status' => 'DEPLOYED|IN_PROGRESS',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidArgumentException:

An argument that you specified is invalid.

InvalidNextTokenException:

There isn't another item to return.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

ListCustomRoutingEndpointGroups

$result = $client->listCustomRoutingEndpointGroups([/* ... */]);
$promise = $client->listCustomRoutingEndpointGroupsAsync([/* ... */]);

List the endpoint groups that are associated with a listener for a custom routing accelerator.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'EndpointGroups' => [
        [
            'DestinationDescriptions' => [
                [
                    'FromPort' => <integer>,
                    'Protocols' => ['<string>', ...],
                    'ToPort' => <integer>,
                ],
                // ...
            ],
            'EndpointDescriptions' => [
                [
                    'EndpointId' => '<string>',
                ],
                // ...
            ],
            'EndpointGroupArn' => '<string>',
            'EndpointGroupRegion' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ListenerNotFoundException:

The listener that you specified doesn't exist.

InvalidNextTokenException:

There isn't another item to return.

InvalidArgumentException:

An argument that you specified is invalid.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

ListCustomRoutingListeners

$result = $client->listCustomRoutingListeners([/* ... */]);
$promise = $client->listCustomRoutingListenersAsync([/* ... */]);

List the listeners for a custom routing accelerator.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Listeners' => [
        [
            'ListenerArn' => '<string>',
            'PortRanges' => [
                [
                    'FromPort' => <integer>,
                    'ToPort' => <integer>,
                ],
                // ...
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidArgumentException:

An argument that you specified is invalid.

AcceleratorNotFoundException:

The accelerator that you specified doesn't exist.

InvalidNextTokenException:

There isn't another item to return.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

ListCustomRoutingPortMappings

$result = $client->listCustomRoutingPortMappings([/* ... */]);
$promise = $client->listCustomRoutingPortMappingsAsync([/* ... */]);

Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance IP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator. For each subnet endpoint that you add, Global Accelerator creates a new static port mapping for the accelerator. The port mappings don't change after Global Accelerator generates them, so you can retrieve and cache the full mapping on your servers.

If you remove a subnet from your accelerator, Global Accelerator removes (reclaims) the port mappings. If you add a subnet to your accelerator, Global Accelerator creates new port mappings (the existing ones don't change). If you add or remove EC2 instances in your subnet, the port mappings don't change, because the mappings are created when you add the subnet to Global Accelerator.

The mappings also include a flag for each destination denoting which destination IP addresses and ports are allowed or denied traffic.

Parameter Syntax

$result = $client->listCustomRoutingPortMappings([
    'AcceleratorArn' => '<string>', // REQUIRED
    'EndpointGroupArn' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'PortMappings' => [
        [
            'AcceleratorPort' => <integer>,
            'DestinationSocketAddress' => [
                'IpAddress' => '<string>',
                'Port' => <integer>,
            ],
            'DestinationTrafficState' => 'ALLOW|DENY',
            'EndpointGroupArn' => '<string>',
            'EndpointId' => '<string>',
            'Protocols' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidArgumentException:

An argument that you specified is invalid.

InvalidNextTokenException:

There isn't another item to return.

EndpointGroupNotFoundException:

The endpoint group that you specified doesn't exist.

AcceleratorNotFoundException:

The accelerator that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

ListCustomRoutingPortMappingsByDestination

$result = $client->listCustomRoutingPortMappingsByDestination([/* ... */]);
$promise = $client->listCustomRoutingPortMappingsByDestinationAsync([/* ... */]);

List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint. The response is the mappings for one destination IP address. This is useful when your subnet endpoint has mappings that span multiple custom routing accelerators in your account, or for scenarios where you only want to list the port mappings for a specific destination instance.

Parameter Syntax

$result = $client->listCustomRoutingPortMappingsByDestination([
    'DestinationAddress' => '<string>', // REQUIRED
    'EndpointId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DestinationPortMappings' => [
        [
            'AcceleratorArn' => '<string>',
            'AcceleratorSocketAddresses' => [
                [
                    'IpAddress' => '<string>',
                    'Port' => <integer>,
                ],
                // ...
            ],
            'DestinationSocketAddress' => [
                'IpAddress' => '<string>',
                'Port' => <integer>,
            ],
            'DestinationTrafficState' => 'ALLOW|DENY',
            'EndpointGroupArn' => '<string>',
            'EndpointGroupRegion' => '<string>',
            'EndpointId' => '<string>',
            'IpAddressType' => 'IPV4|DUAL_STACK',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidArgumentException:

An argument that you specified is invalid.

InvalidNextTokenException:

There isn't another item to return.

EndpointNotFoundException:

The endpoint that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

ListEndpointGroups

$result = $client->listEndpointGroups([/* ... */]);
$promise = $client->listEndpointGroupsAsync([/* ... */]);

List the endpoint groups that are associated with a listener.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'EndpointGroups' => [
        [
            'EndpointDescriptions' => [
                [
                    'ClientIPPreservationEnabled' => true || false,
                    'EndpointId' => '<string>',
                    'HealthReason' => '<string>',
                    'HealthState' => 'INITIAL|HEALTHY|UNHEALTHY',
                    'Weight' => <integer>,
                ],
                // ...
            ],
            'EndpointGroupArn' => '<string>',
            'EndpointGroupRegion' => '<string>',
            'HealthCheckIntervalSeconds' => <integer>,
            'HealthCheckPath' => '<string>',
            'HealthCheckPort' => <integer>,
            'HealthCheckProtocol' => 'TCP|HTTP|HTTPS',
            'PortOverrides' => [
                [
                    'EndpointPort' => <integer>,
                    'ListenerPort' => <integer>,
                ],
                // ...
            ],
            'ThresholdCount' => <integer>,
            'TrafficDialPercentage' => <float>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ListenerNotFoundException:

The listener that you specified doesn't exist.

InvalidNextTokenException:

There isn't another item to return.

InvalidArgumentException:

An argument that you specified is invalid.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

ListListeners

$result = $client->listListeners([/* ... */]);
$promise = $client->listListenersAsync([/* ... */]);

List the listeners for an accelerator.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Listeners' => [
        [
            'ClientAffinity' => 'NONE|SOURCE_IP',
            'ListenerArn' => '<string>',
            'PortRanges' => [
                [
                    'FromPort' => <integer>,
                    'ToPort' => <integer>,
                ],
                // ...
            ],
            'Protocol' => 'TCP|UDP',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidArgumentException:

An argument that you specified is invalid.

AcceleratorNotFoundException:

The accelerator that you specified doesn't exist.

InvalidNextTokenException:

There isn't another item to return.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

List all tags for an accelerator.

For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

AcceleratorNotFoundException:

The accelerator that you specified doesn't exist.

AttachmentNotFoundException:

No cross-account attachment was found.

EndpointGroupNotFoundException:

The endpoint group that you specified doesn't exist.

ListenerNotFoundException:

The listener that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

ProvisionByoipCidr

$result = $client->provisionByoipCidr([/* ... */]);
$promise = $client->provisionByoipCidrAsync([/* ... */]);

Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.

For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

Parameter Syntax

$result = $client->provisionByoipCidr([
    'Cidr' => '<string>', // REQUIRED
    'CidrAuthorizationContext' => [ // REQUIRED
        'Message' => '<string>', // REQUIRED
        'Signature' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'ByoipCidr' => [
        'Cidr' => '<string>',
        'Events' => [
            [
                'Message' => '<string>',
                'Timestamp' => <DateTime>,
            ],
            // ...
        ],
        'State' => 'PENDING_PROVISIONING|READY|PENDING_ADVERTISING|ADVERTISING|PENDING_WITHDRAWING|PENDING_DEPROVISIONING|DEPROVISIONED|FAILED_PROVISION|FAILED_ADVERTISING|FAILED_WITHDRAW|FAILED_DEPROVISION',
    ],
]

Result Details

Errors

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

LimitExceededException:

Processing your request would cause you to exceed an Global Accelerator limit.

AccessDeniedException:

You don't have access permission.

IncorrectCidrStateException:

The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be incorrect for this action.

RemoveCustomRoutingEndpoints

$result = $client->removeCustomRoutingEndpoints([/* ... */]);
$promise = $client->removeCustomRoutingEndpointsAsync([/* ... */]);

Remove endpoints from a custom routing accelerator.

Parameter Syntax

$result = $client->removeCustomRoutingEndpoints([
    'EndpointGroupArn' => '<string>', // REQUIRED
    'EndpointIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EndpointGroupNotFoundException:

The endpoint group that you specified doesn't exist.

EndpointNotFoundException:

The endpoint that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

AccessDeniedException:

You don't have access permission.

ConflictException:

You can't use both of those options.

RemoveEndpoints

$result = $client->removeEndpoints([/* ... */]);
$promise = $client->removeEndpointsAsync([/* ... */]);

Remove endpoints from an endpoint group.

The RemoveEndpoints API operation is the recommended option for removing endpoints. The alternative is to remove endpoints by updating an endpoint group by using the UpdateEndpointGroup API operation. There are two advantages to using AddEndpoints to remove endpoints instead:

• It's more convenient, because you only need to specify the endpoints that you want to remove. With the UpdateEndpointGroup API operation, you must specify all of the endpoints in the endpoint group except the ones that you want to remove from the group.

• It's faster, because Global Accelerator doesn't need to resolve any endpoints. With the UpdateEndpointGroup API operation, Global Accelerator must resolve all of the endpoints that remain in the group.

Parameter Syntax

$result = $client->removeEndpoints([
    'EndpointGroupArn' => '<string>', // REQUIRED
    'EndpointIdentifiers' => [ // REQUIRED
        [
            'ClientIPPreservationEnabled' => true || false,
            'EndpointId' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EndpointGroupNotFoundException:

The endpoint group that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

AccessDeniedException:

You don't have access permission.

TransactionInProgressException:

There's already a transaction in progress. Another transaction can't be processed.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Add tags to an accelerator resource.

For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AcceleratorNotFoundException:

The accelerator that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Remove tags from a Global Accelerator resource. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from an accelerator that was already removed.

For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AcceleratorNotFoundException:

The accelerator that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

UpdateAccelerator

$result = $client->updateAccelerator([/* ... */]);
$promise = $client->updateAcceleratorAsync([/* ... */]);

Update an accelerator to make changes, such as the following:

• Change the name of the accelerator.

• Disable the accelerator so that it no longer accepts or routes traffic, or so that you can delete it.

• Enable the accelerator, if it is disabled.

• Change the IP address type to dual-stack if it is IPv4, or change the IP address type to IPv4 if it's dual-stack.

Be aware that static IP addresses remain assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete the accelerator, you lose the static IP addresses that are assigned to it, so you can no longer route traffic by using them.

Parameter Syntax

$result = $client->updateAccelerator([
    'AcceleratorArn' => '<string>', // REQUIRED
    'Enabled' => true || false,
    'IpAddressType' => 'IPV4|DUAL_STACK',
    'IpAddresses' => ['<string>', ...],
    'Name' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Accelerator' => [
        'AcceleratorArn' => '<string>',
        'CreatedTime' => <DateTime>,
        'DnsName' => '<string>',
        'DualStackDnsName' => '<string>',
        'Enabled' => true || false,
        'Events' => [
            [
                'Message' => '<string>',
                'Timestamp' => <DateTime>,
            ],
            // ...
        ],
        'IpAddressType' => 'IPV4|DUAL_STACK',
        'IpSets' => [
            [
                'IpAddressFamily' => 'IPv4|IPv6',
                'IpAddresses' => ['<string>', ...],
                'IpFamily' => '<string>',
            ],
            // ...
        ],
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'Status' => 'DEPLOYED|IN_PROGRESS',
    ],
]

Result Details

Errors

AcceleratorNotFoundException:

The accelerator that you specified doesn't exist.

AccessDeniedException:

You don't have access permission.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

TransactionInProgressException:

There's already a transaction in progress. Another transaction can't be processed.

ConflictException:

You can't use both of those options.

UpdateAcceleratorAttributes

$result = $client->updateAcceleratorAttributes([/* ... */]);
$promise = $client->updateAcceleratorAttributesAsync([/* ... */]);

Update the attributes for an accelerator.

Parameter Syntax

$result = $client->updateAcceleratorAttributes([
    'AcceleratorArn' => '<string>', // REQUIRED
    'FlowLogsEnabled' => true || false,
    'FlowLogsS3Bucket' => '<string>',
    'FlowLogsS3Prefix' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AcceleratorAttributes' => [
        'FlowLogsEnabled' => true || false,
        'FlowLogsS3Bucket' => '<string>',
        'FlowLogsS3Prefix' => '<string>',
    ],
]

Result Details

Errors

AcceleratorNotFoundException:

The accelerator that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

AccessDeniedException:

You don't have access permission.

TransactionInProgressException:

There's already a transaction in progress. Another transaction can't be processed.

UpdateCrossAccountAttachment

$result = $client->updateCrossAccountAttachment([/* ... */]);
$promise = $client->updateCrossAccountAttachmentAsync([/* ... */]);

Update a cross-account attachment to add or remove principals or resources. When you update an attachment to remove a principal (account ID or accelerator) or a resource, Global Accelerator revokes the permission for specific resources.

For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.

Parameter Syntax

$result = $client->updateCrossAccountAttachment([
    'AddPrincipals' => ['<string>', ...],
    'AddResources' => [
        [
            'Cidr' => '<string>',
            'EndpointId' => '<string>',
            'Region' => '<string>',
        ],
        // ...
    ],
    'AttachmentArn' => '<string>', // REQUIRED
    'Name' => '<string>',
    'RemovePrincipals' => ['<string>', ...],
    'RemoveResources' => [
        [
            'Cidr' => '<string>',
            'EndpointId' => '<string>',
            'Region' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'CrossAccountAttachment' => [
        'AttachmentArn' => '<string>',
        'CreatedTime' => <DateTime>,
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'Principals' => ['<string>', ...],
        'Resources' => [
            [
                'Cidr' => '<string>',
                'EndpointId' => '<string>',
                'Region' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

AttachmentNotFoundException:

No cross-account attachment was found.

AccessDeniedException:

You don't have access permission.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

LimitExceededException:

Processing your request would cause you to exceed an Global Accelerator limit.

TransactionInProgressException:

There's already a transaction in progress. Another transaction can't be processed.

UpdateCustomRoutingAccelerator

$result = $client->updateCustomRoutingAccelerator([/* ... */]);
$promise = $client->updateCustomRoutingAcceleratorAsync([/* ... */]);

Update a custom routing accelerator.

Parameter Syntax

$result = $client->updateCustomRoutingAccelerator([
    'AcceleratorArn' => '<string>', // REQUIRED
    'Enabled' => true || false,
    'IpAddressType' => 'IPV4|DUAL_STACK',
    'IpAddresses' => ['<string>', ...],
    'Name' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Accelerator' => [
        'AcceleratorArn' => '<string>',
        'CreatedTime' => <DateTime>,
        'DnsName' => '<string>',
        'Enabled' => true || false,
        'IpAddressType' => 'IPV4|DUAL_STACK',
        'IpSets' => [
            [
                'IpAddressFamily' => 'IPv4|IPv6',
                'IpAddresses' => ['<string>', ...],
                'IpFamily' => '<string>',
            ],
            // ...
        ],
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'Status' => 'DEPLOYED|IN_PROGRESS',
    ],
]

Result Details

Errors

AcceleratorNotFoundException:

The accelerator that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

TransactionInProgressException:

There's already a transaction in progress. Another transaction can't be processed.

ConflictException:

You can't use both of those options.

UpdateCustomRoutingAcceleratorAttributes

$result = $client->updateCustomRoutingAcceleratorAttributes([/* ... */]);
$promise = $client->updateCustomRoutingAcceleratorAttributesAsync([/* ... */]);

Update the attributes for a custom routing accelerator.

Parameter Syntax

$result = $client->updateCustomRoutingAcceleratorAttributes([
    'AcceleratorArn' => '<string>', // REQUIRED
    'FlowLogsEnabled' => true || false,
    'FlowLogsS3Bucket' => '<string>',
    'FlowLogsS3Prefix' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AcceleratorAttributes' => [
        'FlowLogsEnabled' => true || false,
        'FlowLogsS3Bucket' => '<string>',
        'FlowLogsS3Prefix' => '<string>',
    ],
]

Result Details

Errors

AcceleratorNotFoundException:

The accelerator that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

AccessDeniedException:

You don't have access permission.

TransactionInProgressException:

There's already a transaction in progress. Another transaction can't be processed.

UpdateCustomRoutingListener

$result = $client->updateCustomRoutingListener([/* ... */]);
$promise = $client->updateCustomRoutingListenerAsync([/* ... */]);

Update a listener for a custom routing accelerator.

Parameter Syntax

$result = $client->updateCustomRoutingListener([
    'ListenerArn' => '<string>', // REQUIRED
    'PortRanges' => [ // REQUIRED
        [
            'FromPort' => <integer>,
            'ToPort' => <integer>,
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Listener' => [
        'ListenerArn' => '<string>',
        'PortRanges' => [
            [
                'FromPort' => <integer>,
                'ToPort' => <integer>,
            ],
            // ...
        ],
    ],
]

Result Details

Errors

InvalidArgumentException:

An argument that you specified is invalid.

InvalidPortRangeException:

The port numbers that you specified are not valid numbers or are not unique for this accelerator.

ListenerNotFoundException:

The listener that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

LimitExceededException:

Processing your request would cause you to exceed an Global Accelerator limit.

UpdateEndpointGroup

$result = $client->updateEndpointGroup([/* ... */]);
$promise = $client->updateEndpointGroupAsync([/* ... */]);

Update an endpoint group. A resource must be valid and active when you add it as an endpoint.

Parameter Syntax

$result = $client->updateEndpointGroup([
    'EndpointConfigurations' => [
        [
            'AttachmentArn' => '<string>',
            'ClientIPPreservationEnabled' => true || false,
            'EndpointId' => '<string>',
            'Weight' => <integer>,
        ],
        // ...
    ],
    'EndpointGroupArn' => '<string>', // REQUIRED
    'HealthCheckIntervalSeconds' => <integer>,
    'HealthCheckPath' => '<string>',
    'HealthCheckPort' => <integer>,
    'HealthCheckProtocol' => 'TCP|HTTP|HTTPS',
    'PortOverrides' => [
        [
            'EndpointPort' => <integer>,
            'ListenerPort' => <integer>,
        ],
        // ...
    ],
    'ThresholdCount' => <integer>,
    'TrafficDialPercentage' => <float>,
]);

Parameter Details

Result Syntax

[
    'EndpointGroup' => [
        'EndpointDescriptions' => [
            [
                'ClientIPPreservationEnabled' => true || false,
                'EndpointId' => '<string>',
                'HealthReason' => '<string>',
                'HealthState' => 'INITIAL|HEALTHY|UNHEALTHY',
                'Weight' => <integer>,
            ],
            // ...
        ],
        'EndpointGroupArn' => '<string>',
        'EndpointGroupRegion' => '<string>',
        'HealthCheckIntervalSeconds' => <integer>,
        'HealthCheckPath' => '<string>',
        'HealthCheckPort' => <integer>,
        'HealthCheckProtocol' => 'TCP|HTTP|HTTPS',
        'PortOverrides' => [
            [
                'EndpointPort' => <integer>,
                'ListenerPort' => <integer>,
            ],
            // ...
        ],
        'ThresholdCount' => <integer>,
        'TrafficDialPercentage' => <float>,
    ],
]

Result Details

Errors

InvalidArgumentException:

An argument that you specified is invalid.

EndpointGroupNotFoundException:

The endpoint group that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

LimitExceededException:

Processing your request would cause you to exceed an Global Accelerator limit.

AccessDeniedException:

You don't have access permission.

UpdateListener

$result = $client->updateListener([/* ... */]);
$promise = $client->updateListenerAsync([/* ... */]);

Update a listener.

Parameter Syntax

$result = $client->updateListener([
    'ClientAffinity' => 'NONE|SOURCE_IP',
    'ListenerArn' => '<string>', // REQUIRED
    'PortRanges' => [
        [
            'FromPort' => <integer>,
            'ToPort' => <integer>,
        ],
        // ...
    ],
    'Protocol' => 'TCP|UDP',
]);

Parameter Details

Result Syntax

[
    'Listener' => [
        'ClientAffinity' => 'NONE|SOURCE_IP',
        'ListenerArn' => '<string>',
        'PortRanges' => [
            [
                'FromPort' => <integer>,
                'ToPort' => <integer>,
            ],
            // ...
        ],
        'Protocol' => 'TCP|UDP',
    ],
]

Result Details

Errors

InvalidArgumentException:

An argument that you specified is invalid.

InvalidPortRangeException:

The port numbers that you specified are not valid numbers or are not unique for this accelerator.

ListenerNotFoundException:

The listener that you specified doesn't exist.

InternalServiceErrorException:

There was an internal error for Global Accelerator.

LimitExceededException:

Processing your request would cause you to exceed an Global Accelerator limit.

WithdrawByoipCidr

$result = $client->withdrawByoipCidr([/* ... */]);
$promise = $client->withdrawByoipCidrAsync([/* ... */]);

Stops advertising an address range that is provisioned as an address pool. You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.

It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of propagation delays.

For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ByoipCidr' => [
        'Cidr' => '<string>',
        'Events' => [
            [
                'Message' => '<string>',
                'Timestamp' => <DateTime>,
            ],
            // ...
        ],
        'State' => 'PENDING_PROVISIONING|READY|PENDING_ADVERTISING|ADVERTISING|PENDING_WITHDRAWING|PENDING_DEPROVISIONING|DEPROVISIONED|FAILED_PROVISION|FAILED_ADVERTISING|FAILED_WITHDRAW|FAILED_DEPROVISION',
    ],
]

Result Details

Errors

InternalServiceErrorException:

There was an internal error for Global Accelerator.

InvalidArgumentException:

An argument that you specified is invalid.

AccessDeniedException:

You don't have access permission.

ByoipCidrNotFoundException:

The CIDR that you specified was not found or is incorrect.

IncorrectCidrStateException:

The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be incorrect for this action.