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

Description

Lists one or more AMIs that are currently in the Recycle Bin. For more information, see Recycle Bin in the Amazon EC2 User Guide.

This operation returns paginated results.

Synopsis

Creating a Request

data ListImagesInRecycleBin Source #

See: newListImagesInRecycleBin smart constructor.

Constructors

ListImagesInRecycleBin' 

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.

  • imageIds :: Maybe [Text]

    The IDs of the AMIs to list. Omit this parameter to list all of the AMIs that are in the Recycle Bin. You can specify up to 20 IDs in a single request.

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

    If you do not specify a value for MaxResults, the request returns 1,000 items per page by default. For more information, see Pagination.

  • nextToken :: Maybe Text

    The token for the next page of results.

Instances

Instances details
ToHeaders ListImagesInRecycleBin Source # 
Instance details

Defined in Amazonka.EC2.ListImagesInRecycleBin

ToPath ListImagesInRecycleBin Source # 
Instance details

Defined in Amazonka.EC2.ListImagesInRecycleBin

ToQuery ListImagesInRecycleBin Source # 
Instance details

Defined in Amazonka.EC2.ListImagesInRecycleBin

AWSPager ListImagesInRecycleBin Source # 
Instance details

Defined in Amazonka.EC2.ListImagesInRecycleBin

AWSRequest ListImagesInRecycleBin Source # 
Instance details

Defined in Amazonka.EC2.ListImagesInRecycleBin

Associated Types

type AWSResponse ListImagesInRecycleBin #

Generic ListImagesInRecycleBin Source # 
Instance details

Defined in Amazonka.EC2.ListImagesInRecycleBin

Associated Types

type Rep ListImagesInRecycleBin :: Type -> Type #

Read ListImagesInRecycleBin Source # 
Instance details

Defined in Amazonka.EC2.ListImagesInRecycleBin

Show ListImagesInRecycleBin Source # 
Instance details

Defined in Amazonka.EC2.ListImagesInRecycleBin

NFData ListImagesInRecycleBin Source # 
Instance details

Defined in Amazonka.EC2.ListImagesInRecycleBin

Methods

rnf :: ListImagesInRecycleBin -> () #

Eq ListImagesInRecycleBin Source # 
Instance details

Defined in Amazonka.EC2.ListImagesInRecycleBin

Hashable ListImagesInRecycleBin Source # 
Instance details

Defined in Amazonka.EC2.ListImagesInRecycleBin

type AWSResponse ListImagesInRecycleBin Source # 
Instance details

Defined in Amazonka.EC2.ListImagesInRecycleBin

type Rep ListImagesInRecycleBin Source # 
Instance details

Defined in Amazonka.EC2.ListImagesInRecycleBin

type Rep ListImagesInRecycleBin = D1 ('MetaData "ListImagesInRecycleBin" "Amazonka.EC2.ListImagesInRecycleBin" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ListImagesInRecycleBin'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "imageIds") '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)))))

newListImagesInRecycleBin :: ListImagesInRecycleBin Source #

Create a value of ListImagesInRecycleBin 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:ListImagesInRecycleBin', listImagesInRecycleBin_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:imageIds:ListImagesInRecycleBin', listImagesInRecycleBin_imageIds - The IDs of the AMIs to list. Omit this parameter to list all of the AMIs that are in the Recycle Bin. You can specify up to 20 IDs in a single request.

$sel:maxResults:ListImagesInRecycleBin', listImagesInRecycleBin_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.

If you do not specify a value for MaxResults, the request returns 1,000 items per page by default. For more information, see Pagination.

ListImagesInRecycleBin, listImagesInRecycleBin_nextToken - The token for the next page of results.

Request Lenses

listImagesInRecycleBin_dryRun :: Lens' ListImagesInRecycleBin (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.

listImagesInRecycleBin_imageIds :: Lens' ListImagesInRecycleBin (Maybe [Text]) Source #

The IDs of the AMIs to list. Omit this parameter to list all of the AMIs that are in the Recycle Bin. You can specify up to 20 IDs in a single request.

listImagesInRecycleBin_maxResults :: Lens' ListImagesInRecycleBin (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.

If you do not specify a value for MaxResults, the request returns 1,000 items per page by default. For more information, see Pagination.

listImagesInRecycleBin_nextToken :: Lens' ListImagesInRecycleBin (Maybe Text) Source #

The token for the next page of results.

Destructuring the Response

data ListImagesInRecycleBinResponse Source #

See: newListImagesInRecycleBinResponse smart constructor.

Constructors

ListImagesInRecycleBinResponse' 

Fields

Instances

Instances details
Generic ListImagesInRecycleBinResponse Source # 
Instance details

Defined in Amazonka.EC2.ListImagesInRecycleBin

Associated Types

type Rep ListImagesInRecycleBinResponse :: Type -> Type #

Read ListImagesInRecycleBinResponse Source # 
Instance details

Defined in Amazonka.EC2.ListImagesInRecycleBin

Show ListImagesInRecycleBinResponse Source # 
Instance details

Defined in Amazonka.EC2.ListImagesInRecycleBin

NFData ListImagesInRecycleBinResponse Source # 
Instance details

Defined in Amazonka.EC2.ListImagesInRecycleBin

Eq ListImagesInRecycleBinResponse Source # 
Instance details

Defined in Amazonka.EC2.ListImagesInRecycleBin

type Rep ListImagesInRecycleBinResponse Source # 
Instance details

Defined in Amazonka.EC2.ListImagesInRecycleBin

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

newListImagesInRecycleBinResponse Source #

Create a value of ListImagesInRecycleBinResponse 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:images:ListImagesInRecycleBinResponse', listImagesInRecycleBinResponse_images - Information about the AMIs.

ListImagesInRecycleBin, listImagesInRecycleBinResponse_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:ListImagesInRecycleBinResponse', listImagesInRecycleBinResponse_httpStatus - The response's http status code.

Response Lenses

listImagesInRecycleBinResponse_nextToken :: Lens' ListImagesInRecycleBinResponse (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.