list_workflow_executions `async` ¶

list_workflow_executions(
    image_build_version_arn: ImageBuildVersionArn,
    *,
    config_overrides: Optional[AsyncimagebuilderClientConfig] = None,
    max_results: Optional[RestrictedInteger] = None,
    next_token: Optional[PaginationToken] = None,
) -> ListWorkflowExecutionsResponse

Returns a list of workflow runtime instance metadata objects for a specific image build version.

Parameters:

max_results (Optional[RestrictedInteger], default: None ) –

The maximum number of items to return in a single request.
next_token (Optional[PaginationToken], default: None ) –

A token to specify where to start paginating. Use the nextToken value from a previously truncated response.
image_build_version_arn (ImageBuildVersionArn) –

List all workflow runtime instances for the specified image build version resource ARN.

Raises:

CallRateLimitExceededException –

You have exceeded the permitted request rate for the Amazon EC2 APIs that Image Builder calls on your behalf. Retry with an increasing or variable delay between requests.
ClientException –

A generic client error. This error usually indicates that the request failed a validation check, such as when a downstream service rejects a configured value.
ForbiddenException –

You are not authorized to perform the requested operation.
InvalidPaginationTokenException –

You have provided an invalid pagination token in your request.
InvalidRequestException –

The request is malformed or otherwise invalid. Verify the request and try again.
ServiceException –

An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
ServiceUnavailableException –

The service is unable to process your request at this time.
UnknownServiceError –

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

Examples:

List the workflow runtime instances for an image build version The following example lists the workflow runtime instances that ran for the specified image build version, which was built with the Image Builder default build and test workflows.

>>> await client.list_workflow_executions(image_build_version_arn='arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1')

Source code in docs_src/capo_imagebuilder/_services/async_imagebuilder.py

async def list_workflow_executions(
    self,
    image_build_version_arn: "capo_imagebuilder.types.image_build_version_arn.ImageBuildVersionArn",
    *,
    config_overrides: Optional[AsyncimagebuilderClientConfig] = None,
    max_results: Optional[
        "capo_imagebuilder.types.restricted_integer.RestrictedInteger"
    ] = None,
    next_token: Optional[
        "capo_imagebuilder.types.pagination_token.PaginationToken"
    ] = None,
) -> "capo_imagebuilder.types.list_workflow_executions_response.ListWorkflowExecutionsResponse":
    """<p>Returns a list of workflow runtime instance metadata objects for a specific image build version.</p>

    Args:
        max_results: <p>The maximum number of items to return in a single request.</p>
        next_token: <p>A token to specify where to start paginating. Use the <code>nextToken</code> value from a previously truncated response.</p>
        image_build_version_arn: <p>List all workflow runtime instances for the specified image build version resource ARN.</p>

    Raises:
        capo_imagebuilder.errors.call_rate_limit_exceeded_exception.CallRateLimitExceededException: <p>You have exceeded the permitted request rate for the Amazon EC2 APIs that Image Builder calls on your behalf. Retry with an increasing or variable delay between requests.</p>
        capo_imagebuilder.errors.client_exception.ClientException: <p>A generic client error. This error usually indicates that the request failed a validation check, such as when a downstream service rejects a configured value.</p>
        capo_imagebuilder.errors.forbidden_exception.ForbiddenException: <p>You are not authorized to perform the requested operation.</p>
        capo_imagebuilder.errors.invalid_pagination_token_exception.InvalidPaginationTokenException: <p>You have provided an invalid pagination token in your request.</p>
        capo_imagebuilder.errors.invalid_request_exception.InvalidRequestException: <p>The request is malformed or otherwise invalid. Verify the request and try again.</p>
        capo_imagebuilder.errors.service_exception.ServiceException: <p>An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.</p>
        capo_imagebuilder.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is unable to process your request at this time.</p>
        capo_imagebuilder.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        List the workflow runtime instances for an image build version
        The following example lists the workflow runtime instances that ran for the specified image build version, which was built with the Image Builder default build and test workflows.

        >>> await client.list_workflow_executions(image_build_version_arn='arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_imagebuilder.types.list_workflow_executions_request.ListWorkflowExecutionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_imagebuilder.types.list_workflow_executions_response.ListWorkflowExecutionsResponse"
    ]:
        import capo_imagebuilder._operations.imagebuilder.list_workflow_executions

        (
            output,
            http_response,
        ) = await capo_imagebuilder._operations.imagebuilder.list_workflow_executions.async_list_workflow_executions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListWorkflowExecutions")
    )
    input_: capo_imagebuilder.types.list_workflow_executions_request.ListWorkflowExecutionsRequest = {
        "image_build_version_arn": image_build_version_arn
    }
    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_workflow_executions async ¶

list_workflow_executions `async` ¶