Amazon EC2 Ec2 Network Interface Permission API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Network Interface Permission…
  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: Network Interface Permission
paths:
  /?Action=CreateNetworkInterfacePermission:
    post:
      operationId: CreateNetworkInterfacePermission
      summary: Create Network Interface Permission
      description: Grants an Amazon Web Services-authorized account permission to attach the specified network interface to an instance in their account. You can grant permission to a single Amazon Web Services account only, and only one account at a time.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateNetworkInterfacePermissionResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateNetworkInterfacePermission
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateNetworkInterfacePermissionRequest'
      tags:
      - Network Interface Permission
  /?Action=DeleteNetworkInterfacePermission:
    post:
      operationId: DeleteNetworkInterfacePermission
      summary: Delete Network Interface Permission
      description: Deletes a permission for a network interface. By default, you cannot delete the permission if the account for which you're removing the permission has attached the network interface to an instance. However, you can force delete the permission, regardless of any attachment.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteNetworkInterfacePermissionResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteNetworkInterfacePermission
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteNetworkInterfacePermissionRequest'
      tags:
      - Network Interface Permission
  /?Action=DescribeNetworkInterfacePermissions:
    post:
      operationId: DescribeNetworkInterfacePermissions
      summary: Describe Network Interface Permissions
      description: Describes the permissions for your network interfaces.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeNetworkInterfacePermissionsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeNetworkInterfacePermissions
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeNetworkInterfacePermissionsRequest'
      tags:
      - Network Interface Permission
components:
  schemas:
    DescribeNetworkInterfacePermissionsResult:
      type: object
      properties:
        NetworkInterfacePermissions:
          type: array
          items:
            $ref: '#/components/schemas/NetworkInterfacePermission'
          description: The network interface permissions.
        NextToken:
          type: string
          description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
    DeleteNetworkInterfacePermissionRequest:
      type: object
      properties:
        NetworkInterfacePermissionId:
          type: string
          description: The ID of the network interface permission.
        Force:
          type: boolean
          description: Specify true to remove the permission even if the network interface is attached to an instance.
        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.
      required:
      - NetworkInterfacePermissionId
    CreateNetworkInterfacePermissionRequest:
      type: object
      properties:
        NetworkInterfaceId:
          type: string
          description: The ID of the network interface.
        AwsAccountId:
          type: string
          description: The Amazon Web Services account ID.
        AwsService:
          type: string
          description: The Amazon Web Services service. Currently not supported.
        Permission:
          type: string
          enum:
          - INSTANCE-ATTACH
          - EIP-ASSOCIATE
          description: The type of permission to grant.
        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.
      required:
      - NetworkInterfaceId
      - Permission
    CreateNetworkInterfacePermissionResult:
      type: object
      properties:
        InterfacePermission:
          $ref: '#/components/schemas/NetworkInterfacePermission'
    NetworkInterfacePermissionState:
      type: object
      properties:
        State:
          type: string
          enum:
          - pending
          - granted
          - revoking
          - revoked
          description: The state of the permission.
        StatusMessage:
          type: string
          description: A status message, if applicable.
    DescribeNetworkInterfacePermissionsRequest:
      type: object
      properties:
        NetworkInterfacePermissionIds:
          type: array
          items:
            type: string
          description: The network interface permission IDs.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: One or more filters. network-interface-permission.network-interface-permission-id - The ID of the permission. network-interface-permission.network-interface-id - The ID of the network interface. network-interface-permission.aws-account-id - The Amazon Web Services account ID. network-interface-permission.aws-service - The Amazon Web Services service. network-interface-permission.permission - The type of permission (INSTANCE-ATTACH | EIP-ASSOCIATE).
        NextToken:
          type: string
          description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
        MaxResults:
          type: integer
          description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. If this parameter is not specified, up to 50 results are returned by default. For more information, see Pagination.
    NetworkInterfacePermission:
      type: object
      properties:
        NetworkInterfacePermissionId:
          type: string
          description: The ID of the network interface permission.
        NetworkInterfaceId:
          type: string
          description: The ID of the network interface.
        AwsAccountId:
          type: string
          description: The Amazon Web Services account ID.
        AwsService:
          type: string
          description: The Amazon Web Services service.
        Permission:
          type: string
          enum:
          - INSTANCE-ATTACH
          - EIP-ASSOCIATE
          description: The type of permission.
        PermissionState:
          $ref: '#/components/schemas/NetworkInterfacePermissionState'
    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.
    DeleteNetworkInterfacePermissionResult:
      type: object
      properties:
        Return:
          type: boolean
          description: Is true if the request succeeds and an error otherwise.
  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)