CloudFront Anycast Ip List API

openapi: 3.1.0
info:
  title: Amazon CloudFront Anycast Ip List API
  version: '2020-05-31'
  description: Generated from AWS's published Smithy model for Amazon CloudFront. 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://cloudfront.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /2020-05-31/anycast-ip-list:
    post:
      operationId: CreateAnycastIpList
      summary: Create Anycast Ip List
      description: Creates an Anycast static IP list.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateAnycastIpListResult'
        '403':
          description: AccessDenied
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AccessDenied'
        '409':
          description: EntityAlreadyExists
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/EntityAlreadyExists'
        '400':
          description: EntityLimitExceeded; InvalidArgument; InvalidTagging; UnsupportedOperation
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/EntityLimitExceeded'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/CreateAnycastIpListRequest'
      tags:
      - Anycast Ip List
    get:
      operationId: ListAnycastIpLists
      summary: List Anycast Ip Lists
      description: Lists your Anycast static IP lists.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ListAnycastIpListsResult'
        '403':
          description: AccessDenied
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AccessDenied'
        '404':
          description: EntityNotFound
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/EntityNotFound'
        '400':
          description: InvalidArgument; UnsupportedOperation
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidArgument'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/ListAnycastIpListsRequest'
      tags:
      - Anycast Ip List
  /2020-05-31/anycast-ip-list/{Id}:
    delete:
      operationId: DeleteAnycastIpList
      summary: Delete Anycast Ip List
      description: Deletes an Anycast static IP list.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
        '403':
          description: AccessDenied
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AccessDenied'
        '409':
          description: CannotDeleteEntityWhileInUse
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CannotDeleteEntityWhileInUse'
        '404':
          description: EntityNotFound
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/EntityNotFound'
        '400':
          description: IllegalDelete; InvalidArgument; InvalidIfMatchVersion; UnsupportedOperation
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/IllegalDelete'
        '412':
          description: PreconditionFailed
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/PreconditionFailed'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/DeleteAnycastIpListRequest'
      tags:
      - Anycast Ip List
    get:
      operationId: GetAnycastIpList
      summary: Get Anycast Ip List
      description: Gets an Anycast static IP list.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GetAnycastIpListResult'
        '403':
          description: AccessDenied
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AccessDenied'
        '404':
          description: EntityNotFound
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/EntityNotFound'
        '400':
          description: InvalidArgument; UnsupportedOperation
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidArgument'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/GetAnycastIpListRequest'
      tags:
      - Anycast Ip List
    put:
      operationId: UpdateAnycastIpList
      summary: Update Anycast Ip List
      description: Updates an Anycast static IP list.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/UpdateAnycastIpListResult'
        '403':
          description: AccessDenied
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AccessDenied'
        '404':
          description: EntityNotFound
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/EntityNotFound'
        '400':
          description: InvalidArgument; InvalidIfMatchVersion; UnsupportedOperation
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidArgument'
        '412':
          description: PreconditionFailed
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/PreconditionFailed'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/UpdateAnycastIpListRequest'
      tags:
      - Anycast Ip List
