Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ComputeOptimizer.GetEBSVolumeRecommendations

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.

Compute Optimizer generates recommendations for Amazon EBS volumes that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.

Synopsis

Creating a Request

data GetEBSVolumeRecommendations Source #

See: newGetEBSVolumeRecommendations smart constructor.

Constructors

GetEBSVolumeRecommendations'

Fields

accountIds :: Maybe [Text]
The ID of the Amazon Web Services account for which to return volume recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return volume recommendations.
Only one account ID can be specified per request.
filters :: Maybe [EBSFilter]
An array of objects to specify a filter that returns a more specific list of volume recommendations.
nextToken :: Maybe Text
The token to advance to the next page of volume recommendations.
volumeArns :: Maybe [Text]
The Amazon Resource Name (ARN) of the volumes for which to return recommendations.
maxResults :: Maybe Int
The maximum number of volume recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned nextToken value.

Instances

Instances details

Eq GetEBSVolumeRecommendations Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEBSVolumeRecommendations Methods (==) :: GetEBSVolumeRecommendations -> GetEBSVolumeRecommendations -> Bool # (/=) :: GetEBSVolumeRecommendations -> GetEBSVolumeRecommendations -> Bool #
Read GetEBSVolumeRecommendations Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEBSVolumeRecommendations Methods readsPrec :: Int -> ReadS GetEBSVolumeRecommendations # readList :: ReadS [GetEBSVolumeRecommendations] # readPrec :: ReadPrec GetEBSVolumeRecommendations # readListPrec :: ReadPrec [GetEBSVolumeRecommendations] #
Show GetEBSVolumeRecommendations Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEBSVolumeRecommendations Methods showsPrec :: Int -> GetEBSVolumeRecommendations -> ShowS # show :: GetEBSVolumeRecommendations -> String # showList :: [GetEBSVolumeRecommendations] -> ShowS #
Generic GetEBSVolumeRecommendations Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEBSVolumeRecommendations Associated Types type Rep GetEBSVolumeRecommendations :: Type -> Type # Methods from :: GetEBSVolumeRecommendations -> Rep GetEBSVolumeRecommendations x # to :: Rep GetEBSVolumeRecommendations x -> GetEBSVolumeRecommendations #
NFData GetEBSVolumeRecommendations Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEBSVolumeRecommendations Methods rnf :: GetEBSVolumeRecommendations -> () #
Hashable GetEBSVolumeRecommendations Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEBSVolumeRecommendations Methods hashWithSalt :: Int -> GetEBSVolumeRecommendations -> Int # hash :: GetEBSVolumeRecommendations -> Int #
ToJSON GetEBSVolumeRecommendations Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEBSVolumeRecommendations Methods toJSON :: GetEBSVolumeRecommendations -> Value # toEncoding :: GetEBSVolumeRecommendations -> Encoding # toJSONList :: [GetEBSVolumeRecommendations] -> Value # toEncodingList :: [GetEBSVolumeRecommendations] -> Encoding #
AWSRequest GetEBSVolumeRecommendations Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEBSVolumeRecommendations Associated Types type AWSResponse GetEBSVolumeRecommendations # Methods request :: GetEBSVolumeRecommendations -> Request GetEBSVolumeRecommendations # response :: MonadResource m => Logger -> Service -> Proxy GetEBSVolumeRecommendations -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetEBSVolumeRecommendations))) #
ToHeaders GetEBSVolumeRecommendations Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEBSVolumeRecommendations Methods toHeaders :: GetEBSVolumeRecommendations -> [Header] #
ToPath GetEBSVolumeRecommendations Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEBSVolumeRecommendations Methods toPath :: GetEBSVolumeRecommendations -> ByteString #
ToQuery GetEBSVolumeRecommendations Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEBSVolumeRecommendations Methods toQuery :: GetEBSVolumeRecommendations -> QueryString #
type Rep GetEBSVolumeRecommendations Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEBSVolumeRecommendations type Rep GetEBSVolumeRecommendations = D1 ('MetaData "GetEBSVolumeRecommendations" "Amazonka.ComputeOptimizer.GetEBSVolumeRecommendations" "libZSservicesZSamazonka-compute-optimizerZSamazonka-compute-optimizer" 'False) (C1 ('MetaCons "GetEBSVolumeRecommendations'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accountIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EBSFilter]))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "volumeArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))
type AWSResponse GetEBSVolumeRecommendations Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEBSVolumeRecommendations type AWSResponse GetEBSVolumeRecommendations = GetEBSVolumeRecommendationsResponse

newGetEBSVolumeRecommendations :: GetEBSVolumeRecommendations Source #

Create a value of GetEBSVolumeRecommendations 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:accountIds:GetEBSVolumeRecommendations', getEBSVolumeRecommendations_accountIds - The ID of the Amazon Web Services account for which to return volume recommendations.

If your account is the management account of an organization, use this parameter to specify the member account for which you want to return volume recommendations.

Only one account ID can be specified per request.

$sel:filters:GetEBSVolumeRecommendations', getEBSVolumeRecommendations_filters - An array of objects to specify a filter that returns a more specific list of volume recommendations.

$sel:nextToken:GetEBSVolumeRecommendations', getEBSVolumeRecommendations_nextToken - The token to advance to the next page of volume recommendations.

$sel:volumeArns:GetEBSVolumeRecommendations', getEBSVolumeRecommendations_volumeArns - The Amazon Resource Name (ARN) of the volumes for which to return recommendations.

$sel:maxResults:GetEBSVolumeRecommendations', getEBSVolumeRecommendations_maxResults - The maximum number of volume recommendations to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

Request Lenses

getEBSVolumeRecommendations_accountIds :: Lens' GetEBSVolumeRecommendations (Maybe [Text]) Source #

