ImageBuilderAgentAccessConfig
The configuration for agent access on an image builder. Agent access enables AI agents to interact with desktop applications during streaming sessions to the image builder.
Contents
- ScreenImageFormat
-
The image format for agent screen captures.
-
PNG - PNG format.
-
JPEG - JPEG format.
Type: String
Valid Values:
PNG | JPEGRequired: Yes
-
- ScreenResolution
-
The screen resolution for the agent streaming environment.
-
W_1280xH_720 - 1280 x 720 pixels.
Type: String
Valid Values:
W_1280xH_720Required: Yes
-
- Settings
-
The list of agent access settings that define permissions for each agent action. You must specify at least one setting, and at least one agent action must be enabled.
Type: Array of AgentAccessSetting objects
Required: Yes
- S3BucketArn
-
The Amazon Resource Name (ARN) of the Amazon S3 bucket where agent screenshots are stored. Required when ScreenshotsUploadEnabled is true.
Type: String
Pattern:
^arn:aws(?:\-cn|\-iso\-b|\-iso|\-us\-gov)?:s3:::[a-z0-9][a-z0-9.\-]{1,61}[a-z0-9]$Required: No
- ScreenshotsUploadEnabled
-
Specifies whether screenshot uploads to Amazon S3 are enabled for agent sessions.
Type: Boolean
Required: No
- UserControlMode
-
The user control mode for agent sessions. This setting determines how users can interact with agent sessions.
-
VIEW_ONLY - Users can view and observe agent actions as they happen.
-
VIEW_STOP - Users can view agent actions and stop the agent if needed.
-
DISABLED - Users cannot view or stop the agent session.
Type: String
Valid Values:
VIEW_ONLY | VIEW_STOP | DISABLEDRequired: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: