describe_import_task_batches ¶

def describe_import_task_batches(
    self,
    import_id: "capo_cloudwatch_logs.types.import_id.ImportId",
    *,
    config_overrides: Optional[CloudWatchLogsClientConfig] = None,
    batch_import_status: Optional[
        "capo_cloudwatch_logs.types.import_status_list.ImportStatusList"
    ] = None,
    limit: Optional[
        "capo_cloudwatch_logs.types.describe_limit.DescribeLimit"
    ] = None,
    next_token: Optional["capo_cloudwatch_logs.types.next_token.NextToken"] = None,
) -> "capo_cloudwatch_logs.types.describe_import_task_batches_response.DescribeImportTaskBatchesResponse":
    """<p>Gets detailed information about the individual batches within an import task, including their status and any error messages. For CloudTrail Event Data Store sources, a batch refers to a subset of stored events grouped by their eventTime. </p>

    Args:
        import_id: <p>The ID of the import task to get batch information for.</p>
        batch_import_status: <p>Optional filter to list import batches by their status. Accepts multiple status values: IN_PROGRESS, CANCELLED, COMPLETED and FAILED.</p>
        limit: <p>The maximum number of import batches to return in the response. Default: 10</p>
        next_token: <p>The pagination token for the next set of results.</p>

    Raises:
        capo_cloudwatch_logs.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient permissions to perform this action.</p>
        capo_cloudwatch_logs.errors.invalid_operation_exception.InvalidOperationException: <p>The operation is not valid on the specified resource.</p>
        capo_cloudwatch_logs.errors.invalid_parameter_exception.InvalidParameterException: <p>A parameter is specified incorrectly.</p>
        capo_cloudwatch_logs.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_cloudwatch_logs.errors.throttling_exception.ThrottlingException: <p>The request was throttled because of quota limits.</p>
        capo_cloudwatch_logs.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cloudwatch_logs.types.describe_import_task_batches_request.DescribeImportTaskBatchesRequest]",
    ) -> OperationResponse[
        "capo_cloudwatch_logs.types.describe_import_task_batches_response.DescribeImportTaskBatchesResponse"
    ]:
        import capo_cloudwatch_logs._operations.logs_20140328.describe_import_task_batches

        output, http_response = (
            capo_cloudwatch_logs._operations.logs_20140328.describe_import_task_batches.describe_import_task_batches(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeImportTaskBatches")
    )
    input_: capo_cloudwatch_logs.types.describe_import_task_batches_request.DescribeImportTaskBatchesRequest = {
        "import_id": import_id
    }
    if batch_import_status is not None:
        input_["batch_import_status"] = batch_import_status
    if limit is not None:
        input_["limit"] = limit
    if next_token is not None:
        input_["next_token"] = next_token

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