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

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.

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

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

Instances

Instances details
Eq DescribeVolumes Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Read DescribeVolumes Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Show DescribeVolumes Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Generic DescribeVolumes Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Associated Types

type Rep DescribeVolumes :: Type -> Type #

NFData DescribeVolumes Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Methods

rnf :: DescribeVolumes -> () #

Hashable DescribeVolumes Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

ToJSON DescribeVolumes Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

AWSRequest DescribeVolumes Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Associated Types

type AWSResponse DescribeVolumes #

ToHeaders DescribeVolumes Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

ToPath DescribeVolumes Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

ToQuery DescribeVolumes Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

type Rep DescribeVolumes Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

type Rep DescribeVolumes = D1 ('MetaData "DescribeVolumes" "Amazonka.OpsWorks.DescribeVolumes" "libZSservicesZSamazonka-opsworksZSamazonka-opsworks" 'False) (C1 ('MetaCons "DescribeVolumes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "volumeIds") '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)))))
type AWSResponse DescribeVolumes Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

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:

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

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

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

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

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

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.

Destructuring the Response

data DescribeVolumesResponse Source #

Contains the response to a DescribeVolumes request.

See: newDescribeVolumesResponse smart constructor.

Constructors

DescribeVolumesResponse' 

Fields

Instances

Instances details
Eq DescribeVolumesResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Read DescribeVolumesResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Show DescribeVolumesResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Generic DescribeVolumesResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Associated Types

type Rep DescribeVolumesResponse :: Type -> Type #

NFData DescribeVolumesResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

Methods

rnf :: DescribeVolumesResponse -> () #

type Rep DescribeVolumesResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeVolumes

type Rep DescribeVolumesResponse = D1 ('MetaData "DescribeVolumesResponse" "Amazonka.OpsWorks.DescribeVolumes" "libZSservicesZSamazonka-opsworksZSamazonka-opsworks" '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 #

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