Amazon EC2 Ec2 Ipam Internet Registry Association API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Ipam Internet Registry…
  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 Internet Registry Association
paths:
  /?Action=CreateIpamInternetRegistryAssociation:
    post:
      operationId: CreateIpamInternetRegistryAssociation
      summary: Create Ipam Internet Registry Association
      description: Creates an association between an IPAM and a Regional Internet Registry (RIR) for Resource Public Key Infrastructure (RPKI) management. You can use this association to create Route Origin Authorizations (ROAs) for IP address prefixes registered with the internet registry. Your IPAM must be in the Advanced tier to use this feature.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateIpamInternetRegistryAssociationResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateIpamInternetRegistryAssociation
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateIpamInternetRegistryAssociationRequest'
      tags:
      - Ipam Internet Registry Association
  /?Action=DeleteIpamInternetRegistryAssociation:
    post:
      operationId: DeleteIpamInternetRegistryAssociation
      summary: Delete Ipam Internet Registry Association
      description: Deletes an IPAM internet registry association. Before deleting, you must remove all routing policy registrations associated with the internet registry.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteIpamInternetRegistryAssociationResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteIpamInternetRegistryAssociation
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteIpamInternetRegistryAssociationRequest'
      tags:
      - Ipam Internet Registry Association
  /?Action=DescribeIpamInternetRegistryAssociations:
    post:
      operationId: DescribeIpamInternetRegistryAssociations
      summary: Describe Ipam Internet Registry Associations
      description: Describes one or more IPAM internet registry associations. We recommend using pagination to ensure that the operation returns quickly and successfully.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeIpamInternetRegistryAssociationsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeIpamInternetRegistryAssociations
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeIpamInternetRegistryAssociationsRequest'
      tags:
      - Ipam Internet Registry Association
  /?Action=EnableIpamInternetRegistryAssociation:
    post:
      operationId: EnableIpamInternetRegistryAssociation
      summary: Enable Ipam Internet Registry Association
      description: Enables Resource Public Key Infrastructure (RPKI) on an existing IPAM internet registry association by providing BGP Public Key Infrastructure (BPKI) certificate details. After enabling, you can create Route Origin Authorizations (ROAs) for prefixes registered with the internet registry.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/EnableIpamInternetRegistryAssociationResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: EnableIpamInternetRegistryAssociation
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/EnableIpamInternetRegistryAssociationRequest'
      tags:
      - Ipam Internet Registry Association
