View a markdown version of this page

UpdateImageBuilder - Amazon WorkSpaces Applications

UpdateImageBuilder

Updates the specified fields for the specified image builder. The image builder must be in the STOPPED state.

Request Syntax

{ "AgentAccessConfig": { "S3BucketArn": "string", "ScreenImageFormat": "string", "ScreenResolution": "string", "ScreenshotsUploadEnabled": boolean, "Settings": [ { "AgentAction": "string", "Permission": "string" } ], "UserControlMode": "string" }, "AttributesToDelete": [ "string" ], "Description": "string", "DisplayName": "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.

AgentAccessConfig

The configuration for agent access on the image builder. Specify this to update agent access settings. To remove agent access, use AttributesToDelete with the AGENT_ACCESS_CONFIG value.

Type: ImageBuilderAgentAccessConfigForUpdate object

Required: No

AttributesToDelete

The image builder attributes to delete.

Type: Array of strings

Array Members: Maximum number of 2 items.

Valid Values: AGENT_ACCESS_CONFIG

Required: No

Description

The description to display.

Type: String

Length Constraints: Maximum length of 256.

Required: No

DisplayName

The image builder name to display.

Type: String

Length Constraints: Maximum length of 100.

Required: No

Name

The name of the image builder.

Type: String

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

Required: Yes

Response Syntax

{ "ImageBuilder": { "AccessEndpoints": [ { "EndpointType": "string", "VpceId": "string" } ], "AgentAccessConfig": { "S3BucketArn": "string", "ScreenImageFormat": "string", "ScreenResolution": "string", "ScreenshotsUploadEnabled": boolean, "Settings": [ { "AgentAction": "string", "Permission": "string" } ], "UserControlMode": "string" }, "AppstreamAgentVersion": "string", "Arn": "string", "CreatedTime": number, "Description": "string", "DisableIMDSV1": boolean, "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", "EniIpv6Addresses": [ "string" ], "EniPrivateIpAddress": "string" }, "Platform": "string", "RootVolumeConfig": { "VolumeSizeInGb": number }, "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 Error Types.

ConcurrentModificationException

An API error occurred. Wait a few minutes and try again.

Message

The error message in the exception.

HTTP Status Code: 400

IncompatibleImageException

The image can't be updated because it's not compatible for updates.

Message

The error message in the exception.

HTTP Status Code: 400

InvalidAccountStatusException

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

Message

The error message in the exception.

HTTP Status Code: 400

InvalidParameterCombinationException

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

Message

The error message in the exception.

HTTP Status Code: 400

OperationNotPermittedException

The attempted operation is not permitted.

Message

The error message in the exception.

HTTP Status Code: 400

RequestLimitExceededException

WorkSpaces Applications can't process the request right now because this operation is being throttled. Try again later.

Message

The error message in the exception.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

Message

The error message in the exception.

HTTP Status Code: 400

See Also

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