amazonka-ec2-2.0: Amazon Elastic Compute Cloud 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.EC2.DescribeVolumesModifications

Description

Describes the most recent volume modification request for the specified EBS volumes.

If a volume has never been modified, some information in the output will be null. If a volume has been modified more than once, the output includes only the most recent modification request.

You can also use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see Monitor the progress of volume modifications in the Amazon Elastic Compute Cloud User Guide.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeVolumesModifications Source #

See: newDescribeVolumesModifications smart constructor.

Constructors

DescribeVolumesModifications' 

Fields

  • dryRun :: Maybe Bool

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • filters :: Maybe [Filter]

    The filters.

    • modification-state - The current modification state (modifying | optimizing | completed | failed).
    • original-iops - The original IOPS rate of the volume.
    • original-size - The original size of the volume, in GiB.
    • original-volume-type - The original volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).
    • originalMultiAttachEnabled - Indicates whether Multi-Attach support was enabled (true | false).
    • start-time - The modification start time.
    • target-iops - The target IOPS rate of the volume.
    • target-size - The target size of the volume, in GiB.
    • target-volume-type - The target volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).
    • targetMultiAttachEnabled - Indicates whether Multi-Attach support is to be enabled (true | false).
    • volume-id - The ID of the volume.
  • maxResults :: Maybe Int

    The maximum number of results (up to a limit of 500) to be returned in a paginated request.

  • nextToken :: Maybe Text

    The nextToken value returned by a previous paginated request.

  • volumeIds :: Maybe [Text]

    The IDs of the volumes.

Instances

Instances details
ToHeaders DescribeVolumesModifications Source # 
Instance details

Defined in Amazonka.EC2.DescribeVolumesModifications

Methods

toHeaders :: DescribeVolumesModifications -> [Header] #

ToPath DescribeVolumesModifications Source # 
Instance details

Defined in Amazonka.EC2.DescribeVolumesModifications

Methods

toPath :: DescribeVolumesModifications -> ByteString #

ToQuery DescribeVolumesModifications Source # 
Instance details

Defined in Amazonka.EC2.DescribeVolumesModifications

Methods

toQuery :: DescribeVolumesModifications -> QueryString #

AWSPager DescribeVolumesModifications Source # 
Instance details

Defined in Amazonka.EC2.DescribeVolumesModifications

Methods

page :: DescribeVolumesModifications -> AWSResponse DescribeVolumesModifications -> Maybe DescribeVolumesModifications #

AWSRequest DescribeVolumesModifications Source # 
Instance details

Defined in Amazonka.EC2.DescribeVolumesModifications

Associated Types

type AWSResponse DescribeVolumesModifications #

Methods

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

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

Generic DescribeVolumesModifications Source # 
Instance details

Defined in Amazonka.EC2.DescribeVolumesModifications

Associated Types

type Rep DescribeVolumesModifications :: Type -> Type #

Methods

from :: DescribeVolumesModifications -> Rep DescribeVolumesModifications x #

to :: Rep DescribeVolumesModifications x -> DescribeVolumesModifications #

Read DescribeVolumesModifications Source # 
Instance details

Defined in Amazonka.EC2.DescribeVolumesModifications

Methods

readsPrec :: Int -> ReadS DescribeVolumesModifications #

readList :: ReadS [DescribeVolumesModifications] #

readPrec :: ReadPrec DescribeVolumesModifications #

readListPrec :: ReadPrec [DescribeVolumesModifications] #

Show DescribeVolumesModifications Source # 
Instance details

Defined in Amazonka.EC2.DescribeVolumesModifications

Methods

showsPrec :: Int -> DescribeVolumesModifications -> ShowS #

show :: DescribeVolumesModifications -> String #

showList :: [DescribeVolumesModifications] -> ShowS #

NFData DescribeVolumesModifications Source # 
Instance details

Defined in Amazonka.EC2.DescribeVolumesModifications

Methods

rnf :: DescribeVolumesModifications -> () #

Eq DescribeVolumesModifications Source # 
Instance details

Defined in Amazonka.EC2.DescribeVolumesModifications

Methods

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

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

Hashable DescribeVolumesModifications Source # 
Instance details

Defined in Amazonka.EC2.DescribeVolumesModifications

Methods

hashWithSalt :: Int -> DescribeVolumesModifications -> Int #

hash :: DescribeVolumesModifications -> Int #

type AWSResponse DescribeVolumesModifications Source # 
Instance details

Defined in Amazonka.EC2.DescribeVolumesModifications

type AWSResponse DescribeVolumesModifications = DescribeVolumesModificationsResponse
type Rep DescribeVolumesModifications Source # 
Instance details

Defined in Amazonka.EC2.DescribeVolumesModifications

