Amazonka.CostExplorer.GetSavingsPlansUtilizationDetails

Retrieves attribute data along with aggregate utilization and savings data for a given time period. This doesn't support granular or grouped data (daily/monthly) in response. You can't retrieve data by dates in a single response similar to GetSavingsPlanUtilization, but you have the option to make multiple calls to GetSavingsPlanUtilizationDetails by providing individual dates. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.

GetSavingsPlanUtilizationDetails internally groups data by SavingsPlansArn.

Creating a Request

data GetSavingsPlansUtilizationDetails

See: newGetSavingsPlansUtilizationDetails smart constructor.

Constructors

GetSavingsPlansUtilizationDetails'

Fields

• dataType :: Maybe [SavingsPlansDataType]

  The data type.

• filter' :: Maybe Expression

  Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

  • LINKED_ACCOUNT

  • SAVINGS_PLAN_ARN

  • REGION

  • PAYMENT_OPTION

  • INSTANCE_TYPE_FAMILY

  GetSavingsPlansUtilizationDetails uses the same Expression object as the other operations, but only AND is supported among each dimension.

• maxResults :: Maybe Natural

  The number of items to be returned in a response. The default is 20, with a minimum value of 1.

• nextToken :: Maybe Text

  The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

• sortBy :: Maybe SortDefinition

  The value that you want to sort the data by.

  The following values are supported for Key:

  • UtilizationPercentage

  • TotalCommitment

  • UsedCommitment

  • UnusedCommitment

  • NetSavings

  • AmortizedRecurringCommitment

  • AmortizedUpfrontCommitment

  The supported values for SortOrder are ASCENDING and DESCENDING.

• timePeriod :: DateInterval

  The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

Instances

ToJSON GetSavingsPlansUtilizationDetails

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilizationDetails

Methods

toJSON :: GetSavingsPlansUtilizationDetails -> Value

toEncoding :: GetSavingsPlansUtilizationDetails -> Encoding

toJSONList :: [GetSavingsPlansUtilizationDetails] -> Value

toEncodingList :: [GetSavingsPlansUtilizationDetails] -> Encoding

ToHeaders GetSavingsPlansUtilizationDetails

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilizationDetails

Methods

toHeaders :: GetSavingsPlansUtilizationDetails -> [Header]

ToPath GetSavingsPlansUtilizationDetails

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilizationDetails

Methods

toPath :: GetSavingsPlansUtilizationDetails -> ByteString

ToQuery GetSavingsPlansUtilizationDetails

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilizationDetails

Methods

toQuery :: GetSavingsPlansUtilizationDetails -> QueryString

AWSRequest GetSavingsPlansUtilizationDetails

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilizationDetails

Associated Types

type AWSResponse GetSavingsPlansUtilizationDetails

Methods

request :: (Service -> Service) -> GetSavingsPlansUtilizationDetails -> Request GetSavingsPlansUtilizationDetails

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

Generic GetSavingsPlansUtilizationDetails

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilizationDetails

Associated Types

type Rep GetSavingsPlansUtilizationDetails :: Type -> Type

Methods

from :: GetSavingsPlansUtilizationDetails -> Rep GetSavingsPlansUtilizationDetails x

to :: Rep GetSavingsPlansUtilizationDetails x -> GetSavingsPlansUtilizationDetails

Read GetSavingsPlansUtilizationDetails

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilizationDetails

Methods

readsPrec :: Int -> ReadS GetSavingsPlansUtilizationDetails

readList :: ReadS [GetSavingsPlansUtilizationDetails]

readPrec :: ReadPrec GetSavingsPlansUtilizationDetails

readListPrec :: ReadPrec [GetSavingsPlansUtilizationDetails]

Show GetSavingsPlansUtilizationDetails

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilizationDetails

Methods

showsPrec :: Int -> GetSavingsPlansUtilizationDetails -> ShowS

show :: GetSavingsPlansUtilizationDetails -> String

showList :: [GetSavingsPlansUtilizationDetails] -> ShowS

NFData GetSavingsPlansUtilizationDetails

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilizationDetails

Methods

rnf :: GetSavingsPlansUtilizationDetails -> ()

Eq GetSavingsPlansUtilizationDetails

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilizationDetails

Methods

(==) :: GetSavingsPlansUtilizationDetails -> GetSavingsPlansUtilizationDetails -> Bool

(/=) :: GetSavingsPlansUtilizationDetails -> GetSavingsPlansUtilizationDetails -> Bool

Hashable GetSavingsPlansUtilizationDetails

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilizationDetails

Methods

hashWithSalt :: Int -> GetSavingsPlansUtilizationDetails -> Int

