CreateComponent - EC2 Image Builder

CreateComponent

Creates a new component that can be used to build, validate, test, and assess your image.

Request Syntax

PUT /CreateComponent HTTP/1.1 Content-type: application/json { "changeDescription": "string", "clientToken": "string", "data": "string", "description": "string", "kmsKeyId": "string", "name": "string", "platform": "string", "semanticVersion": "string", "supportedOsVersions": [ "string" ], "tags": { "string" : "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. Describes what change has been made in this version, or what makes this version different from other versions of this component.

Type: String

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

Required: No

clientToken

The idempotency token of the component.

Type: String

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

Required: Yes

data

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.

Type: String

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

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

kmsKeyId

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

Type: String

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

Required: No

name

The name of the component.

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

Required: Yes

semanticVersion

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

Type: String

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

Required: Yes

supportedOsVersions

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.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Length Constraints: Minimum length of 1.

Required: No

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-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Required: No

uri

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.

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 idempotency token used to make this request idempotent.

Type: String

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

componentBuildVersionArn

The Amazon Resource Name (ARN) of the component that was created by this request.

Type: String

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

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

CallRateLimitExceededException

You have exceeded the permitted request rate for the specific operation.

HTTP Status Code: 429

ClientException

These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.

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 two or more mutually exclusive parameters. Review the error message for details.

HTTP Status Code: 400

InvalidRequestException

You have made a request for an action that is not supported by the service.

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

This exception is thrown when the service encounters an unrecoverable exception.

HTTP Status Code: 500

ServiceQuotaExceededException

You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.

HTTP Status Code: 402

ServiceUnavailableException

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

HTTP Status Code: 503

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: