amazonka-opsworks-2.0: Amazon OpsWorks SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.OpsWorks.DescribeVolumes

Description

Describes an instance's Amazon EBS volumes.

This call accepts only one resource-identifying parameter.

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 about user permissions, see Managing User Permissions.

Synopsis

Creating a Request

data DescribeVolumes Source #

See: newDescribeVolumes smart constructor.

Constructors

DescribeVolumes' 

Fields

  • instanceId :: Maybe Text

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

  • raidArrayId :: Maybe Text

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

  • stackId :: Maybe Text

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

  • volumeIds :: Maybe [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.

Instances

Instances details
ToJSON DescribeVolumes Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Methods

toJSON :: DescribeVolumes -> Value #

toEncoding :: DescribeVolumes -> Encoding #

toJSONList :: [DescribeVolumes] -> Value #

toEncodingList :: [DescribeVolumes] -> Encoding #

ToHeaders DescribeVolumes Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Methods

toHeaders :: DescribeVolumes -> [Header] #

ToPath DescribeVolumes Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Methods

toPath :: DescribeVolumes -> ByteString #

ToQuery DescribeVolumes Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Methods

toQuery :: DescribeVolumes -> QueryString #

AWSRequest DescribeVolumes Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Associated Types

type AWSResponse DescribeVolumes #

Methods

request :: (Service -> Service) -> DescribeVolumes -> Request DescribeVolumes #

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

Generic DescribeVolumes Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Associated Types

type Rep DescribeVolumes :: Type -> Type #

Methods

from :: DescribeVolumes -> Rep DescribeVolumes x #

to :: Rep DescribeVolumes x -> DescribeVolumes #

Read DescribeVolumes Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Methods

readsPrec :: Int -> ReadS DescribeVolumes #

readList :: ReadS [DescribeVolumes] #

readPrec :: ReadPrec DescribeVolumes #

readListPrec :: ReadPrec [DescribeVolumes] #

Show DescribeVolumes Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Methods

showsPrec :: Int -> DescribeVolumes -> ShowS #

show :: DescribeVolumes -> String #

showList :: [DescribeVolumes] -> ShowS #

NFData DescribeVolumes Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Methods

rnf :: DescribeVolumes -> () #

Eq DescribeVolumes Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Methods

(==) :: DescribeVolumes -> DescribeVolumes -> Bool #

(/=) :: DescribeVolumes -> DescribeVolumes -> Bool #

Hashable DescribeVolumes Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Methods

hashWithSalt :: Int -> DescribeVolumes -> Int #

hash :: DescribeVolumes -> Int #

type AWSResponse DescribeVolumes Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

type AWSResponse DescribeVolumes = DescribeVolumesResponse
type Rep DescribeVolumes Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

type Rep DescribeVolumes = D1 ('MetaData "DescribeVolumes" "Amazonka.OpsWorks.DescribeVolumes" "amazonka-opsworks-2.0-7XrzSD2vbuN9lVUGWMVZ7S" 'False) (C1 ('MetaCons "DescribeVolumes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "raidArrayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "stackId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "volumeIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))

newDescribeVolumes :: DescribeVolumes Source #

Create a value of DescribeVolumes 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:

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

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

DescribeVolumes, describeVolumes_stackId - A stack ID. The action describes the stack's registered Amazon EBS volumes.

$sel:volumeIds:DescribeVolumes', describeVolumes_volumeIds - 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.

Request Lenses

describeVolumes_instanceId :: Lens' DescribeVolumes (Maybe Text) Source #

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

describeVolumes_raidArrayId :: Lens' DescribeVolumes (Maybe Text) Source #

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

describeVolumes_stackId :: Lens' DescribeVolumes (Maybe Text) Source #

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

describeVolumes_volumeIds :: Lens' DescribeVolumes (Maybe [Text]) Source #

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.

Destructuring the Response

data DescribeVolumesResponse Source #

Contains the response to a DescribeVolumes request.

See: newDescribeVolumesResponse smart constructor.

Constructors

DescribeVolumesResponse' 

Fields

Instances

Instances details
Generic DescribeVolumesResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Associated Types

type Rep DescribeVolumesResponse :: Type -> Type #

Methods

from :: DescribeVolumesResponse -> Rep DescribeVolumesResponse x #

to :: Rep DescribeVolumesResponse x -> DescribeVolumesResponse #

Read DescribeVolumesResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Methods

readsPrec :: Int -> ReadS DescribeVolumesResponse #

readList :: ReadS [DescribeVolumesResponse] #

readPrec :: ReadPrec DescribeVolumesResponse #

readListPrec :: ReadPrec [DescribeVolumesResponse] #

Show DescribeVolumesResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Methods

showsPrec :: Int -> DescribeVolumesResponse -> ShowS #

show :: DescribeVolumesResponse -> String #

showList :: [DescribeVolumesResponse] -> ShowS #

NFData DescribeVolumesResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Methods

rnf :: DescribeVolumesResponse -> () #

Eq DescribeVolumesResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Methods

(==) :: DescribeVolumesResponse -> DescribeVolumesResponse -> Bool #

(/=) :: DescribeVolumesResponse -> DescribeVolumesResponse -> Bool #

type Rep DescribeVolumesResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

type Rep DescribeVolumesResponse = D1 ('MetaData "DescribeVolumesResponse" "Amazonka.OpsWorks.DescribeVolumes" "amazonka-opsworks-2.0-7XrzSD2vbuN9lVUGWMVZ7S" 'False) (C1 ('MetaCons "DescribeVolumesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "volumes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Volume])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeVolumesResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeVolumesResponse'

-> DescribeVolumesResponse 

Create a value of DescribeVolumesResponse 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:volumes:DescribeVolumesResponse', describeVolumesResponse_volumes - An array of volume IDs.

$sel:httpStatus:DescribeVolumesResponse', describeVolumesResponse_httpStatus - The response's http status code.

Response Lenses

describeVolumesResponse_volumes :: Lens' DescribeVolumesResponse (Maybe [Volume]) Source #

An array of volume IDs.

describeVolumesResponse_httpStatus :: Lens' DescribeVolumesResponse Int Source #

The response's http status code.