DevOpsGuru / Client / get_cost_estimation

get_cost_estimation#

DevOpsGuru.Client.get_cost_estimation(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.get_cost_estimation(
    NextToken='string'
)
Parameters:

NextToken (string) – The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Return type:

dict

Returns:

Response Syntax

{
    'ResourceCollection': {
        'CloudFormation': {
            'StackNames': [
                'string',
            ]
        },
        'Tags': [
            {
                'AppBoundaryKey': 'string',
                'TagValues': [
                    'string',
                ]
            },
        ]
    },
    'Status': 'ONGOING'|'COMPLETED',
    'Costs': [
        {
            'Type': 'string',
            'State': 'ACTIVE'|'INACTIVE',
            'Count': 123,
            'UnitCost': 123.0,
            'Cost': 123.0
        },
    ],
    'TimeRange': {
        'StartTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1)
    },
    'TotalCost': 123.0,
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ResourceCollection (dict) –

      The collection of the Amazon Web Services resources used to create your monthly DevOps Guru cost estimate.

      • CloudFormation (dict) –

        An object that specifies the CloudFormation stack that defines the Amazon Web Services 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) –

      • Tags (list) –

        The Amazon Web Services tags used to filter the resource collection that is used for a cost estimate.

        Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

        Each Amazon Web Services tag has two parts.

        • A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.

        • An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.

        Together these are known as key-value pairs.

        Warning

        The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

        • (dict) –

          Information about a collection of Amazon Web Services resources that are identified by an Amazon Web Services tag. This collection of resources is used to create a monthly cost estimate for DevOps Guru to analyze Amazon Web Services resources. The maximum number of tags you can specify for a cost estimate is one. The estimate created is for the cost to analyze the Amazon Web Services resources defined by the tag. For more information, see Stacks in the Amazon Web Services CloudFormation User Guide.

          • AppBoundaryKey (string) –

            An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.

            Warning

            The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

          • TagValues (list) –

            The values in an Amazon Web Services tag collection.

            The tag’s value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag’s key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.

            • (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 Amazon Web Services resources.

      • (dict) –

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

        • Type (string) –

          The type of the Amazon Web Services 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 Amazon Web Services 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 (float) –

          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 (float) –

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

    • TimeRange (dict) –

      The start and end time of the cost estimation.

      • StartTime (datetime) –

        The start time of the cost estimation.

      • EndTime (datetime) –

        The end time of the cost estimation.

    • TotalCost (float) –

      The estimated monthly cost to analyze the Amazon Web Services 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.

Exceptions

  • DevOpsGuru.Client.exceptions.AccessDeniedException

  • DevOpsGuru.Client.exceptions.InternalServerException

  • DevOpsGuru.Client.exceptions.ResourceNotFoundException

  • DevOpsGuru.Client.exceptions.ThrottlingException

  • DevOpsGuru.Client.exceptions.ValidationException