Amazon EC2 Ec2 Secondary Network API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Secondary Network 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: Secondary Network
paths:
  /?Action=CreateSecondaryNetwork:
    post:
      operationId: CreateSecondaryNetwork
      summary: Create Secondary Network
      description: Creates a secondary network. The allowed size for a secondary network CIDR block is between /28 netmask (16 IP addresses) and /12 netmask (1,048,576 IP addresses).
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateSecondaryNetworkResult'
              example:
                SecondaryNetwork:
                  SecondaryNetworkId: sn-0123456789abcdef0
                  SecondaryNetworkArn: arn:aws:ec2:us-east-2:123456789012:secondary-network/sn-0123456789abcdef0
                  OwnerId: '123456789012'
                  Type: rdma
                  State: create-in-progress
                  Ipv4CidrBlockAssociations:
                  - AssociationId: sn-cidr-assoc-56789901234abcdef0
                    CidrBlock: 10.0.0.0/16
                    State: associating
                  Tags:
                  - Key: Name
                    Value: Prod Secondary Network
                ClientToken: 550e8400-e29b-41d4-a716-446655440000
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateSecondaryNetwork
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateSecondaryNetworkRequest'
            example:
              Ipv4CidrBlock: 10.0.0.0/16
              NetworkType: rdma
              ClientToken: 550e8400-e29b-41d4-a716-446655440000
              TagSpecifications:
              - ResourceType: secondary-network
                Tags:
                - Key: Name
                  Value: Prod Secondary Network
      tags:
      - Secondary Network
  /?Action=DeleteSecondaryNetwork:
    post:
      operationId: DeleteSecondaryNetwork
      summary: Delete Secondary Network
      description: Deletes a secondary network. You must delete all secondary subnets in the secondary network before you can delete the secondary network.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteSecondaryNetworkResult'
              example:
                SecondaryNetwork:
                  SecondaryNetworkId: sn-0123456789abcdef0
                  SecondaryNetworkArn: arn:aws:ec2:us-east-2:123456789012:secondary-network/sn-0123456789abcdef0
                  OwnerId: '123456789012'
                  Type: rdma
                  State: delete-in-progress
                  Ipv4CidrBlockAssociations:
                  - AssociationId: sn-cidr-assoc-56789901234abcdef0
                    CidrBlock: 10.0.0.0/16
                    State: disassociating
                  Tags:
                  - Key: Name
                    Value: Prod Secondary Network
                ClientToken: 550e8400-e29b-41d4-a716-446655440000
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteSecondaryNetwork
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteSecondaryNetworkRequest'
            example:
              SecondaryNetworkId: sn-0123456789abcdef0
              ClientToken: 550e8400-e29b-41d4-a716-446655440000
      tags:
      - Secondary Network
  /?Action=DescribeSecondaryNetworks:
    post:
      operationId: DescribeSecondaryNetworks
      summary: Describe Secondary Networks
      description: Describes one or more secondary networks.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeSecondaryNetworksResult'
              example:
                SecondaryNetworks:
                - SecondaryNetworkId: sn-0123456789abcdef0
                  SecondaryNetworkArn: arn:aws:ec2:us-east-2:123456789012:secondary-network/sn-0123456789abcdef0
                  OwnerId: '123456789012'
                  Type: rdma
                  State: create-complete
                  Ipv4CidrBlockAssociations:
                  - AssociationId: sn-cidr-assoc-56789901234abcdef0
                    CidrBlock: 10.0.0.0/16
                    State: associated
                  Tags:
                  - Key: Name
                    Value: Prod Secondary Network
                - SecondaryNetworkId: sn-0987654321fedcba0
                  SecondaryNetworkArn: arn:aws:ec2:us-east-2:123456789012:secondary-network/sn-0987654321fedcba0
                  OwnerId: '123456789012'
                  Type: rdma
                  State: create-complete
                  Ipv4CidrBlockAssociations:
                  - AssociationId: sn-cidr-assoc-09876543210fedcba0
                    CidrBlock: 10.1.0.0/16
                    State: associated
                  Tags:
                  - Key: Name
                    Value: Dev Secondary Network
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeSecondaryNetworks
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeSecondaryNetworksRequest'
            example:
              SecondaryNetworkIds:
              - sn-0123456789abcdef0
              - sn-0987654321fedcba0
      tags:
      - Secondary Network
