Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.AppStream.DescribeImages

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described.

This operation returns paginated results.

Synopsis

data DescribeImages = DescribeImages' {
- nextToken :: Maybe Text
- names :: Maybe [Text]
- type' :: Maybe VisibilityType
- arns :: Maybe [Text]
- maxResults :: Maybe Natural
}
newDescribeImages :: DescribeImages
describeImages_nextToken :: Lens' DescribeImages (Maybe Text)
describeImages_names :: Lens' DescribeImages (Maybe [Text])
describeImages_type :: Lens' DescribeImages (Maybe VisibilityType)
describeImages_arns :: Lens' DescribeImages (Maybe [Text])
describeImages_maxResults :: Lens' DescribeImages (Maybe Natural)
data DescribeImagesResponse = DescribeImagesResponse' {
- images :: Maybe [Image]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newDescribeImagesResponse :: Int -> DescribeImagesResponse
describeImagesResponse_images :: Lens' DescribeImagesResponse (Maybe [Image])
describeImagesResponse_nextToken :: Lens' DescribeImagesResponse (Maybe Text)
describeImagesResponse_httpStatus :: Lens' DescribeImagesResponse Int

Creating a Request

data DescribeImages Source #

See: newDescribeImages smart constructor.

Constructors

DescribeImages'

Fields

nextToken :: Maybe Text
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
names :: Maybe [Text]
The names of the public or private images to describe.
type' :: Maybe VisibilityType
The type of image (public, private, or shared) to describe.
arns :: Maybe [Text]
The ARNs of the public, private, and shared images to describe.
maxResults :: Maybe Natural
The maximum size of each page of results.

Instances

Instances details

