Skip to content

describe_capacity_manager_data_exports

describe_capacity_manager_data_exports(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    capacity_manager_data_export_ids: Optional[CapacityManagerDataExportIdSet] = None,
    max_results: Optional[DescribeCapacityManagerDataExportsRequestMaxResults] = None,
    next_token: Optional[String] = None,
    dry_run: Optional[Boolean] = None,
    filters: Optional[FilterList] = None,
) -> DescribeCapacityManagerDataExportsResult

Describes one or more Capacity Manager data export configurations. Returns information about export settings, delivery status, and recent export activity.

Parameters:

  • capacity_manager_data_export_ids (Optional[CapacityManagerDataExportIdSet], default: None ) –

    The IDs of the data export configurations to describe. If not specified, all export configurations are returned.

  • max_results (Optional[DescribeCapacityManagerDataExportsRequestMaxResults], default: None ) –

    The maximum number of results to return in a single call. If not specified, up to 1000 results are returned.

  • next_token (Optional[String], default: None ) –

    The token for the next page of results. Use this value in a subsequent call to retrieve additional results.

  • dry_run (Optional[Boolean], default: 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.

  • filters (Optional[FilterList], default: None ) –

    One or more filters to narrow the results. Supported filters include export status, creation date, and S3 bucket name.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def describe_capacity_manager_data_exports(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    capacity_manager_data_export_ids: Optional[
        "capo_ec2.types.capacity_manager_data_export_id_set.CapacityManagerDataExportIdSet"
    ] = None,
    max_results: Optional[
        "capo_ec2.types.describe_capacity_manager_data_exports_request_max_results.DescribeCapacityManagerDataExportsRequestMaxResults"
    ] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
) -> "capo_ec2.types.describe_capacity_manager_data_exports_result.DescribeCapacityManagerDataExportsResult":
    """<p> Describes one or more Capacity Manager data export configurations. Returns information about export settings, delivery status, and recent export activity. </p>

    Args:
        capacity_manager_data_export_ids: <p> The IDs of the data export configurations to describe. If not specified, all export configurations are returned. </p>
        max_results: <p> The maximum number of results to return in a single call. If not specified, up to 1000 results are returned. </p>
        next_token: <p> The token for the next page of results. Use this value in a subsequent call to retrieve additional results. </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>
        filters: <p> One or more filters to narrow the results. Supported filters include export status, creation date, and S3 bucket name. </p>

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

    def _handler(
        req: "OperationRequest[capo_ec2.types.describe_capacity_manager_data_exports_request.DescribeCapacityManagerDataExportsRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_capacity_manager_data_exports_result.DescribeCapacityManagerDataExportsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_capacity_manager_data_exports

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeCapacityManagerDataExports")
    )
    input_: capo_ec2.types.describe_capacity_manager_data_exports_request.DescribeCapacityManagerDataExportsRequest = {}
    if capacity_manager_data_export_ids is not None:
        input_["capacity_manager_data_export_ids"] = (
            capacity_manager_data_export_ids
        )
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if filters is not None:
        input_["filters"] = filters

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