Skip to content

list_tasks async

list_tasks(
    *,
    config_overrides: Optional[AsyncSnowDeviceManagementClientConfig] = None,
    state: Optional[TaskState] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListTasksOutput

Returns a list of tasks that can be filtered by state.

Parameters:

  • state (Optional[TaskState], default: None ) –

    A structure used to filter the list of tasks.

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

    The maximum number of tasks per page.

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

    A pagination token to continue to the next page of tasks.

Raises:

Source code in docs_src/capo_snow_device_management/_services/async_snow_device_management.py
async def list_tasks(
    self,
    *,
    config_overrides: Optional[AsyncSnowDeviceManagementClientConfig] = None,
    state: Optional[
        "capo_snow_device_management.types.task_state.TaskState"
    ] = None,
    max_results: Optional[
        "capo_snow_device_management.types.max_results.MaxResults"
    ] = None,
    next_token: Optional[
        "capo_snow_device_management.types.next_token.NextToken"
    ] = None,
) -> "capo_snow_device_management.types.list_tasks_output.ListTasksOutput":
    """<p>Returns a list of tasks that can be filtered by state.</p>

    Args:
        state: <p>A structure used to filter the list of tasks.</p>
        max_results: <p>The maximum number of tasks per page.</p>
        next_token: <p>A pagination token to continue to the next page of tasks.</p>

    Raises:
        capo_snow_device_management.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action.</p>
        capo_snow_device_management.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred while processing the request.</p>
        capo_snow_device_management.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_snow_device_management.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_snow_device_management.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_snow_device_management.types.list_tasks_input.ListTasksInput]",
    ) -> AsyncOperationResponse[
        "capo_snow_device_management.types.list_tasks_output.ListTasksOutput"
    ]:
        import capo_snow_device_management._operations.snow_device_management.list_tasks

        (
            output,
            http_response,
        ) = await capo_snow_device_management._operations.snow_device_management.list_tasks.async_list_tasks(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListTasks")
    )
    input_: capo_snow_device_management.types.list_tasks_input.ListTasksInput = {}
    if state is not None:
        input_["state"] = state
    if max_results is not None:
        input_["max_results"] = max_results
    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