Skip to content

EC2  >  Operations  >  describe_instance_connect_endpoints

describe_instance_connect_endpoints

Operation

describe_instance_connect_endpoints async 

describe_instance_connect_endpoints(input: DescribeInstanceConnectEndpointsInput, plugins: list[Plugin] | None = None) -> DescribeInstanceConnectEndpointsOutput

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

Parameters:

Name Type Description Default
input DescribeInstanceConnectEndpointsInput

An instance of DescribeInstanceConnectEndpointsInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
DescribeInstanceConnectEndpointsOutput

An instance of DescribeInstanceConnectEndpointsOutput.

Input

DescribeInstanceConnectEndpointsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeInstanceConnectEndpointsInput structure.

Attributes

dry_run class-attribute instance-attribute 
dry_run: bool | None = ...

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 class-attribute instance-attribute 
filters: list[Filter] | None = ...

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.

instance_connect_endpoint_ids class-attribute instance-attribute 
instance_connect_endpoint_ids: list[str] | None = ...

One or more EC2 Instance Connect Endpoint IDs.

max_results class-attribute instance-attribute 
max_results: int | None = ...

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.

next_token class-attribute instance-attribute 
next_token: str | None = ...

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

Output

DescribeInstanceConnectEndpointsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeInstanceConnectEndpointsOutput structure.

Attributes

instance_connect_endpoints class-attribute instance-attribute 
instance_connect_endpoints: list[Ec2InstanceConnectEndpoint] | None = ...

Information about the EC2 Instance Connect Endpoints.

next_token class-attribute instance-attribute 
next_token: str | None = ...

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.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.