describe_accelerator

GlobalAccelerator.Client.describe_accelerator(**kwargs)

Describe an accelerator.

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

Exceptions

• GlobalAccelerator.Client.exceptions.AcceleratorNotFoundException
• GlobalAccelerator.Client.exceptions.InternalServiceErrorException
• GlobalAccelerator.Client.exceptions.InvalidArgumentException