View a markdown version of this page

AgentAccessConfig - Amazon WorkSpaces Applications

AgentAccessConfig

The configuration for agent access on a stack. Agent access enables AI agents to interact with desktop applications during streaming sessions.

Contents

ScreenImageFormat

The image format for agent screen captures.

Type: String

Valid Values: PNG | JPEG

Required: Yes

ScreenResolution

The screen resolution for the agent streaming environment.

Type: String

Valid Values: W_1280xH_720

Required: 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

KmsKeyArn

The Amazon Resource Name (ARN) of the customer managed symmetric encryption KMS key that encrypts Replay Session artifacts while WorkSpaces Applications processes them. The key must be in the same Region as the stack, and ReplaySessionEnabled must be true.

Type: String

Pattern: ^arn:aws(?:\-cn|\-iso\-b|\-iso|\-us\-gov)?:kms:[a-z0-9\-]+:\d{12}:key/[A-Za-z0-9\-]+$

Required: No

ReplaySessionEnabled

Indicates whether Replay Session is enabled for agent sessions. WorkSpaces Applications delivers a video combining session screenshots, a transcript, and a report for each session. Requires the COMPUTER_VISION agent action.

Type: Boolean

Required: No

S3BucketArn

The Amazon Resource Name (ARN) of the Amazon S3 bucket where agent screenshots and Replay Session artifacts are stored. Required when ScreenshotsUploadEnabled or ReplaySessionEnabled 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

Indicates 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.

Type: String

Valid Values: VIEW_ONLY | VIEW_STOP | DISABLED

Required: No

See Also

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