Amazonka.CostExplorer.GetReservationCoverage

Retrieves the reservation coverage for your account, which you can use to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization's management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data about reservation usage by the following dimensions:

• AZ
• CACHE_ENGINE
• DATABASE_ENGINE
• DEPLOYMENT_OPTION
• INSTANCE_TYPE
• LINKED_ACCOUNT
• OPERATING_SYSTEM
• PLATFORM
• REGION
• SERVICE
• TAG
• TENANCY

To determine valid values for a dimension, use the GetDimensionValues operation.

Creating a Request

data GetReservationCoverage

You can use the following request parameters to query for how much of your instance usage a reservation covered.

See: newGetReservationCoverage smart constructor.

Constructors

GetReservationCoverage'

Fields

• filter' :: Maybe Expression

  Filters utilization data by dimensions. You can filter by the following dimensions:

  • AZ
  • CACHE_ENGINE
  • DATABASE_ENGINE
  • DEPLOYMENT_OPTION
  • INSTANCE_TYPE
  • LINKED_ACCOUNT
  • OPERATING_SYSTEM
  • PLATFORM
  • REGION
  • SERVICE
  • TAG
  • TENANCY

  GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.

  If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.

  Cost category is also supported.

• granularity :: Maybe Granularity

  The granularity of the Amazon Web Services cost data for the reservation. Valid values are MONTHLY and DAILY.

  If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY.

  The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.

• groupBy :: Maybe [GroupDefinition]

  You can group the data by the following attributes:

  • AZ
  • CACHE_ENGINE
  • DATABASE_ENGINE
  • DEPLOYMENT_OPTION
  • INSTANCE_TYPE
  • INVOICING_ENTITY
  • LINKED_ACCOUNT
  • OPERATING_SYSTEM
  • PLATFORM
  • REGION
  • TENANCY
• maxResults :: Maybe Natural

  The maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.

• metrics :: Maybe [Text]

  The measurement that you want your reservation coverage reported in.

  Valid values are Hour, Unit, and Cost. You can use multiple values in a request.

• nextPageToken :: 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 by which you want to sort the data.

  The following values are supported for Key:

  • OnDemandCost

  • CoverageHoursPercentage

  • OnDemandHours

  • ReservedHours

  • TotalRunningHours

  • CoverageNormalizedUnitsPercentage

  • OnDemandNormalizedUnits

  • ReservedNormalizedUnits

  • TotalRunningNormalizedUnits

  • Time

  Supported values for SortOrder are ASCENDING or DESCENDING.

• timePeriod :: DateInterval

  The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

Instances

ToJSON GetReservationCoverage

Defined in Amazonka.CostExplorer.GetReservationCoverage

Methods

toJSON :: GetReservationCoverage -> Value

toEncoding :: GetReservationCoverage -> Encoding

toJSONList :: [GetReservationCoverage] -> Value

toEncodingList :: [GetReservationCoverage] -> Encoding

ToHeaders GetReservationCoverage

Defined in Amazonka.CostExplorer.GetReservationCoverage

Methods

toHeaders :: GetReservationCoverage -> [Header]

ToPath GetReservationCoverage

Defined in Amazonka.CostExplorer.GetReservationCoverage

Methods

toPath :: GetReservationCoverage -> ByteString

ToQuery GetReservationCoverage

Defined in Amazonka.CostExplorer.GetReservationCoverage

Methods

toQuery :: GetReservationCoverage -> QueryString

AWSRequest GetReservationCoverage

Defined in Amazonka.CostExplorer.GetReservationCoverage

Associated Types

type AWSResponse GetReservationCoverage

Methods

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

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

Generic GetReservationCoverage

Defined in Amazonka.CostExplorer.GetReservationCoverage

Associated Types

type Rep GetReservationCoverage :: Type -> Type

Methods

from :: GetReservationCoverage -> Rep GetReservationCoverage x

to :: Rep GetReservationCoverage x -> GetReservationCoverage

Read GetReservationCoverage

Defined in Amazonka.CostExplorer.GetReservationCoverage

Methods

readsPrec :: Int -> ReadS GetReservationCoverage

readList :: ReadS [GetReservationCoverage]

readPrec :: ReadPrec GetReservationCoverage

readListPrec :: ReadPrec [GetReservationCoverage]

Show GetReservationCoverage

Defined in Amazonka.CostExplorer.GetReservationCoverage

Methods

showsPrec :: Int -> GetReservationCoverage -> ShowS

show :: GetReservationCoverage -> String

showList :: [GetReservationCoverage] -> ShowS

NFData GetReservationCoverage

Defined in Amazonka.CostExplorer.GetReservationCoverage

