find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-ec2:amazon-ec2-ipam-byoasn-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Ipam Byoasn API
  version: '2016-11-15'
  description: Generated from AWS's published Smithy model for Amazon Elastic Compute Cloud. 3 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 Byoasn
paths:
  /?Action=AssociateIpamByoasn:
    post:
      operationId: AssociateIpamByoasn
      summary: Associate Ipam Byoasn
      description: 'Associates your Autonomous System Number (ASN) with a BYOIP CIDR that you own in the same Amazon Web Services Region. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide. After the association succeeds, the ASN is eligible for advertisement. You can view the association with DescribeByoipCidrs. You can advertise the CIDR with AdvertiseByoipCidr.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AssociateIpamByoasnResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: AssociateIpamByoasn
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/AssociateIpamByoasnRequest'
      tags:
      - Ipam Byoasn
  /?Action=DescribeIpamByoasn:
    post:
      operationId: DescribeIpamByoasn
      summary: Describe Ipam Byoasn
      description: 'Describes your Autonomous System Numbers (ASNs), their provisioning statuses, and the BYOIP CIDRs with which they are associated. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeIpamByoasnResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeIpamByoasn
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeIpamByoasnRequest'
      tags:
      - Ipam Byoasn
  /?Action=DisassociateIpamByoasn:
    post:
      operationId: DisassociateIpamByoasn
      summary: Disassociate Ipam Byoasn
      description: 'Remove the association between your Autonomous System Number (ASN) and your BYOIP CIDR. You may want to use this action to disassociate an ASN from a CIDR or if you want to swap ASNs. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DisassociateIpamByoasnResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DisassociateIpamByoasn
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DisassociateIpamByoasnRequest'
      tags:
      - Ipam Byoasn
components:
  schemas:
    Byoasn:
      type: object
      properties:
        Asn:
          type: string
          description: A public 2-byte or 4-byte ASN.
        IpamId:
          type: string
          description: An IPAM ID.
        StatusMessage:
          type: string
          description: The status message.
        State:
          type: string
          enum:
          - deprovisioned
          - failed-deprovision
          - failed-provision
          - pending-deprovision
          - pending-provision
          - provisioned
          description: The provisioning state of the BYOASN.
    AssociateIpamByoasnRequest:
      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.
        Asn:
          type: string
          description: A public 2-byte or 4-byte ASN.
        Cidr:
          type: string
          description: The BYOIP CIDR you want to associate with an ASN.
      required:
      - Asn
      - Cidr
    AsnAssociation:
      type: object
      properties:
        Asn:
          type: string
          description: The association's ASN.
        Cidr:
          type: string
          description: The association's CIDR.
        StatusMessage:
          type: string
          description: The association's status message.
        State:
          type: string
          enum:
          - disassociated
          - failed-disassociation
          - failed-association
          - pending-disassociation
          - pending-association
          - associated
          description: The association's state.
    DescribeIpamByoasnRequest:
      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.
        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.
    DescribeIpamByoasnResult:
      type: object
      properties:
        Byoasns:
          type: array
          items:
            $ref: '#/components/schemas/Byoasn'
          description: ASN and BYOIP CIDR associations.
        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.
    AssociateIpamByoasnResult:
      type: object
      properties:
        AsnAssociation:
          $ref: '#/components/schemas/AsnAssociation'
    DisassociateIpamByoasnResult:
      type: object
      properties:
        AsnAssociation:
          $ref: '#/components/schemas/AsnAssociation'
    DisassociateIpamByoasnRequest:
      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.
        Asn:
          type: string
          description: A public 2-byte or 4-byte ASN.
        Cidr:
          type: string
          description: A BYOIP CIDR.
      required:
      - Asn
      - Cidr
  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)