AWS Global Accelerator

2022/07/27 - AWS Global Accelerator - 9 updated api methods

Changes  Global Accelerator now supports dual-stack accelerators, enabling support for IPv4 and IPv6 traffic.

CreateAccelerator (updated) Link ¶
Changes (request, response)
Request 
{'IpAddressType': {'DUAL_STACK'}}
Response 
{'Accelerator': {'DualStackDnsName': 'string',
                 'Events': [{'Message': 'string', 'Timestamp': 'timestamp'}],
                 'IpAddressType': {'DUAL_STACK'},
                 'IpSets': {'IpAddressFamily': 'IPv4 | IPv6'}}}

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.

Warning

Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2 on AWS CLI commands.

See also: AWS API Documentation

Request Syntax

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

string

param Name

[REQUIRED]

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

type IpAddressType

string

param IpAddressType

The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.

type IpAddresses

list

param IpAddresses

Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the accelerator's static IPv4 address when you create an accelerator.

After you bring an address range to Amazon Web Services, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is because Global Accelerator assigns each address range to a different network zone, for high availability.

You can specify one or two addresses, separated by a space. Do not include the /32 suffix.

Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.

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

  • (string) --

type Enabled

boolean

param Enabled

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.

type IdempotencyToken

string

param IdempotencyToken

[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.

type Tags

list

param Tags

Create tags for an accelerator.

For more information, see Tagging in Global Accelerator in the 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.

rtype

dict

returns

Response Syntax

{
    'Accelerator': {
        'AcceleratorArn': 'string',
        'Name': 'string',
        'IpAddressType': 'IPV4'|'DUAL_STACK',
        'Enabled': True|False,
        'IpSets': [
            {
                'IpFamily': 'string',
                'IpAddresses': [
                    'string',
                ],
                'IpAddressFamily': 'IPv4'|'IPv6'
            },
        ],
        'DnsName': 'string',
        'Status': 'DEPLOYED'|'IN_PROGRESS',
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1),
        'DualStackDnsName': 'string',
        'Events': [
            {
                'Message': 'string',
                'Timestamp': 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 IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.

      • 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) --

            IpFamily is deprecated and has been replaced by IpAddressFamily.

          • 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) --

          • IpAddressFamily (string) --

            The types of IP addresses included in this IP set.

      • DnsName (string) --

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

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

        If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four static addresses for the accelerator (two IPv4 addresses and two IPv6 addresses).

        For more information about the default DNS name, see Support for DNS Addressing in Global Accelerator in the 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.

      • DualStackDnsName (string) --

        The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses.

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

        Note: Global Accelerator also assigns a default DNS name, DnsName, to your accelerator that points just to the static IPv4 addresses.

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

      • Events (list) --

        A history of changes that you make to an accelerator in Global Accelerator.

        • (dict) --

          A complex type that contains a Timestamp value and Message for changes that you make to an accelerator in Global Accelerator. Messages stored here provide progress or error information when you update an accelerator from IPv4 to dual-stack, or from dual-stack to IPv4. Global Accelerator stores a maximum of ten event messages.

          • Message (string) --

            A string that contains an Event message describing changes or errors when you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.

          • Timestamp (datetime) --

            A timestamp for when you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.

CreateCustomRoutingAccelerator (updated) Link ¶
Changes (request, response)
Request 
{'IpAddressType': {'DUAL_STACK'}}
Response 
{'Accelerator': {'IpAddressType': {'DUAL_STACK'},
                 'IpSets': {'IpAddressFamily': 'IPv4 | IPv6'}}}

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

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

Warning

Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2 on AWS CLI commands.

See also: AWS API Documentation

Request Syntax

client.create_custom_routing_accelerator(
    Name='string',
    IpAddressType='IPV4'|'DUAL_STACK',
    IpAddresses=[
        'string',
    ],
    Enabled=True|False,
    IdempotencyToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type Name

string

param Name

[REQUIRED]

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

type IpAddressType

string

param IpAddressType

The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.

type IpAddresses

list

param IpAddresses

Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the accelerator's static IPv4 address when you create an accelerator.

After you bring an address range to Amazon Web Services, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is because Global Accelerator assigns each address range to a different network zone, for high availability.

You can specify one or two addresses, separated by a space. Do not include the /32 suffix.

Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.

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

  • (string) --

type Enabled

boolean

param Enabled

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.

type IdempotencyToken

string

param IdempotencyToken

[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.

type Tags

list

param Tags

Create tags for an accelerator.

For more information, see Tagging in Global Accelerator in the 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.

rtype

dict

returns

Response Syntax

{
    'Accelerator': {
        'AcceleratorArn': 'string',
        'Name': 'string',
        'IpAddressType': 'IPV4'|'DUAL_STACK',
        'Enabled': True|False,
        'IpSets': [
            {
                'IpFamily': 'string',
                'IpAddresses': [
                    'string',
                ],
                'IpAddressFamily': 'IPv4'|'IPv6'
            },
        ],
        '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.

      • AcceleratorArn (string) --

        The Amazon Resource Name (ARN) of the custom routing 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 IP address type that an accelerator supports. For a custom routing accelerator, the value 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) --

            IpFamily is deprecated and has been replaced by IpAddressFamily.

          • 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) --

          • IpAddressFamily (string) --

            The types of IP addresses included in this IP set.

      • DnsName (string) --

        The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 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.

        If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four static addresses for the accelerator (two IPv4 addresses and two IPv6 addresses).

        For more information about the default DNS name, see Support for DNS Addressing in Global Accelerator in the 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.

DescribeAccelerator (updated) Link ¶
Changes (response) 
{'Accelerator': {'DualStackDnsName': 'string',
                 'Events': [{'Message': 'string', 'Timestamp': 'timestamp'}],
                 'IpAddressType': {'DUAL_STACK'},
                 'IpSets': {'IpAddressFamily': 'IPv4 | IPv6'}}}

Describe an accelerator.

See also: AWS API Documentation

Request Syntax

client.describe_accelerator(
    AcceleratorArn='string'
)
type AcceleratorArn

string

param AcceleratorArn

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'Accelerator': {
        'AcceleratorArn': 'string',
        'Name': 'string',
        'IpAddressType': 'IPV4'|'DUAL_STACK',
        'Enabled': True|False,
        'IpSets': [
            {
                'IpFamily': 'string',
                'IpAddresses': [
                    'string',
                ],
                'IpAddressFamily': 'IPv4'|'IPv6'
            },
        ],
        'DnsName': 'string',
        'Status': 'DEPLOYED'|'IN_PROGRESS',
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1),
        'DualStackDnsName': 'string',
        'Events': [
            {
                'Message': 'string',
                'Timestamp': 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 IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.

      • 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) --

            IpFamily is deprecated and has been replaced by IpAddressFamily.

          • 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) --

          • IpAddressFamily (string) --

            The types of IP addresses included in this IP set.

      • DnsName (string) --

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

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

        If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four static addresses for the accelerator (two IPv4 addresses and two IPv6 addresses).

        For more information about the default DNS name, see Support for DNS Addressing in Global Accelerator in the 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.

      • DualStackDnsName (string) --

        The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses.

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

        Note: Global Accelerator also assigns a default DNS name, DnsName, to your accelerator that points just to the static IPv4 addresses.

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

      • Events (list) --

        A history of changes that you make to an accelerator in Global Accelerator.

        • (dict) --

          A complex type that contains a Timestamp value and Message for changes that you make to an accelerator in Global Accelerator. Messages stored here provide progress or error information when you update an accelerator from IPv4 to dual-stack, or from dual-stack to IPv4. Global Accelerator stores a maximum of ten event messages.

          • Message (string) --

            A string that contains an Event message describing changes or errors when you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.

          • Timestamp (datetime) --

            A timestamp for when you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.

DescribeCustomRoutingAccelerator (updated) Link ¶
Changes (response) 
{'Accelerator': {'IpAddressType': {'DUAL_STACK'},
                 'IpSets': {'IpAddressFamily': 'IPv4 | IPv6'}}}

Describe a custom routing accelerator.

See also: AWS API Documentation

Request Syntax

client.describe_custom_routing_accelerator(
    AcceleratorArn='string'
)
type AcceleratorArn

string

param AcceleratorArn

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'Accelerator': {
        'AcceleratorArn': 'string',
        'Name': 'string',
        'IpAddressType': 'IPV4'|'DUAL_STACK',
        'Enabled': True|False,
        'IpSets': [
            {
                'IpFamily': 'string',
                'IpAddresses': [
                    'string',
                ],
                'IpAddressFamily': 'IPv4'|'IPv6'
            },
        ],
        '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 custom routing accelerator.

      • AcceleratorArn (string) --

        The Amazon Resource Name (ARN) of the custom routing 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 IP address type that an accelerator supports. For a custom routing accelerator, the value 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) --

            IpFamily is deprecated and has been replaced by IpAddressFamily.

          • 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) --

          • IpAddressFamily (string) --

            The types of IP addresses included in this IP set.

      • DnsName (string) --

        The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 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.

        If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four static addresses for the accelerator (two IPv4 addresses and two IPv6 addresses).

        For more information about the default DNS name, see Support for DNS Addressing in Global Accelerator in the 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.

ListAccelerators (updated) Link ¶
Changes (response) 
{'Accelerators': {'DualStackDnsName': 'string',
                  'Events': [{'Message': 'string', 'Timestamp': 'timestamp'}],
                  'IpAddressType': {'DUAL_STACK'},
                  'IpSets': {'IpAddressFamily': 'IPv4 | IPv6'}}}

List the accelerators for an Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

client.list_accelerators(
    MaxResults=123,
    NextToken='string'
)
type MaxResults

integer

param MaxResults

The number of Global Accelerator objects that you want to return with this call. The default value is 10.

type NextToken

string

param NextToken

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

rtype

dict

returns

Response Syntax

{
    'Accelerators': [
        {
            'AcceleratorArn': 'string',
            'Name': 'string',
            'IpAddressType': 'IPV4'|'DUAL_STACK',
            'Enabled': True|False,
            'IpSets': [
                {
                    'IpFamily': 'string',
                    'IpAddresses': [
                        'string',
                    ],
                    'IpAddressFamily': 'IPv4'|'IPv6'
                },
            ],
            'DnsName': 'string',
            'Status': 'DEPLOYED'|'IN_PROGRESS',
            'CreatedTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'DualStackDnsName': 'string',
            'Events': [
                {
                    'Message': 'string',
                    'Timestamp': 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 IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.

        • 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) --

              IpFamily is deprecated and has been replaced by IpAddressFamily.

            • 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) --

            • IpAddressFamily (string) --

              The types of IP addresses included in this IP set.

        • DnsName (string) --

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

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

          If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four static addresses for the accelerator (two IPv4 addresses and two IPv6 addresses).

          For more information about the default DNS name, see Support for DNS Addressing in Global Accelerator in the 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.

        • DualStackDnsName (string) --

          The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses.

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

          Note: Global Accelerator also assigns a default DNS name, DnsName, to your accelerator that points just to the static IPv4 addresses.

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

        • Events (list) --

          A history of changes that you make to an accelerator in Global Accelerator.

          • (dict) --

            A complex type that contains a Timestamp value and Message for changes that you make to an accelerator in Global Accelerator. Messages stored here provide progress or error information when you update an accelerator from IPv4 to dual-stack, or from dual-stack to IPv4. Global Accelerator stores a maximum of ten event messages.

            • Message (string) --

              A string that contains an Event message describing changes or errors when you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.

            • Timestamp (datetime) --

              A timestamp for when you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.

    • NextToken (string) --

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

ListCustomRoutingAccelerators (updated) Link ¶
Changes (response) 
{'Accelerators': {'IpAddressType': {'DUAL_STACK'},
                  'IpSets': {'IpAddressFamily': 'IPv4 | IPv6'}}}

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

See also: AWS API Documentation

Request Syntax

client.list_custom_routing_accelerators(
    MaxResults=123,
    NextToken='string'
)
type MaxResults

integer

param MaxResults

The number of custom routing Global Accelerator objects that you want to return with this call. The default value is 10.

type NextToken

string

param NextToken

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

rtype

dict

returns

Response Syntax

{
    'Accelerators': [
        {
            'AcceleratorArn': 'string',
            'Name': 'string',
            'IpAddressType': 'IPV4'|'DUAL_STACK',
            'Enabled': True|False,
            'IpSets': [
                {
                    'IpFamily': 'string',
                    'IpAddresses': [
                        'string',
                    ],
                    'IpAddressFamily': 'IPv4'|'IPv6'
                },
            ],
            '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 custom routing accelerators for a customer account.

      • (dict) --

        Attributes of a custom routing accelerator.

        • AcceleratorArn (string) --

          The Amazon Resource Name (ARN) of the custom routing 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 IP address type that an accelerator supports. For a custom routing accelerator, the value 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) --

              IpFamily is deprecated and has been replaced by IpAddressFamily.

            • 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) --

            • IpAddressFamily (string) --

              The types of IP addresses included in this IP set.

        • DnsName (string) --

          The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 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.

          If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four static addresses for the accelerator (two IPv4 addresses and two IPv6 addresses).

          For more information about the default DNS name, see Support for DNS Addressing in Global Accelerator in the 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.

ListCustomRoutingPortMappingsByDestination (updated) Link ¶
Changes (response) 
{'DestinationPortMappings': {'IpAddressType': {'DUAL_STACK'}}}

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

See also: AWS API Documentation

Request Syntax

client.list_custom_routing_port_mappings_by_destination(
    EndpointId='string',
    DestinationAddress='string',
    MaxResults=123,
    NextToken='string'
)
type EndpointId

string

param EndpointId

[REQUIRED]

The ID for the virtual private cloud (VPC) subnet.

type DestinationAddress

string

param DestinationAddress

[REQUIRED]

The endpoint IP address in a virtual private cloud (VPC) subnet for which you want to receive back port mappings.

type MaxResults

integer

param MaxResults

The number of destination port mappings that you want to return with this call. The default value is 10.

type NextToken

string

param NextToken

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

rtype

dict

returns

Response Syntax

{
    'DestinationPortMappings': [
        {
            'AcceleratorArn': 'string',
            'AcceleratorSocketAddresses': [
                {
                    'IpAddress': 'string',
                    'Port': 123
                },
            ],
            'EndpointGroupArn': 'string',
            'EndpointId': 'string',
            'EndpointGroupRegion': 'string',
            'DestinationSocketAddress': {
                'IpAddress': 'string',
                'Port': 123
            },
            'IpAddressType': 'IPV4'|'DUAL_STACK',
            'DestinationTrafficState': 'ALLOW'|'DENY'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • DestinationPortMappings (list) --

      The port mappings for the endpoint IP address that you specified in the request.

      • (dict) --

        The port mappings for a specified endpoint IP address (destination).

        • AcceleratorArn (string) --

          The Amazon Resource Name (ARN) of the custom routing accelerator that you have port mappings for.

        • AcceleratorSocketAddresses (list) --

          The IP address/port combinations (sockets) that map to a given destination socket address.

          • (dict) --

            An IP address/port combination.

            • IpAddress (string) --

              The IP address for the socket address.

            • Port (integer) --

              The port for the socket address.

        • EndpointGroupArn (string) --

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

        • EndpointId (string) --

          The ID for the virtual private cloud (VPC) subnet.

        • EndpointGroupRegion (string) --

          The Amazon Web Services Region for the endpoint group.

        • DestinationSocketAddress (dict) --

          The endpoint IP address/port combination for traffic received on the accelerator socket address.

          • IpAddress (string) --

            The IP address for the socket address.

          • Port (integer) --

            The port for the socket address.

        • IpAddressType (string) --

          The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.

        • DestinationTrafficState (string) --

          Indicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if traffic is allowed to the destination, or DENY, if traffic is not allowed to the destination.

    • NextToken (string) --

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

UpdateAccelerator (updated) Link ¶
Changes (request, response)
Request 
{'IpAddressType': {'DUAL_STACK'}}
Response 
{'Accelerator': {'DualStackDnsName': 'string',
                 'Events': [{'Message': 'string', 'Timestamp': 'timestamp'}],
                 'IpAddressType': {'DUAL_STACK'},
                 'IpSets': {'IpAddressFamily': 'IPv4 | IPv6'}}}

Update an accelerator.

Warning

Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2 on AWS CLI commands.

See also: AWS API Documentation

Request Syntax

client.update_accelerator(
    AcceleratorArn='string',
    Name='string',
    IpAddressType='IPV4'|'DUAL_STACK',
    Enabled=True|False
)
type AcceleratorArn

string

param AcceleratorArn

[REQUIRED]

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

type Name

string

param Name

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

type IpAddressType

string

param IpAddressType

The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.

type Enabled

boolean

param Enabled

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.

rtype

dict

returns

Response Syntax

{
    'Accelerator': {
        'AcceleratorArn': 'string',
        'Name': 'string',
        'IpAddressType': 'IPV4'|'DUAL_STACK',
        'Enabled': True|False,
        'IpSets': [
            {
                'IpFamily': 'string',
                'IpAddresses': [
                    'string',
                ],
                'IpAddressFamily': 'IPv4'|'IPv6'
            },
        ],
        'DnsName': 'string',
        'Status': 'DEPLOYED'|'IN_PROGRESS',
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1),
        'DualStackDnsName': 'string',
        'Events': [
            {
                'Message': 'string',
                'Timestamp': 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 IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.

      • 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) --

            IpFamily is deprecated and has been replaced by IpAddressFamily.

          • 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) --

          • IpAddressFamily (string) --

            The types of IP addresses included in this IP set.

      • DnsName (string) --

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

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

        If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four static addresses for the accelerator (two IPv4 addresses and two IPv6 addresses).

        For more information about the default DNS name, see Support for DNS Addressing in Global Accelerator in the 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.

      • DualStackDnsName (string) --

        The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses.

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

        Note: Global Accelerator also assigns a default DNS name, DnsName, to your accelerator that points just to the static IPv4 addresses.

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

      • Events (list) --

        A history of changes that you make to an accelerator in Global Accelerator.

        • (dict) --

          A complex type that contains a Timestamp value and Message for changes that you make to an accelerator in Global Accelerator. Messages stored here provide progress or error information when you update an accelerator from IPv4 to dual-stack, or from dual-stack to IPv4. Global Accelerator stores a maximum of ten event messages.

          • Message (string) --

            A string that contains an Event message describing changes or errors when you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.

          • Timestamp (datetime) --

            A timestamp for when you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.

UpdateCustomRoutingAccelerator (updated) Link ¶
Changes (request, response)
Request 
{'IpAddressType': {'DUAL_STACK'}}
Response 
{'Accelerator': {'IpAddressType': {'DUAL_STACK'},
                 'IpSets': {'IpAddressFamily': 'IPv4 | IPv6'}}}

Update a custom routing accelerator.

See also: AWS API Documentation

Request Syntax

client.update_custom_routing_accelerator(
    AcceleratorArn='string',
    Name='string',
    IpAddressType='IPV4'|'DUAL_STACK',
    Enabled=True|False
)
type AcceleratorArn

string

param AcceleratorArn

[REQUIRED]

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

type Name

string

param Name

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

type IpAddressType

string

param IpAddressType

The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.

type Enabled

boolean

param Enabled

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.

rtype

dict

returns

Response Syntax

{
    'Accelerator': {
        'AcceleratorArn': 'string',
        'Name': 'string',
        'IpAddressType': 'IPV4'|'DUAL_STACK',
        'Enabled': True|False,
        'IpSets': [
            {
                'IpFamily': 'string',
                'IpAddresses': [
                    'string',
                ],
                'IpAddressFamily': 'IPv4'|'IPv6'
            },
        ],
        '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 custom routing accelerator.

      • AcceleratorArn (string) --

        The Amazon Resource Name (ARN) of the custom routing 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 IP address type that an accelerator supports. For a custom routing accelerator, the value 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) --

            IpFamily is deprecated and has been replaced by IpAddressFamily.

          • 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) --

          • IpAddressFamily (string) --

            The types of IP addresses included in this IP set.

      • DnsName (string) --

        The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 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.

        If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four static addresses for the accelerator (two IPv4 addresses and two IPv6 addresses).

        For more information about the default DNS name, see Support for DNS Addressing in Global Accelerator in the 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.