Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

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' {
- arns :: Maybe [Text]
- maxResults :: Maybe Natural
- names :: Maybe [Text]
- nextToken :: Maybe Text
- type' :: Maybe VisibilityType
}
newDescribeImages :: DescribeImages
describeImages_arns :: Lens' DescribeImages (Maybe [Text])
describeImages_maxResults :: Lens' DescribeImages (Maybe Natural)
describeImages_names :: Lens' DescribeImages (Maybe [Text])
describeImages_nextToken :: Lens' DescribeImages (Maybe Text)
describeImages_type :: Lens' DescribeImages (Maybe VisibilityType)
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

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.
names :: Maybe [Text]
The names of the public or private images to describe.
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.
type' :: Maybe VisibilityType
The type of image (public, private, or shared) to describe.

Instances

Instances details

ToJSON DescribeImages Source #
Instance details Defined in Amazonka.AppStream.DescribeImages Methods toJSON :: DescribeImages -> Value # toEncoding :: DescribeImages -> Encoding # toJSONList :: [DescribeImages] -> Value # toEncodingList :: [DescribeImages] -> Encoding #
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 #
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 :: (Service -> Service) -> DescribeImages -> Request DescribeImages # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeImages -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeImages))) #
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 #
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 #
NFData DescribeImages Source #
Instance details Defined in Amazonka.AppStream.DescribeImages Methods rnf :: DescribeImages -> () #
Eq DescribeImages Source #
Instance details Defined in Amazonka.AppStream.DescribeImages Methods (==) :: DescribeImages -> DescribeImages -> Bool # (/=) :: DescribeImages -> DescribeImages -> Bool #
Hashable DescribeImages Source #
Instance details Defined in Amazonka.AppStream.DescribeImages Methods hashWithSalt :: Int -> DescribeImages -> Int # hash :: DescribeImages -> Int #
type AWSResponse DescribeImages Source #
Instance details Defined in Amazonka.AppStream.DescribeImages type AWSResponse DescribeImages = DescribeImagesResponse
type Rep DescribeImages Source #
Instance details Defined in Amazonka.AppStream.DescribeImages type Rep DescribeImages = D1 ('MetaData "DescribeImages" "Amazonka.AppStream.DescribeImages" "amazonka-appstream-2.0-2EgS7yjN1zMCngYkSFPgOd" 'False) (C1 ('MetaCons "DescribeImages'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "names") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VisibilityType))))))

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

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

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:type':DescribeImages', describeImages_type - The type of image (public, private, or shared) to describe.

Request Lenses

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.

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

The names of the public or private images to describe.

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_type :: Lens' DescribeImages (Maybe VisibilityType) Source #

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

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

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 #
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 #
NFData DescribeImagesResponse Source #
Instance details Defined in Amazonka.AppStream.DescribeImages Methods rnf :: DescribeImagesResponse -> () #
Eq DescribeImagesResponse Source #
Instance details Defined in Amazonka.AppStream.DescribeImages Methods (==) :: DescribeImagesResponse -> DescribeImagesResponse -> Bool # (/=) :: DescribeImagesResponse -> DescribeImagesResponse -> Bool #
type Rep DescribeImagesResponse Source #
Instance details Defined in Amazonka.AppStream.DescribeImages type Rep DescribeImagesResponse = D1 ('MetaData "DescribeImagesResponse" "Amazonka.AppStream.DescribeImages" "amazonka-appstream-2.0-2EgS7yjN1zMCngYkSFPgOd" '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.

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.