Returns the list of components that you have access to¶

Description¶

Returns the list of components that you have access to. By default, the response doesn't include components in the DEPRECATED state. To list deprecated components, use the status filter with the value DEPRECATED.

The semantic version has four nodes: \<major>.\<minor>.\<patch>/\<build>. You can assign values for the first three, and can filter on all of them.

Filtering: You can use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

Usage¶

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

Arguments¶

• owner

  Filters results based on the type of owner for the component. By default, this request returns a list of components that your account owns. To see results for other types of owners, you can specify components that Amazon manages, components from the Amazon Web Services Marketplace, third party components, or components that other accounts have shared with you.

• filters

  Use the following filters to streamline results:

  • description
  • name
  • platform
  • productCodes
  • status
  • supportedOsVersion
  • type
  • version

• byName

  Specifies whether to return one entry per component name, with all versions of each component aggregated. Defaults to false, which returns one entry per component 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(
  requestId = "string",
  componentVersionList = list(
    list(
      arn = "string",
      name = "string",
      version = "string",
      description = "string",
      platform = "Windows"|"Linux"|"macOS",
      supportedOsVersions = list(
        "string"
      ),
      type = "BUILD"|"TEST",
      owner = "string",
      dateCreated = "string",
      status = "DEPRECATED"|"DISABLED"|"ACTIVE",
      productCodes = list(
        list(
          productCodeId = "string",
          productCodeType = "marketplace"
        )
      )
    )
  ),
  nextToken = "string"
)

Request syntax¶

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