Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

ImportComponent

Imports a component and transforms its data into a component document. For the SHELL format, Image Builder wraps your script in a component document with a single step that runs the script.

Request Syntax


PUT /ImportComponent HTTP/1.1
Content-type: application/json

{
   "changeDescription": "string",
   "clientToken": "string",
   "data": "string",
   "description": "string",
   "format": "string",
   "kmsKeyId": "string",
   "name": "string",
   "platform": "string",
   "semanticVersion": "string",
   "tags": { 
      "string" : "string" 
   },
   "type": "string",
   "uri": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

changeDescription

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

clientToken

A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

data

The data of the component. For the SHELL format, this is the plain script content. You must specify exactly one of the data or uri properties. For scripts that exceed the inline length constraint, use the uri property.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

description

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

format

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

Type: String

Valid Values: SHELL

Required: Yes

kmsKeyId

The Amazon Resource Name (ARN) of the KMS key that is used to encrypt this component. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Amazon Key Management Service Developer Guide. If you don't specify a key, Image Builder encrypts the component data with a KMS key that Image Builder owns.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

name

The name of the component. Image Builder generates the component ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name. If a component with the same name and semantic version already exists in your account in the same Amazon Web Services Region, the request creates a new build version for it. If the content is also identical to the latest build version, the request fails because the component already exists.

Type: String

Pattern: ^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$

Required: Yes

platform

The platform of the component.

Type: String

Valid Values: Windows | Linux | macOS

Required: Yes

semanticVersion

The semantic version of the component. This version follows the semantic version syntax.

Note

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.

Assignment: For the first three nodes, you can assign any positive integer value, including zero. The upper limit is 2^30-1, or 1073741823, for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

Type: String

Pattern: ^[0-9]+\.[0-9]+\.[0-9]+$

Required: Yes

tags

The tags of the component.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z0-9\s_.:/=+\-@]*$

Value Length Constraints: Maximum length of 256.

Required: No

type

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

Type: String

Valid Values: BUILD | TEST

Required: Yes

uri

The uri of the component. Must be an Amazon S3 URL and you must have permission to access the Amazon S3 bucket. If you use Amazon 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.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "clientToken": "string",
   "componentBuildVersionArn": "string",
   "requestId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

clientToken

The client token that uniquely identifies the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

componentBuildVersionArn

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

Type: String

Pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?|third-party):component/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+/[0-9]+$

requestId

The request ID that uniquely identifies this request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Errors

For information about the errors that are common to all actions, see Common Error Types.

CallRateLimitExceededException

You have exceeded the permitted request rate for the Amazon EC2 APIs that Image Builder calls on your behalf. Retry with an increasing or variable delay between requests.

HTTP Status Code: 429

ClientException

A generic client error. This error usually indicates that the request failed a validation check, such as when a downstream service rejects a configured value.

HTTP Status Code: 400

ForbiddenException

You are not authorized to perform the requested operation.

HTTP Status Code: 403

IdempotentParameterMismatchException

You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.

HTTP Status Code: 400

InvalidParameterCombinationException

You have specified a combination of parameters that isn't valid. For example, two mutually exclusive parameters, or a parameter without its required companion parameter. Review the error message for details.

HTTP Status Code: 400

InvalidRequestException

The request is malformed or otherwise invalid. Verify the request and try again.

HTTP Status Code: 400

InvalidVersionNumberException

Your version number is out of bounds or does not follow the required syntax.

HTTP Status Code: 400

ResourceInUseException

The resource that you are trying to operate on is currently in use. Review the message details and retry later.

HTTP Status Code: 400

ServiceException

An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.

HTTP Status Code: 500

ServiceUnavailableException

The service is unable to process your request at this time.

HTTP Status Code: 503

Examples

Import a component from a shell script

The following example imports a plain shell script as a Linux build component.

Sample Request


PUT /ImportComponent HTTP/1.1
Content-type: application/json

{
    "name": "my-example-imported-component",
    "semanticVersion": "1.0.0",
    "description": "Installs my application from an imported shell script",
    "type": "BUILD",
    "format": "SHELL",
    "platform": "Linux",
    "data": "sudo yum update -y\nsudo yum -y install my-app\n",
    "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE88888"
}

Sample Response


HTTP/1.1 200
Content-type: application/json

{
    "requestId": "e62cb87f-e291-4fb2-9305-54a7878c3b99",
    "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE88888",
    "componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-imported-component/1.0.0/1"
}