Menu
Amazon AppStream 2.0
API Reference (API Version 2016-12-01)

CreateImageBuilder

Creates an image builder.

The initial state of the builder is PENDING. When it is ready, the state is RUNNING.

Request Syntax

{
   "Description": "string",
   "DisplayName": "string",
   "DomainJoinInfo": { 
      "DirectoryName": "string",
      "OrganizationalUnitDistinguishedName": "string"
   },
   "EnableDefaultInternetAccess": boolean,
   "ImageName": "string",
   "InstanceType": "string",
   "Name": "string",
   "VpcConfig": { 
      "SecurityGroupIds": [ "string" ],
      "SubnetIds": [ "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.

Description

The description for display.

Type: String

Length Constraints: Maximum length of 256.

Required: No

DisplayName

The image builder name for display.

Type: String

Length Constraints: Maximum length of 100.

Required: No

DomainJoinInfo

The information needed to join a Microsoft Active Directory domain.

Type: DomainJoinInfo object

Required: No

EnableDefaultInternetAccess

Enables or disables default internet access for the image builder.

Type: Boolean

Required: No

ImageName

The name of the image used to create the builder.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

InstanceType

The instance type to use when launching the image builder.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

Name

A unique name for the image builder.

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$

Required: Yes

VpcConfig

The VPC configuration for the image builder. You can specify only one subnet.

Type: VpcConfig object

Required: No

Response Syntax

{
   "ImageBuilder": { 
      "Arn": "string",
      "CreatedTime": number,
      "Description": "string",
      "DisplayName": "string",
      "DomainJoinInfo": { 
         "DirectoryName": "string",
         "OrganizationalUnitDistinguishedName": "string"
      },
      "EnableDefaultInternetAccess": boolean,
      "ImageArn": "string",
      "ImageBuilderErrors": [ 
         { 
            "ErrorCode": "string",
            "ErrorMessage": "string",
            "ErrorTimestamp": number
         }
      ],
      "InstanceType": "string",
      "Name": "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 does not support storage connectors.

HTTP Status Code: 400

InvalidParameterCombinationException

Indicates an incorrect combination of parameters, or a missing parameter.

HTTP Status Code: 400

InvalidRoleException

The specified role is invalid.

HTTP Status Code: 400

LimitExceededException

The requested limit exceeds the permitted limit for an account.

HTTP Status Code: 400

ResourceAlreadyExistsException

The specified resource already exists.

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: