@datafire/amazonaws_ce NPM

@datafire/amazonaws_ce

Client library for AWS Cost Explorer Service

Installation and Usage

npm install --save @datafire/amazonaws_ce

let amazonaws_ce = require('@datafire/amazonaws_ce').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_ce.GetCostAndUsage({}).then(data => {
  console.log(data);
});

Description

Actions

GetCostAndUsage

amazonaws_ce.GetCostAndUsage({}, context)

Input

input object
- Filter Expression
- Granularity Granularity
- GroupBy GroupDefinitions
- Metrics MetricNames
- NextPageToken NextPageToken
- TimePeriod DateInterval

Output

output GetCostAndUsageResponse

GetDimensionValues

amazonaws_ce.GetDimensionValues({
  "TimePeriod": {
    "Start": "",
    "End": ""
  },
  "Dimension": ""
}, context)

Input

input object
- Context Context
- Dimension required Dimension
- NextPageToken NextPageToken
- SearchString SearchString
- TimePeriod required DateInterval

Output

output GetDimensionValuesResponse

GetReservationUtilization

amazonaws_ce.GetReservationUtilization({
  "TimePeriod": {
    "Start": "",
    "End": ""
  }
}, context)

Input

input object
- Filter Expression
- Granularity Granularity
- GroupBy GroupDefinitions
- NextPageToken NextPageToken
- TimePeriod required DateInterval

Output

output GetReservationUtilizationResponse

GetTags

amazonaws_ce.GetTags({
  "TimePeriod": {
    "Start": "",
    "End": ""
  }
}, context)

Input

input object
- NextPageToken NextPageToken
- SearchString SearchString
- TagKey TagKey
- TimePeriod required DateInterval

Output

output GetTagsResponse

Definitions

AttributeType

AttributeType string

AttributeValue

AttributeValue string

Attributes

Attributes array
- items object
  - key AttributeType
  - value AttributeValue

Context

Context string (values: COST_AND_USAGE, RESERVATIONS)

DateInterval

DateInterval object: The time period that you want the usage and costs for.
- End required YearMonthDay
- Start required YearMonthDay

Dimension

Dimension string (values: AZ, INSTANCE_TYPE, LINKED_ACCOUNT, OPERATION, PURCHASE_TYPE, REGION, SERVICE, USAGE_TYPE, USAGE_TYPE_GROUP, RECORD_TYPE, OPERATING_SYSTEM, TENANCY, SCOPE, PLATFORM, SUBSCRIPTION_ID)

DimensionValues

DimensionValues object: The metadata that you can use to filter and group your results. You can use GetDimensionValues to find specific values.
- Key Dimension
- Values Values

DimensionValuesWithAttributes

DimensionValuesWithAttributes object: The metadata of a specific type that you can use to filter and group your results. You can use GetDimensionValues to find specific values.
- Attributes Attributes
- Value Value

DimensionValuesWithAttributesList

DimensionValuesWithAttributesList array
- items DimensionValuesWithAttributes

Entity

Entity string

ErrorMessage

ErrorMessage string

Estimated

Estimated boolean

Expression

