Skip to content

List Components

imagebuilder_list_components R Documentation

Returns the list of components that can be filtered by name, or by using the listed filters to streamline results

Description

Returns the list of components that can be filtered by name, or by using the listed filters to streamline results. Newly created components can take up to two minutes to appear in the ListComponents API Results.

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: With semantic versioning, you have the flexibility to 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, third party components, or components that other accounts have shared with you.

filters

Use the following filters to streamline results:

  • description

  • name

  • platform

  • supportedOsVersion

  • type

  • version

byName

Returns the list of components for the specified name.

maxResults

The maximum items to return in a request.

nextToken

A token to specify where to start paginating. This is the nextToken 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",
      supportedOsVersions = list(
        "string"
      ),
      type = "BUILD"|"TEST",
      owner = "string",
      dateCreated = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

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