Amazon EC2 Ec2 Ipam Routing Policy Registration API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Ipam Routing Policy…
  version: '2016-11-15'
  description: Generated from AWS's published Smithy model for Amazon Elastic Compute Cloud. 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://ec2.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Ipam Routing Policy Registration
paths:
  /?Action=BatchModifyIpamRoutingPolicyRegistrations:
    post:
      operationId: BatchModifyIpamRoutingPolicyRegistrations
      summary: Batch Modify Ipam Routing Policy Registrations
      description: Modifies multiple routing policy registrations in a single operation. You can create, update, or delete Route Origin Authorizations (ROAs) in batch.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/BatchModifyIpamRoutingPolicyRegistrationsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: BatchModifyIpamRoutingPolicyRegistrations
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/BatchModifyIpamRoutingPolicyRegistrationsRequest'
      tags:
      - Ipam Routing Policy Registration
  /?Action=CreateIpamRoutingPolicyRegistration:
    post:
      operationId: CreateIpamRoutingPolicyRegistration
      summary: Create Ipam Routing Policy Registration
      description: Creates a routing policy registration and publishes Route Origin Authorizations (ROAs) to the RPKI for the specified CIDR prefix and ASNs.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateIpamRoutingPolicyRegistrationResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateIpamRoutingPolicyRegistration
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateIpamRoutingPolicyRegistrationRequest'
      tags:
      - Ipam Routing Policy Registration
  /?Action=DeleteIpamRoutingPolicyRegistration:
    post:
      operationId: DeleteIpamRoutingPolicyRegistration
      summary: Delete Ipam Routing Policy Registration
      description: Deletes a routing policy registration for a specified CIDR prefix.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteIpamRoutingPolicyRegistrationResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteIpamRoutingPolicyRegistration
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteIpamRoutingPolicyRegistrationRequest'
      tags:
      - Ipam Routing Policy Registration
  /?Action=GetIpamRoutingPolicyRegistrations:
    post:
      operationId: GetIpamRoutingPolicyRegistrations
      summary: Get Ipam Routing Policy Registrations
      description: Retrieves routing policy registrations for an IPAM internet registry association. Each registration represents a Route Origin Authorization (ROA) that has been created or is pending publication to the RPKI. We recommend using pagination to ensure that the operation returns quickly and successfully.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GetIpamRoutingPolicyRegistrationsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: GetIpamRoutingPolicyRegistrations
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/GetIpamRoutingPolicyRegistrationsRequest'
      tags:
      - Ipam Routing Policy Registration
  /?Action=ModifyIpamRoutingPolicyRegistration:
    post:
      operationId: ModifyIpamRoutingPolicyRegistration
      summary: Modify Ipam Routing Policy Registration
      description: Modifies an existing routing policy registration. You can update the authorized ASNs, maximum prefix length, and other properties of a Route Origin Authorization (ROA).
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyIpamRoutingPolicyRegistrationResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyIpamRoutingPolicyRegistration
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/ModifyIpamRoutingPolicyRegistrationRequest'
      tags:
      - Ipam Routing Policy Registration
