AWS Global Accelerator

{'Accelerator': {'DnsName': 'string'}}

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.

See also: AWS API Documentation

Request Syntax

client.create_accelerator(
    Name='string',
    IpAddressType='IPV4',
    Enabled=True|False,
    IdempotencyToken='string'
)

type Name:

string

param Name:

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

type IpAddressType:

string

param IpAddressType:

The value for the address type 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, 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.

rtype:

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: a lower case 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.

{'Accelerator': {'DnsName': 'string'}}

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

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',
        '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: a lower case 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.

{'Accelerators': {'DnsName': 'string'}}

List the accelerators for an AWS 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',
            '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: a lower case 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.

{'Accelerator': {'DnsName': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.update_accelerator(
    AcceleratorArn='string',
    Name='string',
    IpAddressType='IPV4',
    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 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

type IpAddressType:

string

param IpAddressType:

The value for the address type 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',
        '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: a lower case 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.