Amazon Global Accelerator Global Accelerator Cross Account Attachment API

openapi: 3.2.0
info:
  title: AWS Global Accelerator Cross Account Attachment API
  version: '2018-08-08'
  description: Generated from AWS's published Smithy model for AWS Global Accelerator. 5 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: Cross Account Attachment
paths:
  /#CreateCrossAccountAttachment:
    post:
      operationId: CreateCrossAccountAttachment
      summary: Create Cross Account Attachment
      description: 'Create a cross-account attachment in Global Accelerator. You create a cross-account attachment to specify the principals who have permission to work with resources in accelerators in their own account. You specify, in the same attachment, the resources that are shared. A principal can be an Amazon Web Services account number or the Amazon Resource Name (ARN) for an accelerator. For account numbers that are listed as principals, to work with a resource listed in the attachment, you must sign in to an account specified as a principal. Then, you can work with resources that are listed, with any of your accelerators. If an accelerator ARN is listed in the cross-account attachment as a principal, anyone with permission to make updates to the accelerator can work with resources that are listed in the attachment. Specify each principal and resource separately. To specify two CIDR address pools, list them individually under Resources, and so on. For a command line operation, for example, you might use a statement like the following: "Resources": [{"Cidr": "169.254.60.0/24"},{"Cidr": "169.254.59.0/24"}] For more information, see Working with cross-account attachments and resources in Global'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateCrossAccountAttachmentResponse'
        '403':
          description: AccessDeniedException; LimitExceededException
          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
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidArgumentException'
        '409':
          description: TransactionInProgressException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/TransactionInProgressException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GlobalAccelerator_V20180706.CreateCrossAccountAttachment
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateCrossAccountAttachmentRequest'
      tags:
      - Cross Account Attachment
  /#DeleteCrossAccountAttachment:
    post:
      operationId: DeleteCrossAccountAttachment
      summary: Delete Cross Account Attachment
      description: Delete a cross-account attachment. When you delete an attachment, Global Accelerator revokes the permission to use the resources in the attachment from all principals in the list of principals. Global Accelerator revokes the permission for specific 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:
                type: string
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '404':
          description: AttachmentNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AttachmentNotFoundException'
        '500':
          description: InternalServiceErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServiceErrorException'
        '400':
          description: InvalidArgumentException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidArgumentException'
        '409':
          description: TransactionInProgressException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/TransactionInProgressException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GlobalAccelerator_V20180706.DeleteCrossAccountAttachment
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteCrossAccountAttachmentRequest'
      tags:
      - Cross Account Attachment
  /#DescribeCrossAccountAttachment:
    post:
      operationId: DescribeCrossAccountAttachment
      summary: Describe Cross Account Attachment
      description: Gets configuration information about a cross-account attachment.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeCrossAccountAttachmentResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '404':
          description: AttachmentNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AttachmentNotFoundException'
        '500':
          description: InternalServiceErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServiceErrorException'
        '400':
          description: InvalidArgumentException
          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.DescribeCrossAccountAttachment
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeCrossAccountAttachmentRequest'
      tags:
      - Cross Account Attachment
  /#ListCrossAccountAttachments:
    post:
      operationId: ListCrossAccountAttachments
      summary: List Cross Account Attachments
      description: List the cross-account attachments that have been created in Global Accelerator.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListCrossAccountAttachmentsResponse'
        '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.ListCrossAccountAttachments
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListCrossAccountAttachmentsRequest'
      tags:
      - Cross Account Attachment
  /#UpdateCrossAccountAttachment:
    post:
      operationId: UpdateCrossAccountAttachment
      summary: Update Cross Account Attachment
      description: Update a cross-account attachment to add or remove principals or resources. When you update an attachment to remove a principal (account ID or accelerator) or a resource, Global Accelerator revokes the permission for specific 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/UpdateCrossAccountAttachmentResponse'
        '403':
          description: AccessDeniedException; LimitExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '404':
          description: AttachmentNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AttachmentNotFoundException'
        '500':
          description: InternalServiceErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServiceErrorException'
        '400':
          description: InvalidArgumentException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidArgumentException'
        '409':
          description: TransactionInProgressException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/TransactionInProgressException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GlobalAccelerator_V20180706.UpdateCrossAccountAttachment
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateCrossAccountAttachmentRequest'
      tags:
      - Cross Account Attachment
