CreateCapacityManagerDataExport
Creates a new data export configuration for EC2 Capacity Manager. This allows you to automatically export capacity usage data to an S3 bucket on a scheduled basis. The exported data includes metrics for On-Demand, Spot, and Capacity Reservations usage across your organization.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- ClientToken
-
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
Type: String
Required: No
- DryRun
-
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation. Otherwise, it isUnauthorizedOperation.Type: Boolean
Required: No
- OutputFormat
-
The file format for the exported data. Parquet format is recommended for large datasets and better compression.
Type: String
Valid Values:
csv | parquetRequired: Yes
- S3BucketName
-
The name of the S3 bucket where the capacity data export files will be delivered. The bucket must exist and you must have write permissions to it.
Type: String
Required: Yes
- S3BucketPrefix
-
The S3 key prefix for the exported data files. This allows you to organize exports in a specific folder structure within your bucket. If not specified, files are placed at the bucket root.
Type: String
Required: No
- Schedule
-
The frequency at which data exports are generated.
Type: String
Valid Values:
hourlyRequired: Yes
- TagSpecification.N
-
The tags to apply to the data export configuration. You can tag the export for organization and cost tracking purposes.
Type: Array of TagSpecification objects
Required: No
Response Elements
The following elements are returned by the service.
- capacityManagerDataExportId
-
The unique identifier for the created data export configuration. Use this ID to reference the export in other API calls.
Type: String
- requestId
-
The ID of the request.
Type: String
Errors
For information about the errors that are common to all actions, see Common client error codes.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
