Skip to content

EC2  >  Operations  >  create_capacity_manager_data_export

create_capacity_manager_data_export

Operation

create_capacity_manager_data_export async 

create_capacity_manager_data_export(input: CreateCapacityManagerDataExportInput, plugins: list[Plugin] | None = None) -> CreateCapacityManagerDataExportOutput

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.

Parameters:

Name Type Description Default
input CreateCapacityManagerDataExportInput

An instance of CreateCapacityManagerDataExportInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
CreateCapacityManagerDataExportOutput

An instance of CreateCapacityManagerDataExportOutput.

Input

CreateCapacityManagerDataExportInput dataclass

Bases: _SerdeShape

Dataclass for CreateCapacityManagerDataExportInput structure.

Attributes

client_token class-attribute instance-attribute 
client_token: str | None = ...

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

This field is autopopulated if not provided.

dry_run class-attribute instance-attribute 
dry_run: bool | None = ...

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 is UnauthorizedOperation.

output_format class-attribute instance-attribute 
output_format: str | None = ...

The file format for the exported data. Parquet format is recommended for large datasets and better compression.

s3_bucket_name class-attribute instance-attribute 
s3_bucket_name: str | None = ...

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.

s3_bucket_prefix class-attribute instance-attribute 
s3_bucket_prefix: str | None = ...

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.

schedule class-attribute instance-attribute 
schedule: str | None = ...

The frequency at which data exports are generated.

tag_specifications class-attribute instance-attribute 
tag_specifications: list[TagSpecification] | None = ...

The tags to apply to the data export configuration. You can tag the export for organization and cost tracking purposes.

Output

CreateCapacityManagerDataExportOutput dataclass

Bases: _SerdeShape

Dataclass for CreateCapacityManagerDataExportOutput structure.

Attributes

capacity_manager_data_export_id class-attribute instance-attribute 
capacity_manager_data_export_id: str | None = ...

The unique identifier for the created data export configuration. Use this ID to reference the export in other API calls.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.