CreateComponent
Creates a new component that can be used to build, validate, test, and assess your image. The component is based on a YAML document that you specify using exactly one of the following methods:
-
Inline, using the
data
property in the request body. -
A URL that points to a YAML document file stored in Amazon S3, using the
uri
property in the request body.
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 the component.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- clientToken
-
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Required: Yes
- data
-
Component
data
contains inline YAML document content for the component. Alternatively, you can specify theuri
of a YAML document file stored in Amazon S3. However, you cannot specify both properties.Type: String
Length Constraints: Minimum length of 1. Maximum length of 16000.
Pattern:
[^\x00]+
Required: No
- description
-
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 is 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 operating system 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, with an upper limit of 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
- supportedOsVersions
-
The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base 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
-
The tags that apply to 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 a YAML component document file. This must be an S3 URL (s3://bucket/key
), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.Alternatively, you can specify the YAML document inline, using the component
data
property. You cannot specify both properties.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 36.
- componentBuildVersionArn
-
The Amazon Resource Name (ARN) of the component that the request created.
Type: String
Pattern:
^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):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 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 requested an action that that the service doesn't support.
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 Amazon SDKs, see the following: