[ aws . imagebuilder ]

get-component

Description

Gets a component object.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-component
--component-build-version-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--component-build-version-arn (string)

The Amazon Resource Name (ARN) of the component that you want to retrieve. Regex requires “/d+$” suffix.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To get component details

The following get-component example lists the details of a component by specifying its ARN.

aws imagebuilder get-component \
    --component-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:component/component-name/1.0.0/1

Output:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "component": {
        "arn": "arn:aws:imagebuilder:us-west-2:123456789012:component/component-name/1.0.0/1",
        "name": "component-name",
        "version": "1.0.0",
        "type": "TEST",
        "platform": "Linux",
        "owner": "123456789012",
        "data": "name: HelloWorldTestingDocument\ndescription: This is hello world testing document.\nschemaVersion: 1.0\n\nphases:\n  - name: test\n    steps:\n      - name: HelloWorldStep\n        action: ExecuteBash\n        inputs:\n          commands:\n            - echo \"Hello World! Test.\"\n",
        "encrypted": true,
        "dateCreated": "2020-01-27T20:43:30.306Z",
        "tags": {}
    }
}

For more information, see Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI in the EC2 Image Builder Users Guide.

Output

requestId -> (string)

The request ID that uniquely identifies this request.

component -> (structure)

The component object associated with the specified ARN.

arn -> (string)

The Amazon Resource Name (ARN) of the component.

name -> (string)

The name of the component.

version -> (string)

The version of the component.

description -> (string)

The description of the component.

changeDescription -> (string)

The change description of the component.

type -> (string)

The type of the component denotes whether the component is used to build the image or only to test it.

platform -> (string)

The platform of the component.

supportedOsVersions -> (list)

The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation.

(string)

owner -> (string)

The owner of the component.

data -> (string)

The data of the component.

kmsKeyId -> (string)

The KMS key identifier used to encrypt the component.

encrypted -> (boolean)

The encryption status of the component.

dateCreated -> (string)

The date that the component was created.

tags -> (map)

The tags associated with the component.

key -> (string)

value -> (string)