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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a list that describes the available WorkSpace bundles.

You can filter the results using either bundle ID or owner, but not both.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeWorkspaceBundles Source #

See: newDescribeWorkspaceBundles smart constructor.

Constructors

DescribeWorkspaceBundles'

Fields

bundleIds :: Maybe (NonEmpty Text)
The identifiers of the bundles. You cannot combine this parameter with any other filter.
owner :: Maybe Text
The owner of the bundles. You cannot combine this parameter with any other filter.
To describe the bundles provided by Amazon Web Services, specify AMAZON. To describe the bundles that belong to your account, don't specify a value.
nextToken :: Maybe Text
The token for the next set of results. (You received this token from a previous call.)

Instances

Instances details

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

newDescribeWorkspaceBundles :: DescribeWorkspaceBundles Source #

Create a value of DescribeWorkspaceBundles 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:bundleIds:DescribeWorkspaceBundles', describeWorkspaceBundles_bundleIds - The identifiers of the bundles. You cannot combine this parameter with any other filter.

$sel:owner:DescribeWorkspaceBundles', describeWorkspaceBundles_owner - The owner of the bundles. You cannot combine this parameter with any other filter.

To describe the bundles provided by Amazon Web Services, specify AMAZON. To describe the bundles that belong to your account, don't specify a value.

$sel:nextToken:DescribeWorkspaceBundles', describeWorkspaceBundles_nextToken - The token for the next set of results. (You received this token from a previous call.)

Request Lenses

describeWorkspaceBundles_bundleIds :: Lens' DescribeWorkspaceBundles (Maybe (NonEmpty Text)) Source #

The identifiers of the bundles. You cannot combine this parameter with any other filter.

describeWorkspaceBundles_owner :: Lens' DescribeWorkspaceBundles (Maybe Text) Source #

The owner of the bundles. You cannot combine this parameter with any other filter.

To describe the bundles provided by Amazon Web Services, specify AMAZON. To describe the bundles that belong to your account, don't specify a value.

describeWorkspaceBundles_nextToken :: Lens' DescribeWorkspaceBundles (Maybe Text) Source #

The token for the next set of results. (You received this token from a previous call.)

Destructuring the Response

data DescribeWorkspaceBundlesResponse Source #

See: newDescribeWorkspaceBundlesResponse smart constructor.

Constructors

DescribeWorkspaceBundlesResponse'
Fields bundles :: Maybe [WorkspaceBundle] Information about the bundles. 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. This token is valid for one day and must be used within that time frame. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeWorkspaceBundlesResponse Source #

Arguments

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

Create a value of DescribeWorkspaceBundlesResponse 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:bundles:DescribeWorkspaceBundlesResponse', describeWorkspaceBundlesResponse_bundles - Information about the bundles.

$sel:nextToken:DescribeWorkspaceBundles', describeWorkspaceBundlesResponse_nextToken - The token to use to retrieve the next page of results. This value is null when there are no more results to return. This token is valid for one day and must be used within that time frame.

$sel:httpStatus:DescribeWorkspaceBundlesResponse', describeWorkspaceBundlesResponse_httpStatus - The response's http status code.

Response Lenses

describeWorkspaceBundlesResponse_bundles :: Lens' DescribeWorkspaceBundlesResponse (Maybe [WorkspaceBundle]) Source #

Information about the bundles.

describeWorkspaceBundlesResponse_nextToken :: Lens' DescribeWorkspaceBundlesResponse (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. This token is valid for one day and must be used within that time frame.

describeWorkspaceBundlesResponse_httpStatus :: Lens' DescribeWorkspaceBundlesResponse Int Source #

The response's http status code.