Methods

rnf :: GetReservationCoverage -> ()

Eq GetReservationCoverage

Defined in Amazonka.CostExplorer.GetReservationCoverage

Methods

(==) :: GetReservationCoverage -> GetReservationCoverage -> Bool

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

Hashable GetReservationCoverage

Defined in Amazonka.CostExplorer.GetReservationCoverage

Methods

hashWithSalt :: Int -> GetReservationCoverage -> Int

hash :: GetReservationCoverage -> Int

type AWSResponse GetReservationCoverage

Defined in Amazonka.CostExplorer.GetReservationCoverage

type AWSResponse GetReservationCoverage = GetReservationCoverageResponse

type Rep GetReservationCoverage

Defined in Amazonka.CostExplorer.GetReservationCoverage

type Rep GetReservationCoverage = D1 ('MetaData "GetReservationCoverage" "Amazonka.CostExplorer.GetReservationCoverage" "amazonka-cost-explorer-2.0-QqVzyVvst98QYs5s2Ea4h" 'False) (C1 ('MetaCons "GetReservationCoverage'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Expression)) :*: S1 ('MetaSel ('Just "granularity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Granularity))) :*: (S1 ('MetaSel ('Just "groupBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GroupDefinition])) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "metrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "nextPageToken") '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)))))

newGetReservationCoverage

Arguments

:: DateInterval

GetReservationCoverage

-> GetReservationCoverage

Create a value of GetReservationCoverage 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:filter':GetReservationCoverage', getReservationCoverage_filter - Filters utilization data by dimensions. You can filter by the following dimensions:

• AZ
• CACHE_ENGINE
• DATABASE_ENGINE
• DEPLOYMENT_OPTION
• INSTANCE_TYPE
• LINKED_ACCOUNT
• OPERATING_SYSTEM
• PLATFORM
• REGION
• SERVICE
• TAG
• TENANCY

GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.

If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.

Cost category is also supported.

$sel:granularity:GetReservationCoverage', getReservationCoverage_granularity - The granularity of the Amazon Web Services cost data for the reservation. Valid values are MONTHLY and DAILY.

If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY.

The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.

$sel:groupBy:GetReservationCoverage', getReservationCoverage_groupBy - You can group the data by the following attributes:

• AZ
• CACHE_ENGINE
• DATABASE_ENGINE
• DEPLOYMENT_OPTION
• INSTANCE_TYPE
• INVOICING_ENTITY
• LINKED_ACCOUNT
• OPERATING_SYSTEM
• PLATFORM
• REGION
• TENANCY

$sel:maxResults:GetReservationCoverage', getReservationCoverage_maxResults - The maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.

GetReservationCoverage, getReservationCoverage_metrics - The measurement that you want your reservation coverage reported in.

Valid values are Hour, Unit, and Cost. You can use multiple values in a request.

GetReservationCoverage, getReservationCoverage_nextPageToken - 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:GetReservationCoverage', getReservationCoverage_sortBy - The value by which you want to sort the data.

The following values are supported for Key:

• OnDemandCost

• CoverageHoursPercentage

• OnDemandHours

• ReservedHours

• TotalRunningHours

• CoverageNormalizedUnitsPercentage

• OnDemandNormalizedUnits

• ReservedNormalizedUnits

• TotalRunningNormalizedUnits

• Time

Supported values for SortOrder are ASCENDING or DESCENDING.

GetReservationCoverage, getReservationCoverage_timePeriod - The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

Request Lenses

getReservationCoverage_filter :: Lens' GetReservationCoverage (Maybe Expression)

Filters utilization data by dimensions. You can filter by the following dimensions:

• AZ
• CACHE_ENGINE
• DATABASE_ENGINE
• DEPLOYMENT_OPTION
• INSTANCE_TYPE
• LINKED_ACCOUNT
• OPERATING_SYSTEM
• PLATFORM
• REGION
• SERVICE
• TAG
• TENANCY

GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.

If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.

Cost category is also supported.

getReservationCoverage_granularity :: Lens' GetReservationCoverage (Maybe Granularity)

The granularity of the Amazon Web Services cost data for the reservation. Valid values are MONTHLY and DAILY.

If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY.

The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.

getReservationCoverage_groupBy :: Lens' GetReservationCoverage (Maybe [GroupDefinition])

You can group the data by the following attributes:

• AZ
• CACHE_ENGINE
• DATABASE_ENGINE
• DEPLOYMENT_OPTION
• INSTANCE_TYPE
• INVOICING_ENTITY
• LINKED_ACCOUNT
• OPERATING_SYSTEM
• PLATFORM
• REGION
• TENANCY

