amazonka-workspaces-1.4.5: Amazon WorkSpaces SDK.

Copyright(c) 2013-2016 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.

Synopsis

Creating a Request

describeWorkspaceBundles :: DescribeWorkspaceBundles #

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:

  • dwbBundleIds - An array of strings that contains the identifiers of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.
  • dwbOwner - 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 - The NextToken value from a previous call to this operation. Pass null if this is the first call.

data DescribeWorkspaceBundles #

Contains the inputs for the DescribeWorkspaceBundles operation.

See: describeWorkspaceBundles smart constructor.

Instances

Eq DescribeWorkspaceBundles # 
Data DescribeWorkspaceBundles # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeWorkspaceBundles -> c DescribeWorkspaceBundles #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeWorkspaceBundles #

toConstr :: DescribeWorkspaceBundles -> Constr #

dataTypeOf :: DescribeWorkspaceBundles -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeWorkspaceBundles) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeWorkspaceBundles) #

gmapT :: (forall b. Data b => b -> b) -> DescribeWorkspaceBundles -> DescribeWorkspaceBundles #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeWorkspaceBundles -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeWorkspaceBundles -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeWorkspaceBundles -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeWorkspaceBundles -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeWorkspaceBundles -> m DescribeWorkspaceBundles #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeWorkspaceBundles -> m DescribeWorkspaceBundles #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeWorkspaceBundles -> m DescribeWorkspaceBundles #

Read DescribeWorkspaceBundles # 
Show DescribeWorkspaceBundles # 
Generic DescribeWorkspaceBundles # 
Hashable DescribeWorkspaceBundles # 
ToJSON DescribeWorkspaceBundles # 
NFData DescribeWorkspaceBundles # 
AWSRequest DescribeWorkspaceBundles # 
ToQuery DescribeWorkspaceBundles # 
ToPath DescribeWorkspaceBundles # 
ToHeaders DescribeWorkspaceBundles # 
type Rep DescribeWorkspaceBundles # 
type Rep DescribeWorkspaceBundles = D1 (MetaData "DescribeWorkspaceBundles" "Network.AWS.WorkSpaces.DescribeWorkspaceBundles" "amazonka-workspaces-1.4.5-3ohyArvn0vQ6jMfbHLtMmt" False) (C1 (MetaCons "DescribeWorkspaceBundles'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dwbBundleIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (List1 Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_dwbOwner") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dwbNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Rs DescribeWorkspaceBundles # 

Request Lenses

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

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

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

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

Destructuring the Response

describeWorkspaceBundlesResponse #

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:

  • dwbrsBundles - An array of structures that contain information about the bundles.
  • dwbrsNextToken - 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 time frame.
  • dwbrsResponseStatus - -- | The response status code.

data DescribeWorkspaceBundlesResponse #

Contains the results of the DescribeWorkspaceBundles operation.

See: describeWorkspaceBundlesResponse smart constructor.

Instances

Eq DescribeWorkspaceBundlesResponse # 
Data DescribeWorkspaceBundlesResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeWorkspaceBundlesResponse -> c DescribeWorkspaceBundlesResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeWorkspaceBundlesResponse #

toConstr :: DescribeWorkspaceBundlesResponse -> Constr #

dataTypeOf :: DescribeWorkspaceBundlesResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeWorkspaceBundlesResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeWorkspaceBundlesResponse) #

gmapT :: (forall b. Data b => b -> b) -> DescribeWorkspaceBundlesResponse -> DescribeWorkspaceBundlesResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeWorkspaceBundlesResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeWorkspaceBundlesResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeWorkspaceBundlesResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeWorkspaceBundlesResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeWorkspaceBundlesResponse -> m DescribeWorkspaceBundlesResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeWorkspaceBundlesResponse -> m DescribeWorkspaceBundlesResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeWorkspaceBundlesResponse -> m DescribeWorkspaceBundlesResponse #

Read DescribeWorkspaceBundlesResponse # 
Show DescribeWorkspaceBundlesResponse # 
Generic DescribeWorkspaceBundlesResponse # 
NFData DescribeWorkspaceBundlesResponse # 
type Rep DescribeWorkspaceBundlesResponse # 
type Rep DescribeWorkspaceBundlesResponse = D1 (MetaData "DescribeWorkspaceBundlesResponse" "Network.AWS.WorkSpaces.DescribeWorkspaceBundles" "amazonka-workspaces-1.4.5-3ohyArvn0vQ6jMfbHLtMmt" False) (C1 (MetaCons "DescribeWorkspaceBundlesResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dwbrsBundles") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [WorkspaceBundle]))) ((:*:) (S1 (MetaSel (Just Symbol "_dwbrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dwbrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

dwbrsBundles :: Lens' DescribeWorkspaceBundlesResponse [WorkspaceBundle] #

An array of structures that contain information about the bundles.

dwbrsNextToken :: Lens' DescribeWorkspaceBundlesResponse (Maybe Text) #

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 time frame.