hash :: GetSavingsPlansUtilizationDetails -> Int

type AWSResponse GetSavingsPlansUtilizationDetails

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilizationDetails

type AWSResponse GetSavingsPlansUtilizationDetails = GetSavingsPlansUtilizationDetailsResponse

type Rep GetSavingsPlansUtilizationDetails

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilizationDetails

type Rep GetSavingsPlansUtilizationDetails = D1 ('MetaData "GetSavingsPlansUtilizationDetails" "Amazonka.CostExplorer.GetSavingsPlansUtilizationDetails" "amazonka-cost-explorer-2.0-QqVzyVvst98QYs5s2Ea4h" 'False) (C1 ('MetaCons "GetSavingsPlansUtilizationDetails'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dataType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SavingsPlansDataType])) :*: (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Expression)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortDefinition)) :*: S1 ('MetaSel ('Just "timePeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DateInterval)))))

newGetSavingsPlansUtilizationDetails

Arguments

:: DateInterval

GetSavingsPlansUtilizationDetails

-> GetSavingsPlansUtilizationDetails

Create a value of GetSavingsPlansUtilizationDetails 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:dataType:GetSavingsPlansUtilizationDetails', getSavingsPlansUtilizationDetails_dataType - The data type.

$sel:filter':GetSavingsPlansUtilizationDetails', getSavingsPlansUtilizationDetails_filter - Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

• LINKED_ACCOUNT

• SAVINGS_PLAN_ARN

• REGION

• PAYMENT_OPTION

• INSTANCE_TYPE_FAMILY

GetSavingsPlansUtilizationDetails uses the same Expression object as the other operations, but only AND is supported among each dimension.

$sel:maxResults:GetSavingsPlansUtilizationDetails', getSavingsPlansUtilizationDetails_maxResults - The number of items to be returned in a response. The default is 20, with a minimum value of 1.

GetSavingsPlansUtilizationDetails, getSavingsPlansUtilizationDetails_nextToken - The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

$sel:sortBy:GetSavingsPlansUtilizationDetails', getSavingsPlansUtilizationDetails_sortBy - The value that you want to sort the data by.

The following values are supported for Key:

• UtilizationPercentage

• TotalCommitment

• UsedCommitment

• UnusedCommitment

• NetSavings

• AmortizedRecurringCommitment

• AmortizedUpfrontCommitment

The supported values for SortOrder are ASCENDING and DESCENDING.

GetSavingsPlansUtilizationDetails, getSavingsPlansUtilizationDetails_timePeriod - The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

Request Lenses

getSavingsPlansUtilizationDetails_dataType :: Lens' GetSavingsPlansUtilizationDetails (Maybe [SavingsPlansDataType])

The data type.

getSavingsPlansUtilizationDetails_filter :: Lens' GetSavingsPlansUtilizationDetails (Maybe Expression)

Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

• LINKED_ACCOUNT

• SAVINGS_PLAN_ARN

• REGION

• PAYMENT_OPTION

• INSTANCE_TYPE_FAMILY

GetSavingsPlansUtilizationDetails uses the same Expression object as the other operations, but only AND is supported among each dimension.

getSavingsPlansUtilizationDetails_maxResults :: Lens' GetSavingsPlansUtilizationDetails (Maybe Natural)

The number of items to be returned in a response. The default is 20, with a minimum value of 1.

getSavingsPlansUtilizationDetails_nextToken :: Lens' GetSavingsPlansUtilizationDetails (Maybe Text)

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

getSavingsPlansUtilizationDetails_sortBy :: Lens' GetSavingsPlansUtilizationDetails (Maybe SortDefinition)

The value that you want to sort the data by.

The following values are supported for Key:

• UtilizationPercentage

• TotalCommitment

• UsedCommitment

• UnusedCommitment

• NetSavings

• AmortizedRecurringCommitment

• AmortizedUpfrontCommitment

The supported values for SortOrder are ASCENDING and DESCENDING.

getSavingsPlansUtilizationDetails_timePeriod :: Lens' GetSavingsPlansUtilizationDetails DateInterval

The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

Destructuring the Response

data GetSavingsPlansUtilizationDetailsResponse

See: newGetSavingsPlansUtilizationDetailsResponse smart constructor.

Constructors

GetSavingsPlansUtilizationDetailsResponse'

Fields

• nextToken :: Maybe Text

  The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

• total :: Maybe SavingsPlansUtilizationAggregates

  The total Savings Plans utilization, regardless of time period.

• httpStatus :: Int

  The response's http status code.

• savingsPlansUtilizationDetails :: [SavingsPlansUtilizationDetail]

  Retrieves a single daily or monthly Savings Plans utilization rate and details for your account.

• timePeriod :: DateInterval

Instances

Generic GetSavingsPlansUtilizationDetailsResponse

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilizationDetails

Associated Types

type Rep GetSavingsPlansUtilizationDetailsResponse :: Type -> Type

Methods

from :: GetSavingsPlansUtilizationDetailsResponse -> Rep GetSavingsPlansUtilizationDetailsResponse x

to :: Rep GetSavingsPlansUtilizationDetailsResponse x -> GetSavingsPlansUtilizationDetailsResponse

Read GetSavingsPlansUtilizationDetailsResponse

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilizationDetails

Methods

readsPrec :: Int -> ReadS GetSavingsPlansUtilizationDetailsResponse

readList :: ReadS [GetSavingsPlansUtilizationDetailsResponse]

readPrec :: ReadPrec GetSavingsPlansUtilizationDetailsResponse

readListPrec :: ReadPrec [GetSavingsPlansUtilizationDetailsResponse]

Show GetSavingsPlansUtilizationDetailsResponse

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilizationDetails

Methods

showsPrec :: Int -> GetSavingsPlansUtilizationDetailsResponse -> ShowS

show :: GetSavingsPlansUtilizationDetailsResponse -> String

showList :: [GetSavingsPlansUtilizationDetailsResponse] -> ShowS

NFData GetSavingsPlansUtilizationDetailsResponse

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilizationDetails

Methods

rnf :: GetSavingsPlansUtilizationDetailsResponse -> ()

Eq GetSavingsPlansUtilizationDetailsResponse

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilizationDetails

Methods

(==) :: GetSavingsPlansUtilizationDetailsResponse -> GetSavingsPlansUtilizationDetailsResponse -> Bool

(/=) :: GetSavingsPlansUtilizationDetailsResponse -> GetSavingsPlansUtilizationDetailsResponse -> Bool

type Rep GetSavingsPlansUtilizationDetailsResponse

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilizationDetails

type Rep GetSavingsPlansUtilizationDetailsResponse = D1 ('MetaData "GetSavingsPlansUtilizationDetailsResponse" "Amazonka.CostExplorer.GetSavingsPlansUtilizationDetails" "amazonka-cost-explorer-2.0-QqVzyVvst98QYs5s2Ea4h" 'False) (C1 ('MetaCons "GetSavingsPlansUtilizationDetailsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "total") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SavingsPlansUtilizationAggregates))) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "savingsPlansUtilizationDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [SavingsPlansUtilizationDetail]) :*: S1 ('MetaSel ('Just "timePeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DateInterval)))))

newGetSavingsPlansUtilizationDetailsResponse

Arguments

:: Int

$sel:httpStatus:GetSavingsPlansUtilizationDetailsResponse'

-> DateInterval

GetSavingsPlansUtilizationDetails

-> GetSavingsPlansUtilizationDetailsResponse

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

GetSavingsPlansUtilizationDetails, getSavingsPlansUtilizationDetailsResponse_nextToken - The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

GetSavingsPlansUtilizationDetailsResponse, getSavingsPlansUtilizationDetailsResponse_total - The total Savings Plans utilization, regardless of time period.

$sel:httpStatus:GetSavingsPlansUtilizationDetailsResponse', getSavingsPlansUtilizationDetailsResponse_httpStatus - The response's http status code.

$sel:savingsPlansUtilizationDetails:GetSavingsPlansUtilizationDetailsResponse', getSavingsPlansUtilizationDetailsResponse_savingsPlansUtilizationDetails - Retrieves a single daily or monthly Savings Plans utilization rate and details for your account.

GetSavingsPlansUtilizationDetails, getSavingsPlansUtilizationDetailsResponse_timePeriod - Undocumented member.

Response Lenses

getSavingsPlansUtilizationDetailsResponse_nextToken :: Lens' GetSavingsPlansUtilizationDetailsResponse (Maybe Text)

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

getSavingsPlansUtilizationDetailsResponse_total :: Lens' GetSavingsPlansUtilizationDetailsResponse (Maybe SavingsPlansUtilizationAggregates)

The total Savings Plans utilization, regardless of time period.

getSavingsPlansUtilizationDetailsResponse_httpStatus :: Lens' GetSavingsPlansUtilizationDetailsResponse Int

The response's http status code.

getSavingsPlansUtilizationDetailsResponse_savingsPlansUtilizationDetails :: Lens' GetSavingsPlansUtilizationDetailsResponse [SavingsPlansUtilizationDetail]

Retrieves a single daily or monthly Savings Plans utilization rate and details for your account.

getSavingsPlansUtilizationDetailsResponse_timePeriod :: Lens' GetSavingsPlansUtilizationDetailsResponse DateInterval

Undocumented member.