GlobalAccelerator

Client

class GlobalAccelerator.Client

A low-level client representing AWS Global Accelerator:

client = session.create_client('globalaccelerator')

These are the available methods:

advertise_byoip_cidr(**kwargs)

Advertises an IPv4 address range that is provisioned for use with your AWS resources through bring your own IP addresses (BYOIP). It can take a few minutes before traffic to the specified addresses starts routing to AWS because of propagation delays. To see an AWS CLI example of advertising an address range, scroll down to Example .

To stop advertising the BYOIP address range, use WithdrawByoipCidr .

For more information, see Bring Your Own IP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.advertise_byoip_cidr(
    Cidr='string'
)
Parameters
Cidr (string) --

[REQUIRED]

The address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only a portion of the provisioned range.

Return type
dict
Returns
Response Syntax
{
    'ByoipCidr': {
        'Cidr': 'string',
        'State': 'PENDING_PROVISIONING'|'READY'|'PENDING_ADVERTISING'|'ADVERTISING'|'PENDING_WITHDRAWING'|'PENDING_DEPROVISIONING'|'DEPROVISIONED'|'FAILED_PROVISION'|'FAILED_ADVERTISING'|'FAILED_WITHDRAW'|'FAILED_DEPROVISION',
        'Events': [
            {
                'Message': 'string',
                'Timestamp': datetime(2015, 1, 1)
            },
        ]
    }
}

Response Structure

  • (dict) --
    • ByoipCidr (dict) --

      Information about the address range.

      • Cidr (string) --

        The address range, in CIDR notation.

      • State (string) --

        The state of the address pool.

      • Events (list) --

        A history of status changes for an IP address range that that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

        • (dict) --

          A complex type that contains a Message and a Timestamp value for changes that you make in the status an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

          • Message (string) --

            A string that contains an Event message describing changes that you make in the status of an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

          • Timestamp (datetime) --

            A timestamp when you make a status change for an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

Exceptions

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_accelerator(**kwargs)

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. To see an AWS CLI example of creating an accelerator, scroll down to Example .

If you bring your own IP address ranges to AWS Global Accelerator (BYOIP), you can assign IP addresses from your own pool to your accelerator as the static IP address entry points. Only one IP address from each of your IP address ranges can be used for each accelerator.

Warning

You must specify the US West (Oregon) Region to create or update accelerators.

See also: AWS API Documentation

Request Syntax

response = client.create_accelerator(
    Name='string',
    IpAddressType='IPV4',
    IpAddresses=[
        'string',
    ],
    Enabled=True|False,
    IdempotencyToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name of an accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

  • IpAddressType (string) -- The value for the address type must be IPv4.
  • IpAddresses (list) --

    Optionally, if you've added your own IP address pool to Global Accelerator, you can choose IP addresses from your own pool to use for the accelerator's static IP addresses. You can specify one or two addresses, separated by a comma. Do not include the /32 suffix.

    If you specify only one IP address from your IP address range, Global Accelerator assigns a second static IP address for the accelerator from the AWS IP address pool.

    For more information, see Bring Your Own IP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide .

    • (string) --
  • Enabled (boolean) --

    Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

    If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.

  • IdempotencyToken (string) --

    [REQUIRED]

    A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of an accelerator.

    This field is autopopulated if not provided.

  • Tags (list) --

    Create tags for an accelerator.

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

    • (dict) --

      A complex type that contains a Tag key and Tag value.

      • Key (string) -- [REQUIRED]

        A string that contains a Tag key.

      • Value (string) -- [REQUIRED]

        A string that contains a Tag value.

Return type

dict

Returns

Response Syntax

{
    'Accelerator': {
        'AcceleratorArn': 'string',
        'Name': 'string',
        'IpAddressType': 'IPV4',
        'Enabled': True|False,
        'IpSets': [
            {
                'IpFamily': 'string',
                'IpAddresses': [
                    'string',
                ]
            },
        ],
        'DnsName': 'string',
        'Status': 'DEPLOYED'|'IN_PROGRESS',
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • Accelerator (dict) --

      The accelerator that is created by specifying a listener and the supported IP address types.

      • AcceleratorArn (string) --

        The Amazon Resource Name (ARN) of the accelerator.

      • Name (string) --

        The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

      • IpAddressType (string) --

        The value for the address type must be IPv4.

      • Enabled (boolean) --

        Indicates whether the accelerator is enabled. The value is true or false. The default value is true.

        If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.

      • IpSets (list) --

        The static IP addresses that Global Accelerator associates with the accelerator.

        • (dict) --

          A complex type for the set of IP addresses for an accelerator.

          • IpFamily (string) --

            The types of IP addresses included in this IP set.

          • IpAddresses (list) --

            The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.

            • (string) --
      • DnsName (string) --

        The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.

        The naming convention for the DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.

        For more information about the default DNS name, see Support for DNS Addressing in Global Accelerator in the AWS Global Accelerator Developer Guide .

      • Status (string) --

        Describes the deployment status of the accelerator.

      • CreatedTime (datetime) --

        The date and time that the accelerator was created.

      • LastModifiedTime (datetime) --

        The date and time that the accelerator was last modified.

Exceptions

create_endpoint_group(**kwargs)

Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one AWS Region. To see an AWS CLI example of creating an endpoint group, scroll down to Example .

See also: AWS API Documentation

Request Syntax

response = client.create_endpoint_group(
    ListenerArn='string',
    EndpointGroupRegion='string',
    EndpointConfigurations=[
        {
            'EndpointId': 'string',
            'Weight': 123,
            'ClientIPPreservationEnabled': True|False
        },
    ],
    TrafficDialPercentage=...,
    HealthCheckPort=123,
    HealthCheckProtocol='TCP'|'HTTP'|'HTTPS',
    HealthCheckPath='string',
    HealthCheckIntervalSeconds=123,
    ThresholdCount=123,
    IdempotencyToken='string'
)
Parameters
  • ListenerArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the listener.

  • EndpointGroupRegion (string) --

    [REQUIRED]

    The name of the AWS Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.

  • EndpointConfigurations (list) --

    The list of endpoint objects.

    • (dict) --

      A complex type for endpoints.

      • EndpointId (string) --

        An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For EC2 instances, this is the EC2 instance ID.

        An Application Load Balancer can be either internal or internet-facing.

      • Weight (integer) --

        The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide .

      • ClientIPPreservationEnabled (boolean) --

        Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.

        If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

        For more information, see Preserve Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide .

  • TrafficDialPercentage (float) --

    The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.

    Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

    The default value is 100.

  • HealthCheckPort (integer) -- The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list.
  • HealthCheckProtocol (string) -- The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
  • HealthCheckPath (string) -- If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).
  • HealthCheckIntervalSeconds (integer) -- The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
  • ThresholdCount (integer) -- The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
  • IdempotencyToken (string) --

    [REQUIRED]

    A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'EndpointGroup': {
        'EndpointGroupArn': 'string',
        'EndpointGroupRegion': 'string',
        'EndpointDescriptions': [
            {
                'EndpointId': 'string',
                'Weight': 123,
                'HealthState': 'INITIAL'|'HEALTHY'|'UNHEALTHY',
                'HealthReason': 'string',
                'ClientIPPreservationEnabled': True|False
            },
        ],
        'TrafficDialPercentage': ...,
        'HealthCheckPort': 123,
        'HealthCheckProtocol': 'TCP'|'HTTP'|'HTTPS',
        'HealthCheckPath': 'string',
        'HealthCheckIntervalSeconds': 123,
        'ThresholdCount': 123
    }
}

Response Structure

  • (dict) --

    • EndpointGroup (dict) --

      The information about the endpoint group that was created.

      • EndpointGroupArn (string) --

        The Amazon Resource Name (ARN) of the endpoint group.

      • EndpointGroupRegion (string) --

        The AWS Region that this endpoint group belongs.

      • EndpointDescriptions (list) --

        The list of endpoint objects.

        • (dict) --

          A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.

          • EndpointId (string) --

            An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For EC2 instances, this is the EC2 instance ID.

            An Application Load Balancer can be either internal or internet-facing.

          • Weight (integer) --

            The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide .

          • HealthState (string) --

            The health status of the endpoint.

          • HealthReason (string) --

            The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided.

            If the endpoint state is unhealthy , the reason code can be one of the following values:

            • Timeout : The health check requests to the endpoint are timing out before returning a status.
            • Failed : The health check failed, for example because the endpoint response was invalid (malformed).

            If the endpoint state is initial , the reason code can be one of the following values:

            • ProvisioningInProgress : The endpoint is in the process of being provisioned.
            • InitialHealthChecking : Global Accelerator is still setting up the minimum number of health checks for the endpoint that are required to determine its health status.
          • ClientIPPreservationEnabled (boolean) --

            Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.

            If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

            For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide .

      • TrafficDialPercentage (float) --

        The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.

        Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

        The default value is 100.

      • HealthCheckPort (integer) --

        The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

        The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.

      • HealthCheckProtocol (string) --

        The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.

      • HealthCheckPath (string) --

        If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).

      • HealthCheckIntervalSeconds (integer) --

        The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.

      • ThresholdCount (integer) --

        The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