components:
  schemas:
    CreateSecondaryNetworkResult:
      type: object
      properties:
        SecondaryNetwork:
          $ref: '#/components/schemas/SecondaryNetwork'
        ClientToken:
          type: string
          description: Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
    DeleteSecondaryNetworkRequest:
      type: object
      properties:
        ClientToken:
          type: string
          description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
        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.
        SecondaryNetworkId:
          type: string
          description: The ID of the secondary network.
      required:
      - SecondaryNetworkId
    DescribeSecondaryNetworksResult:
      type: object
      properties:
        SecondaryNetworks:
          type: array
          items:
            $ref: '#/components/schemas/SecondaryNetwork'
          description: Information about the secondary networks.
        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.
    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.'
    DescribeSecondaryNetworksRequest:
      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.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'The filters. The following are the possible values: ipv4-cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the secondary network. ipv4-cidr-block-association.cidr-block - An IPv4 CIDR block associated with the secondary network. ipv4-cidr-block-association.state - The state of an IPv4 CIDR block associated with the secondary network. owner-id - The ID of the Amazon Web Services account that owns the secondary network. secondary-network-id - The ID of the secondary network. secondary-network-arn - The ARN of the secondary network. state - The stat'
        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.
        SecondaryNetworkIds:
          type: array
          items:
            type: string
          description: The IDs of the secondary networks.
    SecondaryNetworkIpv4CidrBlockAssociation:
      type: object
      properties:
        AssociationId:
          type: string
          description: The association ID for the IPv4 CIDR block.
        CidrBlock:
          type: string
          description: The IPv4 CIDR block.
        State:
          type: string
          enum:
          - associating
          - associated
          - association-failed
          - disassociating
          - disassociated
          - disassociation-failed
          description: The state of the CIDR block association.
        StateReason:
          type: string
          description: The reason for the current state of the CIDR block association.
    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.
    CreateSecondaryNetworkRequest:
      type: object
      properties:
        ClientToken:
          type: string
          description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
        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.
        Ipv4CidrBlock:
          type: string
          description: The IPv4 CIDR block for the secondary network. The CIDR block size must be between /12 and /28.
        NetworkType:
          type: string
          enum:
          - rdma
          description: The type of secondary network.
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to assign to the secondary network.
      required:
      - Ipv4CidrBlock
      - NetworkType
    DeleteSecondaryNetworkResult:
      type: object
      properties:
        SecondaryNetwork:
          $ref: '#/components/schemas/SecondaryNetwork'
        ClientToken:
          type: string
          description: Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
    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.
    SecondaryNetwork:
      type: object
      properties:
        SecondaryNetworkId:
          type: string
          description: The ID of the secondary network.
        SecondaryNetworkArn:
          type: string
          description: The Amazon Resource Name (ARN) of the secondary network.
        OwnerId:
          type: string
          description: The ID of the Amazon Web Services account that owns the secondary network.
        Type:
          type: string
          enum:
          - rdma
          description: The type of the secondary network.
        State:
          type: string
          enum:
          - create-in-progress
          - create-complete
          - create-failed
          - delete-in-progress
          - delete-complete
          - delete-failed
          description: The state of the secondary network.
        StateReason:
          type: string
          description: The reason for the current state of the secondary network.
        Ipv4CidrBlockAssociations:
          type: array
          items:
            $ref: '#/components/schemas/SecondaryNetworkIpv4CidrBlockAssociation'
          description: Information about the IPv4 CIDR blocks associated with the secondary network.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags assigned to the secondary network.
  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)