Amazon Global Accelerator #X Amz Target=GlobalAccelerator V20180706.ListCustomRoutingAccelerators API

openapi: 3.2.0
info:
  version: '2018-08-08'
  x-release: v4
  title: 'AWS Global Accelerator #X Amz Target=GlobalAccelerator…'
  description: 'Global Accelerator

    This is the Global Accelerator API Reference.'
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: globalaccelerator
  x-aws-signingName: globalaccelerator
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/globalaccelerator-2018-08-08.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://globalaccelerator.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Global Accelerator multi-region endpoint
- url: https://globalaccelerator.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Global Accelerator multi-region endpoint
- url: http://globalaccelerator.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Global Accelerator endpoint for China (Beijing) and China (Ningxia)
- url: https://globalaccelerator.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Global Accelerator endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=GlobalAccelerator V20180706.ListCustomRoutingAccelerators'
paths:
  /#X-Amz-Target=GlobalAccelerator_V20180706.ListCustomRoutingAccelerators:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: ListCustomRoutingAccelerators
      description: List the custom routing accelerators for an Amazon Web Services account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCustomRoutingAcceleratorsResponse'
              examples:
                ListCustomRoutingAccelerators200Example:
                  summary: Default ListCustomRoutingAccelerators 200 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '480':
          description: InvalidArgumentException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidArgumentException'
              examples:
                ListCustomRoutingAccelerators480Example:
                  summary: Default ListCustomRoutingAccelerators 480 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '481':
          description: InvalidNextTokenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
              examples:
                ListCustomRoutingAccelerators481Example:
                  summary: Default ListCustomRoutingAccelerators 481 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '482':
          description: InternalServiceErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceErrorException'
              examples:
                ListCustomRoutingAccelerators482Example:
                  summary: Default ListCustomRoutingAccelerators 482 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListCustomRoutingAcceleratorsRequest'
      parameters:
      - name: MaxResults
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: NextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GlobalAccelerator_V20180706.ListCustomRoutingAccelerators
      summary: Amazon Global Accelerator List Custom Routing Accelerators
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=GlobalAccelerator V20180706.ListCustomRoutingAccelerators'
components:
  schemas:
    CustomRoutingAccelerator:
      type: object
      properties:
        AcceleratorArn:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The Amazon Resource Name (ARN) of the custom routing accelerator.
        Name:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
        IpAddressType:
          allOf:
          - $ref: '#/components/schemas/IpAddressType'
          - description: The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.
        Enabled:
          allOf:
          - $ref: '#/components/schemas/GenericBoolean'
          - description: <p>Indicates whether the accelerator is enabled. The value is true or false. The default value is true. </p> <p>If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.</p>
        IpSets:
          allOf:
          - $ref: '#/components/schemas/IpSets'
          - description: The static IP addresses that Global Accelerator associates with the accelerator.
        DnsName:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: '<p>The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator''s static IPv4 addresses. </p> <p>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.</p> <p>If you have a dual-stack accelerator, you also have a second DNS name, <code>DualStackDnsName</code>, 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.</p> <p>For more information about the default DNS name, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/dns-addressing-custom-domains.dns-addressing.html"> Support for DNS addressing in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>'
        Status:
          allOf:
          - $ref: '#/components/schemas/CustomRoutingAcceleratorStatus'
          - description: Describes the deployment status of the accelerator.
        CreatedTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date and time that the accelerator was created.
        LastModifiedTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date and time that the accelerator was last modified.
      description: Attributes of a custom routing accelerator.
    IpSet:
      type: object
      properties:
        IpFamily:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - deprecated: true
            description: IpFamily is deprecated and has been replaced by IpAddressFamily.IpFamily has been replaced by IpAddressFamily
        IpAddresses:
          allOf:
          - $ref: '#/components/schemas/IpAddresses'
          - description: The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.
        IpAddressFamily:
          allOf:
          - $ref: '#/components/schemas/IpAddressFamily'
          - description: 'The types of IP addresses included in this IP set. '
      description: A complex type for the set of IP addresses for an accelerator.
    InternalServiceErrorException: {}
    IpAddressFamily:
      type: string
      enum:
      - IPv4
      - IPv6
    IpAddressType:
      type: string
      enum:
      - IPV4
      - DUAL_STACK
    IpSets:
      type: array
      items:
        $ref: '#/components/schemas/IpSet'
    IpAddress:
      type: string
      maxLength: 45
    InvalidArgumentException: {}
    IpAddresses:
      type: array
      items:
        $ref: '#/components/schemas/IpAddress'
      minItems: 0
      maxItems: 2
    GenericBoolean:
      type: boolean
    Timestamp:
      type: string
      format: date-time
    InvalidNextTokenException: {}
    ListCustomRoutingAcceleratorsRequest:
      type: object
      title: ListCustomRoutingAcceleratorsRequest
      properties:
        MaxResults:
          allOf:
          - $ref: '#/components/schemas/MaxResults'
          - description: The number of custom routing Global Accelerator objects that you want to return with this call. The default value is 10.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The token for the next set of results. You receive this token from a previous call.
    CustomRoutingAcceleratorStatus:
      type: string
      enum:
      - DEPLOYED
      - IN_PROGRESS
    MaxResults:
      type: integer
      minimum: 1
      maximum: 100
    CustomRoutingAccelerators:
      type: array
      items:
        $ref: '#/components/schemas/CustomRoutingAccelerator'
    ListCustomRoutingAcceleratorsResponse:
      type: object
      properties:
        Accelerators:
          allOf:
          - $ref: '#/components/schemas/CustomRoutingAccelerators'
          - description: The list of custom routing accelerators for a customer account.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The token for the next set of results. You receive this token from a previous call.
    GenericString:
      type: string
      maxLength: 255
  parameters:
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/globalaccelerator/
x-hasEquivalentPaths: true