[ aws . devops-guru ]

get-cost-estimation

Description

Returns an estimate of the monthly cost for DevOps Guru to analyze your AWS resources. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

get-cost-estimation is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Costs

Synopsis

  get-cost-estimation
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

ResourceCollection -> (structure)

The collection of the AWS resources used to create your monthly DevOps Guru cost estimate.

CloudFormation -> (structure)

An object that specifies the CloudFormation stack that defines the AWS resources used to create a monthly estimate for DevOps Guru.

StackNames -> (list)

An array of CloudFormation stack names. Its size is fixed at 1 item.

(string)

Status -> (string)

The status of creating this cost estimate. If it’s still in progress, the status ONGOING is returned. If it is finished, the status COMPLETED is returned.

Costs -> (list)

An array of ResourceCost objects that each contains details about the monthly cost estimate to analyze one of your AWS resources.

(structure)

An object that contains information about the estimated monthly cost to analyze an AWS resource. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing .

Type -> (string)

The type of the AWS resource.

State -> (string)

The state of the resource. The resource is ACTIVE if it produces metrics, events, or logs within an hour, otherwise it is INACTIVE . You pay for the number of active AWS resource hours analyzed for each resource. Inactive resources are not charged.

Count -> (integer)

The number of active resources analyzed for this service to create a monthly cost estimate.

UnitCost -> (double)

The price per hour to analyze the resources in the service. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing .

Cost -> (double)

The total estimated monthly cost to analyze the active resources for this resource.

TimeRange -> (structure)

The start and end time of the cost estimation.

StartTime -> (timestamp)

The start time of the cost estimation.

EndTime -> (timestamp)

The end time of the cost estimation.

TotalCost -> (double)

The estimated monthly cost to analyze the AWS resources. This value is the sum of the estimated costs to analyze each resource in the Costs object in this response.

NextToken -> (string)

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.