Skip to content

list_import_tasks

list_import_tasks(
    *,
    config_overrides: Optional[NeptuneGraphClientConfig] = None,
    graph_identifier: Optional[GraphIdentifier] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListImportTasksOutput

Lists import tasks.

Parameters:

  • graph_identifier (Optional[GraphIdentifier], default: None ) –

    The unique identifier of the Neptune Analytics graph. When provided, the service returns only import tasks associated with this graph. If not specified, the service returns all import tasks.

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

    Pagination token used to paginate output.

    When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.

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

    The total number of records to return in the command's output.

    If the total number of records available is more than the value specified, nextToken is provided in the command's output. To resume pagination, provide the nextToken output value in the nextToken argument of a subsequent command. Do not use the nextToken response element directly outside of the Amazon CLI.

Raises:

Source code in docs_src/capo_neptune_graph/_services/neptune_graph.py
def list_import_tasks(
    self,
    *,
    config_overrides: Optional[NeptuneGraphClientConfig] = None,
    graph_identifier: Optional[
        "capo_neptune_graph.types.graph_identifier.GraphIdentifier"
    ] = None,
    next_token: Optional[
        "capo_neptune_graph.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional["capo_neptune_graph.types.max_results.MaxResults"] = None,
) -> "capo_neptune_graph.types.list_import_tasks_output.ListImportTasksOutput":
    """<p>Lists import tasks.</p>

    Args:
        graph_identifier: <p>The unique identifier of the Neptune Analytics graph. When provided, the service returns only import tasks associated with this graph. If not specified, the service returns all import tasks.</p>
        next_token: <p>Pagination token used to paginate output.</p> <p>When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.</p>
        max_results: <p>The total number of records to return in the command's output.</p> <p>If the total number of records available is more than the value specified, <code>nextToken</code> is provided in the command's output. To resume pagination, provide the <code>nextToken</code> output value in the <code>nextToken</code> argument of a subsequent command. Do not use the <code>nextToken</code> response element directly outside of the Amazon CLI.</p>

    Raises:
        capo_neptune_graph.errors.internal_server_exception.InternalServerException: <p>A failure occurred on the server.</p>
        capo_neptune_graph.errors.resource_not_found_exception.ResourceNotFoundException: <p>A specified resource could not be located.</p>
        capo_neptune_graph.errors.throttling_exception.ThrottlingException: <p>The exception was interrupted by throttling.</p>
        capo_neptune_graph.errors.validation_exception.ValidationException: <p>A resource could not be validated.</p>
        capo_neptune_graph.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_neptune_graph.types.list_import_tasks_input.ListImportTasksInput]",
    ) -> OperationResponse[
        "capo_neptune_graph.types.list_import_tasks_output.ListImportTasksOutput"
    ]:
        import capo_neptune_graph._operations.amazon_neptune_graph.list_import_tasks

        output, http_response = (
            capo_neptune_graph._operations.amazon_neptune_graph.list_import_tasks.list_import_tasks(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListImportTasks")
    )
    input_: capo_neptune_graph.types.list_import_tasks_input.ListImportTasksInput = {}
    if graph_identifier is not None:
        input_["graph_identifier"] = graph_identifier
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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