components:
  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: cloudfront
  schemas:
    AccessDenied:
      type: object
      properties:
        Message:
          type: string
    AnycastIpList:
      type: object
      properties:
        Id:
          type: string
          description: The ID of the Anycast static IP list.
        Name:
          type: string
          description: The name of the Anycast static IP list.
        Status:
          type: string
          description: 'The status of the Anycast static IP list. Valid values: Deployed, Deploying, or Failed.'
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the Anycast static IP list.
        IpAddressType:
          type: string
          enum:
          - ipv4
          - ipv6
          - dualstack
          description: The IP address type for the Anycast static IP list.
        IpamConfig:
          $ref: '#/components/schemas/IpamConfig'
        AnycastIps:
          type: array
          items:
            type: string
          description: The static IP addresses that are allocated to the Anycast static IP list.
        IpCount:
          type: integer
          description: The number of IP addresses in the Anycast static IP list.
        LastModifiedTime:
          type: string
          format: date-time
          description: The last time the Anycast static IP list was modified.
      required:
      - Id
      - Name
      - Status
      - Arn
      - AnycastIps
      - IpCount
      - LastModifiedTime
    AnycastIpListCollection:
      type: object
      properties:
        Items:
          type: array
          items:
            $ref: '#/components/schemas/AnycastIpListSummary'
          description: Items in the Anycast static IP list collection. Each item is of the AnycastIpListSummary structure
            type.
        Marker:
          type: string
          description: Use this field when paginating results to indicate where to begin in your list. The response includes
            items in the list that occur after the marker. To get the next page of the list, set this field's value to the
            value of NextMarker from the current page's response.
        NextMarker:
          type: string
          description: Indicates the next page of the Anycast static IP list collection. To get the next page of the list,
            use this value in the Marker field of your request.
        MaxItems:
          type: integer
          description: The maximum number of Anycast static IP list collections that you want returned in the response.
        IsTruncated:
          type: boolean
          description: If there are more items in the list collection than are in this response, this value is true.
        Quantity:
          type: integer
          description: The quantity of Anycast static IP lists in the collection.
      required:
      - Marker
      - MaxItems
      - IsTruncated
      - Quantity
    AnycastIpListSummary:
      type: object
      properties:
        Id:
          type: string
          description: The ID of the Anycast static IP list.
        Name:
          type: string
          description: The name of the Anycast static IP list.
        Status:
          type: string
          description: 'The deployment status of the Anycast static IP list. Valid values: Deployed, Deploying, or Failed.'
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the Anycast static IP list.
        IpCount:
          type: integer
          description: The number of IP addresses in the Anycast static IP list.
        LastModifiedTime:
          type: string
          format: date-time
          description: The last time the Anycast static IP list was modified.
        IpAddressType:
          type: string
          enum:
          - ipv4
          - ipv6
          - dualstack
          description: The IP address type for the Anycast static IP list.
        ETag:
          type: string
          description: The current version (ETag value) of the Anycast static IP list.
        IpamConfig:
          $ref: '#/components/schemas/IpamConfig'
      required:
      - Id
      - Name
      - Status
      - Arn
      - IpCount
      - LastModifiedTime
    CannotDeleteEntityWhileInUse:
      type: object
      properties:
        Message:
          type: string
    CreateAnycastIpListRequest:
      type: object
      properties:
        Name:
          type: string
          description: Name of the Anycast static IP list.
        IpCount:
          type: integer
          description: 'The number of static IP addresses that are allocated to the Anycast static IP list. Valid values:
            21 or 3.'
        Tags:
          $ref: '#/components/schemas/Tags'
        IpAddressType:
          type: string
          enum:
          - ipv4
          - ipv6
          - dualstack
          description: 'The IP address type for the Anycast static IP list. You can specify one of the following options:
            ipv4 only ipv6 only dualstack - Allocate a list of both IPv4 and IPv6 addresses'
        IpamCidrConfigs:
          type: array
          items:
            $ref: '#/components/schemas/IpamCidrConfig'
          description: A list of IPAM CIDR configurations that specify the IP address ranges and IPAM pool settings for creating
            the Anycast static IP list.
      required:
      - Name
      - IpCount
    CreateAnycastIpListResult:
      type: object
      properties:
        AnycastIpList:
          $ref: '#/components/schemas/AnycastIpList'
        ETag:
          type: string
          description: The version identifier for the current version of the Anycast static IP list.
    DeleteAnycastIpListRequest:
      type: object
      properties:
        Id:
          type: string
          description: The ID of the Anycast static IP list.
        IfMatch:
          type: string
          description: The current version (ETag value) of the Anycast static IP list that you are deleting.
      required:
      - Id
      - IfMatch
    EntityAlreadyExists:
      type: object
      properties:
        Message:
          type: string
    EntityLimitExceeded:
      type: object
      properties:
        Message:
          type: string
    EntityNotFound:
      type: object
      properties:
        Message:
          type: string
    GetAnycastIpListRequest:
      type: object
      properties:
        Id:
          type: string
          description: The ID of the Anycast static IP list.
      required:
      - Id
    GetAnycastIpListResult:
      type: object
      properties:
        AnycastIpList:
          $ref: '#/components/schemas/AnycastIpList'
        ETag:
          type: string
          description: The version identifier for the current version of the Anycast static IP list.
    IllegalDelete:
      type: object
      properties:
        Message:
          type: string
    InvalidArgument:
      type: object
      properties:
        Message:
          type: string
    IpamCidrConfig:
      type: object
      properties:
        Cidr:
          type: string
          description: The CIDR that specifies the IP address range for this IPAM configuration.
        IpamPoolArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IPAM pool that the CIDR block is assigned to.
        AnycastIp:
          type: string
          description: The specified Anycast IP address allocated from the IPAM pool for this CIDR configuration.
        Status:
          type: string
          enum:
          - provisioned
          - failed-provision
          - provisioning
          - deprovisioned
          - failed-deprovision
          - deprovisioning
          - advertised
          - failed-advertise
          - advertising
          - withdrawn
          - failed-withdraw
          - withdrawing
          description: The current status of the IPAM CIDR configuration.
      required:
      - Cidr
      - IpamPoolArn
    IpamConfig:
      type: object
      properties:
        Quantity:
          type: integer
          description: The number of IPAM CIDR configurations in the IpamCidrConfigs list.
        IpamCidrConfigs:
          type: array
          items:
            $ref: '#/components/schemas/IpamCidrConfig'
          description: A list of IPAM CIDR configurations that define the IP address ranges, IPAM pools, and associated Anycast
            IP addresses.
      required:
      - Quantity
      - IpamCidrConfigs
    ListAnycastIpListsRequest:
      type: object
      properties:
        Marker:
          type: string
          description: Use this field when paginating results to indicate where to begin in your list. The response includes
            items in the list that occur after the marker. To get the next page of the list, set this field's value to the
            value of NextMarker from the current page's response.
        MaxItems:
          type: integer
          description: The maximum number of Anycast static IP lists that you want returned in the response.
    ListAnycastIpListsResult:
      type: object
      properties:
        AnycastIpLists:
          $ref: '#/components/schemas/AnycastIpListCollection'
    PreconditionFailed:
      type: object
      properties:
        Message:
          type: string
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: 'A string that contains Tag key. The string length should be between 1 and 128 characters. Valid characters
            include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.'
        Value:
          type: string
          description: 'A string that contains an optional Tag value. The string length should be between 0 and 256 characters.
            Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.'
      required:
      - Key
    Tags:
      type: object
      properties:
        Items:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A complex type that contains Tag elements.
    UpdateAnycastIpListRequest:
      type: object
      properties:
        Id:
          type: string
          description: The ID of the Anycast static IP list.
        IpAddressType:
          type: string
          enum:
          - ipv4
          - ipv6
          - dualstack
          description: 'The IP address type for the Anycast static IP list. You can specify one of the following options:
            ipv4 only ipv6 only dualstack - Allocate a list of both IPv4 and IPv6 addresses'
        IpamCidrConfigs:
          type: array
          items:
            $ref: '#/components/schemas/IpamCidrConfig'
          description: A list of IPAM CIDR configurations that specify the IP address ranges and IPAM pool settings for updating
            the Anycast static IP list.
        IfMatch:
          type: string
          description: The current version (ETag value) of the Anycast static IP list that you are updating.
      required:
      - Id
      - IfMatch
    UpdateAnycastIpListResult:
      type: object
      properties:
        AnycastIpList:
          $ref: '#/components/schemas/AnycastIpList'
        ETag:
          type: string
          description: The current version of the Anycast static IP list.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/cloudfront/service/2020-05-31/cloudfront-2020-05-31.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)