components:
  schemas:
    GetIpamRoutingPolicyRegistrationsRequest:
      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.
        Cidr:
          type: string
          description: Filter results to a specific CIDR prefix.
        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.
      required:
      - IpamInternetRegistryAssociationId
    GetIpamRoutingPolicyRegistrationsResult:
      type: object
      properties:
        IpamRoutingPolicyRegistrations:
          type: array
          items:
            $ref: '#/components/schemas/IpamRoutingPolicyRegistration'
          description: The routing policy registrations.
        NextToken:
          type: string
          description: The token to use to retrieve the next page of results.
    CreateIpamRoutingPolicyRegistrationRequest:
      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.
        Cidr:
          type: string
          description: The IP address prefix in CIDR notation to authorize in the ROA.
        Asns:
          type: array
          items:
            type: string
          description: The Autonomous System Numbers (ASNs) authorized to originate the prefix.
        PermitMoreSpecificAnnouncements:
          type: boolean
          description: 'Specifies whether to permit more specific route announcements than the CIDR prefix. When enabled, ASNs can announce sub-prefixes of the authorized CIDR up to the specified maximum length. Default: false.'
        MaxLength:
          type: integer
          description: The maximum prefix length that the ASNs are authorized to announce. Must be greater than or equal to the prefix length of the CIDR. If not specified, defaults to the prefix length of the CIDR (exact match only).
        Description:
          type: string
          description: A description for the routing policy registration.
        Force:
          type: boolean
          description: 'Forces the creation of the routing policy registration even if it conflicts with an announced route. Default: false.'
        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
      - Cidr
      - Asns
    ModifyIpamRoutingPolicyRegistrationRequest:
      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.
        Cidr:
          type: string
          description: The IP address prefix in CIDR notation identifying the routing policy registration to modify.
        Asns:
          type: array
          items:
            type: string
          description: The updated list of Autonomous System Numbers (ASNs) authorized to originate the prefix.
        PermitMoreSpecificAnnouncements:
          type: boolean
          description: 'Specifies whether to permit more specific route announcements than the CIDR prefix. Default: false.'
        MaxLength:
          type: integer
          description: The new maximum prefix length that the ASNs are authorized to announce. Must be greater than or equal to the prefix length of the CIDR.
        Description:
          type: string
          description: A new description for the routing policy registration.
        Force:
          type: boolean
          description: 'Forces the modification even if it conflicts with an announced route. Default: false.'
        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
      - Cidr
      - Asns
    ModifyIpamRoutingPolicyRegistrationResult:
      type: object
      properties:
        IpamRoutingPolicyRegistrationDelta:
          $ref: '#/components/schemas/IpamRoutingPolicyRegistrationDelta'
    CreateIpamRoutingPolicyRegistrationResult:
      type: object
      properties:
        IpamRoutingPolicyRegistrationDelta:
          $ref: '#/components/schemas/IpamRoutingPolicyRegistrationDelta'
    BatchModifyIpamRoutingPolicyRegistrationsResult:
      type: object
      properties:
        IpamRoutingPolicyRegistrationDelta:
          $ref: '#/components/schemas/IpamRoutingPolicyRegistrationDelta'
    DeleteIpamRoutingPolicyRegistrationResult:
      type: object
      properties:
        IpamRoutingPolicyRegistrationDelta:
          $ref: '#/components/schemas/IpamRoutingPolicyRegistrationDelta'
    IpamRoutingPolicyRegistration:
      type: object
      properties:
        Cidr:
          type: string
          description: The IP address prefix in CIDR notation authorized by the ROA.
        Asns:
          type: array
          items:
            type: string
          description: The Autonomous System Numbers (ASNs) authorized to originate the prefix.
        PermitMoreSpecificAnnouncements:
          type: boolean
          description: 'Specifies whether to permit more specific route announcements than the CIDR prefix. When enabled, ASNs can announce sub-prefixes of the authorized CIDR up to the specified maximum length. Default: false.'
        MaxLength:
          type: integer
          description: The maximum prefix length that the ASNs are authorized to announce.
        Description:
          type: string
          description: The description of the routing policy registration.
        LatestDeltaId:
          type: string
          description: The ID of the most recent delta that modified this registration.
        State:
          type: string
          enum:
          - pending-activate
          - activate-failed
          - create-in-progress
          - create-complete
          - update-in-progress
          - update-complete
          - delete-in-progress
          - delete-complete
          description: 'The state of the routing policy registration. Valid values: pending-activate | activate-failed | create-in-progress | create-complete | update-in-progress | update-complete | delete-in-progress | delete-complete.'
    DeleteIpamRoutingPolicyRegistrationRequest:
      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.
        Cidr:
          type: string
          description: The IP address prefix in CIDR notation identifying the routing policy registration to delete.
        Force:
          type: boolean
          description: 'Forces the deletion even if it conflicts with an announced route. Default: false.'
        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
      - Cidr
    IpamRoutingPolicyRegistrationDelta:
      type: object
      properties:
        DeltaId:
          type: string
          description: The unique identifier of the delta.
        DeltaJson:
          type: string
          description: The JSON specification describing the changes applied in this delta.
        State:
          type: string
          enum:
          - pending
          - published
          - failed
          description: 'The state of the delta. Valid values: pending | published | failed.'
        StateMessage:
          type: string
          description: A message describing the current state, including error information if the delta failed.
    BatchModifyIpamRoutingPolicyRegistrationsRequest:
      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.
        DeltaJson:
          type: string
          description: The batch modifications to apply, in JSON format.
        Force:
          type: boolean
          description: 'Forces the batch modification even if individual changes conflict with announced routes. Default: false.'
        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
      - DeltaJson
  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)