Amazon EC2 Ec2 Managed Prefix List API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Managed Prefix List API
  version: '2016-11-15'
  description: Generated from AWS's published Smithy model for Amazon Elastic Compute Cloud. 4 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://ec2.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Managed Prefix List
paths:
  /?Action=CreateManagedPrefixList:
    post:
      operationId: CreateManagedPrefixList
      summary: Create Managed Prefix List
      description: Creates a managed prefix list. You can specify entries for the prefix list. Each entry consists of a CIDR block and an optional description.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateManagedPrefixListResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateManagedPrefixList
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateManagedPrefixListRequest'
      tags:
      - Managed Prefix List
  /?Action=DeleteManagedPrefixList:
    post:
      operationId: DeleteManagedPrefixList
      summary: Delete Managed Prefix List
      description: Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteManagedPrefixListResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteManagedPrefixList
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteManagedPrefixListRequest'
      tags:
      - Managed Prefix List
  /?Action=DescribeManagedPrefixLists:
    post:
      operationId: DescribeManagedPrefixLists
      summary: Describe Managed Prefix Lists
      description: Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeManagedPrefixListsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeManagedPrefixLists
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeManagedPrefixListsRequest'
      tags:
      - Managed Prefix List
  /?Action=ModifyManagedPrefixList:
    post:
      operationId: ModifyManagedPrefixList
      summary: Modify Managed Prefix List
      description: Modifies the specified managed prefix list. Adding or removing entries in a prefix list creates a new version of the prefix list. Changing the name of the prefix list does not affect the version. If you specify a current version number that does not match the true current version number, the request fails.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyManagedPrefixListResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyManagedPrefixList
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/ModifyManagedPrefixListRequest'
      tags:
      - Managed Prefix List
