Amazon EC2 Ec2 Instance Connect Endpoint API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Instance Connect Endpoint API
  version: '2016-11-15'
  description: Generated from AWS's published Smithy model for Amazon Elastic Compute Cloud. 4 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: Instance Connect Endpoint
paths:
  /?Action=CreateInstanceConnectEndpoint:
    post:
      operationId: CreateInstanceConnectEndpoint
      summary: Create Instance Connect Endpoint
      description: Creates an EC2 Instance Connect Endpoint. An EC2 Instance Connect Endpoint allows you to connect to an instance, without requiring the instance to have a public IPv4 or public IPv6 address. For more information, see Connect to your instances using EC2 Instance Connect Endpoint in the Amazon EC2 User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateInstanceConnectEndpointResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateInstanceConnectEndpoint
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateInstanceConnectEndpointRequest'
      tags:
      - Instance Connect Endpoint
  /?Action=DeleteInstanceConnectEndpoint:
    post:
      operationId: DeleteInstanceConnectEndpoint
      summary: Delete Instance Connect Endpoint
      description: Deletes the specified EC2 Instance Connect Endpoint.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteInstanceConnectEndpointResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteInstanceConnectEndpoint
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteInstanceConnectEndpointRequest'
      tags:
      - Instance Connect Endpoint
  /?Action=DescribeInstanceConnectEndpoints:
    post:
      operationId: DescribeInstanceConnectEndpoints
      summary: Describe Instance Connect Endpoints
      description: Describes the specified EC2 Instance Connect Endpoints or all EC2 Instance Connect Endpoints.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeInstanceConnectEndpointsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeInstanceConnectEndpoints
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeInstanceConnectEndpointsRequest'
      tags:
      - Instance Connect Endpoint
  /?Action=ModifyInstanceConnectEndpoint:
    post:
      operationId: ModifyInstanceConnectEndpoint
      summary: Modify Instance Connect Endpoint
      description: Modifies the specified EC2 Instance Connect Endpoint. For more information, see Modify an EC2 Instance Connect Endpoint in the Amazon EC2 User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyInstanceConnectEndpointResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyInstanceConnectEndpoint
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/ModifyInstanceConnectEndpointRequest'
      tags:
      - Instance Connect Endpoint
