Amazon EC2 Ec2 Ipam Prefix List Resolver API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Ipam Prefix List Resolver 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: Ipam Prefix List Resolver
paths:
  /?Action=CreateIpamPrefixListResolver:
    post:
      operationId: CreateIpamPrefixListResolver
      summary: Create Ipam Prefix List Resolver
      description: Creates an IPAM prefix list resolver. An IPAM prefix list resolver is a component that manages the synchronization between IPAM's CIDR selection rules and customer-managed prefix lists. It automates connectivity configurations by selecting CIDRs from IPAM's database based on your business logic and synchronizing them with prefix lists used in resources such as VPC route tables and security groups. For more information about IPAM prefix list resolver, see Automate prefix list updates with IPAM in the Amazon VPC IPAM User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateIpamPrefixListResolverResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateIpamPrefixListResolver
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateIpamPrefixListResolverRequest'
      tags:
      - Ipam Prefix List Resolver
  /?Action=DeleteIpamPrefixListResolver:
    post:
      operationId: DeleteIpamPrefixListResolver
      summary: Delete Ipam Prefix List Resolver
      description: Deletes an IPAM prefix list resolver. Before deleting a resolver, you must first delete all resolver targets associated with it.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteIpamPrefixListResolverResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteIpamPrefixListResolver
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteIpamPrefixListResolverRequest'
      tags:
      - Ipam Prefix List Resolver
  /?Action=DescribeIpamPrefixListResolvers:
    post:
      operationId: DescribeIpamPrefixListResolvers
      summary: Describe Ipam Prefix List Resolvers
      description: Describes one or more IPAM prefix list resolvers. Use this operation to view the configuration, status, and properties of your resolvers.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeIpamPrefixListResolversResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeIpamPrefixListResolvers
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeIpamPrefixListResolversRequest'
      tags:
      - Ipam Prefix List Resolver
  /?Action=ModifyIpamPrefixListResolver:
    post:
      operationId: ModifyIpamPrefixListResolver
      summary: Modify Ipam Prefix List Resolver
      description: Modifies an IPAM prefix list resolver. You can update the description and CIDR selection rules. Changes to rules will trigger re-evaluation and potential updates to associated prefix lists.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyIpamPrefixListResolverResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyIpamPrefixListResolver
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/ModifyIpamPrefixListResolverRequest'
      tags:
      - Ipam Prefix List Resolver