Expression object: Use Expression to filter by cost or by usage. There are two patterns: Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for InstanceType==m4.xlarge OR InstanceType==c4.large. The Expression for that looks like this. { "Dimensions": { "Key": "InstanceType", "Values": "m4.xlarge", “c4.large” } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with methods or set methods in multiple lines. Compound dimension values with logical operations - You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. This allows you to filter on more advanced options. For example, you can filter on ((InstanceType == m4.large OR InstanceType == m3.large) OR (Tag.Type == Type1)) AND (UsageType != DataTransfer). The Expression for that looks like this. { "And": [ {"Or": [ {"Dimensions": { "Key": "InstanceType", "Values": "m4.x.large", "c4.large" }}, {"Tag": { "Key": "TagName", "Values": "Value1" } } ]}, {"Not": {"dimensions": { "Key": "UsageType", "Values": "DataTransfer" }}} ] } Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that will create an error. { "And": ... , "DimensionValues": { "Dimension": "UsageType", "Values": "DataTransfer" } }
- And Expressions
- Dimensions DimensionValues
- Not Expression
- Or Expressions
- Tags TagValues

Expressions

Expressions array
- items Expression

GetCostAndUsageRequest

GetCostAndUsageRequest object
- Filter Expression
- Granularity Granularity
- GroupBy GroupDefinitions
- Metrics MetricNames
- NextPageToken NextPageToken
- TimePeriod DateInterval

GetCostAndUsageResponse

GetCostAndUsageResponse object
- GroupDefinitions GroupDefinitions
- NextPageToken NextPageToken
- ResultsByTime ResultsByTime

GetDimensionValuesRequest

GetDimensionValuesRequest object
- Context Context
- Dimension required Dimension
- NextPageToken NextPageToken
- SearchString SearchString
- TimePeriod required DateInterval

GetDimensionValuesResponse

GetDimensionValuesResponse object
- DimensionValues required DimensionValuesWithAttributesList
- NextPageToken NextPageToken
- ReturnSize required PageSize
- TotalSize required PageSize

GetReservationUtilizationRequest

GetReservationUtilizationRequest object
- Filter Expression
- Granularity Granularity
- GroupBy GroupDefinitions
- NextPageToken NextPageToken
- TimePeriod required DateInterval

GetReservationUtilizationResponse

GetReservationUtilizationResponse object
- NextPageToken NextPageToken
- Total ReservationAggregates
- UtilizationsByTime required UtilizationsByTime

GetTagsRequest

GetTagsRequest object
- NextPageToken NextPageToken
- SearchString SearchString
- TagKey TagKey
- TimePeriod required DateInterval

GetTagsResponse

GetTagsResponse object
- NextPageToken NextPageToken
- ReturnSize required PageSize
- Tags required TagList
- TotalSize required PageSize

Granularity

Granularity string (values: DAILY, MONTHLY)

Group

Group object: One level of grouped data within the results.
- Keys Keys
- Metrics Metrics

GroupDefinition

GroupDefinition object: Represents a group when you specify a group by criteria, or in the response to a query with a specific grouping.
- Key GroupDefinitionKey
- Type GroupDefinitionType

GroupDefinitionKey

GroupDefinitionKey string

GroupDefinitionType

GroupDefinitionType string (values: DIMENSION, TAG)

GroupDefinitions

GroupDefinitions array
- items GroupDefinition

Groups

Groups array
- items Group

Key

Key string

Keys

Keys array
- items Key

LimitExceededException

LimitExceededException object: You made too many calls in a short period of time. Try again later.
- Message ErrorMessage

MetricAmount

MetricAmount string

MetricName

MetricName string

MetricNames

MetricNames array
- items MetricName

MetricUnit

MetricUnit string

MetricValue

MetricValue object: The aggregated value for a metric.
- Amount MetricAmount
- Unit MetricUnit

Metrics

Metrics array
- items object
  - key MetricName
  - value MetricValue

NextPageToken

NextPageToken string

PageSize

PageSize integer

PurchasedHours

PurchasedHours string

ReservationAggregates

ReservationAggregates object: The aggregated numbers for your RI usage.
- PurchasedHours PurchasedHours
- TotalActualHours TotalActualHours
- UnusedHours UnusedHours
- UtilizationPercentage UtilizationPercentage

ReservationGroupKey

ReservationGroupKey string

ReservationGroupValue

ReservationGroupValue string

ReservationUtilizationGroup

ReservationUtilizationGroup object: A group of RIs that share a set of attributes.
- Attributes Attributes
- Key ReservationGroupKey
- Utilization ReservationAggregates
- Value ReservationGroupValue

ReservationUtilizationGroups

ReservationUtilizationGroups array
- items ReservationUtilizationGroup

ResultByTime

ResultByTime object: The result that is associated with a time period.
- Estimated Estimated
- Groups Groups
- TimePeriod DateInterval
- Total Metrics

ResultsByTime

ResultsByTime array
- items ResultByTime

SearchString

SearchString string

TagKey

TagKey string

TagList

TagList array
- items Entity

TagValues

TagValues object: The values that are available for a tag.
- Key TagKey
- Values Values

TotalActualHours

TotalActualHours string

UnusedHours

UnusedHours string

UtilizationByTime

UtilizationByTime object: The amount of utilization, in hours.
- Groups ReservationUtilizationGroups
- TimePeriod DateInterval
- Total ReservationAggregates

UtilizationPercentage

UtilizationPercentage string

UtilizationsByTime

UtilizationsByTime array
- items UtilizationByTime

Value

Value string

Values

Values array
- items Value

YearMonthDay

YearMonthDay string

datafire aws-sdk

@infinitebrahmanuniverse/nolb-_datafire_am @everything-registry/sub-chunk-220

5.0.0

7 years ago

4.0.0

8 years ago