Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetBillingGroupCostReport

Retrieves the margin summary report, which includes the AWS cost and charged amount (pro forma cost) by AWS service for a specific billing group.

Request Syntax


POST /get-billing-group-cost-report HTTP/1.1
Content-type: application/json

{
   "Arn": "string",
   "BillingPeriodRange": { 
      "ExclusiveEndBillingPeriod": "string",
      "InclusiveStartBillingPeriod": "string"
   },
   "GroupBy": [ "string" ],
   "MaxResults": number,
   "NextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Arn

The Amazon Resource Number (ARN) that uniquely identifies the billing group.

Type: String

Pattern: (arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/)?[0-9]{12}

Required: Yes

BillingPeriodRange

A time range for which the margin summary is effective. You can specify up to 12 months.

Type: BillingPeriodRange object

Required: No

GroupBy

A list of strings that specify the attributes that are used to break down costs in the margin summary reports for the billing group. For example, you can view your costs by the AWS service name or the billing period.

Type: Array of strings

Valid Values: PRODUCT_NAME | BILLING_PERIOD

Required: No

MaxResults

The maximum number of margin summary reports to retrieve.

Type: Integer

Valid Range: Minimum value of 200. Maximum value of 300.

Required: No

NextToken

The pagination token used on subsequent calls to get reports.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "BillingGroupCostReportResults": [ 
      { 
         "Arn": "string",
         "Attributes": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "AWSCost": "string",
         "Currency": "string",
         "Margin": "string",
         "MarginPercentage": "string",
         "ProformaCost": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

BillingGroupCostReportResults

The list of margin summary reports.

Type: Array of BillingGroupCostReportResultElement objects

NextToken

The pagination token used on subsequent calls to get reports.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing a request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that doesn't exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input doesn't match with the constraints specified by AWS services.

HTTP Status Code: 400