list_executions `async` ¶

list_executions(
    task_id: TaskId,
    *,
    config_overrides: Optional[AsyncSnowDeviceManagementClientConfig] = None,
    state: Optional[ExecutionState] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListExecutionsOutput

Returns the status of tasks for one or more target devices.

Parameters:

task_id (TaskId) –

The ID of the task.
state (Optional[ExecutionState], default: None ) –

A structure used to filter the tasks by their current state.
max_results (Optional[MaxResults], default: None ) –

The maximum number of tasks to list per page.
next_token (Optional[NextToken], default: None ) –

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

Raises:

AccessDeniedException –

You don't have sufficient access to perform this action.
InternalServerException –

An unexpected error occurred while processing the request.
ResourceNotFoundException –

The request references a resource that doesn't exist.
ThrottlingException –

The request was denied due to request throttling.
ValidationException –

The input fails to satisfy the constraints specified by an Amazon Web Services service.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_snow_device_management/_services/async_snow_device_management.py

async def list_executions(
    self,
    task_id: "capo_snow_device_management.types.task_id.TaskId",
    *,
    config_overrides: Optional[AsyncSnowDeviceManagementClientConfig] = None,
    state: Optional[
        "capo_snow_device_management.types.execution_state.ExecutionState"
    ] = 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_executions_output.ListExecutionsOutput"
):
    """<p>Returns the status of tasks for one or more target devices.</p>

    Args:
        task_id: <p>The ID of the task.</p>
        state: <p>A structure used to filter the tasks by their current state.</p>
        max_results: <p>The maximum number of tasks to list 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.resource_not_found_exception.ResourceNotFoundException: <p>The request references a resource that doesn't exist.</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_executions_input.ListExecutionsInput]",
    ) -> AsyncOperationResponse[
        "capo_snow_device_management.types.list_executions_output.ListExecutionsOutput"
    ]:
        import capo_snow_device_management._operations.snow_device_management.list_executions

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListExecutions")
    )
    input_: capo_snow_device_management.types.list_executions_input.ListExecutionsInput = {
        "task_id": task_id
    }
    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

list_executions async ¶

list_executions `async` ¶