2026/03/30 - Amazon AppStream - 3 updated api methods
Changes Add support for URL Redirection
{'ContentRedirection': {'HostToClient': {'AllowedUrls': ['string'],
'DeniedUrls': ['string'],
'Enabled': 'boolean'}}}
Response {'Stack': {'ContentRedirection': {'HostToClient': {'AllowedUrls': ['string'],
'DeniedUrls': ['string'],
'Enabled': 'boolean'}}}}
Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.
See also: AWS API Documentation
Request Syntax
client.create_stack(
Name='string',
Description='string',
DisplayName='string',
StorageConnectors=[
{
'ConnectorType': 'HOMEFOLDERS'|'GOOGLE_DRIVE'|'ONE_DRIVE',
'ResourceIdentifier': 'string',
'Domains': [
'string',
],
'DomainsRequireAdminConsent': [
'string',
]
},
],
RedirectURL='string',
FeedbackURL='string',
UserSettings=[
{
'Action': 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE'|'CLIPBOARD_COPY_TO_LOCAL_DEVICE'|'FILE_UPLOAD'|'FILE_DOWNLOAD'|'PRINTING_TO_LOCAL_DEVICE'|'DOMAIN_PASSWORD_SIGNIN'|'DOMAIN_SMART_CARD_SIGNIN'|'AUTO_TIME_ZONE_REDIRECTION',
'Permission': 'ENABLED'|'DISABLED',
'MaximumLength': 123
},
],
ApplicationSettings={
'Enabled': True|False,
'SettingsGroup': 'string'
},
Tags={
'string': 'string'
},
AccessEndpoints=[
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
],
EmbedHostDomains=[
'string',
],
StreamingExperienceSettings={
'PreferredProtocol': 'TCP'|'UDP'
},
ContentRedirection={
'HostToClient': {
'Enabled': True|False,
'AllowedUrls': [
'string',
],
'DeniedUrls': [
'string',
]
}
}
)
string
[REQUIRED]
The name of the stack.
string
The description to display.
string
The stack name to display.
list
The storage connectors to enable.
(dict) --
Describes a connector that enables persistent storage for users.
ConnectorType (string) -- [REQUIRED]
The type of storage connector.
ResourceIdentifier (string) --
The ARN of the storage connector.
Domains (list) --
The names of the domains for the account.
(string) -- GSuite domain for GDrive integration.
DomainsRequireAdminConsent (list) --
The OneDrive for Business domains where you require admin consent when users try to link their OneDrive account to WorkSpaces Applications. The attribute can only be specified when ConnectorType=ONE_DRIVE.
(string) -- GSuite domain for GDrive integration.
string
The URL that users are redirected to after their streaming session ends.
string
The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
list
The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.
(dict) --
Describes an action and whether the action is enabled or disabled for users during their streaming sessions.
Action (string) -- [REQUIRED]
The action that is enabled or disabled.
Permission (string) -- [REQUIRED]
Indicates whether the action is enabled or disabled.
MaximumLength (integer) --
Specifies the number of characters that can be copied by end users from the local device to the remote session, and to the local device from the remote session.
This can be specified only for the CLIPBOARD_COPY_FROM_LOCAL_DEVICE and CLIPBOARD_COPY_TO_LOCAL_DEVICE actions.
This defaults to 20,971,520 (20 MB) when unspecified and the permission is ENABLED. This can't be specified when the permission is DISABLED.
The value can be between 1 and 20,971,520 (20 MB).
dict
The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.
Enabled (boolean) -- [REQUIRED]
Enables or disables persistent application settings for users during their streaming sessions.
SettingsGroup (string) --
The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack.
dict
The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
If you do not specify a value, the value is set to an empty string.
Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
_ . : / = + - @
For more information about tags, see Tagging Your Resources in the Amazon WorkSpaces Applications Administration Guide.
(string) --
(string) --
list
The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to WorkSpaces Applications only through the specified endpoints.
(dict) --
Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and WorkSpaces Applications. When you specify an interface endpoint for a stack, users of the stack can connect to WorkSpaces Applications only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
EndpointType (string) -- [REQUIRED]
The type of interface endpoint.
VpceId (string) --
The identifier (ID) of the VPC in which the interface endpoint is used.
list
The domains where WorkSpaces Applications streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded WorkSpaces Applications streaming sessions.
(string) -- Specifies a valid domain that can embed AppStream. Valid examples include: ["testorigin.tt--com", "testingorigin.com.us", "test.com.us"] Invalid examples include: ["test,com", ".com", "h*llo.com". ""]
dict
The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
PreferredProtocol (string) --
The preferred protocol that you want to use while streaming your application.
dict
Configuration for bidirectional URL redirection between the streaming session and the local client. Use HostToClient to redirect URLs from the remote desktop to the local browser.
HostToClient (dict) --
Configuration for redirecting URLs from the remote desktop to the local client browser.
Enabled (boolean) -- [REQUIRED]
Whether URL redirection is enabled for this direction.
AllowedUrls (list) --
List of URL patterns that are allowed to be redirected. URLs matching these patterns will be redirected unless they also match a pattern in the denied list.
(string) --
A glob pattern using wildcards (* for zero or more characters, ? for exactly one character) to match URLs for redirection rules. Patterns do not include a protocol prefix; HTTPS is enforced automatically. Valid examples: , *.example.com, github.com/myorg/, api?.example.com Invalid examples: https://example.com (no protocol), empty string
DeniedUrls (list) --
List of URL patterns that are denied from redirection. This list takes precedence over the allowed list.
(string) --
A glob pattern using wildcards (* for zero or more characters, ? for exactly one character) to match URLs for redirection rules. Patterns do not include a protocol prefix; HTTPS is enforced automatically. Valid examples: , *.example.com, github.com/myorg/, api?.example.com Invalid examples: https://example.com (no protocol), empty string
dict
Response Syntax
{
'Stack': {
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'DisplayName': 'string',
'CreatedTime': datetime(2015, 1, 1),
'StorageConnectors': [
{
'ConnectorType': 'HOMEFOLDERS'|'GOOGLE_DRIVE'|'ONE_DRIVE',
'ResourceIdentifier': 'string',
'Domains': [
'string',
],
'DomainsRequireAdminConsent': [
'string',
]
},
],
'RedirectURL': 'string',
'FeedbackURL': 'string',
'StackErrors': [
{
'ErrorCode': 'STORAGE_CONNECTOR_ERROR'|'INTERNAL_SERVICE_ERROR',
'ErrorMessage': 'string'
},
],
'UserSettings': [
{
'Action': 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE'|'CLIPBOARD_COPY_TO_LOCAL_DEVICE'|'FILE_UPLOAD'|'FILE_DOWNLOAD'|'PRINTING_TO_LOCAL_DEVICE'|'DOMAIN_PASSWORD_SIGNIN'|'DOMAIN_SMART_CARD_SIGNIN'|'AUTO_TIME_ZONE_REDIRECTION',
'Permission': 'ENABLED'|'DISABLED',
'MaximumLength': 123
},
],
'ApplicationSettings': {
'Enabled': True|False,
'SettingsGroup': 'string',
'S3BucketName': 'string'
},
'AccessEndpoints': [
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
],
'EmbedHostDomains': [
'string',
],
'StreamingExperienceSettings': {
'PreferredProtocol': 'TCP'|'UDP'
},
'ContentRedirection': {
'HostToClient': {
'Enabled': True|False,
'AllowedUrls': [
'string',
],
'DeniedUrls': [
'string',
]
}
}
}
}
Response Structure
(dict) --
Stack (dict) --
Information about the stack.
Arn (string) --
The ARN of the stack.
Name (string) --
The name of the stack.
Description (string) --
The description to display.
DisplayName (string) --
The stack name to display.
CreatedTime (datetime) --
The time the stack was created.
StorageConnectors (list) --
The storage connectors to enable.
(dict) --
Describes a connector that enables persistent storage for users.
ConnectorType (string) --
The type of storage connector.
ResourceIdentifier (string) --
The ARN of the storage connector.
Domains (list) --
The names of the domains for the account.
(string) -- GSuite domain for GDrive integration.
DomainsRequireAdminConsent (list) --
The OneDrive for Business domains where you require admin consent when users try to link their OneDrive account to WorkSpaces Applications. The attribute can only be specified when ConnectorType=ONE_DRIVE.
(string) -- GSuite domain for GDrive integration.
RedirectURL (string) --
The URL that users are redirected to after their streaming session ends.
FeedbackURL (string) --
The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
StackErrors (list) --
The errors for the stack.
(dict) --
Describes a stack error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
UserSettings (list) --
The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.
(dict) --
Describes an action and whether the action is enabled or disabled for users during their streaming sessions.
Action (string) --
The action that is enabled or disabled.
Permission (string) --
Indicates whether the action is enabled or disabled.
MaximumLength (integer) --
Specifies the number of characters that can be copied by end users from the local device to the remote session, and to the local device from the remote session.
This can be specified only for the CLIPBOARD_COPY_FROM_LOCAL_DEVICE and CLIPBOARD_COPY_TO_LOCAL_DEVICE actions.
This defaults to 20,971,520 (20 MB) when unspecified and the permission is ENABLED. This can't be specified when the permission is DISABLED.
The value can be between 1 and 20,971,520 (20 MB).
ApplicationSettings (dict) --
The persistent application settings for users of the stack.
Enabled (boolean) --
Specifies whether persistent application settings are enabled for users during their streaming sessions.
SettingsGroup (string) --
The path prefix for the S3 bucket where users’ persistent application settings are stored.
S3BucketName (string) --
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 AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region.
AccessEndpoints (list) --
The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to WorkSpaces Applications only through the specified endpoints.
(dict) --
Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and WorkSpaces Applications. When you specify an interface endpoint for a stack, users of the stack can connect to WorkSpaces Applications only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
EndpointType (string) --
The type of interface endpoint.
VpceId (string) --
The identifier (ID) of the VPC in which the interface endpoint is used.
EmbedHostDomains (list) --
The domains where WorkSpaces Applications streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded WorkSpaces Applications streaming sessions.
(string) -- Specifies a valid domain that can embed AppStream. Valid examples include: ["testorigin.tt--com", "testingorigin.com.us", "test.com.us"] Invalid examples include: ["test,com", ".com", "h*llo.com". ""]
StreamingExperienceSettings (dict) --
The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
PreferredProtocol (string) --
The preferred protocol that you want to use while streaming your application.
ContentRedirection (dict) --
Configuration for bidirectional URL redirection between the streaming session and the local client. Use HostToClient to redirect URLs from the remote desktop to the local browser.
HostToClient (dict) --
Configuration for redirecting URLs from the remote desktop to the local client browser.
Enabled (boolean) --
Whether URL redirection is enabled for this direction.
AllowedUrls (list) --
List of URL patterns that are allowed to be redirected. URLs matching these patterns will be redirected unless they also match a pattern in the denied list.
(string) --
A glob pattern using wildcards (* for zero or more characters, ? for exactly one character) to match URLs for redirection rules. Patterns do not include a protocol prefix; HTTPS is enforced automatically. Valid examples: , *.example.com, github.com/myorg/, api?.example.com Invalid examples: https://example.com (no protocol), empty string
DeniedUrls (list) --
List of URL patterns that are denied from redirection. This list takes precedence over the allowed list.
(string) --
A glob pattern using wildcards (* for zero or more characters, ? for exactly one character) to match URLs for redirection rules. Patterns do not include a protocol prefix; HTTPS is enforced automatically. Valid examples: , *.example.com, github.com/myorg/, api?.example.com Invalid examples: https://example.com (no protocol), empty string
{'Stacks': {'ContentRedirection': {'HostToClient': {'AllowedUrls': ['string'],
'DeniedUrls': ['string'],
'Enabled': 'boolean'}}}}
Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.
See also: AWS API Documentation
Request Syntax
client.describe_stacks(
Names=[
'string',
],
NextToken='string'
)
list
The names of the stacks to describe.
(string) --
string
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
dict
Response Syntax
{
'Stacks': [
{
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'DisplayName': 'string',
'CreatedTime': datetime(2015, 1, 1),
'StorageConnectors': [
{
'ConnectorType': 'HOMEFOLDERS'|'GOOGLE_DRIVE'|'ONE_DRIVE',
'ResourceIdentifier': 'string',
'Domains': [
'string',
],
'DomainsRequireAdminConsent': [
'string',
]
},
],
'RedirectURL': 'string',
'FeedbackURL': 'string',
'StackErrors': [
{
'ErrorCode': 'STORAGE_CONNECTOR_ERROR'|'INTERNAL_SERVICE_ERROR',
'ErrorMessage': 'string'
},
],
'UserSettings': [
{
'Action': 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE'|'CLIPBOARD_COPY_TO_LOCAL_DEVICE'|'FILE_UPLOAD'|'FILE_DOWNLOAD'|'PRINTING_TO_LOCAL_DEVICE'|'DOMAIN_PASSWORD_SIGNIN'|'DOMAIN_SMART_CARD_SIGNIN'|'AUTO_TIME_ZONE_REDIRECTION',
'Permission': 'ENABLED'|'DISABLED',
'MaximumLength': 123
},
],
'ApplicationSettings': {
'Enabled': True|False,
'SettingsGroup': 'string',
'S3BucketName': 'string'
},
'AccessEndpoints': [
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
],
'EmbedHostDomains': [
'string',
],
'StreamingExperienceSettings': {
'PreferredProtocol': 'TCP'|'UDP'
},
'ContentRedirection': {
'HostToClient': {
'Enabled': True|False,
'AllowedUrls': [
'string',
],
'DeniedUrls': [
'string',
]
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Stacks (list) --
Information about the stacks.
(dict) --
Describes a stack.
Arn (string) --
The ARN of the stack.
Name (string) --
The name of the stack.
Description (string) --
The description to display.
DisplayName (string) --
The stack name to display.
CreatedTime (datetime) --
The time the stack was created.
StorageConnectors (list) --
The storage connectors to enable.
(dict) --
Describes a connector that enables persistent storage for users.
ConnectorType (string) --
The type of storage connector.
ResourceIdentifier (string) --
The ARN of the storage connector.
Domains (list) --
The names of the domains for the account.
(string) -- GSuite domain for GDrive integration.
DomainsRequireAdminConsent (list) --
The OneDrive for Business domains where you require admin consent when users try to link their OneDrive account to WorkSpaces Applications. The attribute can only be specified when ConnectorType=ONE_DRIVE.
(string) -- GSuite domain for GDrive integration.
RedirectURL (string) --
The URL that users are redirected to after their streaming session ends.
FeedbackURL (string) --
The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
StackErrors (list) --
The errors for the stack.
(dict) --
Describes a stack error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
UserSettings (list) --
The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.
(dict) --
Describes an action and whether the action is enabled or disabled for users during their streaming sessions.
Action (string) --
The action that is enabled or disabled.
Permission (string) --
Indicates whether the action is enabled or disabled.
MaximumLength (integer) --
Specifies the number of characters that can be copied by end users from the local device to the remote session, and to the local device from the remote session.
This can be specified only for the CLIPBOARD_COPY_FROM_LOCAL_DEVICE and CLIPBOARD_COPY_TO_LOCAL_DEVICE actions.
This defaults to 20,971,520 (20 MB) when unspecified and the permission is ENABLED. This can't be specified when the permission is DISABLED.
The value can be between 1 and 20,971,520 (20 MB).
ApplicationSettings (dict) --
The persistent application settings for users of the stack.
Enabled (boolean) --
Specifies whether persistent application settings are enabled for users during their streaming sessions.
SettingsGroup (string) --
The path prefix for the S3 bucket where users’ persistent application settings are stored.
S3BucketName (string) --
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 AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region.
AccessEndpoints (list) --
The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to WorkSpaces Applications only through the specified endpoints.
(dict) --
Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and WorkSpaces Applications. When you specify an interface endpoint for a stack, users of the stack can connect to WorkSpaces Applications only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
EndpointType (string) --
The type of interface endpoint.
VpceId (string) --
The identifier (ID) of the VPC in which the interface endpoint is used.
EmbedHostDomains (list) --
The domains where WorkSpaces Applications streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded WorkSpaces Applications streaming sessions.
(string) -- Specifies a valid domain that can embed AppStream. Valid examples include: ["testorigin.tt--com", "testingorigin.com.us", "test.com.us"] Invalid examples include: ["test,com", ".com", "h*llo.com". ""]
StreamingExperienceSettings (dict) --
The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
PreferredProtocol (string) --
The preferred protocol that you want to use while streaming your application.
ContentRedirection (dict) --
Configuration for bidirectional URL redirection between the streaming session and the local client. Use HostToClient to redirect URLs from the remote desktop to the local browser.
HostToClient (dict) --
Configuration for redirecting URLs from the remote desktop to the local client browser.
Enabled (boolean) --
Whether URL redirection is enabled for this direction.
AllowedUrls (list) --
List of URL patterns that are allowed to be redirected. URLs matching these patterns will be redirected unless they also match a pattern in the denied list.
(string) --
A glob pattern using wildcards (* for zero or more characters, ? for exactly one character) to match URLs for redirection rules. Patterns do not include a protocol prefix; HTTPS is enforced automatically. Valid examples: , *.example.com, github.com/myorg/, api?.example.com Invalid examples: https://example.com (no protocol), empty string
DeniedUrls (list) --
List of URL patterns that are denied from redirection. This list takes precedence over the allowed list.
(string) --
A glob pattern using wildcards (* for zero or more characters, ? for exactly one character) to match URLs for redirection rules. Patterns do not include a protocol prefix; HTTPS is enforced automatically. Valid examples: , *.example.com, github.com/myorg/, api?.example.com Invalid examples: https://example.com (no protocol), empty string
NextToken (string) --
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
{'AttributesToDelete': {'CONTENT_REDIRECTION'}}
Response {'Stack': {'ContentRedirection': {'HostToClient': {'AllowedUrls': ['string'],
'DeniedUrls': ['string'],
'Enabled': 'boolean'}}}}
Updates the specified fields for the specified stack.
See also: AWS API Documentation
Request Syntax
client.update_stack(
DisplayName='string',
Description='string',
Name='string',
StorageConnectors=[
{
'ConnectorType': 'HOMEFOLDERS'|'GOOGLE_DRIVE'|'ONE_DRIVE',
'ResourceIdentifier': 'string',
'Domains': [
'string',
],
'DomainsRequireAdminConsent': [
'string',
]
},
],
DeleteStorageConnectors=True|False,
RedirectURL='string',
FeedbackURL='string',
AttributesToDelete=[
'STORAGE_CONNECTORS'|'STORAGE_CONNECTOR_HOMEFOLDERS'|'STORAGE_CONNECTOR_GOOGLE_DRIVE'|'STORAGE_CONNECTOR_ONE_DRIVE'|'REDIRECT_URL'|'FEEDBACK_URL'|'THEME_NAME'|'USER_SETTINGS'|'EMBED_HOST_DOMAINS'|'IAM_ROLE_ARN'|'ACCESS_ENDPOINTS'|'STREAMING_EXPERIENCE_SETTINGS'|'CONTENT_REDIRECTION',
],
UserSettings=[
{
'Action': 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE'|'CLIPBOARD_COPY_TO_LOCAL_DEVICE'|'FILE_UPLOAD'|'FILE_DOWNLOAD'|'PRINTING_TO_LOCAL_DEVICE'|'DOMAIN_PASSWORD_SIGNIN'|'DOMAIN_SMART_CARD_SIGNIN'|'AUTO_TIME_ZONE_REDIRECTION',
'Permission': 'ENABLED'|'DISABLED',
'MaximumLength': 123
},
],
ApplicationSettings={
'Enabled': True|False,
'SettingsGroup': 'string'
},
AccessEndpoints=[
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
],
EmbedHostDomains=[
'string',
],
StreamingExperienceSettings={
'PreferredProtocol': 'TCP'|'UDP'
}
)
string
The stack name to display.
string
The description to display.
string
[REQUIRED]
The name of the stack.
list
The storage connectors to enable.
(dict) --
Describes a connector that enables persistent storage for users.
ConnectorType (string) -- [REQUIRED]
The type of storage connector.
ResourceIdentifier (string) --
The ARN of the storage connector.
Domains (list) --
The names of the domains for the account.
(string) -- GSuite domain for GDrive integration.
DomainsRequireAdminConsent (list) --
The OneDrive for Business domains where you require admin consent when users try to link their OneDrive account to WorkSpaces Applications. The attribute can only be specified when ConnectorType=ONE_DRIVE.
(string) -- GSuite domain for GDrive integration.
boolean
Deletes the storage connectors currently enabled for the stack.
string
The URL that users are redirected to after their streaming session ends.
string
The URL that users are redirected to after they choose the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
list
The stack attributes to delete.
(string) --
list
The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.
(dict) --
Describes an action and whether the action is enabled or disabled for users during their streaming sessions.
Action (string) -- [REQUIRED]
The action that is enabled or disabled.
Permission (string) -- [REQUIRED]
Indicates whether the action is enabled or disabled.
MaximumLength (integer) --
Specifies the number of characters that can be copied by end users from the local device to the remote session, and to the local device from the remote session.
This can be specified only for the CLIPBOARD_COPY_FROM_LOCAL_DEVICE and CLIPBOARD_COPY_TO_LOCAL_DEVICE actions.
This defaults to 20,971,520 (20 MB) when unspecified and the permission is ENABLED. This can't be specified when the permission is DISABLED.
The value can be between 1 and 20,971,520 (20 MB).
dict
The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.
Enabled (boolean) -- [REQUIRED]
Enables or disables persistent application settings for users during their streaming sessions.
SettingsGroup (string) --
The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack.
list
The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to WorkSpaces Applications only through the specified endpoints.
(dict) --
Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and WorkSpaces Applications. When you specify an interface endpoint for a stack, users of the stack can connect to WorkSpaces Applications only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
EndpointType (string) -- [REQUIRED]
The type of interface endpoint.
VpceId (string) --
The identifier (ID) of the VPC in which the interface endpoint is used.
list
The domains where WorkSpaces Applications streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded WorkSpaces Applications streaming sessions.
(string) -- Specifies a valid domain that can embed AppStream. Valid examples include: ["testorigin.tt--com", "testingorigin.com.us", "test.com.us"] Invalid examples include: ["test,com", ".com", "h*llo.com". ""]
dict
The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
PreferredProtocol (string) --
The preferred protocol that you want to use while streaming your application.
dict
Response Syntax
{
'Stack': {
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'DisplayName': 'string',
'CreatedTime': datetime(2015, 1, 1),
'StorageConnectors': [
{
'ConnectorType': 'HOMEFOLDERS'|'GOOGLE_DRIVE'|'ONE_DRIVE',
'ResourceIdentifier': 'string',
'Domains': [
'string',
],
'DomainsRequireAdminConsent': [
'string',
]
},
],
'RedirectURL': 'string',
'FeedbackURL': 'string',
'StackErrors': [
{
'ErrorCode': 'STORAGE_CONNECTOR_ERROR'|'INTERNAL_SERVICE_ERROR',
'ErrorMessage': 'string'
},
],
'UserSettings': [
{
'Action': 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE'|'CLIPBOARD_COPY_TO_LOCAL_DEVICE'|'FILE_UPLOAD'|'FILE_DOWNLOAD'|'PRINTING_TO_LOCAL_DEVICE'|'DOMAIN_PASSWORD_SIGNIN'|'DOMAIN_SMART_CARD_SIGNIN'|'AUTO_TIME_ZONE_REDIRECTION',
'Permission': 'ENABLED'|'DISABLED',
'MaximumLength': 123
},
],
'ApplicationSettings': {
'Enabled': True|False,
'SettingsGroup': 'string',
'S3BucketName': 'string'
},
'AccessEndpoints': [
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
],
'EmbedHostDomains': [
'string',
],
'StreamingExperienceSettings': {
'PreferredProtocol': 'TCP'|'UDP'
},
'ContentRedirection': {
'HostToClient': {
'Enabled': True|False,
'AllowedUrls': [
'string',
],
'DeniedUrls': [
'string',
]
}
}
}
}
Response Structure
(dict) --
Stack (dict) --
Information about the stack.
Arn (string) --
The ARN of the stack.
Name (string) --
The name of the stack.
Description (string) --
The description to display.
DisplayName (string) --
The stack name to display.
CreatedTime (datetime) --
The time the stack was created.
StorageConnectors (list) --
The storage connectors to enable.
(dict) --
Describes a connector that enables persistent storage for users.
ConnectorType (string) --
The type of storage connector.
ResourceIdentifier (string) --
The ARN of the storage connector.
Domains (list) --
The names of the domains for the account.
(string) -- GSuite domain for GDrive integration.
DomainsRequireAdminConsent (list) --
The OneDrive for Business domains where you require admin consent when users try to link their OneDrive account to WorkSpaces Applications. The attribute can only be specified when ConnectorType=ONE_DRIVE.
(string) -- GSuite domain for GDrive integration.
RedirectURL (string) --
The URL that users are redirected to after their streaming session ends.
FeedbackURL (string) --
The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
StackErrors (list) --
The errors for the stack.
(dict) --
Describes a stack error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
UserSettings (list) --
The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.
(dict) --
Describes an action and whether the action is enabled or disabled for users during their streaming sessions.
Action (string) --
The action that is enabled or disabled.
Permission (string) --
Indicates whether the action is enabled or disabled.
MaximumLength (integer) --
Specifies the number of characters that can be copied by end users from the local device to the remote session, and to the local device from the remote session.
This can be specified only for the CLIPBOARD_COPY_FROM_LOCAL_DEVICE and CLIPBOARD_COPY_TO_LOCAL_DEVICE actions.
This defaults to 20,971,520 (20 MB) when unspecified and the permission is ENABLED. This can't be specified when the permission is DISABLED.
The value can be between 1 and 20,971,520 (20 MB).
ApplicationSettings (dict) --
The persistent application settings for users of the stack.
Enabled (boolean) --
Specifies whether persistent application settings are enabled for users during their streaming sessions.
SettingsGroup (string) --
The path prefix for the S3 bucket where users’ persistent application settings are stored.
S3BucketName (string) --
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 AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region.
AccessEndpoints (list) --
The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to WorkSpaces Applications only through the specified endpoints.
(dict) --
Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and WorkSpaces Applications. When you specify an interface endpoint for a stack, users of the stack can connect to WorkSpaces Applications only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
EndpointType (string) --
The type of interface endpoint.
VpceId (string) --
The identifier (ID) of the VPC in which the interface endpoint is used.
EmbedHostDomains (list) --
The domains where WorkSpaces Applications streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded WorkSpaces Applications streaming sessions.
(string) -- Specifies a valid domain that can embed AppStream. Valid examples include: ["testorigin.tt--com", "testingorigin.com.us", "test.com.us"] Invalid examples include: ["test,com", ".com", "h*llo.com". ""]
StreamingExperienceSettings (dict) --
The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
PreferredProtocol (string) --
The preferred protocol that you want to use while streaming your application.
ContentRedirection (dict) --
Configuration for bidirectional URL redirection between the streaming session and the local client. Use HostToClient to redirect URLs from the remote desktop to the local browser.
HostToClient (dict) --
Configuration for redirecting URLs from the remote desktop to the local client browser.
Enabled (boolean) --
Whether URL redirection is enabled for this direction.
AllowedUrls (list) --
List of URL patterns that are allowed to be redirected. URLs matching these patterns will be redirected unless they also match a pattern in the denied list.
(string) --
A glob pattern using wildcards (* for zero or more characters, ? for exactly one character) to match URLs for redirection rules. Patterns do not include a protocol prefix; HTTPS is enforced automatically. Valid examples: , *.example.com, github.com/myorg/, api?.example.com Invalid examples: https://example.com (no protocol), empty string
DeniedUrls (list) --
List of URL patterns that are denied from redirection. This list takes precedence over the allowed list.
(string) --
A glob pattern using wildcards (* for zero or more characters, ? for exactly one character) to match URLs for redirection rules. Patterns do not include a protocol prefix; HTTPS is enforced automatically. Valid examples: , *.example.com, github.com/myorg/, api?.example.com Invalid examples: https://example.com (no protocol), empty string