Amazon Global Accelerator Global Accelerator Operations API

openapi: 3.2.0
info:
  title: AWS Global Accelerator Operations API
  version: '2018-08-08'
  description: Generated from AWS's published Smithy model for AWS Global Accelerator. 8 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://globalaccelerator.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Operations
paths:
  /#ListCrossAccountResourceAccounts:
    post:
      operationId: ListCrossAccountResourceAccounts
      summary: List Cross Account Resource Accounts
      description: List the accounts that have cross-account resources. For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListCrossAccountResourceAccountsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServiceErrorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GlobalAccelerator_V20180706.ListCrossAccountResourceAccounts
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListCrossAccountResourceAccountsRequest'
      tags:
      - Operations
  /#ListCrossAccountResources:
    post:
      operationId: ListCrossAccountResources
      summary: List Cross Account Resources
      description: List the cross-account resources available to work with.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListCrossAccountResourcesResponse'
        '404':
          description: AcceleratorNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AcceleratorNotFoundException'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServiceErrorException'
        '400':
          description: InvalidArgumentException; InvalidNextTokenException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidArgumentException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GlobalAccelerator_V20180706.ListCrossAccountResources
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListCrossAccountResourcesRequest'
      tags:
      - Operations
components:
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    ListCrossAccountResourcesRequest:
      type: object
      properties:
        AcceleratorArn:
          type: string
          description: The Amazon Resource Name (ARN) of an accelerator in a cross-account attachment.
        ResourceOwnerAwsAccountId:
          type: string
          description: The account ID of a resource owner in a cross-account attachment.
        MaxResults:
          type: integer
          description: The number of cross-account resource objects that you want to return with this call. The default value is 10.
        NextToken:
          type: string
          description: The token for the next set of results. You receive this token from a previous call.
      required:
      - ResourceOwnerAwsAccountId
    AcceleratorNotFoundException:
      type: object
      properties:
        Message:
          type: string
    CrossAccountResource:
      type: object
      properties:
        EndpointId:
          type: string
          description: The endpoint ID for the endpoint that is listed in a cross-account attachment and can be added to an accelerator by specified principals.
        Cidr:
          type: string
          description: An IP address range, in CIDR format, that is specified as an Amazon Web Services resource. The address must be provisioned and advertised in Global Accelerator by following the bring your own IP address (BYOIP) process for Global Accelerator. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
        AttachmentArn:
          type: string
          description: The Amazon Resource Name (ARN) of the cross-account attachment that specifies the resources (endpoints or CIDR range) that can be added to accelerators and principals that have permission to add them.
    ListCrossAccountResourceAccountsResponse:
      type: object
      properties:
        ResourceOwnerAwsAccountIds:
          type: array
          items:
            type: string
          description: The account IDs of principals (resource owners) in a cross-account attachment who can work with resources listed in the same attachment.
    InvalidArgumentException:
      type: object
      properties:
        Message:
          type: string
    ListCrossAccountResourcesResponse:
      type: object
      properties:
        CrossAccountResources:
          type: array
          items:
            $ref: '#/components/schemas/CrossAccountResource'
          description: The cross-account resources used with an accelerator.
        NextToken:
          type: string
          description: The token for the next set of results. You receive this token from a previous call.
    ListCrossAccountResourceAccountsRequest:
      type: object
      properties: {}
    InternalServiceErrorException:
      type: object
      properties:
        Message:
          type: string
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: globalaccelerator
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/global-accelerator/service/2018-08-08/global-accelerator-2018-08-08.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)