AWS Cost and Usage Report Service 2017-01-06
- Client: Aws\CostandUsageReportService\CostandUsageReportServiceClient
- Service ID: cur
- Version: 2017-01-06
This page describes the parameters and results for the operations of the AWS Cost and Usage Report Service (2017-01-06), and shows how to use the Aws\CostandUsageReportService\CostandUsageReportServiceClient object to call the described operations. This documentation is specific to the 2017-01-06 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- DeleteReportDefinition ( array $params = [] )
Delete a specified report definition
- DescribeReportDefinitions ( array $params = [] )
Describe a list of report definitions owned by the account
- PutReportDefinition ( array $params = [] )
Create a new report definition
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
DeleteReportDefinition
$result = $client->deleteReportDefinition([/* ... */]); $promise = $client->deleteReportDefinitionAsync([/* ... */]);
Parameter Syntax
$result = $client->deleteReportDefinition([
'ReportName' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'ResponseMessage' => '<string>',
]
Result Details
Errors
-
InternalErrorException: This exception is thrown on a known dependency failure.
-
ValidationException: This exception is thrown when providing an invalid input. eg. Put a report preference with an invalid report name, or Delete a report preference with an empty report name.
DescribeReportDefinitions
$result = $client->describeReportDefinitions([/* ... */]); $promise = $client->describeReportDefinitionsAsync([/* ... */]);
Parameter Syntax
$result = $client->describeReportDefinitions([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'NextToken' => '<string>',
'ReportDefinitions' => [
[
'AdditionalArtifacts' => ['<string>', ...],
'AdditionalSchemaElements' => ['<string>', ...],
'Compression' => 'ZIP|GZIP',
'Format' => 'textORcsv',
'ReportName' => '<string>',
'S3Bucket' => '<string>',
'S3Prefix' => '<string>',
'S3Region' => 'us-east-1|us-west-1|us-west-2|eu-central-1|eu-west-1|ap-southeast-1|ap-southeast-2|ap-northeast-1',
'TimeUnit' => 'HOURLY|DAILY',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
A generic string. - ReportDefinitions
-
- Type: Array of ReportDefinition structures
A list of report definitions.
Errors
-
InternalErrorException: This exception is thrown on a known dependency failure.
PutReportDefinition
$result = $client->putReportDefinition([/* ... */]); $promise = $client->putReportDefinitionAsync([/* ... */]);
Parameter Syntax
$result = $client->putReportDefinition([
'ReportDefinition' => [ // REQUIRED
'AdditionalArtifacts' => ['<string>', ...],
'AdditionalSchemaElements' => ['<string>', ...], // REQUIRED
'Compression' => 'ZIP|GZIP', // REQUIRED
'Format' => 'textORcsv', // REQUIRED
'ReportName' => '<string>', // REQUIRED
'S3Bucket' => '<string>', // REQUIRED
'S3Prefix' => '<string>', // REQUIRED
'S3Region' => 'us-east-1|us-west-1|us-west-2|eu-central-1|eu-west-1|ap-southeast-1|ap-southeast-2|ap-northeast-1', // REQUIRED
'TimeUnit' => 'HOURLY|DAILY', // REQUIRED
],
]);
Parameter Details
Members
- ReportDefinition
-
- Required: Yes
- Type: ReportDefinition structure
The definition of AWS Cost and Usage Report. Customer can specify the report name, time unit, report format, compression format, S3 bucket and additional artifacts and schema elements in the definition.
Result Syntax
[]
Result Details
Errors
-
DuplicateReportNameException: This exception is thrown when putting a report preference with a name that already exists.
-
ReportLimitReachedException: This exception is thrown when the number of report preference reaches max limit. The max number is 5.
-
InternalErrorException: This exception is thrown on a known dependency failure.
-
ValidationException: This exception is thrown when providing an invalid input. eg. Put a report preference with an invalid report name, or Delete a report preference with an empty report name.
Shapes
DuplicateReportNameException
Description
Members
InternalErrorException
Description
Members
ReportDefinition
Description
Members
- AdditionalArtifacts
-
- Type: Array of strings
A list of additional artifacts. - AdditionalSchemaElements
-
- Type: Array of strings
A list of schema elements. - Compression
-
- Type: string
Preferred compression format for report. - Format
-
- Type: string
Preferred format for report. - ReportName
-
- Type: string
Preferred name for a report, it has to be unique. Must starts with a number/letter, case sensitive. Limited to 256 characters. - S3Bucket
-
- Type: string
Name of customer S3 bucket. - S3Prefix
-
- Type: string
Preferred report path prefix. Limited to 256 characters. - S3Region
-
- Type: string
Region of customer S3 bucket. - TimeUnit
-
- Type: string
The frequency on which report data are measured and displayed.
