{ "version": "2.0", "metadata": { "apiVersion": "2017-01-06", "endpointPrefix": "cur", "jsonVersion": "1.1", "protocol": "json", "serviceFullName": "AWS Cost and Usage Report Service", "serviceId": "Cost and Usage Report Service", "signatureVersion": "v4", "signingName": "cur", "targetPrefix": "AWSOrigamiServiceGatewayService", "uid": "cur-2017-01-06" }, "operations": { "DeleteReportDefinition": { "name": "DeleteReportDefinition", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteReportDefinitionRequest" }, "output": { "shape": "DeleteReportDefinitionResponse" }, "errors": [ { "shape": "InternalErrorException" }, { "shape": "ValidationException" } ], "documentation": "

Deletes the specified report. Any tags associated with the report are also deleted.

" }, "DescribeReportDefinitions": { "name": "DescribeReportDefinitions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeReportDefinitionsRequest" }, "output": { "shape": "DescribeReportDefinitionsResponse" }, "errors": [ { "shape": "InternalErrorException" } ], "documentation": "

Lists the Amazon Web Services Cost and Usage Report available to this account.

" }, "ListTagsForResource": { "name": "ListTagsForResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListTagsForResourceRequest" }, "output": { "shape": "ListTagsForResourceResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InternalErrorException" }, { "shape": "ValidationException" } ], "documentation": "

Lists the tags associated with the specified report definition.

" }, "ModifyReportDefinition": { "name": "ModifyReportDefinition", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyReportDefinitionRequest" }, "output": { "shape": "ModifyReportDefinitionResponse" }, "errors": [ { "shape": "InternalErrorException" }, { "shape": "ValidationException" } ], "documentation": "

Allows you to programmatically update your report preferences.

" }, "PutReportDefinition": { "name": "PutReportDefinition", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "PutReportDefinitionRequest" }, "output": { "shape": "PutReportDefinitionResponse" }, "errors": [ { "shape": "DuplicateReportNameException" }, { "shape": "ReportLimitReachedException" }, { "shape": "InternalErrorException" }, { "shape": "ValidationException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "

Creates a new report using the description that you provide.

" }, "TagResource": { "name": "TagResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "TagResourceRequest" }, "output": { "shape": "TagResourceResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InternalErrorException" }, { "shape": "ValidationException" } ], "documentation": "

Associates a set of tags with a report definition.

" }, "UntagResource": { "name": "UntagResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UntagResourceRequest" }, "output": { "shape": "UntagResourceResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InternalErrorException" }, { "shape": "ValidationException" } ], "documentation": "

Disassociates a set of tags from a report definition.

" } }, "shapes": { "AWSRegion": { "type": "string", "documentation": "

The region of the S3 bucket that Amazon Web Services delivers the report into.

", "enum": [ "af-south-1", "ap-east-1", "ap-south-1", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ca-central-1", "eu-central-1", "eu-central-2", "eu-west-1", "eu-west-2", "eu-west-3", "eu-north-1", "eu-south-1", "eu-south-2", "me-central-1", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2", "cn-north-1", "cn-northwest-1" ] }, "AdditionalArtifact": { "type": "string", "documentation": "

The types of manifest that you want Amazon Web Services to create for this report.

", "enum": [ "REDSHIFT", "QUICKSIGHT", "ATHENA" ] }, "AdditionalArtifactList": { "type": "list", "member": { "shape": "AdditionalArtifact" }, "documentation": "

A list of additional artifacts.

" }, "BillingViewArn": { "type": "string", "max": 128, "pattern": "(arn:aws(-cn)?:billing::[0-9]{12}:billingview/)?[a-zA-Z0-9_\\+=\\.\\-@].{1,30}" }, "CompressionFormat": { "type": "string", "documentation": "

The compression format that Amazon Web Services uses for the report.

", "enum": [ "ZIP", "GZIP", "Parquet" ] }, "DeleteReportDefinitionRequest": { "type": "structure", "required": [ "ReportName" ], "members": { "ReportName": { "shape": "ReportName", "documentation": "

The name of the report that you want to delete. The name must be unique, is case sensitive, and can't include spaces.

" } }, "documentation": "

Deletes the specified report.

" }, "DeleteReportDefinitionResponse": { "type": "structure", "members": { "ResponseMessage": { "shape": "DeleteResponseMessage" } }, "documentation": "

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

" }, "DeleteResponseMessage": { "type": "string", "documentation": "

Whether the deletion was successful or not.