getReservationCoverage_maxResults :: Lens' GetReservationCoverage (Maybe Natural)

The maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.

getReservationCoverage_metrics :: Lens' GetReservationCoverage (Maybe [Text])

The measurement that you want your reservation coverage reported in.

Valid values are Hour, Unit, and Cost. You can use multiple values in a request.

getReservationCoverage_nextPageToken :: Lens' GetReservationCoverage (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.

getReservationCoverage_sortBy :: Lens' GetReservationCoverage (Maybe SortDefinition)

The value by which you want to sort the data.

The following values are supported for Key:

• OnDemandCost

• CoverageHoursPercentage

• OnDemandHours

• ReservedHours

• TotalRunningHours

• CoverageNormalizedUnitsPercentage

• OnDemandNormalizedUnits

• ReservedNormalizedUnits

• TotalRunningNormalizedUnits

• Time

Supported values for SortOrder are ASCENDING or DESCENDING.

getReservationCoverage_timePeriod :: Lens' GetReservationCoverage DateInterval

The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

Destructuring the Response

data GetReservationCoverageResponse

See: newGetReservationCoverageResponse smart constructor.

Constructors

GetReservationCoverageResponse'

Fields

• nextPageToken :: Maybe Text

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

• total :: Maybe Coverage

  The total amount of instance usage that a reservation covered.

• httpStatus :: Int

  The response's http status code.

• coveragesByTime :: [CoverageByTime]

  The amount of time that your reservations covered.

Instances

Generic GetReservationCoverageResponse

Defined in Amazonka.CostExplorer.GetReservationCoverage

Associated Types

type Rep GetReservationCoverageResponse :: Type -> Type

Methods

from :: GetReservationCoverageResponse -> Rep GetReservationCoverageResponse x

to :: Rep GetReservationCoverageResponse x -> GetReservationCoverageResponse

Read GetReservationCoverageResponse

Defined in Amazonka.CostExplorer.GetReservationCoverage

Methods

readsPrec :: Int -> ReadS GetReservationCoverageResponse

readList :: ReadS [GetReservationCoverageResponse]

readPrec :: ReadPrec GetReservationCoverageResponse

readListPrec :: ReadPrec [GetReservationCoverageResponse]

Show GetReservationCoverageResponse

Defined in Amazonka.CostExplorer.GetReservationCoverage

Methods

showsPrec :: Int -> GetReservationCoverageResponse -> ShowS

show :: GetReservationCoverageResponse -> String

showList :: [GetReservationCoverageResponse] -> ShowS

NFData GetReservationCoverageResponse

Defined in Amazonka.CostExplorer.GetReservationCoverage

Methods

rnf :: GetReservationCoverageResponse -> ()

Eq GetReservationCoverageResponse

Defined in Amazonka.CostExplorer.GetReservationCoverage

Methods

(==) :: GetReservationCoverageResponse -> GetReservationCoverageResponse -> Bool

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

type Rep GetReservationCoverageResponse

Defined in Amazonka.CostExplorer.GetReservationCoverage

type Rep GetReservationCoverageResponse = D1 ('MetaData "GetReservationCoverageResponse" "Amazonka.CostExplorer.GetReservationCoverage" "amazonka-cost-explorer-2.0-QqVzyVvst98QYs5s2Ea4h" 'False) (C1 ('MetaCons "GetReservationCoverageResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "total") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Coverage))) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "coveragesByTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [CoverageByTime]))))

newGetReservationCoverageResponse

Arguments

:: Int

$sel:httpStatus:GetReservationCoverageResponse'

-> GetReservationCoverageResponse

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

GetReservationCoverage, getReservationCoverageResponse_nextPageToken - The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

GetReservationCoverageResponse, getReservationCoverageResponse_total - The total amount of instance usage that a reservation covered.

$sel:httpStatus:GetReservationCoverageResponse', getReservationCoverageResponse_httpStatus - The response's http status code.

$sel:coveragesByTime:GetReservationCoverageResponse', getReservationCoverageResponse_coveragesByTime - The amount of time that your reservations covered.

Response Lenses

getReservationCoverageResponse_nextPageToken :: Lens' GetReservationCoverageResponse (Maybe Text)

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

getReservationCoverageResponse_total :: Lens' GetReservationCoverageResponse (Maybe Coverage)

The total amount of instance usage that a reservation covered.

getReservationCoverageResponse_httpStatus :: Lens' GetReservationCoverageResponse Int

The response's http status code.

getReservationCoverageResponse_coveragesByTime :: Lens' GetReservationCoverageResponse [CoverageByTime]

The amount of time that your reservations covered.