Amazon EC2 Ec2 Ipam Prefix List Resolver Target API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Ipam Prefix List Resolver…
  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 Target
paths:
  /?Action=CreateIpamPrefixListResolverTarget:
    post:
      operationId: CreateIpamPrefixListResolverTarget
      summary: Create Ipam Prefix List Resolver Target
      description: Creates an IPAM prefix list resolver target. An IPAM prefix list resolver target is an association between a specific customer-managed prefix list and an IPAM prefix list resolver. The target enables the resolver to synchronize CIDRs selected by its rules into the specified prefix list, which can then be referenced in Amazon Web Services resources. 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/CreateIpamPrefixListResolverTargetResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateIpamPrefixListResolverTarget
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateIpamPrefixListResolverTargetRequest'
      tags:
      - Ipam Prefix List Resolver Target
  /?Action=DeleteIpamPrefixListResolverTarget:
    post:
      operationId: DeleteIpamPrefixListResolverTarget
      summary: Delete Ipam Prefix List Resolver Target
      description: Deletes an IPAM prefix list resolver target. This removes the association between the resolver and the managed prefix list, stopping automatic CIDR synchronization. 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/DeleteIpamPrefixListResolverTargetResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteIpamPrefixListResolverTarget
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteIpamPrefixListResolverTargetRequest'
      tags:
      - Ipam Prefix List Resolver Target
  /?Action=DescribeIpamPrefixListResolverTargets:
    post:
      operationId: DescribeIpamPrefixListResolverTargets
      summary: Describe Ipam Prefix List Resolver Targets
      description: Describes one or more IPAM prefix list resolver Targets. Use this operation to view the configuration and status of resolver targets.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeIpamPrefixListResolverTargetsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeIpamPrefixListResolverTargets
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeIpamPrefixListResolverTargetsRequest'
      tags:
      - Ipam Prefix List Resolver Target
  /?Action=ModifyIpamPrefixListResolverTarget:
    post:
      operationId: ModifyIpamPrefixListResolverTarget
      summary: Modify Ipam Prefix List Resolver Target
      description: Modifies an IPAM prefix list resolver target. You can update version tracking settings and the desired version of the target prefix list.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyIpamPrefixListResolverTargetResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyIpamPrefixListResolverTarget
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/ModifyIpamPrefixListResolverTargetRequest'
      tags:
      - Ipam Prefix List Resolver Target
components:
  schemas:
    DeleteIpamPrefixListResolverTargetRequest:
      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.
        IpamPrefixListResolverTargetId:
          type: string
          description: The ID of the IPAM prefix list resolver target to delete.
      required:
      - IpamPrefixListResolverTargetId
    ModifyIpamPrefixListResolverTargetResult:
      type: object
      properties:
        IpamPrefixListResolverTarget:
          $ref: '#/components/schemas/IpamPrefixListResolverTarget'
    DescribeIpamPrefixListResolverTargetsResult:
      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.
        IpamPrefixListResolverTargets:
          type: array
          items:
            $ref: '#/components/schemas/IpamPrefixListResolverTarget'
          description: Information about the IPAM prefix list resolver Targets.
    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.'
    IpamPrefixListResolverTarget:
      type: object
      properties:
        IpamPrefixListResolverTargetId:
          type: string
          description: The ID of the IPAM prefix list resolver target.
        IpamPrefixListResolverTargetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IPAM prefix list resolver target.
        IpamPrefixListResolverId:
          type: string
          description: The ID of the IPAM prefix list resolver associated with this target.
        OwnerId:
          type: string
          description: The ID of the Amazon Web Services account that owns the IPAM prefix list resolver target.
        PrefixListId:
          type: string
          description: The ID of the managed prefix list associated with this target.
        PrefixListRegion:
          type: string
          description: The Amazon Web Services Region where the prefix list associated with this target is located.
        DesiredVersion:
          type: integer
          description: The desired version of the prefix list that this target should synchronize with.
        LastSyncedVersion:
          type: integer
          description: The version of the prefix list that was last successfully synchronized by this target.
        TrackLatestVersion:
          type: boolean
          description: Indicates whether this target automatically tracks the latest version of the prefix list.
        StateMessage:
          type: string
          description: A message describing the current state of the IPAM prefix list resolver target, including any error information.
        State:
          type: string
          enum:
          - create-in-progress
          - create-complete
          - create-failed
          - modify-in-progress
          - modify-complete
          - modify-failed
          - sync-in-progress
          - sync-complete
          - sync-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 target. 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 target.
    ModifyIpamPrefixListResolverTargetRequest:
      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.
        IpamPrefixListResolverTargetId:
          type: string
          description: The ID of the IPAM prefix list resolver target to modify.
        DesiredVersion:
          type: integer
          description: The desired version of the prefix list to target. This allows you to pin the target to a specific version.
        TrackLatestVersion:
          type: boolean
          description: Indicates whether the resolver target should automatically track the latest version of the prefix list. When enabled, the target will always synchronize with the most current version. Choose this for automatic updates when you want your prefix lists to stay current with infrastructure changes without manual intervention.
        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:
      - IpamPrefixListResolverTargetId
    CreateIpamPrefixListResolverTargetResult:
      type: object
      properties:
        IpamPrefixListResolverTarget:
          $ref: '#/components/schemas/IpamPrefixListResolverTarget'
    DeleteIpamPrefixListResolverTargetResult:
      type: object
      properties:
        IpamPrefixListResolverTarget:
          $ref: '#/components/schemas/IpamPrefixListResolverTarget'
    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.
    DescribeIpamPrefixListResolverTargetsRequest:
      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.
        IpamPrefixListResolverTargetIds:
          type: array
          items:
            type: string
          description: The IDs of the IPAM prefix list resolver Targets to describe. If not specified, all targets in your account are described.
        IpamPrefixListResolverId:
          type: string
          description: The ID of the IPAM prefix list resolver to filter targets by. Only targets associated with this resolver will be returned.
    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.
    CreateIpamPrefixListResolverTargetRequest:
      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 that will manage the synchronization of CIDRs to the target prefix list.
        PrefixListId:
          type: string
          description: The ID of the managed prefix list that will be synchronized with CIDRs selected by the IPAM prefix list resolver. 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.
        PrefixListRegion:
          type: string
          description: The Amazon Web Services Region where the prefix list is located. This is required when referencing a prefix list in a different Region.
        DesiredVersion:
          type: integer
          description: The specific version of the prefix list to target. If not specified, the resolver will target the latest version.
        TrackLatestVersion:
          type: boolean
          description: Indicates whether the resolver target should automatically track the latest version of the prefix list. When enabled, the target will always synchronize with the most current version of the prefix list. Choose this for automatic updates when you want your prefix lists to stay current with infrastructure changes without manual intervention.
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to apply to the IPAM prefix list resolver target 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:
      - IpamPrefixListResolverId
      - PrefixListId
      - PrefixListRegion
      - TrackLatestVersion
  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)