amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.DescribeClassicLinkInstances

Description

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.

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeClassicLinkInstances Source #

See: newDescribeClassicLinkInstances smart constructor.

Constructors

DescribeClassicLinkInstances' 

Fields

  • dryRun :: Maybe Bool

    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 :: Maybe [Filter]

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

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

  • instanceIds :: Maybe [Text]

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

  • maxResults :: Maybe Natural

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

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

  • nextToken :: Maybe Text

    The token for the next page of results.

Instances

Instances details
ToHeaders DescribeClassicLinkInstances Source # 
Instance details

Defined in Amazonka.EC2.DescribeClassicLinkInstances

Methods

toHeaders :: DescribeClassicLinkInstances -> [Header] #

ToPath DescribeClassicLinkInstances Source # 
Instance details

Defined in Amazonka.EC2.DescribeClassicLinkInstances

Methods

toPath :: DescribeClassicLinkInstances -> ByteString #

ToQuery DescribeClassicLinkInstances Source # 
Instance details

Defined in Amazonka.EC2.DescribeClassicLinkInstances

Methods

toQuery :: DescribeClassicLinkInstances -> QueryString #

AWSPager DescribeClassicLinkInstances Source # 
Instance details

Defined in Amazonka.EC2.DescribeClassicLinkInstances

Methods

page :: DescribeClassicLinkInstances -> AWSResponse DescribeClassicLinkInstances -> Maybe DescribeClassicLinkInstances #

AWSRequest DescribeClassicLinkInstances Source # 
Instance details

Defined in Amazonka.EC2.DescribeClassicLinkInstances

Associated Types

type AWSResponse DescribeClassicLinkInstances #

Methods

request :: (Service -> Service) -> DescribeClassicLinkInstances -> Request DescribeClassicLinkInstances #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeClassicLinkInstances -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeClassicLinkInstances))) #

Generic DescribeClassicLinkInstances Source # 
Instance details

Defined in Amazonka.EC2.DescribeClassicLinkInstances

Associated Types

type Rep DescribeClassicLinkInstances :: Type -> Type #

Methods

from :: DescribeClassicLinkInstances -> Rep DescribeClassicLinkInstances x #

to :: Rep DescribeClassicLinkInstances x -> DescribeClassicLinkInstances #

Read DescribeClassicLinkInstances Source # 
Instance details

Defined in Amazonka.EC2.DescribeClassicLinkInstances

Methods

readsPrec :: Int -> ReadS DescribeClassicLinkInstances #

readList :: ReadS [DescribeClassicLinkInstances] #

readPrec :: ReadPrec DescribeClassicLinkInstances #

readListPrec :: ReadPrec [DescribeClassicLinkInstances] #

Show DescribeClassicLinkInstances Source # 
Instance details

Defined in Amazonka.EC2.DescribeClassicLinkInstances

Methods

showsPrec :: Int -> DescribeClassicLinkInstances -> ShowS #

show :: DescribeClassicLinkInstances -> String #

showList :: [DescribeClassicLinkInstances] -> ShowS #

NFData DescribeClassicLinkInstances Source # 
Instance details

Defined in Amazonka.EC2.DescribeClassicLinkInstances

Methods

rnf :: DescribeClassicLinkInstances -> () #

Eq DescribeClassicLinkInstances Source # 
Instance details

Defined in Amazonka.EC2.DescribeClassicLinkInstances

Methods

(==) :: DescribeClassicLinkInstances -> DescribeClassicLinkInstances -> Bool #

(/=) :: DescribeClassicLinkInstances -> DescribeClassicLinkInstances -> Bool #

Hashable DescribeClassicLinkInstances Source # 
Instance details

Defined in Amazonka.EC2.DescribeClassicLinkInstances

Methods

hashWithSalt :: Int -> DescribeClassicLinkInstances -> Int #

hash :: DescribeClassicLinkInstances -> Int #

type AWSResponse DescribeClassicLinkInstances Source # 
Instance details

Defined in Amazonka.EC2.DescribeClassicLinkInstances

type AWSResponse DescribeClassicLinkInstances = DescribeClassicLinkInstancesResponse
type Rep DescribeClassicLinkInstances Source # 
Instance details

Defined in Amazonka.EC2.DescribeClassicLinkInstances

