list_workflows ¶

def list_workflows(
    self,
    *,
    config_overrides: Optional[imagebuilderClientConfig] = None,
    owner: Optional["capo_imagebuilder.types.ownership.Ownership"] = None,
    filters: Optional["capo_imagebuilder.types.filter_list.FilterList"] = None,
    by_name: Optional["capo_imagebuilder.types.boolean.Boolean"] = 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_workflows_response.ListWorkflowsResponse":
    """<p>Lists workflow versions based on filtering parameters. To list the build versions of a specific workflow version, call <a>ListWorkflowBuildVersions</a>.</p>

    Args:
        owner: <p>Filters results based on the workflow owner. By default, this request returns the workflows that your account owns (<code>Self</code>). Specify <code>Amazon</code> to list the workflows that Image Builder manages. Image Builder rejects the <code>Shared</code> and <code>ThirdParty</code> owner values for workflows, and <code>AWSMarketplace</code> returns no results.</p>
        filters: <p>Filters to narrow the list of workflows. You can filter on <code>name</code>, <code>version</code>, <code>description</code>, and <code>type</code>.</p>
        by_name: <p>Specifies whether to return one entry per workflow name, with all versions of each workflow aggregated. Defaults to <code>false</code>, which returns one entry per workflow version. You can't combine this option with the <code>version</code> filter.</p>
        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>

    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 workflows that you own
        The following example lists the workflow versions that you own.

        >>> client.list_workflows(owner='Self')
    """

    def _handler(
        req: "OperationRequest[capo_imagebuilder.types.list_workflows_request.ListWorkflowsRequest]",
    ) -> OperationResponse[
        "capo_imagebuilder.types.list_workflows_response.ListWorkflowsResponse"
    ]:
        import capo_imagebuilder._operations.imagebuilder.list_workflows

        output, http_response = (
            capo_imagebuilder._operations.imagebuilder.list_workflows.list_workflows(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListWorkflows")
    )
    input_: capo_imagebuilder.types.list_workflows_request.ListWorkflowsRequest = {}
    if owner is not None:
        input_["owner"] = owner
    if filters is not None:
        input_["filters"] = filters
    if by_name is not None:
        input_["by_name"] = by_name
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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