Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

DescribeClassicLinkInstances

Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink; you cannot use this request to return information about other instances.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

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.

Type: Boolean

Required: No

Filter.N

One or more filters.

  • group-id - The ID of a VPC security group that's associated with the instance.

  • instance-id - The ID of the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC that the instance is linked to.

Type: array of Filter objects

Required: No

InstanceId.N

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

Type: array of Strings

Required: No

MaxResults

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

Constraint: If the value is greater than 1000, we return only 1000 items.

Type: Integer

Required: No

NextToken

The token to retrieve the next page of results.

Type: String

Required: No

Response Elements

The following elements are returned by the service.

instancesSet

Information about one or more linked EC2-Classic instances.

Type: array of ClassicLinkInstance objects

nextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

Examples

Example

This example lists all of your linked EC2-Classic instances.

Sample Request

Copy
https://ec2.amazonaws.com/?Action=DescribeClassicLinkInstances &AUTHPARAMS

Sample Response

Copy
<DescribeClassicLinkInstancesResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> <instancesSet> <item> <instanceId>i-1234567890abcdef0</instanceId> <vpcId>vpc-1a2b3c4d</vpcId> <groupSet> <item> <groupId>sg-a1a1a1a1</groupId> </item> </groupSet> <tagSet/> </item> </instancesSet> </DescribeClassicLinkInstancesResponse>

Example

This example lists all linked EC2-Classic instances, and filters the response to include only instances that are linked to VPC vpc-1a2b3c4d.

Sample Request

Copy
https://ec2.amazonaws.com/?Action=DescribeClassicLinkInstances &Filter.1.Name=vpc-id &Filter.1.Value.1=vpc-1a2b3c4d &AUTHPARAMS

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: