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

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 identifiers are provided. Otherwise, all images in the account are described.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeWorkspaceImages Source #

See: newDescribeWorkspaceImages smart constructor.

Constructors

DescribeWorkspaceImages'
Fields imageIds :: Maybe (NonEmpty Text) The identifier of the image. nextToken :: Maybe Text If you received a `NextToken` from a previous call that was paginated, provide this token to receive the next set of results. imageType :: Maybe ImageType The type (owned or shared) of the image. maxResults :: Maybe Natural The maximum number of items to return.

Instances

Instances details

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

newDescribeWorkspaceImages :: DescribeWorkspaceImages Source #

Create a value of DescribeWorkspaceImages 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:imageIds:DescribeWorkspaceImages', describeWorkspaceImages_imageIds - The identifier of the image.

$sel:nextToken:DescribeWorkspaceImages', describeWorkspaceImages_nextToken - If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

$sel:imageType:DescribeWorkspaceImages', describeWorkspaceImages_imageType - The type (owned or shared) of the image.

$sel:maxResults:DescribeWorkspaceImages', describeWorkspaceImages_maxResults - The maximum number of items to return.

Request Lenses

describeWorkspaceImages_imageIds :: Lens' DescribeWorkspaceImages (Maybe (NonEmpty Text)) Source #

The identifier of the image.

describeWorkspaceImages_nextToken :: Lens' DescribeWorkspaceImages (Maybe Text) Source #

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

describeWorkspaceImages_imageType :: Lens' DescribeWorkspaceImages (Maybe ImageType) Source #

The type (owned or shared) of the image.

describeWorkspaceImages_maxResults :: Lens' DescribeWorkspaceImages (Maybe Natural) Source #

The maximum number of items to return.

Destructuring the Response

data DescribeWorkspaceImagesResponse Source #

See: newDescribeWorkspaceImagesResponse smart constructor.

Constructors

DescribeWorkspaceImagesResponse'
Fields images :: Maybe [WorkspaceImage] Information about the images. nextToken :: Maybe Text The token to use to retrieve the next page of results. This value is null when there are no more results to return. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeWorkspaceImagesResponse Source #

Arguments

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

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

$sel:nextToken:DescribeWorkspaceImages', describeWorkspaceImagesResponse_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:DescribeWorkspaceImagesResponse', describeWorkspaceImagesResponse_httpStatus - The response's http status code.

Response Lenses

describeWorkspaceImagesResponse_images :: Lens' DescribeWorkspaceImagesResponse (Maybe [WorkspaceImage]) Source #

Information about the images.

describeWorkspaceImagesResponse_nextToken :: Lens' DescribeWorkspaceImagesResponse (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.

describeWorkspaceImagesResponse_httpStatus :: Lens' DescribeWorkspaceImagesResponse Int Source #

The response's http status code.