components:
  schemas:
    CreateManagedPrefixListResult:
      type: object
      properties:
        PrefixList:
          $ref: '#/components/schemas/ManagedPrefixList'
    DeleteManagedPrefixListRequest:
      type: object
      properties:
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
        PrefixListId:
          type: string
          description: The ID of the prefix list.
      required:
      - PrefixListId
    AddPrefixListEntry:
      type: object
      properties:
        Cidr:
          type: string
          description: The CIDR block.
        Description:
          type: string
          description: 'A description for the entry. Constraints: Up to 255 characters in length.'
      required:
      - Cidr
    DeleteManagedPrefixListResult:
      type: object
      properties:
        PrefixList:
          $ref: '#/components/schemas/ManagedPrefixList'
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: 'The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.'
        Value:
          type: string
          description: 'The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.'
    DescribeManagedPrefixListsRequest:
      type: object
      properties:
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: One or more filters. owner-id - The ID of the prefix list owner. prefix-list-id - The ID of the prefix list. prefix-list-name - The name of the prefix list.
        MaxResults:
          type: integer
          description: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
        NextToken:
          type: string
          description: The token for the next page of results.
        PrefixListIds:
          type: array
          items:
            type: string
          description: One or more prefix list IDs.
    CreateManagedPrefixListRequest:
      type: object
      properties:
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
        PrefixListName:
          type: string
          description: 'A name for the prefix list. Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.'
        Entries:
          type: array
          items:
            $ref: '#/components/schemas/AddPrefixListEntry'
          description: One or more entries for the prefix list.
        MaxEntries:
          type: integer
          description: The maximum number of entries for the prefix list.
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to apply to the prefix list during creation.
        AddressFamily:
          type: string
          description: 'The IP address type. Valid Values: IPv4 | IPv6'
        ClientToken:
          type: string
          description: 'Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. Constraints: Up to 255 UTF-8 characters in length.'
      required:
      - PrefixListName
      - MaxEntries
      - AddressFamily
    RemovePrefixListEntry:
      type: object
      properties:
        Cidr:
          type: string
          description: The CIDR block.
      required:
      - Cidr
    ModifyManagedPrefixListResult:
      type: object
      properties:
        PrefixList:
          $ref: '#/components/schemas/ManagedPrefixList'
    TagSpecification:
      type: object
      properties:
        ResourceType:
          type: string
          enum:
          - capacity-reservation
          - client-vpn-endpoint
          - customer-gateway
          - carrier-gateway
          - coip-pool
          - declarative-policies-report
          - dedicated-host
          - dhcp-options
          - egress-only-internet-gateway
          - elastic-ip
          - elastic-gpu
          - export-image-task
          - export-instance-task
          - fleet
          - fpga-image
          - host-reservation
          - image
          - image-usage-report
          - import-image-task
          - import-snapshot-task
          - instance
          - instance-event-window
          - internet-gateway
          - ipam
          - ipam-pool
          - ipam-scope
          - ipv4pool-ec2
          - ipv6pool-ec2
          - key-pair
          - launch-template
          - local-gateway
          - local-gateway-route-table
          - local-gateway-virtual-interface
          - local-gateway-virtual-interface-group
          - local-gateway-route-table-vpc-association
          - local-gateway-route-table-virtual-interface-group-association
          - natgateway
          - network-acl
          - network-interface
          - network-insights-analysis
          - network-insights-path
          - network-insights-access-scope
          - network-insights-access-scope-analysis
          - outpost-lag
          - placement-group
          - prefix-list
          - replace-root-volume-task
          - reserved-instances
          - route-table
          - security-group
          - security-group-rule
          - service-link-virtual-interface
          - snapshot
          - spot-fleet-request
          - spot-instances-request
          - subnet
          - subnet-cidr-reservation
          - traffic-mirror-filter
          - traffic-mirror-session
          - traffic-mirror-target
          - transit-gateway
          - transit-gateway-attachment
          - transit-gateway-connect-peer
          - transit-gateway-multicast-domain
          - transit-gateway-policy-table
          - transit-gateway-metering-policy
          - transit-gateway-route-table
          - transit-gateway-route-table-announcement
          - volume
          - vpc
          - vpc-endpoint
          - vpc-endpoint-connection
          - vpc-endpoint-service
          - vpc-endpoint-service-permission
          - vpc-peering-connection
          - vpn-connection
          - vpn-gateway
          - vpc-flow-log
          - capacity-reservation-fleet
          - traffic-mirror-filter-rule
          - vpc-endpoint-connection-device-type
          - verified-access-instance
          - verified-access-group
          - verified-access-endpoint
          - verified-access-policy
          - verified-access-trust-provider
          - vpn-connection-device-type
          - vpc-block-public-access-exclusion
          - vpc-encryption-control
          - route-server
          - route-server-endpoint
          - route-server-peer
          - ipam-resource-discovery
          - ipam-resource-discovery-association
          - instance-connect-endpoint
          - verified-access-endpoint-target
          - ipam-external-resource-verification-token
          - capacity-block
          - mac-modification-task
          - ipam-prefix-list-resolver
          - ipam-policy
          - ipam-prefix-list-resolver-target
          - ipam-internet-registry-association
          - secondary-interface
          - secondary-network
          - secondary-subnet
          - capacity-manager-data-export
          - vpn-concentrator
          - ipam-pool-allocation
          - capacity-reservation-cancellation-quote
          - application-status-check
          - capacity-reservation-modification-quote
          description: The type of resource to tag on creation.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags to apply to the resource.
    ModifyManagedPrefixListRequest:
      type: object
      properties:
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
        PrefixListId:
          type: string
          description: The ID of the prefix list.
        CurrentVersion:
          type: integer
          description: The current version of the prefix list.
        PrefixListName:
          type: string
          description: A name for the prefix list.
        AddEntries:
          type: array
          items:
            $ref: '#/components/schemas/AddPrefixListEntry'
          description: One or more entries to add to the prefix list.
        RemoveEntries:
          type: array
          items:
            $ref: '#/components/schemas/RemovePrefixListEntry'
          description: One or more entries to remove from the prefix list.
        MaxEntries:
          type: integer
          description: The maximum number of entries for the prefix list. You cannot modify the entries of a prefix list and modify the size of a prefix list at the same time. If any of the resources that reference the prefix list cannot support the new maximum size, the modify operation fails. Check the state message for the IDs of the first ten resources that do not support the new maximum size.
        IpamPrefixListResolverSyncEnabled:
          type: boolean
          description: Indicates whether synchronization with an IPAM prefix list resolver should be enabled for this managed prefix list. When enabled, the prefix list CIDRs are automatically updated based on the associated resolver's CIDR selection rules.
      required:
      - PrefixListId
    ManagedPrefixList:
      type: object
      properties:
        PrefixListId:
          type: string
          description: The ID of the prefix list.
        AddressFamily:
          type: string
          description: The IP address version.
        State:
          type: string
          enum:
          - create-in-progress
          - create-complete
          - create-failed
          - modify-in-progress
          - modify-complete
          - modify-failed
          - restore-in-progress
          - restore-complete
          - restore-failed
          - delete-in-progress
          - delete-complete
          - delete-failed
          description: The current state of the prefix list.
        StateMessage:
          type: string
          description: The state message.
        PrefixListArn:
          type: string
          description: The Amazon Resource Name (ARN) for the prefix list.
        PrefixListName:
          type: string
          description: The name of the prefix list.
        MaxEntries:
          type: integer
          description: The maximum number of entries for the prefix list.
        Version:
          type: integer
          description: The version of the prefix list.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags for the prefix list.
        OwnerId:
          type: string
          description: The ID of the owner of the prefix list.
        IpamPrefixListResolverTargetId:
          type: string
          description: The ID of the IPAM prefix list resolver target associated with this managed prefix list. When set, this prefix list becomes an IPAM managed prefix list. An IPAM-managed prefix list is a customer-managed prefix list that has been associated with an IPAM prefix list resolver target. When a prefix list becomes IPAM managed, its CIDRs are automatically synchronized based on the IPAM prefix list resolver's CIDR selection rules, and direct CIDR modifications are restricted.
        IpamPrefixListResolverSyncEnabled:
          type: boolean
          description: Indicates whether synchronization with an IPAM prefix list resolver is enabled for this managed prefix list. When enabled, the prefix list CIDRs are automatically updated based on the resolver's CIDR selection rules.
    Filter:
      type: object
      properties:
        Name:
          type: string
          description: The name of the filter. Filter names are case-sensitive.
        Values:
          type: array
          items:
            type: string
          description: The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
    DescribeManagedPrefixListsResult:
      type: object
      properties:
        NextToken:
          type: string
          description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
        PrefixLists:
          type: array
          items:
            $ref: '#/components/schemas/ManagedPrefixList'
          description: Information about the prefix lists.
  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: ec2
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/ec2/service/2016-11-15/ec2-2016-11-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)