StartImageBuilder
Starts the specified image builder.
Request Syntax
{
"AppstreamAgentVersion": "string",
"Name": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AppstreamAgentVersion
-
The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
- Name
-
The name of the image builder.
Type: String
Length Constraints: Minimum length of 1.
Required: Yes
Response Syntax
{
"ImageBuilder": {
"AccessEndpoints": [
{
"EndpointType": "string",
"VpceId": "string"
}
],
"AppstreamAgentVersion": "string",
"Arn": "string",
"CreatedTime": number,
"Description": "string",
"DisplayName": "string",
"DomainJoinInfo": {
"DirectoryName": "string",
"OrganizationalUnitDistinguishedName": "string"
},
"EnableDefaultInternetAccess": boolean,
"IamRoleArn": "string",
"ImageArn": "string",
"ImageBuilderErrors": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"ErrorTimestamp": number
}
],
"InstanceType": "string",
"LatestAppstreamAgentVersion": "string",
"Name": "string",
"NetworkAccessConfiguration": {
"EniId": "string",
"EniPrivateIpAddress": "string"
},
"Platform": "string",
"State": "string",
"StateChangeReason": {
"Code": "string",
"Message": "string"
},
"VpcConfig": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "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.
- ImageBuilder
-
Information about the image builder.
Type: ImageBuilder object
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConcurrentModificationException
-
An API error occurred. Wait a few minutes and try again.
HTTP Status Code: 400
- IncompatibleImageException
-
The image can't be updated because it's not compatible for updates.
HTTP Status Code: 400
- InvalidAccountStatusException
-
The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
HTTP Status Code: 400
- ResourceNotAvailableException
-
The specified resource exists and is not in use, but isn't available.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
