Class: Aws::AppStream::Types::AgentAccessConfig

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#kms_key_arn ⇒ String

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.

Returns:

  • (String)


133
134
135
136
137
138
139
140
141
142
143
144
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 133

class AgentAccessConfig < Struct.new(
  :settings,
  :s3_bucket_arn,
  :screenshots_upload_enabled,
  :replay_session_enabled,
  :kms_key_arn,
  :screen_resolution,
  :screen_image_format,
  :user_control_mode)
  SENSITIVE = []
  include Aws::Structure
end

#replay_session_enabled ⇒ Boolean

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.

Returns:

  • (Boolean)


133
134
135
136
137
138
139
140
141
142
143
144
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 133

class AgentAccessConfig < Struct.new(
  :settings,
  :s3_bucket_arn,
  :screenshots_upload_enabled,
  :replay_session_enabled,
  :kms_key_arn,
  :screen_resolution,
  :screen_image_format,
  :user_control_mode)
  SENSITIVE = []
  include Aws::Structure
end

#s3_bucket_arn ⇒ String

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.

Returns:

  • (String)


133
134
135
136
137
138
139
140
141
142
143
144
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 133

class AgentAccessConfig < Struct.new(
  :settings,
  :s3_bucket_arn,
  :screenshots_upload_enabled,
  :replay_session_enabled,
  :kms_key_arn,
  :screen_resolution,
  :screen_image_format,
  :user_control_mode)
  SENSITIVE = []
  include Aws::Structure
end

#screen_image_format ⇒ String

The image format for agent screen captures.

Returns:

  • (String)


133
134
135
136
137
138
139
140
141
142
143
144
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 133

class AgentAccessConfig < Struct.new(
  :settings,
  :s3_bucket_arn,
  :screenshots_upload_enabled,
  :replay_session_enabled,
  :kms_key_arn,
  :screen_resolution,
  :screen_image_format,
  :user_control_mode)
  SENSITIVE = []
  include Aws::Structure
end

#screen_resolution ⇒ String

The screen resolution for the agent streaming environment.

Returns:

  • (String)


133
134
135
136
137
138
139
140
141
142
143
144
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 133

class AgentAccessConfig < Struct.new(
  :settings,
  :s3_bucket_arn,
  :screenshots_upload_enabled,
  :replay_session_enabled,
  :kms_key_arn,
  :screen_resolution,
  :screen_image_format,
  :user_control_mode)
  SENSITIVE = []
  include Aws::Structure
end

#screenshots_upload_enabled ⇒ Boolean

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

Returns:

  • (Boolean)


133
134
135
136
137
138
139
140
141
142
143
144
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 133

class AgentAccessConfig < Struct.new(
  :settings,
  :s3_bucket_arn,
  :screenshots_upload_enabled,
  :replay_session_enabled,
  :kms_key_arn,
  :screen_resolution,
  :screen_image_format,
  :user_control_mode)
  SENSITIVE = []
  include Aws::Structure
end

#settings ⇒ Array<Types::AgentAccessSetting>

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.

Returns:



133
134
135
136
137
138
139
140
141
142
143
144
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 133

class AgentAccessConfig < Struct.new(
  :settings,
  :s3_bucket_arn,
  :screenshots_upload_enabled,
  :replay_session_enabled,
  :kms_key_arn,
  :screen_resolution,
  :screen_image_format,
  :user_control_mode)
  SENSITIVE = []
  include Aws::Structure
end

#user_control_mode ⇒ String

The user control mode for agent sessions. This setting determines how users can interact with agent sessions.

Returns:

  • (String)


133
134
135
136
137
138
139
140
141
142
143
144
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 133

class AgentAccessConfig < Struct.new(
  :settings,
  :s3_bucket_arn,
  :screenshots_upload_enabled,
  :replay_session_enabled,
  :kms_key_arn,
  :screen_resolution,
  :screen_image_format,
  :user_control_mode)
  SENSITIVE = []
  include Aws::Structure
end