Skip to content

Describe Instance Connect Endpoints

ec2_describe_instance_connect_endpoints R Documentation

Describes the specified EC2 Instance Connect Endpoints or all EC2 Instance Connect Endpoints

Description

Describes the specified EC2 Instance Connect Endpoints or all EC2 Instance Connect Endpoints.

Usage

ec2_describe_instance_connect_endpoints(DryRun, MaxResults, NextToken,
  Filters, InstanceConnectEndpointIds)

Arguments

DryRun

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

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

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Filters

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:\<key\> - 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:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • tag-value - The value of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific value, regardless of tag key.

  • vpc-id - The ID of the VPC in which the EC2 Instance Connect Endpoint was created.

InstanceConnectEndpointIds

One or more EC2 Instance Connect Endpoint IDs.

Value

A list with the following syntax: 

list(
  InstanceConnectEndpoints = list(
    list(
      OwnerId = "string",
      InstanceConnectEndpointId = "string",
      InstanceConnectEndpointArn = "string",
      State = "create-in-progress"|"create-complete"|"create-failed"|"delete-in-progress"|"delete-complete"|"delete-failed",
      StateMessage = "string",
      DnsName = "string",
      FipsDnsName = "string",
      NetworkInterfaceIds = list(
        "string"
      ),
      VpcId = "string",
      AvailabilityZone = "string",
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      SubnetId = "string",
      PreserveClientIp = TRUE|FALSE,
      SecurityGroupIds = list(
        "string"
      ),
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_instance_connect_endpoints(
  DryRun = TRUE|FALSE,
  MaxResults = 123,
  NextToken = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  InstanceConnectEndpointIds = list(
    "string"
  )
)