The ID of the Amazon Web Services account for which to return volume recommendations.

If your account is the management account of an organization, use this parameter to specify the member account for which you want to return volume recommendations.

Only one account ID can be specified per request.

getEBSVolumeRecommendations_filters :: Lens' GetEBSVolumeRecommendations (Maybe [EBSFilter]) Source #

An array of objects to specify a filter that returns a more specific list of volume recommendations.

getEBSVolumeRecommendations_nextToken :: Lens' GetEBSVolumeRecommendations (Maybe Text) Source #

The token to advance to the next page of volume recommendations.

getEBSVolumeRecommendations_volumeArns :: Lens' GetEBSVolumeRecommendations (Maybe [Text]) Source #

The Amazon Resource Name (ARN) of the volumes for which to return recommendations.

getEBSVolumeRecommendations_maxResults :: Lens' GetEBSVolumeRecommendations (Maybe Int) Source #

The maximum number of volume recommendations to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

Destructuring the Response

data GetEBSVolumeRecommendationsResponse Source #

See: newGetEBSVolumeRecommendationsResponse smart constructor.

Constructors

GetEBSVolumeRecommendationsResponse'

Fields

nextToken :: Maybe Text
The token to use to advance to the next page of volume recommendations.
This value is null when there are no more pages of volume recommendations to return.
volumeRecommendations :: Maybe [VolumeRecommendation]
An array of objects that describe volume recommendations.
errors :: Maybe [GetRecommendationError]
An array of objects that describe errors of the request.
For example, an error is returned if you request recommendations for an unsupported volume.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq GetEBSVolumeRecommendationsResponse Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEBSVolumeRecommendations Methods (==) :: GetEBSVolumeRecommendationsResponse -> GetEBSVolumeRecommendationsResponse -> Bool # (/=) :: GetEBSVolumeRecommendationsResponse -> GetEBSVolumeRecommendationsResponse -> Bool #
Read GetEBSVolumeRecommendationsResponse Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEBSVolumeRecommendations Methods readsPrec :: Int -> ReadS GetEBSVolumeRecommendationsResponse # readList :: ReadS [GetEBSVolumeRecommendationsResponse] # readPrec :: ReadPrec GetEBSVolumeRecommendationsResponse # readListPrec :: ReadPrec [GetEBSVolumeRecommendationsResponse] #
Show GetEBSVolumeRecommendationsResponse Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEBSVolumeRecommendations Methods showsPrec :: Int -> GetEBSVolumeRecommendationsResponse -> ShowS # show :: GetEBSVolumeRecommendationsResponse -> String # showList :: [GetEBSVolumeRecommendationsResponse] -> ShowS #
Generic GetEBSVolumeRecommendationsResponse Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEBSVolumeRecommendations Associated Types type Rep GetEBSVolumeRecommendationsResponse :: Type -> Type # Methods from :: GetEBSVolumeRecommendationsResponse -> Rep GetEBSVolumeRecommendationsResponse x # to :: Rep GetEBSVolumeRecommendationsResponse x -> GetEBSVolumeRecommendationsResponse #
NFData GetEBSVolumeRecommendationsResponse Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEBSVolumeRecommendations Methods rnf :: GetEBSVolumeRecommendationsResponse -> () #
type Rep GetEBSVolumeRecommendationsResponse Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEBSVolumeRecommendations type Rep GetEBSVolumeRecommendationsResponse = D1 ('MetaData "GetEBSVolumeRecommendationsResponse" "Amazonka.ComputeOptimizer.GetEBSVolumeRecommendations" "libZSservicesZSamazonka-compute-optimizerZSamazonka-compute-optimizer" 'False) (C1 ('MetaCons "GetEBSVolumeRecommendationsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "volumeRecommendations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VolumeRecommendation]))) :: (S1 ('MetaSel ('Just "errors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GetRecommendationError])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetEBSVolumeRecommendationsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetEBSVolumeRecommendationsResponse'`
-> GetEBSVolumeRecommendationsResponse

Create a value of GetEBSVolumeRecommendationsResponse 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:nextToken:GetEBSVolumeRecommendations', getEBSVolumeRecommendationsResponse_nextToken - The token to use to advance to the next page of volume recommendations.

This value is null when there are no more pages of volume recommendations to return.

$sel:volumeRecommendations:GetEBSVolumeRecommendationsResponse', getEBSVolumeRecommendationsResponse_volumeRecommendations - An array of objects that describe volume recommendations.

$sel:errors:GetEBSVolumeRecommendationsResponse', getEBSVolumeRecommendationsResponse_errors - An array of objects that describe errors of the request.

For example, an error is returned if you request recommendations for an unsupported volume.

$sel:httpStatus:GetEBSVolumeRecommendationsResponse', getEBSVolumeRecommendationsResponse_httpStatus - The response's http status code.

Response Lenses

getEBSVolumeRecommendationsResponse_nextToken :: Lens' GetEBSVolumeRecommendationsResponse (Maybe Text) Source #

The token to use to advance to the next page of volume recommendations.

This value is null when there are no more pages of volume recommendations to return.

getEBSVolumeRecommendationsResponse_volumeRecommendations :: Lens' GetEBSVolumeRecommendationsResponse (Maybe [VolumeRecommendation]) Source #

An array of objects that describe volume recommendations.

getEBSVolumeRecommendationsResponse_errors :: Lens' GetEBSVolumeRecommendationsResponse (Maybe [GetRecommendationError]) Source #

An array of objects that describe errors of the request.

For example, an error is returned if you request recommendations for an unsupported volume.

getEBSVolumeRecommendationsResponse_httpStatus :: Lens' GetEBSVolumeRecommendationsResponse Int Source #

The response's http status code.