amazonka-workspaces-1.3.5: Amazon WorkSpaces SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.WorkSpaces.DescribeWorkspaceBundles

Contents

Description

Obtains information about the WorkSpace bundles that are available to your account in the specified region.

You can filter the results with either the BundleIds parameter, or the Owner parameter, but not both.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

See: AWS API Reference for DescribeWorkspaceBundles.

Synopsis

Creating a Request

describeWorkspaceBundles :: DescribeWorkspaceBundles Source

Creates a value of DescribeWorkspaceBundles with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Request Lenses

dwbBundleIds :: Lens' DescribeWorkspaceBundles (Maybe (NonEmpty Text)) Source

An array of strings that contains the identifiers of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.

dwbOwner :: Lens' DescribeWorkspaceBundles (Maybe Text) Source

The owner of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.

This contains one of the following values:

  • null - Retrieves the bundles that belong to the account making the call.
  • AMAZON - Retrieves the bundles that are provided by AWS.

dwbNextToken :: Lens' DescribeWorkspaceBundles (Maybe Text) Source

The NextToken value from a previous call to this operation. Pass null if this is the first call.

Destructuring the Response

describeWorkspaceBundlesResponse Source

Creates a value of DescribeWorkspaceBundlesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Response Lenses

dwbrsBundles :: Lens' DescribeWorkspaceBundlesResponse [WorkspaceBundle] Source

An array of structures that contain information about the bundles.

dwbrsNextToken :: Lens' DescribeWorkspaceBundlesResponse (Maybe Text) Source

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to this operation to retrieve the next set of items. This token is valid for one day and must be used within that timeframe.