" }, "DescribeReportDefinitionsRequest": { "type": "structure", "members": { "MaxResults": { "shape": "MaxResults" }, "NextToken": { "shape": "GenericString" } }, "documentation": "

Requests a Amazon Web Services Cost and Usage Report list owned by the account.

" }, "DescribeReportDefinitionsResponse": { "type": "structure", "members": { "ReportDefinitions": { "shape": "ReportDefinitionList", "documentation": "

An Amazon Web Services Cost and Usage Report list owned by the account.

" }, "NextToken": { "shape": "GenericString" } }, "documentation": "

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

" }, "GenericString": { "type": "string", "documentation": "

A generic string.

", "max": 256, "pattern": "[A-Za-z0-9_\\.\\-=]*" }, "LastDelivery": { "type": "string", "max": 20, "min": 16, "pattern": "[0-9]{8}[T][0-9]{6}([Z]|[+-][0-9]{4})" }, "LastStatus": { "type": "string", "enum": [ "SUCCESS", "ERROR_PERMISSIONS", "ERROR_NO_BUCKET" ] }, "ListTagsForResourceRequest": { "type": "structure", "required": [ "ReportName" ], "members": { "ReportName": { "shape": "ReportName", "documentation": "

The report name of the report definition that tags are to be returned for.

" } } }, "ListTagsForResourceResponse": { "type": "structure", "members": { "Tags": { "shape": "TagList", "documentation": "

The tags assigned to the report definition resource.

" } } }, "MaxResults": { "type": "integer", "documentation": "

The maximum number of results that Amazon Web Services returns for the operation.

", "box": true, "max": 5, "min": 5 }, "ModifyReportDefinitionRequest": { "type": "structure", "required": [ "ReportName", "ReportDefinition" ], "members": { "ReportName": { "shape": "ReportName" }, "ReportDefinition": { "shape": "ReportDefinition" } } }, "ModifyReportDefinitionResponse": { "type": "structure", "members": {} }, "PutReportDefinitionRequest": { "type": "structure", "required": [ "ReportDefinition" ], "members": { "ReportDefinition": { "shape": "ReportDefinition", "documentation": "

Represents the output of the PutReportDefinition operation. The content consists of the detailed metadata and data file information.

" }, "Tags": { "shape": "TagList", "documentation": "

The tags to be assigned to the report definition resource.

" } }, "documentation": "

Creates a Cost and Usage Report.

" }, "PutReportDefinitionResponse": { "type": "structure", "members": {}, "documentation": "

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

" }, "RefreshClosedReports": { "type": "boolean", "box": true }, "ReportDefinition": { "type": "structure", "required": [ "ReportName", "TimeUnit", "Format", "Compression", "AdditionalSchemaElements", "S3Bucket", "S3Prefix", "S3Region" ], "members": { "ReportName": { "shape": "ReportName" }, "TimeUnit": { "shape": "TimeUnit" }, "Format": { "shape": "ReportFormat" }, "Compression": { "shape": "CompressionFormat" }, "AdditionalSchemaElements": { "shape": "SchemaElementList", "documentation": "

A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.

" }, "S3Bucket": { "shape": "S3Bucket" }, "S3Prefix": { "shape": "S3Prefix" }, "S3Region": { "shape": "AWSRegion" }, "AdditionalArtifacts": { "shape": "AdditionalArtifactList", "documentation": "

A list of manifests that you want Amazon Web Services to create for this report.

" }, "RefreshClosedReports": { "shape": "RefreshClosedReports", "documentation": "

Whether you want Amazon Web Services to update your reports after they have been finalized if Amazon Web Services detects charges related to previous months. These charges can include refunds, credits, or support fees.

" }, "ReportVersioning": { "shape": "ReportVersioning", "documentation": "

Whether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in addition to the previous versions.

" }, "BillingViewArn": { "shape": "BillingViewArn", "documentation": "

The Amazon resource name of the billing view. The BillingViewArn is needed to create Amazon Web Services Cost and Usage Report for each billing group maintained in the Amazon Web Services Billing Conductor service. The BillingViewArn for a billing group can be constructed as: arn:aws:billing::payer-account-id:billingview/billing-group-primary-account-id

" }, "ReportStatus": { "shape": "ReportStatus", "documentation": "

The status of the report.

" } }, "documentation": "

The definition of Amazon Web Services Cost and Usage Report. You can specify the report name, time unit, report format, compression format, S3 bucket, additional artifacts, and schema elements in the definition.