Exceptions

create_listener(**kwargs)

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. To see an AWS CLI example of creating a listener, scroll down to Example .

See also: AWS API Documentation

Request Syntax

response = client.create_listener(
    AcceleratorArn='string',
    PortRanges=[
        {
            'FromPort': 123,
            'ToPort': 123
        },
    ],
    Protocol='TCP'|'UDP',
    ClientAffinity='NONE'|'SOURCE_IP',
    IdempotencyToken='string'
)
Parameters
  • AcceleratorArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of your accelerator.

  • PortRanges (list) --

    [REQUIRED]

    The list of port ranges to support for connections from clients to your accelerator.

    • (dict) --

      A complex type for a range of ports for a listener.

      • FromPort (integer) --

        The first port in the range of ports, inclusive.

      • ToPort (integer) --

        The last port in the range of ports, inclusive.

  • Protocol (string) --

    [REQUIRED]

    The protocol for connections from clients to your accelerator.

  • ClientAffinity (string) --

    Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always route each client to the same specific endpoint.

    AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE , Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

    If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

    The default value is NONE .

  • IdempotencyToken (string) --

    [REQUIRED]

    A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'Listener': {
        'ListenerArn': 'string',
        'PortRanges': [
            {
                'FromPort': 123,
                'ToPort': 123
            },
        ],
        'Protocol': 'TCP'|'UDP',
        'ClientAffinity': 'NONE'|'SOURCE_IP'
    }
}

Response Structure

  • (dict) --

    • Listener (dict) --

      The listener that you've created.

      • ListenerArn (string) --

        The Amazon Resource Name (ARN) of the listener.

      • PortRanges (list) --

        The list of port ranges for the connections from clients to the accelerator.

        • (dict) --

          A complex type for a range of ports for a listener.

          • FromPort (integer) --

            The first port in the range of ports, inclusive.

          • ToPort (integer) --

            The last port in the range of ports, inclusive.

      • Protocol (string) --

        The protocol for the connections from clients to the accelerator.

      • ClientAffinity (string) --

        Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always route each client to the same specific endpoint.

        AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE , Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

        If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

        The default value is NONE .

Exceptions

delete_accelerator(**kwargs)

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.

Warning

When you create an accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. Alternatively, you can bring your own IP address ranges to Global Accelerator and assign IP addresses from those ranges.

The IP addresses are 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 an accelerator, you lose the static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them. As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see Authentication and Access Control in the AWS Global Accelerator Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.delete_accelerator(
    AcceleratorArn='string'
)
Parameters
AcceleratorArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of an accelerator.

Returns
None

Exceptions

delete_endpoint_group(**kwargs)

Delete an endpoint group from a listener.

See also: AWS API Documentation

Request Syntax

response = client.delete_endpoint_group(
    EndpointGroupArn='string'
)
Parameters
EndpointGroupArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the endpoint group to delete.

Returns
None

Exceptions

delete_listener(**kwargs)

Delete a listener from an accelerator.

See also: AWS API Documentation

Request Syntax

response = client.delete_listener(
    ListenerArn='string'
)
Parameters
ListenerArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the listener.

Returns
None

Exceptions

deprovision_byoip_cidr(**kwargs)

Releases the specified address range that you provisioned to use with your AWS resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool. To see an AWS CLI example of deprovisioning an address range, scroll down to Example .

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 AWS Global Accelerator Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.deprovision_byoip_cidr(
    Cidr='string'
)
Parameters
Cidr (string) --

[REQUIRED]

The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.

Return type
dict
Returns
Response Syntax
{
    'ByoipCidr': {
        'Cidr': 'string',
        'State': 'PENDING_PROVISIONING'|'READY'|'PENDING_ADVERTISING'|'ADVERTISING'|'PENDING_WITHDRAWING'|'PENDING_DEPROVISIONING'|'DEPROVISIONED'|'FAILED_PROVISION'|'FAILED_ADVERTISING'|'FAILED_WITHDRAW'|'FAILED_DEPROVISION',
        'Events': [
            {
                'Message': 'string',
                'Timestamp': datetime(2015, 1, 1)
            },
        ]
    }
}

Response Structure

  • (dict) --
    • ByoipCidr (dict) --

      Information about the address range.

      • Cidr (string) --

        The address range, in CIDR notation.

      • State (string) --

        The state of the address pool.

      • Events (list) --

        A history of status changes for an IP address range that that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

        • (dict) --

          A complex type that contains a Message and a Timestamp value for changes that you make in the status an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

          • Message (string) --

            A string that contains an Event message describing changes that you make in the status of an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

          • Timestamp (datetime) --

            A timestamp when you make a status change for an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

