EC2 / Client / describe_classic_link_instances

describe_classic_link_instances

EC2.Client.describe_classic_link_instances(**kwargs)

Note

This action is deprecated.

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_classic_link_instances(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DryRun=True|False,
    InstanceIds=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)

Parameters:

• Filters (list) –

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

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

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    • Name (string) –

      The name of the filter. Filter names are case-sensitive.

    • Values (list) –

      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.

      • (string) –

• DryRun (boolean) – 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.

• InstanceIds (list) –

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

  • (string) –

• MaxResults (integer) –

  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.

• NextToken (string) – The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Return type:

dict

Returns:

Response Syntax

{
    'Instances': [
        {
            'Groups': [
                {
                    'GroupName': 'string',
                    'GroupId': 'string'
                },
            ],
            'InstanceId': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'VpcId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • Instances (list) –

    Information about one or more linked EC2-Classic instances.

    • (dict) –

      Note

      Deprecated.

      Describes a linked EC2-Classic instance.

      • Groups (list) –

        The security groups.

        • (dict) –

          Describes a security group.

          • GroupName (string) –

            The name of the security group.

          • GroupId (string) –

            The ID of the security group.

      • InstanceId (string) –

        The ID of the instance.

      • Tags (list) –

        Any tags assigned to the instance.

        • (dict) –

          Describes a tag.

          • Key (string) –

            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 (string) –

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

      • VpcId (string) –

        The ID of the VPC.

  • NextToken (string) –

    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.