Skip to content

list_executions async

list_executions(
    target_resource_type: TargetResourceType,
    target_resource_id: ID,
    *,
    config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None,
    resolve_to_resource_type: Optional[ResolveToResourceType] = None,
    resolve_to_resource_id: Optional[ID] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
    action_type: Optional[Name] = None,
) -> ListExecutionsResponse

Retrieves a paginated list of summaries of all executions.

Parameters:

  • target_resource_type (TargetResourceType) –

    The type of the target resource.

  • target_resource_id (ID) –

    The ID of the target resource.

  • resolve_to_resource_type (Optional[ResolveToResourceType], default: None ) –

    The type of the resolved resource.

  • resolve_to_resource_id (Optional[ID], default: None ) –

    The ID of the resolved resource.

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

    The token used for the next set of paginated results.

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

    The maximum number of results returned for each paginated request.

  • action_type (Optional[Name], default: None ) –

    The type of action exectued.

Raises:

  • InternalFailureException –

    IoT SiteWise can't process your request right now. Try again later.

  • InvalidRequestException –

    The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException –

    The requested resource can't be found.

  • ThrottlingException –

    Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

    For more information, see Quotas in the IoT SiteWise User Guide.

  • UnknownServiceError –

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

Source code in docs_src/capo_iotsitewise/_services/async_io_t_site_wise.py
async def list_executions(
    self,
    target_resource_type: "capo_iotsitewise.types.target_resource_type.TargetResourceType",
    target_resource_id: "capo_iotsitewise.types.id.ID",
    *,
    config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None,
    resolve_to_resource_type: Optional[
        "capo_iotsitewise.types.resolve_to_resource_type.ResolveToResourceType"
    ] = None,
    resolve_to_resource_id: Optional["capo_iotsitewise.types.id.ID"] = None,
    next_token: Optional["capo_iotsitewise.types.next_token.NextToken"] = None,
    max_results: Optional["capo_iotsitewise.types.max_results.MaxResults"] = None,
    action_type: Optional["capo_iotsitewise.types.name.Name"] = None,
) -> "capo_iotsitewise.types.list_executions_response.ListExecutionsResponse":
    """<p>Retrieves a paginated list of summaries of all executions.</p>

    Args:
        target_resource_type: <p>The type of the target resource.</p>
        target_resource_id: <p>The ID of the target resource.</p>
        resolve_to_resource_type: <p>The type of the resolved resource.</p>
        resolve_to_resource_id: <p>The ID of the resolved resource.</p>
        next_token: <p>The token used for the next set of paginated results.</p>
        max_results: <p>The maximum number of results returned for each paginated request.</p>
        action_type: <p>The type of action exectued.</p>

    Raises:
        capo_iotsitewise.errors.internal_failure_exception.InternalFailureException: <p>IoT SiteWise can't process your request right now. Try again later.</p>
        capo_iotsitewise.errors.invalid_request_exception.InvalidRequestException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.</p>
        capo_iotsitewise.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_iotsitewise.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        capo_iotsitewise.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iotsitewise.types.list_executions_request.ListExecutionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_iotsitewise.types.list_executions_response.ListExecutionsResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.list_executions

        (
            output,
            http_response,
        ) = await capo_iotsitewise._operations.aws_io_t_site_wise.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_iotsitewise.types.list_executions_request.ListExecutionsRequest = {
        "target_resource_type": target_resource_type,
        "target_resource_id": target_resource_id,
    }
    if resolve_to_resource_type is not None:
        input_["resolve_to_resource_type"] = resolve_to_resource_type
    if resolve_to_resource_id is not None:
        input_["resolve_to_resource_id"] = resolve_to_resource_id
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if action_type is not None:
        input_["action_type"] = action_type

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