Amazon EC2 Ec2 Secondary Subnet API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Secondary Subnet 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 Subnet
paths:
  /?Action=CreateSecondarySubnet:
    post:
      operationId: CreateSecondarySubnet
      summary: Create Secondary Subnet
      description: Creates a secondary subnet in a secondary network. A secondary subnet CIDR block must not overlap with the CIDR block of an existing secondary subnet in the secondary network. After you create a secondary subnet, you can't change its CIDR block. The allowed size for a secondary subnet CIDR block is between /28 netmask (16 IP addresses) and /12 netmask (1,048,576 IP addresses). Amazon reserves the first four IP addresses and the last IP address in each secondary subnet for internal use.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateSecondarySubnetResult'
              example:
                SecondarySubnet:
                  SecondarySubnetId: ss-0123456789abcdef0
                  SecondarySubnetArn: arn:aws:ec2:us-east-2:123456789012:secondary-subnet/ss-0123456789abcdef0
                  SecondaryNetworkId: sn-0123456789abcdef0
                  SecondaryNetworkType: rdma
                  OwnerId: '123456789012'
                  AvailabilityZoneId: use2-az1
                  AvailabilityZone: us-east-2a
                  Ipv4CidrBlockAssociations:
                  - AssociationId: ss-cidr-assoc-56789901234abcdef0
                    CidrBlock: 10.0.0.0/24
                    State: associating
                  State: create-in-progress
                  Tags:
                  - Key: Name
                    Value: Prod Secondary Subnet
                  - Key: Environment
                    Value: Production
                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: CreateSecondarySubnet
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateSecondarySubnetRequest'
            example:
              SecondaryNetworkId: sn-0123456789abcdef0
              Ipv4CidrBlock: 10.0.0.0/24
              AvailabilityZoneId: use2-az1
              ClientToken: 550e8400-e29b-41d4-a716-446655440000
              TagSpecifications:
              - ResourceType: secondary-subnet
                Tags:
                - Key: Name
                  Value: Prod Secondary Subnet
                - Key: Environment
                  Value: Production
      tags:
      - Secondary Subnet
  /?Action=DeleteSecondarySubnet:
    post:
      operationId: DeleteSecondarySubnet
      summary: Delete Secondary Subnet
      description: Deletes a secondary subnet. A secondary subnet must not contain any secondary interfaces prior to deletion.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteSecondarySubnetResult'
              example:
                SecondarySubnet:
                  SecondarySubnetId: ss-0123456789abcdef0
                  SecondarySubnetArn: arn:aws:ec2:us-east-2:123456789012:secondary-subnet/ss-0123456789abcdef0
                  SecondaryNetworkId: sn-0123456789abcdef0
                  SecondaryNetworkType: rdma
                  OwnerId: '123456789012'
                  AvailabilityZoneId: use2-az1
                  AvailabilityZone: us-east-2a
                  Ipv4CidrBlockAssociations:
                  - AssociationId: ss-cidr-assoc-56789901234abcdef0
                    CidrBlock: 10.0.0.0/24
                    State: disassociating
                  State: delete-in-progress
                  Tags:
                  - Key: Name
                    Value: Prod Secondary Subnet
                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: DeleteSecondarySubnet
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteSecondarySubnetRequest'
            example:
              SecondarySubnetId: ss-0123456789abcdef0
              ClientToken: 550e8400-e29b-41d4-a716-446655440000
      tags:
      - Secondary Subnet
  /?Action=DescribeSecondarySubnets:
    post:
      operationId: DescribeSecondarySubnets
      summary: Describe Secondary Subnets
      description: Describes one or more of your secondary subnets.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeSecondarySubnetsResult'
              example:
                SecondarySubnets:
                - SecondarySubnetId: ss-0123456789abcdef0
                  SecondarySubnetArn: arn:aws:ec2:us-east-2:123456789012:secondary-subnet/ss-0123456789abcdef0
                  SecondaryNetworkId: sn-0123456789abcdef0
                  SecondaryNetworkType: rdma
                  OwnerId: '123456789012'
                  AvailabilityZoneId: use2-az1
                  AvailabilityZone: us-east-2a
                  Ipv4CidrBlockAssociations:
                  - AssociationId: ss-cidr-assoc-56789901234abcdef0
                    CidrBlock: 10.0.0.0/24
                    State: associated
                  State: create-complete
                  Tags:
                  - Key: Name
                    Value: Prod Secondary Subnet
                - SecondarySubnetId: ss-0987654321fedcba0
                  SecondarySubnetArn: arn:aws:ec2:us-east-2:123456789012:secondary-subnet/ss-0987654321fedcba0
                  SecondaryNetworkId: sn-0123456789abcdef0
                  SecondaryNetworkType: rdma
                  OwnerId: '123456789012'
                  AvailabilityZoneId: use2-az1
                  AvailabilityZone: us-east-2a
                  Ipv4CidrBlockAssociations:
                  - AssociationId: ss-cidr-assoc-09876543210fedcba0
                    CidrBlock: 10.0.1.0/24
                    State: associated
                  State: create-complete
                  Tags:
                  - Key: Name
                    Value: Dev Secondary Subnet
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeSecondarySubnets
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeSecondarySubnetsRequest'
            example:
              SecondarySubnetIds:
              - ss-0123456789abcdef0
              - ss-0987654321fedcba0
      tags:
      - Secondary Subnet
