Class: Aws::AppStream::Types::ImageBuilderAgentAccessConfig

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

Overview

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#s3_bucket_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon S3 bucket where agent screenshots are stored. Required when ScreenshotsUploadEnabled is true.

Returns:

  • (String)


5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 5313

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

#screen_image_format ⇒ String

The image format for agent screen captures.

  • PNG - PNG format.

  • JPEG - JPEG format.

Returns:

  • (String)


5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 5313

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

#screen_resolution ⇒ String

The screen resolution for the agent streaming environment.

  • W_1280xH_720 - 1280 x 720 pixels.

^

Returns:

  • (String)


5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 5313

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

#screenshots_upload_enabled ⇒ Boolean

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

Returns:

  • (Boolean)


5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 5313

class ImageBuilderAgentAccessConfig < Struct.new(
  :settings,
  :s3_bucket_arn,
  :screenshots_upload_enabled,
  :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:



5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 5313

class ImageBuilderAgentAccessConfig < Struct.new(
  :settings,
  :s3_bucket_arn,
  :screenshots_upload_enabled,
  :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.

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

Returns:

  • (String)


5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 5313

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