components:
  schemas:
    InstanceConnectEndpointDnsNames:
      type: object
      properties:
        DnsName:
          type: string
          description: The DNS name of the EC2 Instance Connect Endpoint.
        FipsDnsName:
          type: string
          description: The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.
    ModifyInstanceConnectEndpointResult:
      type: object
      properties:
        Return:
          type: boolean
          description: Is true if the request succeeds and an error otherwise.
    DescribeInstanceConnectEndpointsRequest:
      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 items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
        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.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'One or more filters. instance-connect-endpoint-id - The ID of the EC2 Instance Connect Endpoint. state - The state of the EC2 Instance Connect Endpoint (create-in-progress | create-complete | create-failed | delete-in-progress | delete-complete | delete-failed). subnet-id - The ID of the subnet in which the EC2 Instance Connect Endpoint was created. tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Own'
        InstanceConnectEndpointIds:
          type: array
          items:
            type: string
          description: One or more EC2 Instance Connect Endpoint IDs.
    DescribeInstanceConnectEndpointsResult:
      type: object
      properties:
        InstanceConnectEndpoints:
          type: array
          items:
            $ref: '#/components/schemas/Ec2InstanceConnectEndpoint'
          description: Information about the EC2 Instance Connect Endpoints.
        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.
    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.'
    Ec2InstanceConnectEndpoint:
      type: object
      properties:
        OwnerId:
          type: string
          description: The ID of the Amazon Web Services account that created the EC2 Instance Connect Endpoint.
        InstanceConnectEndpointId:
          type: string
          description: The ID of the EC2 Instance Connect Endpoint.
        InstanceConnectEndpointArn:
          type: string
          description: The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint.
        State:
          type: string
          enum:
          - create-in-progress
          - create-complete
          - create-failed
          - delete-in-progress
          - delete-complete
          - delete-failed
          - update-in-progress
          - update-complete
          - update-failed
          description: The current state of the EC2 Instance Connect Endpoint.
        StateMessage:
          type: string
          description: The message for the current state of the EC2 Instance Connect Endpoint. Can include a failure message.
        DnsName:
          type: string
          description: The DNS name of the EC2 Instance Connect Endpoint.
        FipsDnsName:
          type: string
          description: The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.
        NetworkInterfaceIds:
          type: array
          items:
            type: string
          description: The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint.
        VpcId:
          type: string
          description: The ID of the VPC in which the EC2 Instance Connect Endpoint was created.
        AvailabilityZone:
          type: string
          description: The Availability Zone of the EC2 Instance Connect Endpoint.
        CreatedAt:
          type: string
          format: date-time
          description: The date and time that the EC2 Instance Connect Endpoint was created.
        SubnetId:
          type: string
          description: The ID of the subnet in which the EC2 Instance Connect Endpoint was created.
        PreserveClientIp:
          type: boolean
          description: 'Indicates whether your client''s IP address is preserved as the source when you connect to a resource. The following are the possible values. true - Use the IP address of the client. Your instance must have an IPv4 address. false - Use the IP address of the network interface. Default: false'
        SecurityGroupIds:
          type: array
          items:
            type: string
          description: The security groups associated with the endpoint. If you didn't specify a security group, the default security group for your VPC is associated with the endpoint.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags assigned to the EC2 Instance Connect Endpoint.
        IpAddressType:
          type: string
          enum:
          - ipv4
          - dualstack
          - ipv6
          description: The IP address type of the endpoint.
        PublicDnsNames:
          $ref: '#/components/schemas/InstanceConnectEndpointPublicDnsNames'
        AvailabilityZoneId:
          type: string
          description: The ID of the Availability Zone of the EC2 Instance Connect Endpoint.
    CreateInstanceConnectEndpointResult:
      type: object
      properties:
        InstanceConnectEndpoint:
          $ref: '#/components/schemas/Ec2InstanceConnectEndpoint'
        ClientToken:
          type: string
          description: Unique, case-sensitive idempotency token provided by the client in the the request.
    DeleteInstanceConnectEndpointResult:
      type: object
      properties:
        InstanceConnectEndpoint:
          $ref: '#/components/schemas/Ec2InstanceConnectEndpoint'
    InstanceConnectEndpointPublicDnsNames:
      type: object
      properties:
        Ipv4:
          $ref: '#/components/schemas/InstanceConnectEndpointDnsNames'
        Dualstack:
          $ref: '#/components/schemas/InstanceConnectEndpointDnsNames'
    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.
    ModifyInstanceConnectEndpointRequest:
      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.
        InstanceConnectEndpointId:
          type: string
          description: The ID of the EC2 Instance Connect Endpoint to modify.
        IpAddressType:
          type: string
          enum:
          - ipv4
          - dualstack
          - ipv6
          description: The new IP address type for the EC2 Instance Connect Endpoint. PreserveClientIp is only supported on IPv4 EC2 Instance Connect Endpoints. To use PreserveClientIp, the value for IpAddressType must be ipv4.
        SecurityGroupIds:
          type: array
          items:
            type: string
          description: Changes the security groups for the EC2 Instance Connect Endpoint. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.
        PreserveClientIp:
          type: boolean
          description: Indicates whether the client IP address is preserved as the source when you connect to a resource. The following are the possible values. true - Use the IP address of the client. Your instance must have an IPv4 address. false - Use the IP address of the network interface.
      required:
      - InstanceConnectEndpointId
    DeleteInstanceConnectEndpointRequest:
      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.
        InstanceConnectEndpointId:
          type: string
          description: The ID of the EC2 Instance Connect Endpoint to delete.
      required:
      - InstanceConnectEndpointId
    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.
    CreateInstanceConnectEndpointRequest:
      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.
        SubnetId:
          type: string
          description: The ID of the subnet in which to create the EC2 Instance Connect Endpoint.
        SecurityGroupIds:
          type: array
          items:
            type: string
          description: One or more security groups to associate with the endpoint. If you don't specify a security group, the default security group for your VPC will be associated with the endpoint.
        PreserveClientIp:
          type: boolean
          description: 'Indicates whether the client IP address is preserved as the source. The following are the possible values. true - Use the client IP address as the source. false - Use the network interface IP address as the source. PreserveClientIp is only supported on IPv4 EC2 Instance Connect Endpoints. To use PreserveClientIp, the value for IpAddressType must be ipv4. Default: false'
        ClientToken:
          type: string
          description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to apply to the EC2 Instance Connect Endpoint during creation.
        IpAddressType:
          type: string
          enum:
          - ipv4
          - dualstack
          - ipv6
          description: 'The IP address type of the endpoint. If no value is specified, the default value is determined by the IP address type of the subnet: dualstack - If the subnet has both IPv4 and IPv6 CIDRs ipv4 - If the subnet has only IPv4 CIDRs ipv6 - If the subnet has only IPv6 CIDRs PreserveClientIp is only supported on IPv4 EC2 Instance Connect Endpoints. To use PreserveClientIp, the value for IpAddressType must be ipv4.'
      required:
      - SubnetId
  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)