" }, "ReportDefinitionList": { "type": "list", "member": { "shape": "ReportDefinition" }, "documentation": "

A list of report definitions.

" }, "ReportFormat": { "type": "string", "documentation": "

The format that Amazon Web Services saves the report in.

", "enum": [ "textORcsv", "Parquet" ] }, "ReportName": { "type": "string", "documentation": "

The name of the report that you want to create. The name must be unique, is case sensitive, and can't include spaces.

", "max": 256, "pattern": "[0-9A-Za-z!\\-_.*\\'()]+" }, "ReportStatus": { "type": "structure", "members": { "lastDelivery": { "shape": "LastDelivery", "documentation": "

A timestamp that gives the date of a report delivery.

" }, "lastStatus": { "shape": "LastStatus", "documentation": "

An enum that gives the status of a report delivery.

" } }, "documentation": "

A two element dictionary with a lastDelivery and lastStatus key whose values describe the date and status of the last delivered report for a particular report definition.

" }, "ReportVersioning": { "type": "string", "enum": [ "CREATE_NEW_REPORT", "OVERWRITE_REPORT" ] }, "S3Bucket": { "type": "string", "documentation": "

The S3 bucket where Amazon Web Services delivers the report.

", "max": 256, "pattern": "[A-Za-z0-9_\\.\\-]+" }, "S3Prefix": { "type": "string", "documentation": "

The prefix that Amazon Web Services adds to the report name when Amazon Web Services delivers the report. Your prefix can't include spaces.

", "max": 256, "pattern": "[0-9A-Za-z!\\-_.*\\'()/]*" }, "SchemaElement": { "type": "string", "documentation": "

Whether or not Amazon Web Services includes resource IDs in the report.

", "enum": [ "RESOURCES", "SPLIT_COST_ALLOCATION_DATA", "MANUAL_DISCOUNT_COMPATIBILITY" ] }, "SchemaElementList": { "type": "list", "member": { "shape": "SchemaElement" }, "documentation": "

A list of strings that indicate the content that is included in the report, such as service or usage type.

" }, "Tag": { "type": "structure", "required": [ "Key", "Value" ], "members": { "Key": { "shape": "TagKey", "documentation": "

The key of the tag. Tag keys are case sensitive. Each report definition can only have up to one tag with the same key. If you try to add an existing tag with the same key, the existing tag value will be updated to the new value.

" }, "Value": { "shape": "TagValue", "documentation": "

The value of the tag. Tag values are case-sensitive. This can be an empty string.

" } }, "documentation": "

Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a report definition.

" }, "TagKey": { "type": "string", "max": 128, "min": 1, "pattern": ".*" }, "TagKeyList": { "type": "list", "member": { "shape": "TagKey" }, "max": 200, "min": 0 }, "TagList": { "type": "list", "member": { "shape": "Tag" }, "max": 200, "min": 0 }, "TagResourceRequest": { "type": "structure", "required": [ "ReportName", "Tags" ], "members": { "ReportName": { "shape": "ReportName", "documentation": "

The report name of the report definition that tags are to be associated with.

" }, "Tags": { "shape": "TagList", "documentation": "

The tags to be assigned to the report definition resource.

" } } }, "TagResourceResponse": { "type": "structure", "members": {} }, "TagValue": { "type": "string", "max": 256, "min": 0, "pattern": ".*" }, "TimeUnit": { "type": "string", "documentation": "

The length of time covered by the report.

", "enum": [ "HOURLY", "DAILY", "MONTHLY" ] }, "UntagResourceRequest": { "type": "structure", "required": [ "ReportName", "TagKeys" ], "members": { "ReportName": { "shape": "ReportName", "documentation": "

The report name of the report definition that tags are to be disassociated from.

" }, "TagKeys": { "shape": "TagKeyList", "documentation": "

The tags to be disassociated from the report definition resource.

" } } }, "UntagResourceResponse": { "type": "structure", "members": {} } }, "documentation": "

You can use the Amazon Web Services Cost and Usage Report API to programmatically create, query, and delete Amazon Web Services Cost and Usage Report definitions.

Amazon Web Services Cost and Usage Report track the monthly Amazon Web Services costs and usage associated with your Amazon Web Services account. The report contains line items for each unique combination of Amazon Web Services product, usage type, and operation that your Amazon Web Services account uses. You can configure the Amazon Web Services Cost and Usage Report to show only the data that you want, using the Amazon Web Services Cost and Usage Report API.

Service Endpoint

The Amazon Web Services Cost and Usage Report API provides the following endpoint:

" }