View a markdown version of this page

AgentAccessConfigForUpdate - Amazon WorkSpaces Applications

AgentAccessConfigForUpdate

The configuration for updating agent access on a stack. This type supports partial updates, so you only need to specify the fields you want to change.

Contents

S3BucketArn

The Amazon Resource Name (ARN) of the Amazon S3 bucket where agent screenshots are stored.

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

ScreenImageFormat

The image format for agent screen captures.

Type: String

Valid Values: PNG | JPEG

Required: No

ScreenResolution

The screen resolution for the agent streaming environment.

Type: String

Valid Values: W_1280xH_720

Required: No

ScreenshotsUploadEnabled

Indicates whether screenshot uploads to Amazon S3 are enabled for agent sessions.

Type: Boolean

Required: No

Settings

The list of agent access settings that define permissions for each agent action.

Type: Array of AgentAccessSetting objects

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: