Skip to content

AgentAccessConfig

Used by
Source code in docs_src/capo_appstream/types/agent_access_config.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class AgentAccessConfig(TypedDict, closed=True):
    settings: NotRequired[
        "capo_appstream.types.agent_access_setting_list.AgentAccessSettingList"
    ]
    """<p>The list of agent access settings that define permissions for each agent action. You must specify at least one setting.</p>"""
    s3_bucket_arn: NotRequired["capo_appstream.types.s3_bucket_arn.S3BucketArn"]
    """<p>The Amazon Resource Name (ARN) of the Amazon S3 bucket where agent screenshots are stored. Required when ScreenshotsUploadEnabled is true.</p>"""
    screenshots_upload_enabled: NotRequired[
        "capo_appstream.types.boolean_object.BooleanObject"
    ]
    """<p>Indicates whether screenshot uploads to Amazon S3 are enabled for agent sessions.</p>"""
    screen_resolution: NotRequired[
        "capo_appstream.types.screen_resolution.ScreenResolution"
    ]
    """<p>The screen resolution for the agent streaming environment.</p>"""
    screen_image_format: NotRequired[
        "capo_appstream.types.screen_image_format.ScreenImageFormat"
    ]
    """<p>The image format for agent screen captures.</p>"""
    user_control_mode: NotRequired[
        "capo_appstream.types.user_control_mode.UserControlMode"
    ]
    """<p>The user control mode for agent sessions. This setting determines how users can interact with agent sessions.</p>"""

s3_bucket_arn instance-attribute 

s3_bucket_arn: NotRequired[S3BucketArn]

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

screen_image_format instance-attribute 

screen_image_format: NotRequired[ScreenImageFormat]

The image format for agent screen captures.

screen_resolution instance-attribute 

screen_resolution: NotRequired[ScreenResolution]

The screen resolution for the agent streaming environment.

screenshots_upload_enabled instance-attribute 

screenshots_upload_enabled: NotRequired[BooleanObject]

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

settings instance-attribute 

settings: NotRequired[AgentAccessSettingList]

The list of agent access settings that define permissions for each agent action. You must specify at least one setting.

user_control_mode instance-attribute 

user_control_mode: NotRequired[UserControlMode]

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