type Rep DescribeClassicLinkInstances = D1 ('MetaData "DescribeClassicLinkInstances" "Amazonka.EC2.DescribeClassicLinkInstances" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeClassicLinkInstances'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :*: (S1 ('MetaSel ('Just "instanceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDescribeClassicLinkInstances :: DescribeClassicLinkInstances Source #

Create a value of DescribeClassicLinkInstances with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dryRun:DescribeClassicLinkInstances', describeClassicLinkInstances_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.

$sel:filters:DescribeClassicLinkInstances', describeClassicLinkInstances_filters - 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> - 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.

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

DescribeClassicLinkInstances, describeClassicLinkInstances_instanceIds - One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

$sel:maxResults:DescribeClassicLinkInstances', describeClassicLinkInstances_maxResults - The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

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

DescribeClassicLinkInstances, describeClassicLinkInstances_nextToken - The token for the next page of results.

Request Lenses

describeClassicLinkInstances_dryRun :: Lens' DescribeClassicLinkInstances (Maybe Bool) Source #

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.

describeClassicLinkInstances_filters :: Lens' DescribeClassicLinkInstances (Maybe [Filter]) Source #

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

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

describeClassicLinkInstances_instanceIds :: Lens' DescribeClassicLinkInstances (Maybe [Text]) Source #

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

describeClassicLinkInstances_maxResults :: Lens' DescribeClassicLinkInstances (Maybe Natural) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

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

describeClassicLinkInstances_nextToken :: Lens' DescribeClassicLinkInstances (Maybe Text) Source #

The token for the next page of results.

Destructuring the Response

data DescribeClassicLinkInstancesResponse Source #

See: newDescribeClassicLinkInstancesResponse smart constructor.

Constructors

DescribeClassicLinkInstancesResponse' 

Fields

Instances

Instances details
Generic DescribeClassicLinkInstancesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeClassicLinkInstances

Associated Types

type Rep DescribeClassicLinkInstancesResponse :: Type -> Type #

Methods

from :: DescribeClassicLinkInstancesResponse -> Rep DescribeClassicLinkInstancesResponse x #

to :: Rep DescribeClassicLinkInstancesResponse x -> DescribeClassicLinkInstancesResponse #

Read DescribeClassicLinkInstancesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeClassicLinkInstances

Methods

readsPrec :: Int -> ReadS DescribeClassicLinkInstancesResponse #

readList :: ReadS [DescribeClassicLinkInstancesResponse] #

readPrec :: ReadPrec DescribeClassicLinkInstancesResponse #

readListPrec :: ReadPrec [DescribeClassicLinkInstancesResponse] #

Show DescribeClassicLinkInstancesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeClassicLinkInstances

Methods

showsPrec :: Int -> DescribeClassicLinkInstancesResponse -> ShowS #

show :: DescribeClassicLinkInstancesResponse -> String #

showList :: [DescribeClassicLinkInstancesResponse] -> ShowS #

NFData DescribeClassicLinkInstancesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeClassicLinkInstances

Methods

rnf :: DescribeClassicLinkInstancesResponse -> () #

Eq DescribeClassicLinkInstancesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeClassicLinkInstances

Methods

(==) :: DescribeClassicLinkInstancesResponse -> DescribeClassicLinkInstancesResponse -> Bool #

(/=) :: DescribeClassicLinkInstancesResponse -> DescribeClassicLinkInstancesResponse -> Bool #

type Rep DescribeClassicLinkInstancesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeClassicLinkInstances

type Rep DescribeClassicLinkInstancesResponse = D1 ('MetaData "DescribeClassicLinkInstancesResponse" "Amazonka.EC2.DescribeClassicLinkInstances" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeClassicLinkInstancesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ClassicLinkInstance])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeClassicLinkInstancesResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeClassicLinkInstancesResponse'

-> DescribeClassicLinkInstancesResponse 

Create a value of DescribeClassicLinkInstancesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeClassicLinkInstancesResponse, describeClassicLinkInstancesResponse_instances - Information about one or more linked EC2-Classic instances.

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

$sel:httpStatus:DescribeClassicLinkInstancesResponse', describeClassicLinkInstancesResponse_httpStatus - The response's http status code.

Response Lenses

describeClassicLinkInstancesResponse_instances :: Lens' DescribeClassicLinkInstancesResponse (Maybe [ClassicLinkInstance]) Source #

Information about one or more linked EC2-Classic instances.

describeClassicLinkInstancesResponse_nextToken :: Lens' DescribeClassicLinkInstancesResponse (Maybe Text) Source #

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

describeClassicLinkInstancesResponse_httpStatus :: Lens' DescribeClassicLinkInstancesResponse Int Source #

The response's http status code.