components:
  schemas:
    DeleteSecondarySubnetResult:
      type: object
      properties:
        SecondarySubnet:
          $ref: '#/components/schemas/SecondarySubnet'
        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.
    CreateSecondarySubnetResult:
      type: object
      properties:
        SecondarySubnet:
          $ref: '#/components/schemas/SecondarySubnet'
        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.
    CreateSecondarySubnetRequest:
      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.
        AvailabilityZone:
          type: string
          description: The Availability Zone for the secondary subnet. You cannot specify both AvailabilityZone and AvailabilityZoneId in the same request.
        AvailabilityZoneId:
          type: string
          description: The ID of the Availability Zone for the secondary subnet. This option is preferred over AvailabilityZone as it provides a consistent identifier across Amazon Web Services accounts. You cannot specify both AvailabilityZone and AvailabilityZoneId in the same request.
        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 subnet. The CIDR block size must be between /12 and /28.
        SecondaryNetworkId:
          type: string
          description: The ID of the secondary network in which to create the secondary subnet.
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to assign to the secondary subnet.
      required:
      - Ipv4CidrBlock
      - SecondaryNetworkId
    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.'
    DescribeSecondarySubnetsRequest:
      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. ipv4-cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the secondary subnet. ipv4-cidr-block-association.cidr-block - An IPv4 CIDR block associated with the secondary subnet. ipv4-cidr-block-association.state - The state of an IPv4 CIDR block associated with the secondary subnet. owner-id - The ID of the Amazon Web Services account that owns the secondary subnet. secondary-network-id - The ID of the secondary network. secondary-network-type - The type of the secondary network (rdma). secondary-subnet-id - The ID of the secondary subn
        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.
        SecondarySubnetIds:
          type: array
          items:
            type: string
          description: The IDs of the secondary subnets.
    DescribeSecondarySubnetsResult:
      type: object
      properties:
        SecondarySubnets:
          type: array
          items:
            $ref: '#/components/schemas/SecondarySubnet'
          description: Information about the secondary subnets.
        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.
    DeleteSecondarySubnetRequest:
      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.
        SecondarySubnetId:
          type: string
          description: The ID of the secondary subnet to delete.
      required:
      - SecondarySubnetId
    SecondarySubnetIpv4CidrBlockAssociation:
      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.
    SecondarySubnet:
      type: object
      properties:
        SecondarySubnetId:
          type: string
          description: The ID of the secondary subnet.
        SecondarySubnetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the secondary subnet.
        SecondaryNetworkId:
          type: string
          description: The ID of the secondary network.
        SecondaryNetworkType:
          type: string
          enum:
          - rdma
          description: The type of the secondary network.
        OwnerId:
          type: string
          description: The ID of the Amazon Web Services account that owns the secondary subnet.
        AvailabilityZoneId:
          type: string
          description: The ID of the Availability Zone of the secondary subnet.
        AvailabilityZone:
          type: string
          description: The Availability Zone of the secondary subnet.
        Ipv4CidrBlockAssociations:
          type: array
          items:
            $ref: '#/components/schemas/SecondarySubnetIpv4CidrBlockAssociation'
          description: Information about the IPv4 CIDR blocks associated with the secondary subnet.
        State:
          type: string
          enum:
          - create-in-progress
          - create-complete
          - create-failed
          - delete-in-progress
          - delete-complete
          - delete-failed
          description: The state of the secondary subnet.
        StateReason:
          type: string
          description: The reason for the current state of the secondary subnet.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags assigned to the secondary subnet.
    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.
  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)