Skip to content

Lists workflow versions based on filtering parameters

Description

Lists workflow versions based on filtering parameters. To list the build versions of a specific workflow version, call list_workflow_build_versions.

Usage

imagebuilder_list_workflows(owner, filters, byName, maxResults,
  nextToken)

Arguments

  • owner

    Filters results based on the workflow owner. By default, this request returns the workflows that your account owns (Self). Specify Amazon to list the workflows that Image Builder manages. Image Builder rejects the Shared and ThirdParty owner values for workflows, and AWSMarketplace returns no results.

  • filters

    Filters to narrow the list of workflows. You can filter on name, version, description, and type.

  • byName

    Specifies whether to return one entry per workflow name, with all versions of each workflow aggregated. Defaults to false, which returns one entry per workflow version. You can't combine this option with the version filter.

  • maxResults

    The maximum number of items to return in a single request.

  • nextToken

    A token to specify where to start paginating. Use the nextToken value from a previously truncated response.

Value

A list with the following syntax:

list(
  workflowVersionList = list(
    list(
      arn = "string",
      name = "string",
      version = "string",
      description = "string",
      type = "BUILD"|"TEST"|"DISTRIBUTION",
      owner = "string",
      dateCreated = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_workflows(
  owner = "Self"|"Shared"|"Amazon"|"ThirdParty"|"AWSMarketplace",
  filters = list(
    list(
      name = "string",
      values = list(
        "string"
      )
    )
  ),
  byName = TRUE|FALSE,
  maxResults = 123,
  nextToken = "string"
)