type Rep DescribeVolumesModifications = D1 ('MetaData "DescribeVolumesModifications" "Amazonka.EC2.DescribeVolumesModifications" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeVolumesModifications'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "volumeIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newDescribeVolumesModifications :: DescribeVolumesModifications Source #

Create a value of DescribeVolumesModifications 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:dryRun:DescribeVolumesModifications', describeVolumesModifications_dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

$sel:filters:DescribeVolumesModifications', describeVolumesModifications_filters - The filters.

  • modification-state - The current modification state (modifying | optimizing | completed | failed).
  • original-iops - The original IOPS rate of the volume.
  • original-size - The original size of the volume, in GiB.
  • original-volume-type - The original volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).
  • originalMultiAttachEnabled - Indicates whether Multi-Attach support was enabled (true | false).
  • start-time - The modification start time.
  • target-iops - The target IOPS rate of the volume.
  • target-size - The target size of the volume, in GiB.
  • target-volume-type - The target volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).
  • targetMultiAttachEnabled - Indicates whether Multi-Attach support is to be enabled (true | false).
  • volume-id - The ID of the volume.

$sel:maxResults:DescribeVolumesModifications', describeVolumesModifications_maxResults - The maximum number of results (up to a limit of 500) to be returned in a paginated request.

DescribeVolumesModifications, describeVolumesModifications_nextToken - The nextToken value returned by a previous paginated request.

$sel:volumeIds:DescribeVolumesModifications', describeVolumesModifications_volumeIds - The IDs of the volumes.

Request Lenses

describeVolumesModifications_dryRun :: Lens' DescribeVolumesModifications (Maybe Bool) Source #

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

describeVolumesModifications_filters :: Lens' DescribeVolumesModifications (Maybe [Filter]) Source #

The filters.

  • modification-state - The current modification state (modifying | optimizing | completed | failed).
  • original-iops - The original IOPS rate of the volume.
  • original-size - The original size of the volume, in GiB.
  • original-volume-type - The original volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).
  • originalMultiAttachEnabled - Indicates whether Multi-Attach support was enabled (true | false).
  • start-time - The modification start time.
  • target-iops - The target IOPS rate of the volume.
  • target-size - The target size of the volume, in GiB.
  • target-volume-type - The target volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).
  • targetMultiAttachEnabled - Indicates whether Multi-Attach support is to be enabled (true | false).
  • volume-id - The ID of the volume.

describeVolumesModifications_maxResults :: Lens' DescribeVolumesModifications (Maybe Int) Source #

The maximum number of results (up to a limit of 500) to be returned in a paginated request.

describeVolumesModifications_nextToken :: Lens' DescribeVolumesModifications (Maybe Text) Source #

The nextToken value returned by a previous paginated request.

describeVolumesModifications_volumeIds :: Lens' DescribeVolumesModifications (Maybe [Text]) Source #

The IDs of the volumes.

Destructuring the Response

data DescribeVolumesModificationsResponse Source #

See: newDescribeVolumesModificationsResponse smart constructor.

Constructors

DescribeVolumesModificationsResponse' 

Fields

Instances

Instances details
Generic DescribeVolumesModificationsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVolumesModifications

Associated Types

type Rep DescribeVolumesModificationsResponse :: Type -> Type #

Methods

from :: DescribeVolumesModificationsResponse -> Rep DescribeVolumesModificationsResponse x #

to :: Rep DescribeVolumesModificationsResponse x -> DescribeVolumesModificationsResponse #

Read DescribeVolumesModificationsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVolumesModifications

Methods

readsPrec :: Int -> ReadS DescribeVolumesModificationsResponse #

readList :: ReadS [DescribeVolumesModificationsResponse] #

readPrec :: ReadPrec DescribeVolumesModificationsResponse #

readListPrec :: ReadPrec [DescribeVolumesModificationsResponse] #

Show DescribeVolumesModificationsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVolumesModifications

Methods

showsPrec :: Int -> DescribeVolumesModificationsResponse -> ShowS #

show :: DescribeVolumesModificationsResponse -> String #

showList :: [DescribeVolumesModificationsResponse] -> ShowS #

NFData DescribeVolumesModificationsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVolumesModifications

Methods

rnf :: DescribeVolumesModificationsResponse -> () #

Eq DescribeVolumesModificationsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVolumesModifications

Methods

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

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

type Rep DescribeVolumesModificationsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVolumesModifications

type Rep DescribeVolumesModificationsResponse = D1 ('MetaData "DescribeVolumesModificationsResponse" "Amazonka.EC2.DescribeVolumesModifications" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeVolumesModificationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "volumesModifications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VolumeModification])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeVolumesModificationsResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeVolumesModificationsResponse'

-> DescribeVolumesModificationsResponse 

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

DescribeVolumesModifications, describeVolumesModificationsResponse_nextToken - Token for pagination, null if there are no more results

$sel:volumesModifications:DescribeVolumesModificationsResponse', describeVolumesModificationsResponse_volumesModifications - Information about the volume modifications.

$sel:httpStatus:DescribeVolumesModificationsResponse', describeVolumesModificationsResponse_httpStatus - The response's http status code.

Response Lenses

describeVolumesModificationsResponse_nextToken :: Lens' DescribeVolumesModificationsResponse (Maybe Text) Source #

Token for pagination, null if there are no more results

describeVolumesModificationsResponse_volumesModifications :: Lens' DescribeVolumesModificationsResponse (Maybe [VolumeModification]) Source #

Information about the volume modifications.

describeVolumesModificationsResponse_httpStatus :: Lens' DescribeVolumesModificationsResponse Int Source #

The response's http status code.