components:
  schemas:
    IpamPrefixListResolverRuleConditionRequest:
      type: object
      properties:
        Operation:
          type: string
          enum:
          - equals
          - not-equals
          - subnet-of
          description: The operation to perform when evaluating this condition.
        IpamPoolId:
          type: string
          description: The ID of the IPAM pool to match against. This condition selects CIDRs that belong to the specified IPAM pool.
        ResourceId:
          type: string
          description: The ID of the Amazon Web Services resource to match against. This condition selects CIDRs associated with the specified resource.
        ResourceOwner:
          type: string
          description: The Amazon Web Services account ID that owns the resources to match against. This condition selects CIDRs from resources owned by the specified account.
        ResourceRegion:
          type: string
          description: The Amazon Web Services Region where the resources are located. This condition selects CIDRs from resources in the specified Region.
        ResourceTag:
          $ref: '#/components/schemas/RequestIpamResourceTag'
        Cidr:
          type: string
          description: A CIDR block to match against. This condition selects CIDRs that fall within or match the specified CIDR range.
      required:
      - Operation
    CreateIpamPrefixListResolverRequest:
      type: object
      properties:
        DryRun:
          type: boolean
          description: A check for 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.
        IpamId:
          type: string
          description: The ID of the IPAM that will serve as the source of the IP address database for CIDR selection. The IPAM must be in the Advanced tier to use this feature.
        Description:
          type: string
          description: A description for the IPAM prefix list resolver to help you identify its purpose and configuration.
        AddressFamily:
          type: string
          enum:
          - ipv4
          - ipv6
          description: The address family for the IPAM prefix list resolver. Valid values are ipv4 and ipv6. You must create separate resolvers for IPv4 and IPv6 CIDRs as they cannot be mixed in the same resolver.
        Rules:
          type: array
          items:
            $ref: '#/components/schemas/IpamPrefixListResolverRuleRequest'
          description: The CIDR selection rules for the resolver. CIDR selection rules define the business logic for selecting CIDRs from IPAM. If a CIDR matches any of the rules, it will be included. If a rule has multiple conditions, the CIDR has to match every condition of that rule. You can create a prefix list resolver without any CIDR selection rules, but it will generate empty versions (containing no CIDRs) until you add rules.
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to apply to the IPAM prefix list resolver during creation. Tags help you organize and manage your Amazon Web Services resources.
        ClientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
      required:
      - IpamId
      - AddressFamily
    ModifyIpamPrefixListResolverResult:
      type: object
      properties:
        IpamPrefixListResolver:
          $ref: '#/components/schemas/IpamPrefixListResolver'
    RequestIpamResourceTag:
      type: object
      properties:
        Key:
          type: string
          description: The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
        Value:
          type: string
          description: The value for the tag.
    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.'
    DescribeIpamPrefixListResolversResult:
      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.
        IpamPrefixListResolvers:
          type: array
          items:
            $ref: '#/components/schemas/IpamPrefixListResolver'
          description: Information about the IPAM prefix list resolvers.
    DescribeIpamPrefixListResolversRequest:
      type: object
      properties:
        DryRun:
          type: boolean
          description: A check for 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 to limit the results.
        MaxResults:
          type: integer
          description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
        NextToken:
          type: string
          description: The token for the next page of results.
        IpamPrefixListResolverIds:
          type: array
          items:
            type: string
          description: The IDs of the IPAM prefix list resolvers to describe. If not specified, all resolvers in your account are described.
    DeleteIpamPrefixListResolverRequest:
      type: object
      properties:
        DryRun:
          type: boolean
          description: A check for 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.
        IpamPrefixListResolverId:
          type: string
          description: The ID of the IPAM prefix list resolver to delete.
      required:
      - IpamPrefixListResolverId
    CreateIpamPrefixListResolverResult:
      type: object
      properties:
        IpamPrefixListResolver:
          $ref: '#/components/schemas/IpamPrefixListResolver'
    ModifyIpamPrefixListResolverRequest:
      type: object
      properties:
        DryRun:
          type: boolean
          description: A check for 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.
        IpamPrefixListResolverId:
          type: string
          description: The ID of the IPAM prefix list resolver to modify.
        Description:
          type: string
          description: A new description for the IPAM prefix list resolver.
        Rules:
          type: array
          items:
            $ref: '#/components/schemas/IpamPrefixListResolverRuleRequest'
          description: The updated CIDR selection rules for the resolver. These rules replace the existing rules entirely.
      required:
      - IpamPrefixListResolverId
    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.
    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.
    DeleteIpamPrefixListResolverResult:
      type: object
      properties:
        IpamPrefixListResolver:
          $ref: '#/components/schemas/IpamPrefixListResolver'
    IpamPrefixListResolver:
      type: object
      properties:
        OwnerId:
          type: string
          description: The ID of the Amazon Web Services account that owns the IPAM prefix list resolver.
        IpamPrefixListResolverId:
          type: string
          description: The ID of the IPAM prefix list resolver.
        IpamPrefixListResolverArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IPAM prefix list resolver.
        IpamArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IPAM associated with this resolver.
        IpamRegion:
          type: string
          description: The Amazon Web Services Region where the associated IPAM is located.
        Description:
          type: string
          description: The description of the IPAM prefix list resolver.
        AddressFamily:
          type: string
          enum:
          - ipv4
          - ipv6
          description: The address family (IPv4 or IPv6) for the IPAM prefix list resolver.
        State:
          type: string
          enum:
          - create-in-progress
          - create-complete
          - create-failed
          - modify-in-progress
          - modify-complete
          - modify-failed
          - delete-in-progress
          - delete-complete
          - delete-failed
          - isolate-in-progress
          - isolate-complete
          - restore-in-progress
          description: The current state of the IPAM prefix list resolver. Valid values include create-in-progress, create-complete, create-failed, modify-in-progress, modify-complete, modify-failed, delete-in-progress, delete-complete, and delete-failed.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags assigned to the IPAM prefix list resolver.
        LastVersionCreationStatus:
          type: string
          enum:
          - pending
          - success
          - failure
          description: The status for the last time a version was created. Each version is a snapshot of what CIDRs matched your rules at that moment in time. The version number increments every time the CIDR list changes due to infrastructure changes.
        LastVersionCreationStatusMessage:
          type: string
          description: The status message for the last time a version was created. Each version is a snapshot of what CIDRs matched your rules at that moment in time. The version number increments every time the CIDR list changes due to infrastructure changes.
    IpamPrefixListResolverRuleRequest:
      type: object
      properties:
        RuleType:
          type: string
          enum:
          - static-cidr
          - ipam-resource-cidr
          - ipam-pool-cidr
          description: The type of CIDR selection rule. Valid values include include for selecting CIDRs that match the conditions, and exclude for excluding CIDRs that match the conditions.
        StaticCidr:
          type: string
          description: A fixed list of CIDRs that do not change (like a manual list replicated across Regions).
        IpamScopeId:
          type: string
          description: The ID of the IPAM scope from which to select CIDRs. This determines whether to select from public or private IP address space.
        ResourceType:
          type: string
          enum:
          - vpc
          - subnet
          - eip
          - public-ipv4-pool
          - ipv6-pool
          - eni
          - anycast-ip-list
          description: For rules of type ipam-resource-cidr, this is the resource type.
        Conditions:
          type: array
          items:
            $ref: '#/components/schemas/IpamPrefixListResolverRuleConditionRequest'
          description: The conditions that determine which CIDRs are selected by this rule. Conditions specify criteria such as resource type, tags, account IDs, and Regions.
      required:
      - RuleType
  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)