Amazonka.WorkSpaces.DescribeWorkspaceImages

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.

Creating a Request

data DescribeWorkspaceImages

See: newDescribeWorkspaceImages smart constructor.

Constructors

DescribeWorkspaceImages'

Fields

• imageIds :: Maybe (NonEmpty Text)

  The identifier of the image.

• imageType :: Maybe ImageType

  The type (owned or shared) of the image.

• maxResults :: Maybe Natural

  The maximum number of items to return.

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

Instances

ToJSON DescribeWorkspaceImages

Defined in Amazonka.WorkSpaces.DescribeWorkspaceImages

Methods

toJSON :: DescribeWorkspaceImages -> Value

toEncoding :: DescribeWorkspaceImages -> Encoding

toJSONList :: [DescribeWorkspaceImages] -> Value

toEncodingList :: [DescribeWorkspaceImages] -> Encoding

ToHeaders DescribeWorkspaceImages

Defined in Amazonka.WorkSpaces.DescribeWorkspaceImages

Methods

toHeaders :: DescribeWorkspaceImages -> [Header]

ToPath DescribeWorkspaceImages

Defined in Amazonka.WorkSpaces.DescribeWorkspaceImages

Methods

toPath :: DescribeWorkspaceImages -> ByteString

ToQuery DescribeWorkspaceImages

Defined in Amazonka.WorkSpaces.DescribeWorkspaceImages

Methods

toQuery :: DescribeWorkspaceImages -> QueryString

AWSPager DescribeWorkspaceImages

Defined in Amazonka.WorkSpaces.DescribeWorkspaceImages

Methods

page :: DescribeWorkspaceImages -> AWSResponse DescribeWorkspaceImages -> Maybe DescribeWorkspaceImages

AWSRequest DescribeWorkspaceImages

Defined in Amazonka.WorkSpaces.DescribeWorkspaceImages

Associated Types

type AWSResponse DescribeWorkspaceImages

Methods

request :: (Service -> Service) -> DescribeWorkspaceImages -> Request DescribeWorkspaceImages

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

Generic DescribeWorkspaceImages

Defined in Amazonka.WorkSpaces.DescribeWorkspaceImages

Associated Types

type Rep DescribeWorkspaceImages :: Type -> Type

Methods

from :: DescribeWorkspaceImages -> Rep DescribeWorkspaceImages x

to :: Rep DescribeWorkspaceImages x -> DescribeWorkspaceImages

Read DescribeWorkspaceImages

Defined in Amazonka.WorkSpaces.DescribeWorkspaceImages

Methods

readsPrec :: Int -> ReadS DescribeWorkspaceImages

readList :: ReadS [DescribeWorkspaceImages]

readPrec :: ReadPrec DescribeWorkspaceImages

readListPrec :: ReadPrec [DescribeWorkspaceImages]

Show DescribeWorkspaceImages

Defined in Amazonka.WorkSpaces.DescribeWorkspaceImages

Methods

showsPrec :: Int -> DescribeWorkspaceImages -> ShowS

show :: DescribeWorkspaceImages -> String

showList :: [DescribeWorkspaceImages] -> ShowS

NFData DescribeWorkspaceImages

Defined in Amazonka.WorkSpaces.DescribeWorkspaceImages

Methods

rnf :: DescribeWorkspaceImages -> ()

Eq DescribeWorkspaceImages

Defined in Amazonka.WorkSpaces.DescribeWorkspaceImages

Methods

(==) :: DescribeWorkspaceImages -> DescribeWorkspaceImages -> Bool

(/=) :: DescribeWorkspaceImages -> DescribeWorkspaceImages -> Bool

Hashable DescribeWorkspaceImages

Defined in Amazonka.WorkSpaces.DescribeWorkspaceImages

Methods

hashWithSalt :: Int -> DescribeWorkspaceImages -> Int

hash :: DescribeWorkspaceImages -> Int

type AWSResponse DescribeWorkspaceImages

Defined in Amazonka.WorkSpaces.DescribeWorkspaceImages

type AWSResponse DescribeWorkspaceImages = DescribeWorkspaceImagesResponse

type Rep DescribeWorkspaceImages

Defined in Amazonka.WorkSpaces.DescribeWorkspaceImages

type Rep DescribeWorkspaceImages = D1 ('MetaData "DescribeWorkspaceImages" "Amazonka.WorkSpaces.DescribeWorkspaceImages" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "DescribeWorkspaceImages'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "imageIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "imageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImageType))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeWorkspaceImages :: DescribeWorkspaceImages

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:imageType:DescribeWorkspaceImages', describeWorkspaceImages_imageType - The type (owned or shared) of the image.

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

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.

Request Lenses

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

The identifier of the image.

describeWorkspaceImages_imageType :: Lens' DescribeWorkspaceImages (Maybe ImageType)

The type (owned or shared) of the image.

describeWorkspaceImages_maxResults :: Lens' DescribeWorkspaceImages (Maybe Natural)

The maximum number of items to return.

describeWorkspaceImages_nextToken :: Lens' DescribeWorkspaceImages (Maybe Text)

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

Destructuring the Response

data DescribeWorkspaceImagesResponse

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

Generic DescribeWorkspaceImagesResponse

Defined in Amazonka.WorkSpaces.DescribeWorkspaceImages

Associated Types

type Rep DescribeWorkspaceImagesResponse :: Type -> Type

Methods

from :: DescribeWorkspaceImagesResponse -> Rep DescribeWorkspaceImagesResponse x

to :: Rep DescribeWorkspaceImagesResponse x -> DescribeWorkspaceImagesResponse

Read DescribeWorkspaceImagesResponse

Defined in Amazonka.WorkSpaces.DescribeWorkspaceImages

Methods

readsPrec :: Int -> ReadS DescribeWorkspaceImagesResponse

readList :: ReadS [DescribeWorkspaceImagesResponse]

readPrec :: ReadPrec DescribeWorkspaceImagesResponse

readListPrec :: ReadPrec [DescribeWorkspaceImagesResponse]

Show DescribeWorkspaceImagesResponse

Defined in Amazonka.WorkSpaces.DescribeWorkspaceImages

Methods

showsPrec :: Int -> DescribeWorkspaceImagesResponse -> ShowS

show :: DescribeWorkspaceImagesResponse -> String

showList :: [DescribeWorkspaceImagesResponse] -> ShowS

NFData DescribeWorkspaceImagesResponse

Defined in Amazonka.WorkSpaces.DescribeWorkspaceImages

Methods

rnf :: DescribeWorkspaceImagesResponse -> ()

Eq DescribeWorkspaceImagesResponse

Defined in Amazonka.WorkSpaces.DescribeWorkspaceImages

Methods

(==) :: DescribeWorkspaceImagesResponse -> DescribeWorkspaceImagesResponse -> Bool

(/=) :: DescribeWorkspaceImagesResponse -> DescribeWorkspaceImagesResponse -> Bool

type Rep DescribeWorkspaceImagesResponse

Defined in Amazonka.WorkSpaces.DescribeWorkspaceImages

type Rep DescribeWorkspaceImagesResponse = D1 ('MetaData "DescribeWorkspaceImagesResponse" "Amazonka.WorkSpaces.DescribeWorkspaceImages" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" '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

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.

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])

Information about the images.

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

describeWorkspaceImagesResponse_httpStatus :: Lens' DescribeWorkspaceImagesResponse Int

The response's http status code.