amazonka-opsworks-1.4.5: Amazon OpsWorks 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.OpsWorks.DescribeVolumes

Contents

Description

Describes an instance's Amazon EBS volumes.

Required Permissions : To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .

Synopsis

Creating a Request

describeVolumes :: DescribeVolumes #

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

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

  • dvInstanceId - The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified instance.
  • dvVolumeIds - Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.
  • dvRAIdArrayId - The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified RAID array.
  • dvStackId - A stack ID. The action describes the stack's registered Amazon EBS volumes.

data DescribeVolumes #

See: describeVolumes smart constructor.

Instances

Eq DescribeVolumes # 
Data DescribeVolumes # 

Methods

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

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

toConstr :: DescribeVolumes -> Constr #

dataTypeOf :: DescribeVolumes -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeVolumes # 
Show DescribeVolumes # 
Generic DescribeVolumes # 
Hashable DescribeVolumes # 
ToJSON DescribeVolumes # 
NFData DescribeVolumes # 

Methods

rnf :: DescribeVolumes -> () #

AWSRequest DescribeVolumes # 
ToQuery DescribeVolumes # 
ToPath DescribeVolumes # 
ToHeaders DescribeVolumes # 
type Rep DescribeVolumes # 
type Rep DescribeVolumes = D1 (MetaData "DescribeVolumes" "Network.AWS.OpsWorks.DescribeVolumes" "amazonka-opsworks-1.4.5-JiFrWEFhyqOE1ZKfkjkheh" False) (C1 (MetaCons "DescribeVolumes'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dvInstanceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dvVolumeIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) ((:*:) (S1 (MetaSel (Just Symbol "_dvRAIdArrayId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dvStackId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Rs DescribeVolumes # 

Request Lenses

dvInstanceId :: Lens' DescribeVolumes (Maybe Text) #

The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified instance.

dvVolumeIds :: Lens' DescribeVolumes [Text] #

Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.

dvRAIdArrayId :: Lens' DescribeVolumes (Maybe Text) #

The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified RAID array.

dvStackId :: Lens' DescribeVolumes (Maybe Text) #

A stack ID. The action describes the stack's registered Amazon EBS volumes.

Destructuring the Response

describeVolumesResponse #

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

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

data DescribeVolumesResponse #

Contains the response to a DescribeVolumes request.

See: describeVolumesResponse smart constructor.

Instances

Eq DescribeVolumesResponse # 
Data DescribeVolumesResponse # 

Methods

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

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

toConstr :: DescribeVolumesResponse -> Constr #

dataTypeOf :: DescribeVolumesResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeVolumesResponse # 
Show DescribeVolumesResponse # 
Generic DescribeVolumesResponse # 
NFData DescribeVolumesResponse # 

Methods

rnf :: DescribeVolumesResponse -> () #

type Rep DescribeVolumesResponse # 
type Rep DescribeVolumesResponse = D1 (MetaData "DescribeVolumesResponse" "Network.AWS.OpsWorks.DescribeVolumes" "amazonka-opsworks-1.4.5-JiFrWEFhyqOE1ZKfkjkheh" False) (C1 (MetaCons "DescribeVolumesResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dvrsVolumes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Volume]))) (S1 (MetaSel (Just Symbol "_dvrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

dvrsVolumes :: Lens' DescribeVolumesResponse [Volume] #

An array of volume IDs.

dvrsResponseStatus :: Lens' DescribeVolumesResponse Int #

  • - | The response status code.