| Column Name | Column Data Type |
|---|
filters Input Column
The filter conditions for the WorkSpaces Pool to return. | STRUCT(
"name" VARCHAR,
"values" VARCHAR[],
"operator" VARCHAR
)[] |
Show child fields- filters[]
Show child fields- filters[].name
The name of the pool to filter. - filters[].operator
The operator values for filtering WorkSpaces Pools. - filters[].values[]
|
limit Input Column
The maximum number of items to return. | BIGINT |
next_token Input Column
If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. | VARCHAR |
pool_ids Input Column
The identifier of the WorkSpaces Pools. | VARCHAR[] |
Show child fields- pool_ids[]
|
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
_aws_region Input Column
The AWS region to use. | VARCHAR |
workspaces_pools
Information about the WorkSpaces Pools. | STRUCT(
"pool_id" VARCHAR,
"pool_arn" VARCHAR,
"capacity_status" STRUCT(
"available_user_sessions" BIGINT,
"desired_user_sessions" BIGINT,
"actual_user_sessions" BIGINT,
"active_user_sessions" BIGINT
),
"pool_name" VARCHAR,
"description" VARCHAR,
"state" VARCHAR,
"created_at" TIMESTAMP_S,
"bundle_id" VARCHAR,
"directory_id" VARCHAR,
"errors" STRUCT(
"error_code" VARCHAR,
"error_message" VARCHAR
)[],
"application_settings" STRUCT(
"status" VARCHAR,
"settings_group" VARCHAR,
"s3_bucket_name" VARCHAR
),
"timeout_settings" STRUCT(
"disconnect_timeout_in_seconds" BIGINT,
"idle_disconnect_timeout_in_seconds" BIGINT,
"max_user_duration_in_seconds" BIGINT
)
)[] |
Show child fields- workspaces_pools[]
Show child fields- workspaces_pools[].application_settings
The persistent application settings for users of the pool. Show child fields- workspaces_pools[].application_settings.s3_bucket_name
The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an Amazon Web Services Region, an S3 bucket is created. The bucket is unique to the Amazon Web Services account and the Region. - workspaces_pools[].application_settings.settings_group
The path prefix for the S3 bucket where users’ persistent application settings are stored. - workspaces_pools[].application_settings.status
Specifies whether persistent application settings are enabled for users during their pool sessions.
- workspaces_pools[].bundle_id
The identifier of the bundle used by the pool. - workspaces_pools[].capacity_status
The capacity status for the pool Show child fields- workspaces_pools[].capacity_status.active_user_sessions
The number of user sessions currently being used for your pool. - workspaces_pools[].capacity_status.actual_user_sessions
The total number of user sessions that are available for streaming or are currently streaming in your pool. ActualUserSessions = AvailableUserSessions + ActiveUserSessions - workspaces_pools[].capacity_status.available_user_sessions
The number of user sessions currently available for streaming from your pool. AvailableUserSessions = ActualUserSessions - ActiveUserSessions - workspaces_pools[].capacity_status.desired_user_sessions
The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your pool can support in a steady state.
- workspaces_pools[].created_at
The time the pool was created. - workspaces_pools[].description
The description of the pool. - workspaces_pools[].directory_id
The identifier of the directory used by the pool. - workspaces_pools[].errors[]
Show child fields- workspaces_pools[].errors[].error_code
The error code. - workspaces_pools[].errors[].error_message
The error message.
- workspaces_pools[].pool_arn
The Amazon Resource Name (ARN) for the pool. - workspaces_pools[].pool_id
The identifier of a pool. - workspaces_pools[].pool_name
The name of the pool, - workspaces_pools[].state
The current state of the pool. - workspaces_pools[].timeout_settings
The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance. Show child fields- workspaces_pools[].timeout_settings.disconnect_timeout_in_seconds
Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance. - workspaces_pools[].timeout_settings.idle_disconnect_timeout_in_seconds
The amount of time in seconds a connection will stay active while idle. - workspaces_pools[].timeout_settings.max_user_duration_in_seconds
Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
|