Exceptions

describe_accelerator(**kwargs)

Describe an accelerator. To see an AWS CLI example of describing an accelerator, scroll down to Example .

See also: AWS API Documentation

Request Syntax

response = client.describe_accelerator(
    AcceleratorArn='string'
)
Parameters
AcceleratorArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the accelerator to describe.

Return type
dict
Returns
Response Syntax
{
    'Accelerator': {
        'AcceleratorArn': 'string',
        'Name': 'string',
        'IpAddressType': 'IPV4',
        'Enabled': True|False,
        'IpSets': [
            {
                'IpFamily': 'string',
                'IpAddresses': [
                    'string',
                ]
            },
        ],
        'DnsName': 'string',
        'Status': 'DEPLOYED'|'IN_PROGRESS',
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --
    • Accelerator (dict) --

      The description of the accelerator.

      • AcceleratorArn (string) --

        The Amazon Resource Name (ARN) of the accelerator.

      • Name (string) --

        The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

      • IpAddressType (string) --

        The value for the address type must be IPv4.

      • Enabled (boolean) --

        Indicates whether the accelerator is enabled. The value is true or false. The default value is true.

        If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.

      • IpSets (list) --

        The static IP addresses that Global Accelerator associates with the accelerator.

        • (dict) --

          A complex type for the set of IP addresses for an accelerator.

          • IpFamily (string) --

            The types of IP addresses included in this IP set.

          • IpAddresses (list) --

            The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.

            • (string) --
      • DnsName (string) --

        The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.

        The naming convention for the DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.

        For more information about the default DNS name, see Support for DNS Addressing in Global Accelerator in the AWS Global Accelerator Developer Guide .

      • Status (string) --

        Describes the deployment status of the accelerator.

      • CreatedTime (datetime) --

        The date and time that the accelerator was created.

      • LastModifiedTime (datetime) --

        The date and time that the accelerator was last modified.

Exceptions

describe_accelerator_attributes(**kwargs)

Describe the attributes of an accelerator. To see an AWS CLI example of describing the attributes of an accelerator, scroll down to Example .

See also: AWS API Documentation

Request Syntax

response = client.describe_accelerator_attributes(
    AcceleratorArn='string'
)
Parameters
AcceleratorArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the accelerator with the attributes that you want to describe.

Return type
dict
Returns
Response Syntax
{
    'AcceleratorAttributes': {
        'FlowLogsEnabled': True|False,
        'FlowLogsS3Bucket': 'string',
        'FlowLogsS3Prefix': 'string'
    }
}

Response Structure

  • (dict) --
    • AcceleratorAttributes (dict) --

      The attributes of the accelerator.

      • FlowLogsEnabled (boolean) --

        Indicates whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.

        For more information, see Flow Logs in the AWS Global Accelerator Developer Guide .

      • FlowLogsS3Bucket (string) --

        The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true . The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket.

      • FlowLogsS3Prefix (string) --

        The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true .

        If you don’t specify a prefix, the flow logs are stored in the root of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:

        s3-bucket_name//AWSLogs/aws_account_id

Exceptions

describe_endpoint_group(**kwargs)

Describe an endpoint group. To see an AWS CLI example of describing an endpoint group, scroll down to Example .

See also: AWS API Documentation

Request Syntax

response = client.describe_endpoint_group(
    EndpointGroupArn='string'
)
Parameters
EndpointGroupArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the endpoint group to describe.

Return type
dict
Returns
Response Syntax
{
    'EndpointGroup': {
        'EndpointGroupArn': 'string',
        'EndpointGroupRegion': 'string',
        'EndpointDescriptions': [
            {
                'EndpointId': 'string',
                'Weight': 123,
                'HealthState': 'INITIAL'|'HEALTHY'|'UNHEALTHY',
                'HealthReason': 'string',
                'ClientIPPreservationEnabled': True|False
            },
        ],
        'TrafficDialPercentage': ...,
        'HealthCheckPort': 123,
        'HealthCheckProtocol': 'TCP'|'HTTP'|'HTTPS',
        'HealthCheckPath': 'string',
        'HealthCheckIntervalSeconds': 123,
        'ThresholdCount': 123
    }
}

Response Structure

  • (dict) --
    • EndpointGroup (dict) --

      The description of an endpoint group.

      • EndpointGroupArn (string) --

        The Amazon Resource Name (ARN) of the endpoint group.

      • EndpointGroupRegion (string) --

        The AWS Region that this endpoint group belongs.

      • EndpointDescriptions (list) --

        The list of endpoint objects.

        • (dict) --

          A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.

          • EndpointId (string) --

            An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For EC2 instances, this is the EC2 instance ID.

            An Application Load Balancer can be either internal or internet-facing.

          • Weight (integer) --

            The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide .

          • HealthState (string) --

            The health status of the endpoint.

          • HealthReason (string) --

            The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided.

            If the endpoint state is unhealthy , the reason code can be one of the following values:

            • Timeout : The health check requests to the endpoint are timing out before returning a status.
            • Failed : The health check failed, for example because the endpoint response was invalid (malformed).

            If the endpoint state is initial , the reason code can be one of the following values:

            • ProvisioningInProgress : The endpoint is in the process of being provisioned.
            • InitialHealthChecking : Global Accelerator is still setting up the minimum number of health checks for the endpoint that are required to determine its health status.
          • ClientIPPreservationEnabled (boolean) --

            Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.

            If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

            For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide .

      • TrafficDialPercentage (float) --

        The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.

        Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

        The default value is 100.

      • HealthCheckPort (integer) --

        The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

        The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.

      • HealthCheckProtocol (string) --

        The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.

      • HealthCheckPath (string) --

        If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).

      • HealthCheckIntervalSeconds (integer) --

        The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.

      • ThresholdCount (integer) --

        The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

Exceptions

describe_listener(**kwargs)

Describe a listener. To see an AWS CLI example of describing a listener, scroll down to Example .

See also: AWS API Documentation

Request Syntax

response = client.describe_listener(
    ListenerArn='string'
)
Parameters
ListenerArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the listener to describe.

Return type
dict
Returns
Response Syntax
{
    'Listener': {
        'ListenerArn': 'string',
        'PortRanges': [
            {
                'FromPort': 123,
                'ToPort': 123
            },
        ],
        'Protocol': 'TCP'|'UDP',
        'ClientAffinity': 'NONE'|'SOURCE_IP'
    }
}

Response Structure

  • (dict) --
    • Listener (dict) --

      The description of a listener.

      • ListenerArn (string) --

        The Amazon Resource Name (ARN) of the listener.

      • PortRanges (list) --

        The list of port ranges for the connections from clients to the accelerator.

        • (dict) --

          A complex type for a range of ports for a listener.

          • FromPort (integer) --

            The first port in the range of ports, inclusive.

          • ToPort (integer) --

            The last port in the range of ports, inclusive.

      • Protocol (string) --

        The protocol for the connections from clients to the accelerator.

      • ClientAffinity (string) --

        Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always route each client to the same specific endpoint.

        AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE , Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

        If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

        The default value is NONE .

Exceptions

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_accelerators(**kwargs)

List the accelerators for an AWS account. To see an AWS CLI example of listing the accelerators for an AWS account, scroll down to Example .

See also: AWS API Documentation

Request Syntax

response = client.list_accelerators(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The number of Global Accelerator objects that you want to return with this call. The default value is 10.
  • NextToken (string) -- The token for the next set of results. You receive this token from a previous call.
Return type

dict

Returns

Response Syntax

{
    'Accelerators': [
        {
            'AcceleratorArn': 'string',
            'Name': 'string',
            'IpAddressType': 'IPV4',
            'Enabled': True|False,
            'IpSets': [
                {
                    'IpFamily': 'string',
                    'IpAddresses': [
                        'string',
                    ]
                },
            ],
            'DnsName': 'string',
            'Status': 'DEPLOYED'|'IN_PROGRESS',
            'CreatedTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Accelerators (list) --

      The list of accelerators for a customer account.

      • (dict) --

        An accelerator is a complex type that includes one or more listeners that process inbound connections and then direct traffic to one or more endpoint groups, each of which includes endpoints, such as load balancers.

        • AcceleratorArn (string) --

          The Amazon Resource Name (ARN) of the accelerator.

        • Name (string) --

          The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

        • IpAddressType (string) --

          The value for the address type must be IPv4.

        • Enabled (boolean) --

          Indicates whether the accelerator is enabled. The value is true or false. The default value is true.

          If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.

        • IpSets (list) --

          The static IP addresses that Global Accelerator associates with the accelerator.

          • (dict) --

            A complex type for the set of IP addresses for an accelerator.

            • IpFamily (string) --

              The types of IP addresses included in this IP set.

            • IpAddresses (list) --

              The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.

              • (string) --
        • DnsName (string) --

          The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.

          The naming convention for the DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.

          For more information about the default DNS name, see Support for DNS Addressing in Global Accelerator in the AWS Global Accelerator Developer Guide .

        • Status (string) --

          Describes the deployment status of the accelerator.

        • CreatedTime (datetime) --

          The date and time that the accelerator was created.

        • LastModifiedTime (datetime) --

          The date and time that the accelerator was last modified.

    • NextToken (string) --

      The token for the next set of results. You receive this token from a previous call.

Exceptions

list_byoip_cidrs(**kwargs)

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

To see an AWS CLI example of listing BYOIP CIDR addresses, scroll down to Example .

See also: AWS API Documentation

Request Syntax

response = client.list_byoip_cidrs(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
  • NextToken (string) -- The token for the next page of results.
Return type

dict

Returns

Response Syntax

{
    'ByoipCidrs': [
        {
            'Cidr': 'string',
            'State': 'PENDING_PROVISIONING'|'READY'|'PENDING_ADVERTISING'|'ADVERTISING'|'PENDING_WITHDRAWING'|'PENDING_DEPROVISIONING'|'DEPROVISIONED'|'FAILED_PROVISION'|'FAILED_ADVERTISING'|'FAILED_WITHDRAW'|'FAILED_DEPROVISION',
            'Events': [
                {
                    'Message': 'string',
                    'Timestamp': datetime(2015, 1, 1)
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ByoipCidrs (list) --

      Information about your address ranges.

      • (dict) --

        Information about an IP address range that is provisioned for use with your AWS resources through bring your own IP address (BYOIP).

        The following describes each BYOIP State that your IP address range can be in.

        • PENDING_PROVISIONING — You’ve submitted a request to provision an IP address range but it is not yet provisioned with AWS Global Accelerator.
        • READY — The address range is provisioned with AWS Global Accelerator and can be advertised.
        • PENDING_ADVERTISING — You’ve submitted a request for AWS Global Accelerator to advertise an address range but it is not yet being advertised.
        • ADVERTISING — The address range is being advertised by AWS Global Accelerator.
        • PENDING_WITHDRAWING — You’ve submitted a request to withdraw an address range from being advertised but it is still being advertised by AWS Global Accelerator.
        • PENDING_DEPROVISIONING — You’ve submitted a request to deprovision an address range from AWS Global Accelerator but it is still provisioned.
        • DEPROVISIONED — The address range is deprovisioned from AWS Global Accelerator.
        • FAILED_PROVISION — The request to provision the address range from AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
        • FAILED_ADVERTISING — The request for AWS Global Accelerator to advertise the address range was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
        • FAILED_WITHDRAW — The request to withdraw the address range from advertising by AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
        • FAILED_DEPROVISION — The request to deprovision the address range from AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
        • Cidr (string) --

          The address range, in CIDR notation.

        • State (string) --

          The state of the address pool.

        • Events (list) --

          A history of status changes for an IP address range that that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

          • (dict) --

            A complex type that contains a Message and a Timestamp value for changes that you make in the status an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

            • Message (string) --

              A string that contains an Event message describing changes that you make in the status of an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

            • Timestamp (datetime) --

              A timestamp when you make a status change for an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

    • NextToken (string) --

      The token for the next page of results.

Exceptions

list_endpoint_groups(**kwargs)

List the endpoint groups that are associated with a listener. To see an AWS CLI example of listing the endpoint groups for listener, scroll down to Example .

See also: AWS API Documentation

Request Syntax

response = client.list_endpoint_groups(
    ListenerArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • ListenerArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the listener.

  • MaxResults (integer) -- The number of endpoint group objects that you want to return with this call. The default value is 10.
  • NextToken (string) -- The token for the next set of results. You receive this token from a previous call.
Return type

dict

Returns

Response Syntax

{
    'EndpointGroups': [
        {
            'EndpointGroupArn': 'string',
            'EndpointGroupRegion': 'string',
            'EndpointDescriptions': [
                {
                    'EndpointId': 'string',
                    'Weight': 123,
                    'HealthState': 'INITIAL'|'HEALTHY'|'UNHEALTHY',
                    'HealthReason': 'string',
                    'ClientIPPreservationEnabled': True|False
                },
            ],
            'TrafficDialPercentage': ...,
            'HealthCheckPort': 123,
            'HealthCheckProtocol': 'TCP'|'HTTP'|'HTTPS',
            'HealthCheckPath': 'string',
            'HealthCheckIntervalSeconds': 123,
            'ThresholdCount': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • EndpointGroups (list) --

      The list of the endpoint groups associated with a listener.

      • (dict) --

        A complex type for the endpoint group. An AWS Region can have only one endpoint group for a specific listener.

        • EndpointGroupArn (string) --

          The Amazon Resource Name (ARN) of the endpoint group.

        • EndpointGroupRegion (string) --

          The AWS Region that this endpoint group belongs.

        • EndpointDescriptions (list) --

          The list of endpoint objects.

          • (dict) --

            A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.

            • EndpointId (string) --

              An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For EC2 instances, this is the EC2 instance ID.

              An Application Load Balancer can be either internal or internet-facing.

            • Weight (integer) --

              The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide .

            • HealthState (string) --

              The health status of the endpoint.

            • HealthReason (string) --

              The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided.

              If the endpoint state is unhealthy , the reason code can be one of the following values:

              • Timeout : The health check requests to the endpoint are timing out before returning a status.
              • Failed : The health check failed, for example because the endpoint response was invalid (malformed).

              If the endpoint state is initial , the reason code can be one of the following values:

              • ProvisioningInProgress : The endpoint is in the process of being provisioned.
              • InitialHealthChecking : Global Accelerator is still setting up the minimum number of health checks for the endpoint that are required to determine its health status.
            • ClientIPPreservationEnabled (boolean) --

              Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.

              If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

              For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide .

        • TrafficDialPercentage (float) --

          The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.

          Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

          The default value is 100.

        • HealthCheckPort (integer) --

          The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

          The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.

        • HealthCheckProtocol (string) --

          The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.

        • HealthCheckPath (string) --

          If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).

        • HealthCheckIntervalSeconds (integer) --

          The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.

        • ThresholdCount (integer) --

          The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

    • NextToken (string) --

      The token for the next set of results. You receive this token from a previous call.

Exceptions

list_listeners(**kwargs)

List the listeners for an accelerator. To see an AWS CLI example of listing the listeners for an accelerator, scroll down to Example .

See also: AWS API Documentation

Request Syntax

response = client.list_listeners(
    AcceleratorArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • AcceleratorArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the accelerator for which you want to list listener objects.

  • MaxResults (integer) -- The number of listener objects that you want to return with this call. The default value is 10.
  • NextToken (string) -- The token for the next set of results. You receive this token from a previous call.
Return type

dict

Returns

Response Syntax

{
    'Listeners': [
        {
            'ListenerArn': 'string',
            'PortRanges': [
                {
                    'FromPort': 123,
                    'ToPort': 123
                },
            ],
            'Protocol': 'TCP'|'UDP',
            'ClientAffinity': 'NONE'|'SOURCE_IP'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Listeners (list) --

      The list of listeners for an accelerator.

      • (dict) --

        A complex type for a listener.

        • ListenerArn (string) --

          The Amazon Resource Name (ARN) of the listener.

        • PortRanges (list) --

          The list of port ranges for the connections from clients to the accelerator.

          • (dict) --

            A complex type for a range of ports for a listener.

            • FromPort (integer) --

              The first port in the range of ports, inclusive.

            • ToPort (integer) --

              The last port in the range of ports, inclusive.

        • Protocol (string) --

          The protocol for the connections from clients to the accelerator.

        • ClientAffinity (string) --

          Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always route each client to the same specific endpoint.

          AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE , Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

          If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

          The default value is NONE .

    • NextToken (string) --

      The token for the next set of results. You receive this token from a previous call.

Exceptions

list_tags_for_resource(**kwargs)

List all tags for an accelerator. To see an AWS CLI example of listing tags for an accelerator, scroll down to Example .

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

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the accelerator to list tags for. An ARN uniquely identifies an accelerator.

Return type
dict
Returns
Response Syntax
{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • Tags (list) --

      Root level tag for the Tags parameters.

      • (dict) --

        A complex type that contains a Tag key and Tag value.

        • Key (string) --

          A string that contains a Tag key.

        • Value (string) --

          A string that contains a Tag value.

Exceptions

provision_byoip_cidr(**kwargs)

Provisions an IP address range to use with your AWS 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 .

To see an AWS CLI example of provisioning an address range for BYOIP, scroll down to Example .

For more information, see Bring Your Own IP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.provision_byoip_cidr(
    Cidr='string',
    CidrAuthorizationContext={
        'Message': 'string',
        'Signature': 'string'
    }
)
Parameters
  • Cidr (string) --

    [REQUIRED]

    The public IPv4 address range, in CIDR notation. The most specific IP prefix that you can specify is /24. The address range cannot overlap with another address range that you've brought to this or another Region.

  • CidrAuthorizationContext (dict) --

    [REQUIRED]

    A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.

    • Message (string) -- [REQUIRED]

      The plain-text authorization message for the prefix and account.

    • Signature (string) -- [REQUIRED]

      The signed authorization message for the prefix and account.

Return type

dict

Returns

Response Syntax

{
    'ByoipCidr': {
        'Cidr': 'string',
        'State': 'PENDING_PROVISIONING'|'READY'|'PENDING_ADVERTISING'|'ADVERTISING'|'PENDING_WITHDRAWING'|'PENDING_DEPROVISIONING'|'DEPROVISIONED'|'FAILED_PROVISION'|'FAILED_ADVERTISING'|'FAILED_WITHDRAW'|'FAILED_DEPROVISION',
        'Events': [
            {
                'Message': 'string',
                'Timestamp': datetime(2015, 1, 1)
            },
        ]
    }
}

Response Structure

  • (dict) --

    • ByoipCidr (dict) --

      Information about the address range.

      • Cidr (string) --

        The address range, in CIDR notation.

      • State (string) --

        The state of the address pool.

      • Events (list) --

        A history of status changes for an IP address range that that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

        • (dict) --

          A complex type that contains a Message and a Timestamp value for changes that you make in the status an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

          • Message (string) --

            A string that contains an Event message describing changes that you make in the status of an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

          • Timestamp (datetime) --

            A timestamp when you make a status change for an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

Exceptions

tag_resource(**kwargs)

Add tags to an accelerator resource. To see an AWS CLI example of adding tags to an accelerator, scroll down to Example .

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

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the Global Accelerator resource to add tags to. An ARN uniquely identifies a resource.

  • Tags (list) --

    [REQUIRED]

    The tags to add to a resource. A tag consists of a key and a value that you define.

    • (dict) --

      A complex type that contains a Tag key and Tag value.

      • Key (string) -- [REQUIRED]

        A string that contains a Tag key.

      • Value (string) -- [REQUIRED]

        A string that contains a Tag value.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Remove tags from a Global Accelerator resource. When you specify a tag key, the action removes both that key and its associated value. To see an AWS CLI example of removing tags from an accelerator, scroll down to Example . The operation succeeds even if you attempt to remove tags from an accelerator that was already removed.

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

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the Global Accelerator resource to remove tags from. An ARN uniquely identifies a resource.

  • TagKeys (list) --

    [REQUIRED]

    The tag key pairs that you want to remove from the specified resources.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_accelerator(**kwargs)

Update an accelerator. To see an AWS CLI example of updating an accelerator, scroll down to Example .

Warning

You must specify the US West (Oregon) Region to create or update accelerators.

See also: AWS API Documentation

Request Syntax

response = client.update_accelerator(
    AcceleratorArn='string',
    Name='string',
    IpAddressType='IPV4',
    Enabled=True|False
)
Parameters
  • AcceleratorArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the accelerator to update.

  • Name (string) -- The name of the accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
  • IpAddressType (string) -- The value for the address type must be IPv4.
  • Enabled (boolean) --

    Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

    If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.

Return type

dict

Returns

Response Syntax

{
    'Accelerator': {
        'AcceleratorArn': 'string',
        'Name': 'string',
        'IpAddressType': 'IPV4',
        'Enabled': True|False,
        'IpSets': [
            {
                'IpFamily': 'string',
                'IpAddresses': [
                    'string',
                ]
            },
        ],
        'DnsName': 'string',
        'Status': 'DEPLOYED'|'IN_PROGRESS',
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • Accelerator (dict) --

      Information about the updated accelerator.

      • AcceleratorArn (string) --

        The Amazon Resource Name (ARN) of the accelerator.

      • Name (string) --

        The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

      • IpAddressType (string) --

        The value for the address type must be IPv4.

      • Enabled (boolean) --

        Indicates whether the accelerator is enabled. The value is true or false. The default value is true.

        If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.

      • IpSets (list) --

        The static IP addresses that Global Accelerator associates with the accelerator.

        • (dict) --

          A complex type for the set of IP addresses for an accelerator.

          • IpFamily (string) --

            The types of IP addresses included in this IP set.

          • IpAddresses (list) --

            The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.

            • (string) --
      • DnsName (string) --

        The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.

        The naming convention for the DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.

        For more information about the default DNS name, see Support for DNS Addressing in Global Accelerator in the AWS Global Accelerator Developer Guide .

      • Status (string) --

        Describes the deployment status of the accelerator.

      • CreatedTime (datetime) --

        The date and time that the accelerator was created.

      • LastModifiedTime (datetime) --

        The date and time that the accelerator was last modified.

Exceptions

update_accelerator_attributes(**kwargs)

Update the attributes for an accelerator. To see an AWS CLI example of updating an accelerator to enable flow logs, scroll down to Example .

See also: AWS API Documentation

Request Syntax

response = client.update_accelerator_attributes(
    AcceleratorArn='string',
    FlowLogsEnabled=True|False,
    FlowLogsS3Bucket='string',
    FlowLogsS3Prefix='string'
)
Parameters
  • AcceleratorArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the accelerator that you want to update.

  • FlowLogsEnabled (boolean) --

    Update whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.

    For more information, see Flow Logs in the AWS Global Accelerator Developer Guide .

  • FlowLogsS3Bucket (string) -- The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true . The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket.
  • FlowLogsS3Prefix (string) --

    Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true .

    If you don’t specify a prefix, the flow logs are stored in the root of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:

    s3-bucket_name//AWSLogs/aws_account_id

Return type

dict

Returns

Response Syntax

{
    'AcceleratorAttributes': {
        'FlowLogsEnabled': True|False,
        'FlowLogsS3Bucket': 'string',
        'FlowLogsS3Prefix': 'string'
    }
}

Response Structure

  • (dict) --

    • AcceleratorAttributes (dict) --

      Updated attributes for the accelerator.

      • FlowLogsEnabled (boolean) --

        Indicates whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.

        For more information, see Flow Logs in the AWS Global Accelerator Developer Guide .

      • FlowLogsS3Bucket (string) --

        The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true . The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket.

      • FlowLogsS3Prefix (string) --

        The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true .

        If you don’t specify a prefix, the flow logs are stored in the root of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:

        s3-bucket_name//AWSLogs/aws_account_id

Exceptions

update_endpoint_group(**kwargs)

Update an endpoint group. To see an AWS CLI example of updating an endpoint group, scroll down to Example .

See also: AWS API Documentation

Request Syntax

response = client.update_endpoint_group(
    EndpointGroupArn='string',
    EndpointConfigurations=[
        {
            'EndpointId': 'string',
            'Weight': 123,
            'ClientIPPreservationEnabled': True|False
        },
    ],
    TrafficDialPercentage=...,
    HealthCheckPort=123,
    HealthCheckProtocol='TCP'|'HTTP'|'HTTPS',
    HealthCheckPath='string',
    HealthCheckIntervalSeconds=123,
    ThresholdCount=123
)
Parameters
  • EndpointGroupArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the endpoint group.

  • EndpointConfigurations (list) --

    The list of endpoint objects.

    • (dict) --

      A complex type for endpoints.

      • EndpointId (string) --

        An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For EC2 instances, this is the EC2 instance ID.

        An Application Load Balancer can be either internal or internet-facing.

      • Weight (integer) --

        The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide .

      • ClientIPPreservationEnabled (boolean) --

        Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.

        If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

        For more information, see Preserve Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide .

  • TrafficDialPercentage (float) --

    The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.

    Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

    The default value is 100.

  • HealthCheckPort (integer) -- The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses the first port in the list.
  • HealthCheckProtocol (string) -- The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
  • HealthCheckPath (string) -- If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).
  • HealthCheckIntervalSeconds (integer) -- The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
  • ThresholdCount (integer) -- The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
Return type

dict

Returns

Response Syntax

{
    'EndpointGroup': {
        'EndpointGroupArn': 'string',
        'EndpointGroupRegion': 'string',
        'EndpointDescriptions': [
            {
                'EndpointId': 'string',
                'Weight': 123,
                'HealthState': 'INITIAL'|'HEALTHY'|'UNHEALTHY',
                'HealthReason': 'string',
                'ClientIPPreservationEnabled': True|False
            },
        ],
        'TrafficDialPercentage': ...,
        'HealthCheckPort': 123,
        'HealthCheckProtocol': 'TCP'|'HTTP'|'HTTPS',
        'HealthCheckPath': 'string',
        'HealthCheckIntervalSeconds': 123,
        'ThresholdCount': 123
    }
}

Response Structure

  • (dict) --

    • EndpointGroup (dict) --

      The information about the endpoint group that was updated.

      • EndpointGroupArn (string) --

        The Amazon Resource Name (ARN) of the endpoint group.

      • EndpointGroupRegion (string) --

        The AWS Region that this endpoint group belongs.

      • EndpointDescriptions (list) --

        The list of endpoint objects.

        • (dict) --

          A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.

          • EndpointId (string) --

            An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For EC2 instances, this is the EC2 instance ID.

            An Application Load Balancer can be either internal or internet-facing.

          • Weight (integer) --

            The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide .

          • HealthState (string) --

            The health status of the endpoint.

          • HealthReason (string) --

            The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided.

            If the endpoint state is unhealthy , the reason code can be one of the following values:

            • Timeout : The health check requests to the endpoint are timing out before returning a status.
            • Failed : The health check failed, for example because the endpoint response was invalid (malformed).

            If the endpoint state is initial , the reason code can be one of the following values:

            • ProvisioningInProgress : The endpoint is in the process of being provisioned.
            • InitialHealthChecking : Global Accelerator is still setting up the minimum number of health checks for the endpoint that are required to determine its health status.
          • ClientIPPreservationEnabled (boolean) --

            Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.

            If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

            For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide .

      • TrafficDialPercentage (float) --

        The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.

        Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

        The default value is 100.

      • HealthCheckPort (integer) --

        The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

        The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.

      • HealthCheckProtocol (string) --

        The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.

      • HealthCheckPath (string) --

        If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).

      • HealthCheckIntervalSeconds (integer) --

        The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.

      • ThresholdCount (integer) --

        The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

Exceptions

update_listener(**kwargs)

Update a listener. To see an AWS CLI example of updating listener, scroll down to Example .

See also: AWS API Documentation

Request Syntax

response = client.update_listener(
    ListenerArn='string',
    PortRanges=[
        {
            'FromPort': 123,
            'ToPort': 123
        },
    ],
    Protocol='TCP'|'UDP',
    ClientAffinity='NONE'|'SOURCE_IP'
)
Parameters
  • ListenerArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the listener to update.

  • PortRanges (list) --

    The updated list of port ranges for the connections from clients to the accelerator.

    • (dict) --

      A complex type for a range of ports for a listener.

      • FromPort (integer) --

        The first port in the range of ports, inclusive.

      • ToPort (integer) --

        The last port in the range of ports, inclusive.

  • Protocol (string) -- The updated protocol for the connections from clients to the accelerator.
  • ClientAffinity (string) --

    Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always route each client to the same specific endpoint.

    AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE , Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

    If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

    The default value is NONE .

Return type

dict

Returns

Response Syntax

{
    'Listener': {
        'ListenerArn': 'string',
        'PortRanges': [
            {
                'FromPort': 123,
                'ToPort': 123
            },
        ],
        'Protocol': 'TCP'|'UDP',
        'ClientAffinity': 'NONE'|'SOURCE_IP'
    }
}

Response Structure

  • (dict) --

    • Listener (dict) --

      Information for the updated listener.

      • ListenerArn (string) --

        The Amazon Resource Name (ARN) of the listener.

      • PortRanges (list) --

        The list of port ranges for the connections from clients to the accelerator.

        • (dict) --

          A complex type for a range of ports for a listener.

          • FromPort (integer) --

            The first port in the range of ports, inclusive.

          • ToPort (integer) --

            The last port in the range of ports, inclusive.

      • Protocol (string) --

        The protocol for the connections from clients to the accelerator.

      • ClientAffinity (string) --

        Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always route each client to the same specific endpoint.

        AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE , Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

        If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

        The default value is NONE .

Exceptions

withdraw_byoip_cidr(**kwargs)

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. To see an AWS CLI example of withdrawing an address range for BYOIP so it will no longer be advertised by AWS, scroll down to Example .

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

For more information, see Bring Your Own IP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.withdraw_byoip_cidr(
    Cidr='string'
)
Parameters
Cidr (string) --

[REQUIRED]

The address range, in CIDR notation.

Return type
dict
Returns
Response Syntax
{
    'ByoipCidr': {
        'Cidr': 'string',
        'State': 'PENDING_PROVISIONING'|'READY'|'PENDING_ADVERTISING'|'ADVERTISING'|'PENDING_WITHDRAWING'|'PENDING_DEPROVISIONING'|'DEPROVISIONED'|'FAILED_PROVISION'|'FAILED_ADVERTISING'|'FAILED_WITHDRAW'|'FAILED_DEPROVISION',
        'Events': [
            {
                'Message': 'string',
                'Timestamp': datetime(2015, 1, 1)
            },
        ]
    }
}

Response Structure

  • (dict) --
    • ByoipCidr (dict) --

      Information about the address pool.

      • Cidr (string) --

        The address range, in CIDR notation.

      • State (string) --

        The state of the address pool.

      • Events (list) --

        A history of status changes for an IP address range that that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

        • (dict) --

          A complex type that contains a Message and a Timestamp value for changes that you make in the status an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

          • Message (string) --

            A string that contains an Event message describing changes that you make in the status of an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

          • Timestamp (datetime) --

            A timestamp when you make a status change for an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class GlobalAccelerator.Client.exceptions.AcceleratorNotDisabledException

The accelerator that you specified could not be disabled.

Example

try:
  ...
except client.exceptions.AcceleratorNotDisabledException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The accelerator that you specified could not be disabled.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class GlobalAccelerator.Client.exceptions.AcceleratorNotFoundException

The accelerator that you specified doesn't exist.

Example

try:
  ...
except client.exceptions.AcceleratorNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The accelerator that you specified doesn't exist.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class GlobalAccelerator.Client.exceptions.AccessDeniedException

You don't have access permission.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You don't have access permission.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class GlobalAccelerator.Client.exceptions.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.

Example

try:
  ...
except client.exceptions.AssociatedEndpointGroupFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    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.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class GlobalAccelerator.Client.exceptions.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.

Example

try:
  ...
except client.exceptions.AssociatedListenerFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    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.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class GlobalAccelerator.Client.exceptions.ByoipCidrNotFoundException

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

Example

try:
  ...
except client.exceptions.ByoipCidrNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

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

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class GlobalAccelerator.Client.exceptions.EndpointGroupAlreadyExistsException

The endpoint group that you specified already exists.

Example

try:
  ...
except client.exceptions.EndpointGroupAlreadyExistsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The endpoint group that you specified already exists.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class GlobalAccelerator.Client.exceptions.EndpointGroupNotFoundException

The endpoint group that you specified doesn't exist.

Example

try:
  ...
except client.exceptions.EndpointGroupNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The endpoint group that you specified doesn't exist.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class GlobalAccelerator.Client.exceptions.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.

Example

try:
  ...
except client.exceptions.IncorrectCidrStateException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

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

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class GlobalAccelerator.Client.exceptions.InternalServiceErrorException

There was an internal error for AWS Global Accelerator.

Example

try:
  ...
except client.exceptions.InternalServiceErrorException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    There was an internal error for AWS Global Accelerator.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class GlobalAccelerator.Client.exceptions.InvalidArgumentException

An argument that you specified is invalid.

Example

try:
  ...
except client.exceptions.InvalidArgumentException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    An argument that you specified is invalid.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class GlobalAccelerator.Client.exceptions.InvalidNextTokenException

There isn't another item to return.

Example

try:
  ...
except client.exceptions.InvalidNextTokenException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    There isn't another item to return.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class GlobalAccelerator.Client.exceptions.InvalidPortRangeException

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

Example

try:
  ...
except client.exceptions.InvalidPortRangeException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

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

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class GlobalAccelerator.Client.exceptions.LimitExceededException

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

Example

try:
  ...
except client.exceptions.LimitExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

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

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class GlobalAccelerator.Client.exceptions.ListenerNotFoundException

The listener that you specified doesn't exist.

Example

try:
  ...
except client.exceptions.ListenerNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The listener that you specified doesn't exist.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class GlobalAccelerator.Paginator.ListAccelerators
paginator = client.get_paginator('list_accelerators')
paginate(**kwargs)

Creates an iterator that will paginate through responses from GlobalAccelerator.Client.list_accelerators().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'Accelerators': [
        {
            'AcceleratorArn': 'string',
            'Name': 'string',
            'IpAddressType': 'IPV4',
            'Enabled': True|False,
            'IpSets': [
                {
                    'IpFamily': 'string',
                    'IpAddresses': [
                        'string',
                    ]
                },
            ],
            'DnsName': 'string',
            'Status': 'DEPLOYED'|'IN_PROGRESS',
            'CreatedTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) --
    • Accelerators (list) --

      The list of accelerators for a customer account.

      • (dict) --

        An accelerator is a complex type that includes one or more listeners that process inbound connections and then direct traffic to one or more endpoint groups, each of which includes endpoints, such as load balancers.

        • AcceleratorArn (string) --

          The Amazon Resource Name (ARN) of the accelerator.

        • Name (string) --

          The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

        • IpAddressType (string) --

          The value for the address type must be IPv4.

        • Enabled (boolean) --

          Indicates whether the accelerator is enabled. The value is true or false. The default value is true.

          If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.

        • IpSets (list) --

          The static IP addresses that Global Accelerator associates with the accelerator.

          • (dict) --

            A complex type for the set of IP addresses for an accelerator.

            • IpFamily (string) --

              The types of IP addresses included in this IP set.

            • IpAddresses (list) --

              The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.

              • (string) --
        • DnsName (string) --

          The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.

          The naming convention for the DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.

          For more information about the default DNS name, see Support for DNS Addressing in Global Accelerator in the AWS Global Accelerator Developer Guide .

        • Status (string) --

          Describes the deployment status of the accelerator.

        • CreatedTime (datetime) --

          The date and time that the accelerator was created.

        • LastModifiedTime (datetime) --

          The date and time that the accelerator was last modified.

class GlobalAccelerator.Paginator.ListEndpointGroups
paginator = client.get_paginator('list_endpoint_groups')
paginate(**kwargs)

Creates an iterator that will paginate through responses from GlobalAccelerator.Client.list_endpoint_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ListenerArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ListenerArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the listener.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'EndpointGroups': [
        {
            'EndpointGroupArn': 'string',
            'EndpointGroupRegion': 'string',
            'EndpointDescriptions': [
                {
                    'EndpointId': 'string',
                    'Weight': 123,
                    'HealthState': 'INITIAL'|'HEALTHY'|'UNHEALTHY',
                    'HealthReason': 'string',
                    'ClientIPPreservationEnabled': True|False
                },
            ],
            'TrafficDialPercentage': ...,
            'HealthCheckPort': 123,
            'HealthCheckProtocol': 'TCP'|'HTTP'|'HTTPS',
            'HealthCheckPath': 'string',
            'HealthCheckIntervalSeconds': 123,
            'ThresholdCount': 123
        },
    ],

}

Response Structure

  • (dict) --

    • EndpointGroups (list) --

      The list of the endpoint groups associated with a listener.

      • (dict) --

        A complex type for the endpoint group. An AWS Region can have only one endpoint group for a specific listener.

        • EndpointGroupArn (string) --

          The Amazon Resource Name (ARN) of the endpoint group.

        • EndpointGroupRegion (string) --

          The AWS Region that this endpoint group belongs.

        • EndpointDescriptions (list) --

          The list of endpoint objects.

          • (dict) --

            A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.

            • EndpointId (string) --

              An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For EC2 instances, this is the EC2 instance ID.

              An Application Load Balancer can be either internal or internet-facing.

            • Weight (integer) --

              The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide .

            • HealthState (string) --

              The health status of the endpoint.

            • HealthReason (string) --

              The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided.

              If the endpoint state is unhealthy , the reason code can be one of the following values:

              • Timeout : The health check requests to the endpoint are timing out before returning a status.
              • Failed : The health check failed, for example because the endpoint response was invalid (malformed).

              If the endpoint state is initial , the reason code can be one of the following values:

              • ProvisioningInProgress : The endpoint is in the process of being provisioned.
              • InitialHealthChecking : Global Accelerator is still setting up the minimum number of health checks for the endpoint that are required to determine its health status.
            • ClientIPPreservationEnabled (boolean) --

              Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.

              If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

              For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide .

        • TrafficDialPercentage (float) --

          The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.

          Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

          The default value is 100.

        • HealthCheckPort (integer) --

          The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

          The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.

        • HealthCheckProtocol (string) --

          The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.

        • HealthCheckPath (string) --

          If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).

        • HealthCheckIntervalSeconds (integer) --

          The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.

        • ThresholdCount (integer) --

          The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

class GlobalAccelerator.Paginator.ListListeners
paginator = client.get_paginator('list_listeners')
paginate(**kwargs)

Creates an iterator that will paginate through responses from GlobalAccelerator.Client.list_listeners().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AcceleratorArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • AcceleratorArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the accelerator for which you want to list listener objects.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Listeners': [
        {
            'ListenerArn': 'string',
            'PortRanges': [
                {
                    'FromPort': 123,
                    'ToPort': 123
                },
            ],
            'Protocol': 'TCP'|'UDP',
            'ClientAffinity': 'NONE'|'SOURCE_IP'
        },
    ],

}

Response Structure

  • (dict) --

    • Listeners (list) --

      The list of listeners for an accelerator.

      • (dict) --

        A complex type for a listener.

        • ListenerArn (string) --

          The Amazon Resource Name (ARN) of the listener.

        • PortRanges (list) --

          The list of port ranges for the connections from clients to the accelerator.

          • (dict) --

            A complex type for a range of ports for a listener.

            • FromPort (integer) --

              The first port in the range of ports, inclusive.

            • ToPort (integer) --

              The last port in the range of ports, inclusive.

        • Protocol (string) --

          The protocol for the connections from clients to the accelerator.

        • ClientAffinity (string) --

          Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always route each client to the same specific endpoint.

          AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE , Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

          If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

          The default value is NONE .