Retrieves a component object¶

Description¶

Retrieves a component object.

Usage¶

imagebuilder_get_component(componentBuildVersionArn)

Arguments¶

componentBuildVersionArn

[required] The Amazon Resource Name (ARN) of the component that you want to get. You can specify a build version ARN, or a component version ARN. The version can use the x wildcard in trailing positions, for example 1.0.x or 1.x.x. Version ARNs resolve to the latest available matching component build version.

Value¶

A list with the following syntax:

list(
  requestId = "string",
  component = list(
    arn = "string",
    name = "string",
    version = "string",
    description = "string",
    changeDescription = "string",
    type = "BUILD"|"TEST",
    platform = "Windows"|"Linux"|"macOS",
    supportedOsVersions = list(
      "string"
    ),
    state = list(
      status = "DEPRECATED"|"DISABLED"|"ACTIVE",
      reason = "string"
    ),
    parameters = list(
      list(
        name = "string",
        type = "string",
        defaultValue = list(
          "string"
        ),
        description = "string"
      )
    ),
    owner = "string",
    data = "string",
    kmsKeyId = "string",
    encrypted = TRUE|FALSE,
    dateCreated = "string",
    tags = list(
      "string"
    ),
    publisher = "string",
    obfuscate = TRUE|FALSE,
    productCodes = list(
      list(
        productCodeId = "string",
        productCodeType = "marketplace"
      )
    )
  ),
  latestVersionReferences = list(
    latestVersionArn = "string",
    latestMajorVersionArn = "string",
    latestMinorVersionArn = "string",
    latestPatchVersionArn = "string"
  )
)

Request syntax¶

svc$get_component(
  componentBuildVersionArn = "string"
)