Skip to content

describe_import_tasks async

describe_import_tasks(
    *,
    config_overrides: Optional[AsyncCloudWatchLogsClientConfig] = None,
    import_id: Optional[ImportId] = None,
    import_status: Optional[ImportStatus] = None,
    import_source_arn: Optional[Arn] = None,
    limit: Optional[DescribeLimit] = None,
    next_token: Optional[NextToken] = None,
) -> DescribeImportTasksResponse

Lists and describes import tasks, with optional filtering by import status and source ARN.

Parameters:

  • import_id (Optional[ImportId], default: None ) –

    Optional filter to describe a specific import task by its ID.

  • import_status (Optional[ImportStatus], default: None ) –

    Optional filter to list imports by their status. Valid values are IN_PROGRESS, CANCELLED, COMPLETED and FAILED.

  • import_source_arn (Optional[Arn], default: None ) –

    Optional filter to list imports from a specific source

  • limit (Optional[DescribeLimit], default: None ) –

    The maximum number of import tasks to return in the response. Default: 50

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

    The pagination token for the next set of results.

Raises:

Source code in docs_src/capo_cloudwatch_logs/_services/async_cloud_watch_logs.py
async def describe_import_tasks(
    self,
    *,
    config_overrides: Optional[AsyncCloudWatchLogsClientConfig] = None,
    import_id: Optional["capo_cloudwatch_logs.types.import_id.ImportId"] = None,
    import_status: Optional[
        "capo_cloudwatch_logs.types.import_status.ImportStatus"
    ] = None,
    import_source_arn: Optional["capo_cloudwatch_logs.types.arn.Arn"] = 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_tasks_response.DescribeImportTasksResponse":
    """<p>Lists and describes import tasks, with optional filtering by import status and source ARN.</p>

    Args:
        import_id: <p>Optional filter to describe a specific import task by its ID.</p>
        import_status: <p>Optional filter to list imports by their status. Valid values are IN_PROGRESS, CANCELLED, COMPLETED and FAILED.</p>
        import_source_arn: <p>Optional filter to list imports from a specific source</p>
        limit: <p>The maximum number of import tasks to return in the response. Default: 50</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cloudwatch_logs.types.describe_import_tasks_request.DescribeImportTasksRequest]",
    ) -> AsyncOperationResponse[
        "capo_cloudwatch_logs.types.describe_import_tasks_response.DescribeImportTasksResponse"
    ]:
        import capo_cloudwatch_logs._operations.logs_20140328.describe_import_tasks

        (
            output,
            http_response,
        ) = await capo_cloudwatch_logs._operations.logs_20140328.describe_import_tasks.async_describe_import_tasks(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeImportTasks")
    )
    input_: capo_cloudwatch_logs.types.describe_import_tasks_request.DescribeImportTasksRequest = {}
    if import_id is not None:
        input_["import_id"] = import_id
    if import_status is not None:
        input_["import_status"] = import_status
    if import_source_arn is not None:
        input_["import_source_arn"] = import_source_arn
    if limit is not None:
        input_["limit"] = limit
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output