Skip to content

describe_classic_link_instances

Operation

describe_classic_link_instances(request: DescribeClassicLinkInstancesInput | DescribeClassicLinkInstancesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeClassicLinkInstancesInputDict]) -> DescribeClassicLinkInstancesOutput
Note

This action is deprecated.

Describes 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.

Parameters:

Name Type Description Default
request DescribeClassicLinkInstancesInput | DescribeClassicLinkInstancesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DescribeClassicLinkInstancesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeClassicLinkInstancesOutput

An instance of DescribeClassicLinkInstancesOutput.

describe_classic_link_instances(request: DescribeClassicLinkInstancesInput | DescribeClassicLinkInstancesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeClassicLinkInstancesInputDict]) -> DescribeClassicLinkInstancesOutput
Note

This action is deprecated.

Describes 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.

Parameters:

Name Type Description Default
request DescribeClassicLinkInstancesInput | DescribeClassicLinkInstancesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DescribeClassicLinkInstancesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeClassicLinkInstancesOutput

An instance of DescribeClassicLinkInstancesOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribeClassicLinkInstancesInputDict

Bases: TypedDict

Dictionary form of DescribeClassicLinkInstancesInput.

Attributes

dry_run 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 instance-attribute
filters: Sequence[Filter | FilterDict] | None

The filters.

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

  • instance-id - The ID of the instance.

  • 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: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.

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

instance_ids instance-attribute
instance_ids: Sequence[str] | None

The instance IDs. Must be instances linked to a VPC through ClassicLink.

max_results 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.

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

next_token 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.

DescribeClassicLinkInstancesInput dataclass

Bases: _SerdeShape

Dataclass for DescribeClassicLinkInstancesInput 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 = ...

The filters.

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

  • instance-id - The ID of the instance.

  • 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: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.

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

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

The instance IDs. Must be instances linked to a VPC through ClassicLink.

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.

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

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

DescribeClassicLinkInstancesOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeClassicLinkInstancesOutput structure.

Attributes

instances class-attribute instance-attribute
instances: list[ClassicLinkInstance] | None = ...

Information about one or more linked EC2-Classic instances.

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.