[ aws . imagebuilder ]



Imports a component and transforms its data into a component document.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--name <value>
--semantic-version <value>
[--description <value>]
[--change-description <value>]
--type <value>
--format <value>
--platform <value>
[--data <value>]
[--uri <value>]
[--kms-key-id <value>]
[--tags <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]


--name (string)

The name of the component.

--semantic-version (string)

The semantic version of the component. This version follows the semantic version syntax. For example, major.minor.patch. This could be versioned like software (2.0.1) or like a date (2019.12.01).

--description (string)

The description of the component. Describes the contents of the component.

--change-description (string)

The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.

--type (string)

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

Possible values:


  • TEST

--format (string)

The format of the resource that you want to import as a component.

Possible values:


--platform (string)

The platform of the component.

Possible values:

  • Windows

  • Linux

--data (string)

The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component.

--uri (string)

The uri of the component. Must be an S3 URL and the requester must have permission to access the S3 bucket. If you use S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.

--kms-key-id (string)

The ID of the KMS key that should be used to encrypt this component.

--tags (map)

The tags of the component.

key -> (string)

value -> (string)

Shorthand Syntax:


JSON Syntax:

{"string": "string"

--client-token (string)

The idempotency token of the component.

--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.


To import a component

The following import-component example imports a preexisting script using a JSON file.

aws imagebuilder import-component \
    --cli-input-json file://import-component.json

Contents of import-component.json:

    "name": "MyImportedComponent",
    "semanticVersion": "1.0.0",
    "description": "An example of how to import a component",
    "changeDescription": "First commit message.",
    "format": "SHELL",
    "platform": "Windows",
    "type": "BUILD",
    "uri": "s3://s3-bucket-name/s3-bucket-path/component.yaml"


    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
    "componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myimportedcomponent/1.0.0/1"

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.


requestId -> (string)

The request ID that uniquely identifies this request.

clientToken -> (string)

The idempotency token used to make this request idempotent.

componentBuildVersionArn -> (string)

The Amazon Resource Name (ARN) of the imported component.