create_capacity_manager_data_export ¶

def create_capacity_manager_data_export(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    s3_bucket_name: Optional["capo_ec2.types.string.String"] = None,
    s3_bucket_prefix: Optional["capo_ec2.types.string.String"] = None,
    schedule: Optional["capo_ec2.types.schedule.Schedule"] = None,
    output_format: Optional["capo_ec2.types.output_format.OutputFormat"] = None,
    client_token: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    tag_specifications: Optional[
        "capo_ec2.types.tag_specification_list.TagSpecificationList"
    ] = None,
) -> "capo_ec2.types.create_capacity_manager_data_export_result.CreateCapacityManagerDataExportResult":
    """<p> 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. </p>

    Args:
        s3_bucket_name: <p> 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. </p>
        s3_bucket_prefix: <p> 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. </p>
        schedule: <p> The frequency at which data exports are generated. </p>
        output_format: <p> The file format for the exported data. Parquet format is recommended for large datasets and better compression. </p>
        client_token: <p> Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency. </p>
        dry_run: <p> 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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>. </p>
        tag_specifications: <p> The tags to apply to the data export configuration. You can tag the export for organization and cost tracking purposes. </p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.create_capacity_manager_data_export_request.CreateCapacityManagerDataExportRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.create_capacity_manager_data_export_result.CreateCapacityManagerDataExportResult"
    ]:
        import capo_ec2._operations.amazon_ec2.create_capacity_manager_data_export

        output, http_response = (
            capo_ec2._operations.amazon_ec2.create_capacity_manager_data_export.create_capacity_manager_data_export(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateCapacityManagerDataExport")
    )
    input_: capo_ec2.types.create_capacity_manager_data_export_request.CreateCapacityManagerDataExportRequest = {}
    if s3_bucket_name is not None:
        input_["s3_bucket_name"] = s3_bucket_name
    if s3_bucket_prefix is not None:
        input_["s3_bucket_prefix"] = s3_bucket_prefix
    if schedule is not None:
        input_["schedule"] = schedule
    if output_format is not None:
        input_["output_format"] = output_format
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if tag_specifications is not None:
        input_["tag_specifications"] = tag_specifications

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output