Eq DescribeImages Source #
Instance details Defined in Amazonka.AppStream.DescribeImages Methods (==) :: DescribeImages -> DescribeImages -> Bool # (/=) :: DescribeImages -> DescribeImages -> Bool #
Read DescribeImages Source #
Instance details Defined in Amazonka.AppStream.DescribeImages Methods readsPrec :: Int -> ReadS DescribeImages # readList :: ReadS [DescribeImages] # readPrec :: ReadPrec DescribeImages # readListPrec :: ReadPrec [DescribeImages] #
Show DescribeImages Source #
Instance details Defined in Amazonka.AppStream.DescribeImages Methods showsPrec :: Int -> DescribeImages -> ShowS # show :: DescribeImages -> String # showList :: [DescribeImages] -> ShowS #
Generic DescribeImages Source #
Instance details Defined in Amazonka.AppStream.DescribeImages Associated Types type Rep DescribeImages :: Type -> Type # Methods from :: DescribeImages -> Rep DescribeImages x # to :: Rep DescribeImages x -> DescribeImages #
NFData DescribeImages Source #
Instance details Defined in Amazonka.AppStream.DescribeImages Methods rnf :: DescribeImages -> () #
Hashable DescribeImages Source #
Instance details Defined in Amazonka.AppStream.DescribeImages Methods hashWithSalt :: Int -> DescribeImages -> Int # hash :: DescribeImages -> Int #
ToJSON DescribeImages Source #
Instance details Defined in Amazonka.AppStream.DescribeImages Methods toJSON :: DescribeImages -> Value # toEncoding :: DescribeImages -> Encoding # toJSONList :: [DescribeImages] -> Value # toEncodingList :: [DescribeImages] -> Encoding #
AWSPager DescribeImages Source #
Instance details Defined in Amazonka.AppStream.DescribeImages Methods page :: DescribeImages -> AWSResponse DescribeImages -> Maybe DescribeImages #
AWSRequest DescribeImages Source #
Instance details Defined in Amazonka.AppStream.DescribeImages Associated Types type AWSResponse DescribeImages # Methods request :: DescribeImages -> Request DescribeImages # response :: MonadResource m => Logger -> Service -> Proxy DescribeImages -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeImages))) #
ToHeaders DescribeImages Source #
Instance details Defined in Amazonka.AppStream.DescribeImages Methods toHeaders :: DescribeImages -> [Header] #
ToPath DescribeImages Source #
Instance details Defined in Amazonka.AppStream.DescribeImages Methods toPath :: DescribeImages -> ByteString #
ToQuery DescribeImages Source #
Instance details Defined in Amazonka.AppStream.DescribeImages Methods toQuery :: DescribeImages -> QueryString #
type Rep DescribeImages Source #
Instance details Defined in Amazonka.AppStream.DescribeImages type Rep DescribeImages = D1 ('MetaData "DescribeImages" "Amazonka.AppStream.DescribeImages" "libZSservicesZSamazonka-appstreamZSamazonka-appstream" 'False) (C1 ('MetaCons "DescribeImages'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "names") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VisibilityType)) :: (S1 ('MetaSel ('Just "arns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))
type AWSResponse DescribeImages Source #
Instance details Defined in Amazonka.AppStream.DescribeImages type AWSResponse DescribeImages = DescribeImagesResponse

newDescribeImages :: DescribeImages Source #

Create a value of DescribeImages 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:nextToken:DescribeImages', describeImages_nextToken - The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

$sel:names:DescribeImages', describeImages_names - The names of the public or private images to describe.

$sel:type':DescribeImages', describeImages_type - The type of image (public, private, or shared) to describe.

$sel:arns:DescribeImages', describeImages_arns - The ARNs of the public, private, and shared images to describe.

$sel:maxResults:DescribeImages', describeImages_maxResults - The maximum size of each page of results.

Request Lenses

describeImages_nextToken :: Lens' DescribeImages (Maybe Text) Source #

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

describeImages_names :: Lens' DescribeImages (Maybe [Text]) Source #

The names of the public or private images to describe.

describeImages_type :: Lens' DescribeImages (Maybe VisibilityType) Source #

The type of image (public, private, or shared) to describe.

describeImages_arns :: Lens' DescribeImages (Maybe [Text]) Source #

The ARNs of the public, private, and shared images to describe.

describeImages_maxResults :: Lens' DescribeImages (Maybe Natural) Source #

The maximum size of each page of results.

Destructuring the Response

data DescribeImagesResponse Source #

See: newDescribeImagesResponse smart constructor.

Constructors

DescribeImagesResponse'
Fields images :: Maybe [Image] Information about the images. nextToken :: Maybe Text The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeImagesResponse Source #
Instance details Defined in Amazonka.AppStream.DescribeImages Methods (==) :: DescribeImagesResponse -> DescribeImagesResponse -> Bool # (/=) :: DescribeImagesResponse -> DescribeImagesResponse -> Bool #
Read DescribeImagesResponse Source #
Instance details Defined in Amazonka.AppStream.DescribeImages Methods readsPrec :: Int -> ReadS DescribeImagesResponse # readList :: ReadS [DescribeImagesResponse] # readPrec :: ReadPrec DescribeImagesResponse # readListPrec :: ReadPrec [DescribeImagesResponse] #
Show DescribeImagesResponse Source #
Instance details Defined in Amazonka.AppStream.DescribeImages Methods showsPrec :: Int -> DescribeImagesResponse -> ShowS # show :: DescribeImagesResponse -> String # showList :: [DescribeImagesResponse] -> ShowS #
Generic DescribeImagesResponse Source #
Instance details Defined in Amazonka.AppStream.DescribeImages Associated Types type Rep DescribeImagesResponse :: Type -> Type # Methods from :: DescribeImagesResponse -> Rep DescribeImagesResponse x # to :: Rep DescribeImagesResponse x -> DescribeImagesResponse #
NFData DescribeImagesResponse Source #
Instance details Defined in Amazonka.AppStream.DescribeImages Methods rnf :: DescribeImagesResponse -> () #
type Rep DescribeImagesResponse Source #
Instance details Defined in Amazonka.AppStream.DescribeImages type Rep DescribeImagesResponse = D1 ('MetaData "DescribeImagesResponse" "Amazonka.AppStream.DescribeImages" "libZSservicesZSamazonka-appstreamZSamazonka-appstream" 'False) (C1 ('MetaCons "DescribeImagesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "images") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Image])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeImagesResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeImagesResponse'`
-> DescribeImagesResponse

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

$sel:nextToken:DescribeImages', describeImagesResponse_nextToken - The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

$sel:httpStatus:DescribeImagesResponse', describeImagesResponse_httpStatus - The response's http status code.

Response Lenses

describeImagesResponse_images :: Lens' DescribeImagesResponse (Maybe [Image]) Source #

Information about the images.

describeImagesResponse_nextToken :: Lens' DescribeImagesResponse (Maybe Text) Source #

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

describeImagesResponse_httpStatus :: Lens' DescribeImagesResponse Int Source #

The response's http status code.