components:
  schemas:
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: A string that contains a Tag key.
        Value:
          type: string
          description: A string that contains a Tag value.
      required:
      - Key
      - Value
    DeleteCrossAccountAttachmentRequest:
      type: object
      properties:
        AttachmentArn:
          type: string
          description: The Amazon Resource Name (ARN) for the cross-account attachment to delete.
      required:
      - AttachmentArn
    Resource:
      type: object
      properties:
        EndpointId:
          type: string
          description: The endpoint ID for the endpoint that is specified as a Amazon Web Services resource. An endpoint ID for the cross-account feature is the ARN of an Amazon Web Services resource, such as a Network Load Balancer, that Global Accelerator supports as an endpoint for an accelerator.
        Cidr:
          type: string
          description: An IP address range, in CIDR format, that is specified as 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.
        Region:
          type: string
          description: The Amazon Web Services Region where a shared endpoint resource is located.
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    DescribeCrossAccountAttachmentRequest:
      type: object
      properties:
        AttachmentArn:
          type: string
          description: The Amazon Resource Name (ARN) for the cross-account attachment to describe.
      required:
      - AttachmentArn
    ListCrossAccountAttachmentsResponse:
      type: object
      properties:
        CrossAccountAttachments:
          type: array
          items:
            $ref: '#/components/schemas/Attachment'
          description: Information about the cross-account attachments.
        NextToken:
          type: string
          description: The token for the next set of results. You receive this token from a previous call.
    CreateCrossAccountAttachmentResponse:
      type: object
      properties:
        CrossAccountAttachment:
          $ref: '#/components/schemas/Attachment'
    ListCrossAccountAttachmentsRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The number of cross-account attachment 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.
    AttachmentNotFoundException:
      type: object
      properties:
        Message:
          type: string
    UpdateCrossAccountAttachmentRequest:
      type: object
      properties:
        AttachmentArn:
          type: string
          description: The Amazon Resource Name (ARN) of the cross-account attachment to update.
        Name:
          type: string
          description: The name of the cross-account attachment.
        AddPrincipals:
          type: array
          items:
            type: string
          description: The principals to add to the cross-account attachment. A principal is an account or the Amazon Resource Name (ARN) of an accelerator that the attachment gives permission to work with resources from another account. The resources are also listed in the attachment. To add more than one principal, separate the account numbers or accelerator ARNs, or both, with commas.
        RemovePrincipals:
          type: array
          items:
            type: string
          description: The principals to remove from the cross-account attachment. A principal is an account or the Amazon Resource Name (ARN) of an accelerator that the attachment gives permission to work with resources from another account. The resources are also listed in the attachment. To remove more than one principal, separate the account numbers or accelerator ARNs, or both, with commas.
        AddResources:
          type: array
          items:
            $ref: '#/components/schemas/Resource'
          description: The resources to add to the cross-account attachment. A resource listed in a cross-account attachment can be used with an accelerator by the principals that are listed in the attachment. To add more than one resource, separate the resource ARNs with commas.
        RemoveResources:
          type: array
          items:
            $ref: '#/components/schemas/Resource'
          description: The resources to remove from the cross-account attachment. A resource listed in a cross-account attachment can be used with an accelerator by the principals that are listed in the attachment. To remove more than one resource, separate the resource ARNs with commas.
      required:
      - AttachmentArn
    UpdateCrossAccountAttachmentResponse:
      type: object
      properties:
        CrossAccountAttachment:
          $ref: '#/components/schemas/Attachment'
    InternalServiceErrorException:
      type: object
      properties:
        Message:
          type: string
    InvalidArgumentException:
      type: object
      properties:
        Message:
          type: string
    TransactionInProgressException:
      type: object
      properties:
        Message:
          type: string
    CreateCrossAccountAttachmentRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the cross-account attachment.
        Principals:
          type: array
          items:
            type: string
          description: The principals to include in the cross-account attachment. A principal can be an Amazon Web Services account number or the Amazon Resource Name (ARN) for an accelerator.
        Resources:
          type: array
          items:
            $ref: '#/components/schemas/Resource'
          description: The Amazon Resource Names (ARNs) for the resources to include in the cross-account attachment. A resource can be any supported Amazon Web Services resource type for Global Accelerator or a CIDR range for a bring your own IP address (BYOIP) address pool.
        IdempotencyToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Add tags for a cross-account attachment. For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
      required:
      - Name
      - IdempotencyToken
    DescribeCrossAccountAttachmentResponse:
      type: object
      properties:
        CrossAccountAttachment:
          $ref: '#/components/schemas/Attachment'
    Attachment:
      type: object
      properties:
        AttachmentArn:
          type: string
          description: The Amazon Resource Name (ARN) of the cross-account attachment.
        Name:
          type: string
          description: The name of the cross-account attachment.
        Principals:
          type: array
          items:
            type: string
          description: The principals included in the cross-account attachment.
        Resources:
          type: array
          items:
            $ref: '#/components/schemas/Resource'
          description: The resources included in the cross-account attachment.
        LastModifiedTime:
          type: string
          format: date-time
          description: The date and time that the cross-account attachment was last modified.
        CreatedTime:
          type: string
          format: date-time
          description: The date and time that the cross-account attachment was created.
  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)