components:
  schemas:
    DescribeIpamInternetRegistryAssociationsRequest:
      type: object
      properties:
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the operation, 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.
        IpamInternetRegistryAssociationIds:
          type: array
          items:
            type: string
          description: The IDs of the internet registry associations to describe.
        MaxResults:
          type: integer
          description: The maximum number of results to return in a single call. If not specified, all available results are returned. 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.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: One or more filters to apply to the results.
    DescribeIpamInternetRegistryAssociationsResult:
      type: object
      properties:
        NextToken:
          type: string
          description: The token to use to retrieve the next page of results.
        IpamInternetRegistryAssociations:
          type: array
          items:
            $ref: '#/components/schemas/IpamInternetRegistryAssociation'
          description: The internet registry associations.
    CreateIpamInternetRegistryAssociationRequest:
      type: object
      properties:
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the operation, 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 to associate with the internet registry.
        Rir:
          type: string
          enum:
          - ripe
          - apnic
          - arin
          - lacnic
          - nicbr
          description: 'The Regional Internet Registry to associate with. Possible values: ripe - RIPE NCC (Europe, the Middle East, and Central Asia). apnic - APNIC (Asia Pacific). arin - ARIN (North America). lacnic - LACNIC (Latin America and the Caribbean).'
        OrganizationHandle:
          type: string
          description: The organization handle at the internet registry (for example, a RIPE NCC organization ID or ARIN Org ID).
        Description:
          type: string
          description: A description for the internet registry association.
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to assign to the internet registry association.
        ClientToken:
          type: string
          description: A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error.
      required:
      - IpamId
      - Rir
      - OrganizationHandle
    EnableIpamInternetRegistryAssociationRequest:
      type: object
      properties:
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the operation, 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.
        IpamInternetRegistryAssociationId:
          type: string
          description: The ID of the IPAM internet registry association to enable.
        RpkiVersion:
          type: string
          description: The RPKI version to use from the Parent Response XML.
        ServiceUri:
          type: string
          description: The RPKI service URI for the publication point from the Parent Response XML.
        ChildHandle:
          type: string
          description: The child handle for the BPKI certificate hierarchy from the Parent Response XML.
        ParentHandle:
          type: string
          description: The parent handle for the BPKI certificate hierarchy from the Parent Response XML.
        ParentBpkiTa:
          type: string
          description: The parent BPKI Trust Anchor certificate in PEM format from the Parent Response XML.
        ClientToken:
          type: string
          description: A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error.
      required:
      - IpamInternetRegistryAssociationId
      - RpkiVersion
      - ServiceUri
      - ChildHandle
      - ParentHandle
      - ParentBpkiTa
    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.'
    CreateIpamInternetRegistryAssociationResult:
      type: object
      properties:
        IpamInternetRegistryAssociation:
          $ref: '#/components/schemas/IpamInternetRegistryAssociation'
    DeleteIpamInternetRegistryAssociationResult:
      type: object
      properties:
        IpamInternetRegistryAssociation:
          $ref: '#/components/schemas/IpamInternetRegistryAssociation'
    EnableIpamInternetRegistryAssociationResult:
      type: object
      properties:
        IpamInternetRegistryAssociation:
          $ref: '#/components/schemas/IpamInternetRegistryAssociation'
    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.
    DeleteIpamInternetRegistryAssociationRequest:
      type: object
      properties:
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the operation, 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.
        IpamInternetRegistryAssociationId:
          type: string
          description: The ID of the IPAM internet registry association to delete.
      required:
      - IpamInternetRegistryAssociationId
    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.
    IpamInternetRegistryAssociation:
      type: object
      properties:
        OwnerId:
          type: string
          description: The ID of the Amazon Web Services account that owns the internet registry association.
        IpamInternetRegistryAssociationId:
          type: string
          description: The ID of the internet registry association.
        IpamInternetRegistryAssociationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the internet registry association.
        IpamId:
          type: string
          description: The ID of the associated IPAM.
        IpamRegion:
          type: string
          description: The Amazon Web Services Region of the IPAM.
        Rir:
          type: string
          enum:
          - ripe
          - apnic
          - arin
          - lacnic
          - nicbr
          description: 'The Regional Internet Registry. Possible values: ripe - RIPE NCC (Europe, the Middle East, and Central Asia). apnic - APNIC (Asia Pacific). arin - ARIN (North America). lacnic - LACNIC (Latin America and the Caribbean).'
        OrganizationHandle:
          type: string
          description: The organization handle at the internet registry.
        Description:
          type: string
          description: The description of the internet registry association.
        State:
          type: string
          enum:
          - pending-enable
          - create-in-progress
          - create-failed
          - enable-in-progress
          - enable-complete
          - enable-failed
          - disable-in-progress
          - disable-complete
          - disable-failed
          - delete-in-progress
          - delete-complete
          - delete-failed
          description: 'The state of the internet registry association. Valid values: pending-activation | pending-enable | create-in-progress | create-failed | enable-in-progress | enable-complete | enable-failed | delete-in-progress | delete-complete | delete-failed.'
        StateMessage:
          type: string
          description: A message describing the current state of the internet registry association, including additional details such as the reason for a failure.
        ChildRequestXml:
          type: string
          description: The XML content for the child request to be submitted to the internet registry to complete the BPKI setup.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags assigned to the internet registry association.
  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)