types

package
v1.42.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 21, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Access is denied.

func (*AccessDeniedException) Error

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage

func (e *AccessDeniedException) ErrorMessage() string

type AuthenticationType added in v1.9.0

type AuthenticationType string
const (
	AuthenticationTypeStandard          AuthenticationType = "Standard"
	AuthenticationTypeIamIdentityCenter AuthenticationType = "IAM_Identity_Center"
)

Enum values for AuthenticationType

func (AuthenticationType) Values added in v1.9.0

Values returns all known values for AuthenticationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type BrandingConfiguration added in v1.35.0

type BrandingConfiguration struct {

	// The color theme for components on the web portal.
	//
	// This member is required.
	ColorTheme ColorTheme

	// Metadata for the favicon image file, including the MIME type, file extension,
	// and upload timestamp.
	//
	// This member is required.
	Favicon *ImageMetadata

	// A map of localized text strings for different languages, allowing the portal to
	// display content in the user's preferred language.
	//
	// This member is required.
	LocalizedStrings map[string]LocalizedBrandingStrings

	// upload timestamp.
	//
	// This member is required.
	Logo *ImageMetadata

	// The terms of service text in Markdown format that users must accept before
	// accessing the portal.
	//
	// This value conforms to the media type: text/markdown
	TermsOfService *string

	// Metadata for the wallpaper image file, including the MIME type, file extension,
	// and upload timestamp.
	Wallpaper *ImageMetadata
	// contains filtered or unexported fields
}

The branding configuration output including custom images metadata, localized strings, color theme, and terms of service.

type BrandingConfigurationCreateInput added in v1.35.0

type BrandingConfigurationCreateInput struct {

	// The color theme for components on the web portal. Choose Light if you upload a
	// dark wallpaper, or Dark for a light wallpaper.
	//
	// This member is required.
	ColorTheme ColorTheme

	// The favicon image for the portal. Provide either a binary image file or an S3
	// URI pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format.
	//
	// This member is required.
	Favicon IconImageInput

	// A map of localized text strings for different supported languages. Each locale
	// must provide the required fields browserTabTitle and welcomeText .
	//
	// This member is required.
	LocalizedStrings map[string]LocalizedBrandingStrings

	// pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format.
	//
	// This member is required.
	Logo IconImageInput

	// The terms of service text in Markdown format. Users will be presented with the
	// terms of service after successfully signing in.
	//
	// This value conforms to the media type: text/markdown
	TermsOfService *string

	// The wallpaper image for the portal. Provide either a binary image file or an S3
	// URI pointing to the image file. Maximum 5 MB in JPEG or PNG format. If not
	// provided, a default wallpaper will be used as the background image.
	Wallpaper WallpaperImageInput
	// contains filtered or unexported fields
}

The input configuration for creating branding settings.

type BrandingConfigurationUpdateInput added in v1.35.0

type BrandingConfigurationUpdateInput struct {

	// The color theme for components on the web portal. Choose Light if you upload a
	// dark wallpaper, or Dark for a light wallpaper.
	ColorTheme ColorTheme

	// The favicon image for the portal. Provide either a binary image file or an S3
	// URI pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format.
	Favicon IconImageInput

	// A map of localized text strings for different supported languages. Each locale
	// must provide the required fields browserTabTitle and welcomeText .
	LocalizedStrings map[string]LocalizedBrandingStrings

	// pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format.
	Logo IconImageInput

	// The terms of service text in Markdown format. To remove existing terms of
	// service, provide an empty string.
	//
	// This value conforms to the media type: text/markdown
	TermsOfService *string

	// The wallpaper image for the portal. Provide either a binary image file or an S3
	// URI pointing to the image file. Maximum 5 MB in JPEG or PNG format.
	Wallpaper WallpaperImageInput
	// contains filtered or unexported fields
}

The input configuration for updating branding settings. All fields are optional when updating existing branding.

type BrowserSettings

type BrowserSettings struct {

	// The ARN of the browser settings.
	//
	// This member is required.
	BrowserSettingsArn *string

	// The additional encryption context of the browser settings.
	AdditionalEncryptionContext map[string]string

	// A list of web portal ARNs that this browser settings is associated with.
	AssociatedPortalArns []string

	// A JSON string containing Chrome Enterprise policies that will be applied to all
	// streaming sessions.
	BrowserPolicy *string

	// The customer managed key used to encrypt sensitive information in the browser
	// settings.
	CustomerManagedKey *string

	// The policy that specifies which URLs end users are allowed to access or which
	// URLs or domain categories they are restricted from accessing for enhanced
	// security.
	WebContentFilteringPolicy *WebContentFilteringPolicy
	// contains filtered or unexported fields
}

The browser settings resource that can be associated with a web portal. Once associated with a web portal, browser settings control how the browser will behave once a user starts a streaming session for the web portal.

type BrowserSettingsSummary

type BrowserSettingsSummary struct {

	// The ARN of the browser settings.
	//
	// This member is required.
	BrowserSettingsArn *string
	// contains filtered or unexported fields
}

The summary for browser settings.

type BrowserType

type BrowserType string
const (
	BrowserTypeChrome BrowserType = "Chrome"
)

Enum values for BrowserType

func (BrowserType) Values

func (BrowserType) Values() []BrowserType

Values returns all known values for BrowserType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Category added in v1.34.0

type Category string
const (
	CategoryCults                      Category = "Cults"
	CategoryGambling                   Category = "Gambling"
	CategoryNudity                     Category = "Nudity"
	CategoryPornography                Category = "Pornography"
	CategorySexEducation               Category = "SexEducation"
	CategoryTasteless                  Category = "Tasteless"
	CategoryViolence                   Category = "Violence"
	CategoryDownloadSites              Category = "DownloadSites"
	CategoryImageSharing               Category = "ImageSharing"
	CategoryPeerToPeer                 Category = "PeerToPeer"
	CategoryStreamingMediaAndDownloads Category = "StreamingMediaAndDownloads"
	CategoryGenerativeAi               Category = "GenerativeAI"
	CategoryCriminalActivity           Category = "CriminalActivity"
	CategoryHacking                    Category = "Hacking"
	CategoryHateAndIntolerance         Category = "HateAndIntolerance"
	CategoryIllegalDrug                Category = "IllegalDrug"
	CategoryIllegalSoftware            Category = "IllegalSoftware"
	CategorySchoolCheating             Category = "SchoolCheating"
	CategorySelfHarm                   Category = "SelfHarm"
	CategoryWeapons                    Category = "Weapons"
	CategoryChat                       Category = "Chat"
	CategoryGames                      Category = "Games"
	CategoryInstantMessaging           Category = "InstantMessaging"
	CategoryProfessionalNetwork        Category = "ProfessionalNetwork"
	CategorySocialNetworking           Category = "SocialNetworking"
	CategoryWebBasedEmail              Category = "WebBasedEmail"
	CategoryParkedDomains              Category = "ParkedDomains"
)

Enum values for Category

func (Category) Values added in v1.34.0

func (Category) Values() []Category

Values returns all known values for Category. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Certificate

type Certificate struct {

	// The body of the certificate.
	Body []byte

	// The entity that issued the certificate.
	Issuer *string

	// The certificate is not valid after this date.
	NotValidAfter *time.Time

	// The certificate is not valid before this date.
	NotValidBefore *time.Time

	// The entity the certificate belongs to.
	Subject *string

	// A hexadecimal identifier for the certificate.
	Thumbprint *string
	// contains filtered or unexported fields
}

The certificate.

type CertificateSummary

type CertificateSummary struct {

	// The entity that issued the certificate.
	Issuer *string

	// The certificate is not valid after this date.
	NotValidAfter *time.Time

	// The certificate is not valid before this date.
	NotValidBefore *time.Time

	// The entity the certificate belongs to.
	Subject *string

	// A hexadecimal identifier for the certificate.
	Thumbprint *string
	// contains filtered or unexported fields
}

The summary of the certificate.

type ColorTheme added in v1.35.0

type ColorTheme string
const (
	ColorThemeLight ColorTheme = "Light"
	ColorThemeDark  ColorTheme = "Dark"
)

Enum values for ColorTheme

func (ColorTheme) Values added in v1.35.0

func (ColorTheme) Values() []ColorTheme

Values returns all known values for ColorTheme. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConflictException

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

There is a conflict.

func (*ConflictException) Error

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage

func (e *ConflictException) ErrorMessage() string

type CookieSpecification added in v1.12.0

type CookieSpecification struct {

	// The domain of the cookie.
	//
	// This member is required.
	Domain *string

	// The name of the cookie.
	Name *string

	// The path of the cookie.
	Path *string
	// contains filtered or unexported fields
}

Specifies a single cookie or set of cookies in an end user's browser.

type CookieSynchronizationConfiguration added in v1.12.0

type CookieSynchronizationConfiguration struct {

	// The list of cookie specifications that are allowed to be synchronized to the
	// remote browser.
	//
	// This member is required.
	Allowlist []CookieSpecification

	// The list of cookie specifications that are blocked from being synchronized to
	// the remote browser.
	Blocklist []CookieSpecification
	// contains filtered or unexported fields
}

The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.

type CustomPattern added in v1.25.0

type CustomPattern struct {

	// The pattern name for the custom pattern.
	//
	// This member is required.
	PatternName *string

	// The pattern regex for the customer pattern. The format must follow JavaScript
	// regex format. The pattern must be enclosed between slashes, and can have flags
	// behind the second slash. For example: “/ab+c/gi”.
	//
	// This member is required.
	PatternRegex *string

	// The keyword regex for the customer pattern. After there is a match to the
	// pattern regex, the keyword regex is used to search within the proximity of the
	// match. If there is a keyword match, then the match is confirmed. If no keyword
	// regex is provided, the pattern regex match will automatically be confirmed. The
	// format must follow JavaScript regex format. The pattern must be enclosed between
	// slashes, and can have flags behind the second slash. For example, “/ab+c/gi”
	KeywordRegex *string

	// The pattern description for the customer pattern.
	PatternDescription *string
	// contains filtered or unexported fields
}

The pattern configuration for redacting custom data types in session.

type DataProtectionSettings added in v1.25.0

type DataProtectionSettings struct {

	// The ARN of the data protection settings resource.
	//
	// This member is required.
	DataProtectionSettingsArn *string

	// The additional encryption context of the data protection settings.
	AdditionalEncryptionContext map[string]string

	// A list of web portal ARNs that this data protection settings resource is
	// associated with.
	AssociatedPortalArns []string

	// The creation date timestamp of the data protection settings.
	CreationDate *time.Time

	// The customer managed key used to encrypt sensitive information in the data
	// protection settings.
	CustomerManagedKey *string

	// The description of the data protection settings.
	Description *string

	// The display name of the data protection settings.
	DisplayName *string

	// The inline redaction configuration for the data protection settings.
	InlineRedactionConfiguration *InlineRedactionConfiguration
	// contains filtered or unexported fields
}

The data protection settings resource that can be associated with a web portal.

type DataProtectionSettingsSummary added in v1.25.0

type DataProtectionSettingsSummary struct {

	// The ARN of the data protection settings.
	//
	// This member is required.
	DataProtectionSettingsArn *string

	// The creation date timestamp of the data protection settings.
	CreationDate *time.Time

	// The description of the data protection settings.
	Description *string

	// The display name of the data protection settings.
	DisplayName *string
	// contains filtered or unexported fields
}

The summary of the data protection settings.

type EnabledType

type EnabledType string
const (
	EnabledTypeDisabled EnabledType = "Disabled"
	EnabledTypeEnabled  EnabledType = "Enabled"
)

Enum values for EnabledType

func (EnabledType) Values

func (EnabledType) Values() []EnabledType

Values returns all known values for EnabledType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Event added in v1.29.0

type Event string
const (
	EventWebsiteInteract                           Event = "WebsiteInteract"
	EventFileDownloadFromSecureBrowserToRemoteDisk Event = "FileDownloadFromSecureBrowserToRemoteDisk"
	EventFileTransferFromRemoteToLocalDisk         Event = "FileTransferFromRemoteToLocalDisk"
	EventFileTransferFromLocalToRemoteDisk         Event = "FileTransferFromLocalToRemoteDisk"
	EventFileUploadFromRemoteDiskToSecureBrowser   Event = "FileUploadFromRemoteDiskToSecureBrowser"
	EventContentPasteToWebsite                     Event = "ContentPasteToWebsite"
	EventContentTransferFromLocalToRemoteClipboard Event = "ContentTransferFromLocalToRemoteClipboard"
	EventContentCopyFromWebsite                    Event = "ContentCopyFromWebsite"
	EventUrlLoad                                   Event = "UrlLoad"
	EventTabOpen                                   Event = "TabOpen"
	EventTabClose                                  Event = "TabClose"
	EventPrintJobSubmit                            Event = "PrintJobSubmit"
	EventSessionConnect                            Event = "SessionConnect"
	EventSessionStart                              Event = "SessionStart"
	EventSessionDisconnect                         Event = "SessionDisconnect"
	EventSessionEnd                                Event = "SessionEnd"
	EventUrlBlockByContentFilter                   Event = "UrlBlockByContentFilter"
)

Enum values for Event

func (Event) Values added in v1.29.0

func (Event) Values() []Event

Values returns all known values for Event. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type EventFilter added in v1.29.0

type EventFilter interface {
	// contains filtered or unexported methods
}

The filter that specifies the events to monitor.

The following types satisfy this interface:

EventFilterMemberAll
EventFilterMemberInclude
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/workspacesweb/types"
)

func main() {
	var union types.EventFilter
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.EventFilterMemberAll:
		_ = v.Value // Value is types.Unit

	case *types.EventFilterMemberInclude:
		_ = v.Value // Value is []types.Event

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type EventFilterMemberAll added in v1.29.0

type EventFilterMemberAll struct {
	Value Unit
	// contains filtered or unexported fields
}

The filter that monitors all of the available events, including any new events emitted in the future.

type EventFilterMemberInclude added in v1.29.0

type EventFilterMemberInclude struct {
	Value []Event
	// contains filtered or unexported fields
}

The filter that monitors only the listed set of events. New events are not auto-monitored.

type FolderStructure added in v1.29.0

type FolderStructure string
const (
	FolderStructureFlat         FolderStructure = "Flat"
	FolderStructureNestedByDate FolderStructure = "NestedByDate"
)

Enum values for FolderStructure

func (FolderStructure) Values added in v1.29.0

func (FolderStructure) Values() []FolderStructure

Values returns all known values for FolderStructure. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type IconImageInput added in v1.35.0

type IconImageInput interface {
	// contains filtered or unexported methods
}

The input for an icon image (logo or favicon). Provide either a binary image file or an S3 URI pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format.

The following types satisfy this interface:

IconImageInputMemberBlob
IconImageInputMemberS3Uri
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/workspacesweb/types"
)

func main() {
	var union types.IconImageInput
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.IconImageInputMemberBlob:
		_ = v.Value // Value is []byte

	case *types.IconImageInputMemberS3Uri:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type IconImageInputMemberBlob added in v1.35.0

type IconImageInputMemberBlob struct {
	Value []byte
	// contains filtered or unexported fields
}

The image provided as a binary image file.

This value conforms to the media type: image/*

type IconImageInputMemberS3Uri added in v1.35.0

type IconImageInputMemberS3Uri struct {
	Value string
	// contains filtered or unexported fields
}

The S3 URI pointing to the image file. The URI must use the format s3://bucket-name/key-name . You must have read access to the S3 object.

type IdentityProvider

type IdentityProvider struct {

	// The ARN of the identity provider.
	//
	// This member is required.
	IdentityProviderArn *string

	// The identity provider details. The following list describes the provider detail
	// keys for each identity provider type.
	//
	//   - For Google and Login with Amazon:
	//
	//   - client_id
	//
	//   - client_secret
	//
	//   - authorize_scopes
	//
	//   - For Facebook:
	//
	//   - client_id
	//
	//   - client_secret
	//
	//   - authorize_scopes
	//
	//   - api_version
	//
	//   - For Sign in with Apple:
	//
	//   - client_id
	//
	//   - team_id
	//
	//   - key_id
	//
	//   - private_key
	//
	//   - authorize_scopes
	//
	//   - For OIDC providers:
	//
	//   - client_id
	//
	//   - client_secret
	//
	//   - attributes_request_method
	//
	//   - oidc_issuer
	//
	//   - authorize_scopes
	//
	//   - authorize_url if not available from discovery URL specified by oidc_issuer
	//   key
	//
	//   - token_url if not available from discovery URL specified by oidc_issuer key
	//
	//   - attributes_url if not available from discovery URL specified by oidc_issuer
	//   key
	//
	//   - jwks_uri if not available from discovery URL specified by oidc_issuer key
	//
	//   - For SAML providers:
	//
	//   - MetadataFile OR MetadataURL
	//
	//   - IDPSignout (boolean) optional
	//
	//   - IDPInit (boolean) optional
	//
	//   - RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256
	//
	//   - EncryptedResponses (boolean) optional
	IdentityProviderDetails map[string]string

	// The identity provider name.
	IdentityProviderName *string

	// The identity provider type.
	IdentityProviderType IdentityProviderType
	// contains filtered or unexported fields
}

The identity provider.

type IdentityProviderSummary

type IdentityProviderSummary struct {

	// The ARN of the identity provider.
	//
	// This member is required.
	IdentityProviderArn *string

	// The identity provider name.
	IdentityProviderName *string

	// The identity provider type.
	IdentityProviderType IdentityProviderType
	// contains filtered or unexported fields
}

The summary of the identity provider.

type IdentityProviderType

type IdentityProviderType string
const (
	IdentityProviderTypeSaml            IdentityProviderType = "SAML"
	IdentityProviderTypeFacebook        IdentityProviderType = "Facebook"
	IdentityProviderTypeGoogle          IdentityProviderType = "Google"
	IdentityProviderTypeLoginWithAmazon IdentityProviderType = "LoginWithAmazon"
	IdentityProviderTypeSignInWithApple IdentityProviderType = "SignInWithApple"
	IdentityProviderTypeOidc            IdentityProviderType = "OIDC"
)

Enum values for IdentityProviderType

func (IdentityProviderType) Values

Values returns all known values for IdentityProviderType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ImageMetadata added in v1.35.0

type ImageMetadata struct {

	// The file extension of the image.
	//
	// This member is required.
	FileExtension *string

	// The timestamp when the image was last uploaded.
	//
	// This member is required.
	LastUploadTimestamp *time.Time

	// The MIME type of the image.
	//
	// This member is required.
	MimeType MimeType
	// contains filtered or unexported fields
}

Metadata information about an uploaded image file.

type InlineRedactionConfiguration added in v1.25.0

type InlineRedactionConfiguration struct {

	// The inline redaction patterns to be enabled for the inline redaction
	// configuration.
	//
	// This member is required.
	InlineRedactionPatterns []InlineRedactionPattern

	// The global confidence level for the inline redaction configuration. This
	// indicates the certainty of data type matches in the redaction process.
	// Confidence level 3 means high confidence, and requires a formatted text pattern
	// match in order for content to be redacted. Confidence level 2 means medium
	// confidence, and redaction considers both formatted and unformatted text, and
	// adds keyword associate to the logic. Confidence level 1 means low confidence,
	// and redaction is enforced for both formatted pattern + unformatted pattern
	// without keyword. This is applied to patterns that do not have a pattern-level
	// confidence level. Defaults to confidence level 2.
	GlobalConfidenceLevel *int32

	// The global enforced URL configuration for the inline redaction configuration.
	// This is applied to patterns that do not have a pattern-level enforced URL list.
	GlobalEnforcedUrls []string

	// The global exempt URL configuration for the inline redaction configuration.
	// This is applied to patterns that do not have a pattern-level exempt URL list.
	GlobalExemptUrls []string
	// contains filtered or unexported fields
}

The configuration for in-session inline redaction.

type InlineRedactionPattern added in v1.25.0

type InlineRedactionPattern struct {

	// The redaction placeholder that will replace the redacted text in session for
	// the inline redaction pattern.
	//
	// This member is required.
	RedactionPlaceHolder *RedactionPlaceHolder

	// The built-in pattern from the list of preconfigured patterns. Either a
	// customPattern or builtInPatternId is required.
	BuiltInPatternId *string

	// The confidence level for inline redaction pattern. This indicates the certainty
	// of data type matches in the redaction process. Confidence level 3 means high
	// confidence, and requires a formatted text pattern match in order for content to
	// be redacted. Confidence level 2 means medium confidence, and redaction considers
	// both formatted and unformatted text, and adds keyword associate to the logic.
	// Confidence level 1 means low confidence, and redaction is enforced for both
	// formatted pattern + unformatted pattern without keyword. This overrides the
	// global confidence level.
	ConfidenceLevel *int32

	// >The configuration for a custom pattern. Either a customPattern or
	// builtInPatternId is required.
	CustomPattern *CustomPattern

	// The enforced URL configuration for the inline redaction pattern. This will
	// override the global enforced URL configuration.
	EnforcedUrls []string

	// The exempt URL configuration for the inline redaction pattern. This will
	// override the global exempt URL configuration for the inline redaction pattern.
	ExemptUrls []string
	// contains filtered or unexported fields
}

The set of patterns that determine the data types redacted in session.

type InstanceType added in v1.18.0

type InstanceType string
const (
	InstanceTypeStandardRegular InstanceType = "standard.regular"
	InstanceTypeStandardLarge   InstanceType = "standard.large"
	InstanceTypeStandardXlarge  InstanceType = "standard.xlarge"
)

Enum values for InstanceType

func (InstanceType) Values added in v1.18.0

func (InstanceType) Values() []InstanceType

Values returns all known values for InstanceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type InternalServerException

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string

	RetryAfterSeconds int32
	// contains filtered or unexported fields
}

There is an internal server error.

func (*InternalServerException) Error

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage

func (e *InternalServerException) ErrorMessage() string

type IpAccessSettings added in v1.10.0

type IpAccessSettings struct {

	// The ARN of the IP access settings resource.
	//
	// This member is required.
	IpAccessSettingsArn *string

	// The additional encryption context of the IP access settings.
	AdditionalEncryptionContext map[string]string

	// A list of web portal ARNs that this IP access settings resource is associated
	// with.
	AssociatedPortalArns []string

	// The creation date timestamp of the IP access settings.
	CreationDate *time.Time

	// The customer managed key used to encrypt sensitive information in the IP access
	// settings.
	CustomerManagedKey *string

	// The description of the IP access settings.
	Description *string

	//  The display name of the IP access settings.
	DisplayName *string

	// The IP rules of the IP access settings.
	IpRules []IpRule
	// contains filtered or unexported fields
}

The IP access settings resource that can be associated with a web portal.

type IpAccessSettingsSummary added in v1.10.0

type IpAccessSettingsSummary struct {

	// The ARN of IP access settings.
	//
	// This member is required.
	IpAccessSettingsArn *string

	// The creation date timestamp of the IP access settings.
	CreationDate *time.Time

	// The description of the IP access settings.
	Description *string

	// The display name of the IP access settings.
	DisplayName *string
	// contains filtered or unexported fields
}

The summary of IP access settings.

type IpRule added in v1.10.0

type IpRule struct {

	// The IP range of the IP rule.
	//
	// This member is required.
	IpRange *string

	// The description of the IP rule.
	Description *string
	// contains filtered or unexported fields
}

The IP rules of the IP access settings.

type Locale added in v1.35.0

type Locale string
const (
	LocaleDe Locale = "de-DE"
	LocaleEn Locale = "en-US"
	LocaleEs Locale = "es-ES"
	LocaleFr Locale = "fr-FR"
	LocaleId Locale = "id-ID"
	LocaleIt Locale = "it-IT"
	LocaleJp Locale = "ja-JP"
	LocaleKr Locale = "ko-KR"
	LocaleBr Locale = "pt-BR"
	LocaleCn Locale = "zh-CN"
	LocaleTw Locale = "zh-TW"
)

Enum values for Locale

func (Locale) Values added in v1.35.0

func (Locale) Values() []Locale

Values returns all known values for Locale. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LocalizedBrandingStrings added in v1.35.0

type LocalizedBrandingStrings struct {

	// The text displayed in the browser tab title.
	//
	// This member is required.
	BrowserTabTitle *string

	// The welcome text displayed on the sign-in page.
	//
	// This member is required.
	WelcomeText *string

	// The text displayed on the contact button. This field is optional and defaults
	// to "Contact us".
	ContactButtonText *string

	// A contact link URL. The URL must start with https:// or mailto: . If not
	// provided, the contact button will be hidden from the web portal screen.
	ContactLink *string

	// The text displayed during session loading. This field is optional and defaults
	// to "Loading your session".
	LoadingText *string

	// The text displayed on the login button. This field is optional and defaults to
	// "Sign In".
	LoginButtonText *string

	// The description text for the login section. This field is optional and defaults
	// to "Sign in to your session".
	LoginDescription *string

	// The title text for the login section. This field is optional and defaults to
	// "Sign In".
	LoginTitle *string
	// contains filtered or unexported fields
}

Localized text strings for a specific language that customize the web portal.

type LogConfiguration added in v1.29.0

type LogConfiguration struct {

	// The configuration for delivering the logs to S3.
	S3 *S3LogConfiguration
	// contains filtered or unexported fields
}

The configuration of the log.

type LogFileFormat added in v1.29.0

type LogFileFormat string
const (
	LogFileFormatJsonLines LogFileFormat = "JSONLines"
	LogFileFormatJson      LogFileFormat = "Json"
)

Enum values for LogFileFormat

func (LogFileFormat) Values added in v1.29.0

func (LogFileFormat) Values() []LogFileFormat

Values returns all known values for LogFileFormat. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MaxDisplayResolution added in v1.26.0

type MaxDisplayResolution string
const (
	MaxDisplayResolutionResolutionDci4k          MaxDisplayResolution = "size4096X2160"
	MaxDisplayResolutionResolutionUhd4k          MaxDisplayResolution = "size3840X2160"
	MaxDisplayResolutionResolution1440pUltraWide MaxDisplayResolution = "size3440X1440"
	MaxDisplayResolutionResolution1440p          MaxDisplayResolution = "size2560X1440"
	MaxDisplayResolutionResolution1080p          MaxDisplayResolution = "size1920X1080"
	MaxDisplayResolutionResolution720p           MaxDisplayResolution = "size1280X720"
	MaxDisplayResolutionResolution768p           MaxDisplayResolution = "size1024X768"
	MaxDisplayResolutionResolution600p           MaxDisplayResolution = "size800X600"
)

Enum values for MaxDisplayResolution

func (MaxDisplayResolution) Values added in v1.26.0

Values returns all known values for MaxDisplayResolution. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MimeType added in v1.35.0

type MimeType string
const (
	MimeTypePng  MimeType = "image/png"
	MimeTypeJpeg MimeType = "image/jpeg"
	MimeTypeIco  MimeType = "image/x-icon"
)

Enum values for MimeType

func (MimeType) Values added in v1.35.0

func (MimeType) Values() []MimeType

Values returns all known values for MimeType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type NetworkSettings

type NetworkSettings struct {

	// The ARN of the network settings.
	//
	// This member is required.
	NetworkSettingsArn *string

	// A list of web portal ARNs that this network settings is associated with.
	AssociatedPortalArns []string

	// One or more security groups used to control access from streaming instances to
	// your VPC.
	SecurityGroupIds []string

	// The subnets in which network interfaces are created to connect streaming
	// instances to your VPC. At least two of these subnets must be in different
	// availability zones.
	SubnetIds []string

	// The VPC that streaming instances will connect to.
	VpcId *string
	// contains filtered or unexported fields
}

A network settings resource that can be associated with a web portal. Once associated with a web portal, network settings define how streaming instances will connect with your specified VPC.

type NetworkSettingsSummary

type NetworkSettingsSummary struct {

	// The ARN of the network settings.
	//
	// This member is required.
	NetworkSettingsArn *string

	// The VPC ID of the network settings.
	VpcId *string
	// contains filtered or unexported fields
}

The summary of network settings.

type Portal

type Portal struct {

	// The ARN of the web portal.
	//
	// This member is required.
	PortalArn *string

	// The additional encryption context of the portal.
	AdditionalEncryptionContext map[string]string

	// The type of authentication integration points used when signing into the web
	// portal. Defaults to Standard .
	//
	// Standard web portals are authenticated directly through your identity provider.
	// You need to call CreateIdentityProvider to integrate your identity provider
	// with your web portal. User and group access to your web portal is controlled
	// through your identity provider.
	//
	// IAM Identity Center web portals are authenticated through IAM Identity Center.
	// Identity sources (including external identity provider integration), plus user
	// and group access to your web portal, can be configured in the IAM Identity
	// Center.
	AuthenticationType AuthenticationType

	// The ARN of the browser settings that is associated with this web portal.
	BrowserSettingsArn *string

	// The browser that users see when using a streaming session.
	BrowserType BrowserType

	// The creation date of the web portal.
	CreationDate *time.Time

	// The customer managed key used to encrypt sensitive information in the portal.
	CustomerManagedKey *string

	// The ARN of the data protection settings.
	DataProtectionSettingsArn *string

	// The name of the web portal.
	DisplayName *string

	// The type and resources of the underlying instance.
	InstanceType InstanceType

	// The ARN of the IP access settings.
	IpAccessSettingsArn *string

	// The maximum number of concurrent sessions for the portal.
	MaxConcurrentSessions *int32

	// The ARN of the network settings that is associated with the web portal.
	NetworkSettingsArn *string

	// The custom domain of the web portal that users access in order to start
	// streaming sessions.
	PortalCustomDomain *string

	// The endpoint URL of the web portal that users access in order to start
	// streaming sessions.
	PortalEndpoint *string

	// The status of the web portal.
	PortalStatus PortalStatus

	// The renderer that is used in streaming sessions.
	RendererType RendererType

	// The ARN of the session logger that is assocaited with the portal.
	SessionLoggerArn *string

	// A message that explains why the web portal is in its current status.
	StatusReason *string

	// The ARN of the trust store that is associated with the web portal.
	TrustStoreArn *string

	// The ARN of the user access logging settings that is associated with the web
	// portal.
	UserAccessLoggingSettingsArn *string

	// The ARN of the user settings that is associated with the web portal.
	UserSettingsArn *string
	// contains filtered or unexported fields
}

The web portal.

type PortalStatus

type PortalStatus string
const (
	PortalStatusIncomplete PortalStatus = "Incomplete"
	PortalStatusPending    PortalStatus = "Pending"
	PortalStatusActive     PortalStatus = "Active"
)

Enum values for PortalStatus

func (PortalStatus) Values

func (PortalStatus) Values() []PortalStatus

Values returns all known values for PortalStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PortalSummary

type PortalSummary struct {

	// The ARN of the web portal.
	//
	// This member is required.
	PortalArn *string

	// The type of authentication integration points used when signing into the web
	// portal. Defaults to Standard .
	//
	// Standard web portals are authenticated directly through your identity provider.
	// You need to call CreateIdentityProvider to integrate your identity provider
	// with your web portal. User and group access to your web portal is controlled
	// through your identity provider.
	//
	// IAM Identity Center web portals are authenticated through IAM Identity Center.
	// Identity sources (including external identity provider integration), plus user
	// and group access to your web portal, can be configured in the IAM Identity
	// Center.
	AuthenticationType AuthenticationType

	// The ARN of the browser settings that is associated with the web portal.
	BrowserSettingsArn *string

	// The browser type of the web portal.
	BrowserType BrowserType

	// The creation date of the web portal.
	CreationDate *time.Time

	// The ARN of the data protection settings.
	DataProtectionSettingsArn *string

	// The name of the web portal.
	DisplayName *string

	// The type and resources of the underlying instance.
	InstanceType InstanceType

	// The ARN of the IP access settings.
	IpAccessSettingsArn *string

	// The maximum number of concurrent sessions for the portal.
	MaxConcurrentSessions *int32

	// The ARN of the network settings that is associated with the web portal.
	NetworkSettingsArn *string

	// The custom domain of the web portal that users access in order to start
	// streaming sessions.
	PortalCustomDomain *string

	// The endpoint URL of the web portal that users access in order to start
	// streaming sessions.
	PortalEndpoint *string

	// The status of the web portal.
	PortalStatus PortalStatus

	// The renderer that is used in streaming sessions.
	RendererType RendererType

	// The ARN of the session logger that is assocaited with the portal.
	SessionLoggerArn *string

	// The ARN of the trust that is associated with this web portal.
	TrustStoreArn *string

	// The ARN of the user access logging settings that is associated with the web
	// portal.
	UserAccessLoggingSettingsArn *string

	// The ARN of the user settings that is associated with the web portal.
	UserSettingsArn *string
	// contains filtered or unexported fields
}

The summary of the portal.

type RedactionPlaceHolder added in v1.25.0

type RedactionPlaceHolder struct {

	// The redaction placeholder type that will replace the redacted text in session.
	//
	// This member is required.
	RedactionPlaceHolderType RedactionPlaceHolderType

	// The redaction placeholder text that will replace the redacted text in session
	// for the custom text redaction placeholder type.
	RedactionPlaceHolderText *string
	// contains filtered or unexported fields
}

The redaction placeholder that will replace the redacted text in session.

type RedactionPlaceHolderType added in v1.25.0

type RedactionPlaceHolderType string
const (
	RedactionPlaceHolderTypeCustomText RedactionPlaceHolderType = "CustomText"
)

Enum values for RedactionPlaceHolderType

func (RedactionPlaceHolderType) Values added in v1.25.0

Values returns all known values for RedactionPlaceHolderType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RendererType

type RendererType string
const (
	RendererTypeAppstream RendererType = "AppStream"
)

Enum values for RendererType

func (RendererType) Values

func (RendererType) Values() []RendererType

Values returns all known values for RendererType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

The resource cannot be found.

func (*ResourceNotFoundException) Error

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault

func (*ResourceNotFoundException) ErrorMessage

func (e *ResourceNotFoundException) ErrorMessage() string

type S3LogConfiguration added in v1.29.0

type S3LogConfiguration struct {

	// The S3 bucket name where logs are delivered.
	//
	// This member is required.
	Bucket *string

	// The folder structure that defines the organizational structure for log files in
	// S3.
	//
	// This member is required.
	FolderStructure FolderStructure

	// The format of the LogFile that is written to S3.
	//
	// This member is required.
	LogFileFormat LogFileFormat

	// The expected bucket owner of the target S3 bucket. The caller must have
	// permissions to write to the target bucket.
	BucketOwner *string

	// The S3 path prefix that determines where log files are stored.
	KeyPrefix *string
	// contains filtered or unexported fields
}

The S3 log configuration.

type ServiceQuotaExceededException

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	ServiceCode  *string
	QuotaCode    *string
	// contains filtered or unexported fields
}

The service quota has been exceeded.

func (*ServiceQuotaExceededException) Error

func (*ServiceQuotaExceededException) ErrorCode

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage

func (e *ServiceQuotaExceededException) ErrorMessage() string

type Session added in v1.22.0

type Session struct {

	// The IP address of the client.
	ClientIpAddresses []string

	// The end time of the session.
	EndTime *time.Time

	// The ARN of the web portal.
	PortalArn *string

	// The ID of the session.
	SessionId *string

	// The start time of the session.
	StartTime *time.Time

	// The status of the session.
	Status SessionStatus

	// The username of the session.
	Username *string
	// contains filtered or unexported fields
}

Information about a secure browser session.

type SessionLogger added in v1.29.0

type SessionLogger struct {

	// The ARN of the session logger resource.
	//
	// This member is required.
	SessionLoggerArn *string

	// The additional encryption context of the session logger.
	AdditionalEncryptionContext map[string]string

	// The associated portal ARN.
	AssociatedPortalArns []string

	// The date the session logger resource was created.
	CreationDate *time.Time

	// The custom managed key of the session logger.
	CustomerManagedKey *string

	// The human-readable display name.
	DisplayName *string

	// The filter that specifies which events to monitor.
	EventFilter EventFilter

	// The configuration that specifies where logs are fowarded.
	LogConfiguration *LogConfiguration
	// contains filtered or unexported fields
}

The session logger resource.

type SessionLoggerSummary added in v1.29.0

type SessionLoggerSummary struct {

	// The ARN of the session logger resource.
	//
	// This member is required.
	SessionLoggerArn *string

	// The date the session logger resource was created.
	CreationDate *time.Time

	// The human-readable display name.
	DisplayName *string

	// The configuration that specifies where the logs are fowarded.
	LogConfiguration *LogConfiguration
	// contains filtered or unexported fields
}

The summary of the session logger resource.

type SessionSortBy added in v1.22.0

type SessionSortBy string
const (
	SessionSortByStartTimeAscending  SessionSortBy = "StartTimeAscending"
	SessionSortByStartTimeDescending SessionSortBy = "StartTimeDescending"
)

Enum values for SessionSortBy

func (SessionSortBy) Values added in v1.22.0

func (SessionSortBy) Values() []SessionSortBy

Values returns all known values for SessionSortBy. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SessionStatus added in v1.22.0

type SessionStatus string
const (
	SessionStatusActive     SessionStatus = "Active"
	SessionStatusTerminated SessionStatus = "Terminated"
)

Enum values for SessionStatus

func (SessionStatus) Values added in v1.22.0

func (SessionStatus) Values() []SessionStatus

Values returns all known values for SessionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SessionSummary added in v1.22.0

type SessionSummary struct {

	// The end time of the session.
	EndTime *time.Time

	// The ARN of the web portal.
	PortalArn *string

	// The ID of the session.
	SessionId *string

	// The start time of the session.
	StartTime *time.Time

	// The status of the session.
	Status SessionStatus

	// The username of the session.
	Username *string
	// contains filtered or unexported fields
}

Summary information about a secure browser session.

type Tag

type Tag struct {

	// The key of the tag.
	//
	// This member is required.
	Key *string

	// The value of the tag
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

The tag.

type ThrottlingException

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	ServiceCode       *string
	QuotaCode         *string
	RetryAfterSeconds int32
	// contains filtered or unexported fields
}

There is a throttling error.

func (*ThrottlingException) Error

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage

func (e *ThrottlingException) ErrorMessage() string

type TooManyTagsException

type TooManyTagsException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceName *string
	// contains filtered or unexported fields
}

There are too many tags.

func (*TooManyTagsException) Error

func (e *TooManyTagsException) Error() string

func (*TooManyTagsException) ErrorCode

func (e *TooManyTagsException) ErrorCode() string

func (*TooManyTagsException) ErrorFault

func (e *TooManyTagsException) ErrorFault() smithy.ErrorFault

func (*TooManyTagsException) ErrorMessage

func (e *TooManyTagsException) ErrorMessage() string

type ToolbarConfiguration added in v1.26.0

type ToolbarConfiguration struct {

	// The list of toolbar items to be hidden.
	HiddenToolbarItems []ToolbarItem

	// The maximum display resolution that is allowed for the session.
	MaxDisplayResolution MaxDisplayResolution

	// The type of toolbar displayed during the session.
	ToolbarType ToolbarType

	// The visual mode of the toolbar.
	VisualMode VisualMode
	// contains filtered or unexported fields
}

The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.

type ToolbarItem added in v1.26.0

type ToolbarItem string
const (
	ToolbarItemWindows     ToolbarItem = "Windows"
	ToolbarItemDualMonitor ToolbarItem = "DualMonitor"
	ToolbarItemFullScreen  ToolbarItem = "FullScreen"
	ToolbarItemWebcam      ToolbarItem = "Webcam"
	ToolbarItemMicrophone  ToolbarItem = "Microphone"
)

Enum values for ToolbarItem

func (ToolbarItem) Values added in v1.26.0

func (ToolbarItem) Values() []ToolbarItem

Values returns all known values for ToolbarItem. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ToolbarType added in v1.26.0

type ToolbarType string
const (
	ToolbarTypeFloating ToolbarType = "Floating"
	ToolbarTypeDocked   ToolbarType = "Docked"
)

Enum values for ToolbarType

func (ToolbarType) Values added in v1.26.0

func (ToolbarType) Values() []ToolbarType

Values returns all known values for ToolbarType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TrustStore

type TrustStore struct {

	// The ARN of the trust store.
	//
	// This member is required.
	TrustStoreArn *string

	// A list of web portal ARNs that this trust store is associated with.
	AssociatedPortalArns []string
	// contains filtered or unexported fields
}

A trust store that can be associated with a web portal. A trust store contains certificate authority (CA) certificates. Once associated with a web portal, the browser in a streaming session will recognize certificates that have been issued using any of the CAs in the trust store. If your organization has internal websites that use certificates issued by private CAs, you should add the private CA certificate to the trust store.

type TrustStoreSummary

type TrustStoreSummary struct {

	// The ARN of the trust store.
	TrustStoreArn *string
	// contains filtered or unexported fields
}

The summary of the trust store.

type Unit added in v1.29.0

type Unit struct {
	// contains filtered or unexported fields
}

type UnknownUnionMember added in v1.29.0

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type UserAccessLoggingSettings added in v1.7.0

type UserAccessLoggingSettings struct {

	// The ARN of the user access logging settings.
	//
	// This member is required.
	UserAccessLoggingSettingsArn *string

	// A list of web portal ARNs that this user access logging settings is associated
	// with.
	AssociatedPortalArns []string

	// The ARN of the Kinesis stream.
	KinesisStreamArn *string
	// contains filtered or unexported fields
}

A user access logging settings resource that can be associated with a web portal.

type UserAccessLoggingSettingsSummary added in v1.7.0

type UserAccessLoggingSettingsSummary struct {

	// The ARN of the user access logging settings.
	//
	// This member is required.
	UserAccessLoggingSettingsArn *string

	// The ARN of the Kinesis stream.
	KinesisStreamArn *string
	// contains filtered or unexported fields
}

The summary of user access logging settings.

type UserSettings

type UserSettings struct {

	// The ARN of the user settings.
	//
	// This member is required.
	UserSettingsArn *string

	// The additional encryption context of the user settings.
	AdditionalEncryptionContext map[string]string

	// A list of web portal ARNs that this user settings is associated with.
	AssociatedPortalArns []string

	// The branding configuration output that customizes the appearance of the web
	// portal for end users.
	BrandingConfiguration *BrandingConfiguration

	// The configuration that specifies which cookies should be synchronized from the
	// end user's local browser to the remote browser.
	CookieSynchronizationConfiguration *CookieSynchronizationConfiguration

	// Specifies whether the user can copy text from the streaming session to the
	// local device.
	CopyAllowed EnabledType

	// The customer managed key used to encrypt sensitive information in the user
	// settings.
	CustomerManagedKey *string

	// Specifies whether the user can use deep links that open automatically when
	// connecting to a session.
	DeepLinkAllowed EnabledType

	// The amount of time that a streaming session remains active after users
	// disconnect.
	DisconnectTimeoutInMinutes *int32

	// Specifies whether the user can download files from the streaming session to the
	// local device.
	DownloadAllowed EnabledType

	// The amount of time that users can be idle (inactive) before they are
	// disconnected from their streaming session and the disconnect timeout interval
	// begins.
	IdleDisconnectTimeoutInMinutes *int32

	// Specifies whether the user can paste text from the local device to the
	// streaming session.
	PasteAllowed EnabledType

	// Specifies whether the user can print to the local device.
	PrintAllowed EnabledType

	// The configuration of the toolbar. This allows administrators to select the
	// toolbar type and visual mode, set maximum display resolution for sessions, and
	// choose which items are visible to end users during their sessions. If
	// administrators do not modify these settings, end users retain control over their
	// toolbar preferences.
	ToolbarConfiguration *ToolbarConfiguration

	// Specifies whether the user can upload files from the local device to the
	// streaming session.
	UploadAllowed EnabledType

	// Specifies whether the user can use WebAuthn redirection for passwordless login
	// to websites within the streaming session.
	WebAuthnAllowed EnabledType
	// contains filtered or unexported fields
}

A user settings resource that can be associated with a web portal. Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

type UserSettingsSummary

type UserSettingsSummary struct {

	// The ARN of the user settings.
	//
	// This member is required.
	UserSettingsArn *string

	// The branding configuration output that customizes the appearance of the web
	// portal for end users.
	BrandingConfiguration *BrandingConfiguration

	// The configuration that specifies which cookies should be synchronized from the
	// end user's local browser to the remote browser.
	CookieSynchronizationConfiguration *CookieSynchronizationConfiguration

	// Specifies whether the user can copy text from the streaming session to the
	// local device.
	CopyAllowed EnabledType

	// Specifies whether the user can use deep links that open automatically when
	// connecting to a session.
	DeepLinkAllowed EnabledType

	// The amount of time that a streaming session remains active after users
	// disconnect.
	DisconnectTimeoutInMinutes *int32

	// Specifies whether the user can download files from the streaming session to the
	// local device.
	DownloadAllowed EnabledType

	// The amount of time that users can be idle (inactive) before they are
	// disconnected from their streaming session and the disconnect timeout interval
	// begins.
	IdleDisconnectTimeoutInMinutes *int32

	// Specifies whether the user can paste text from the local device to the
	// streaming session.
	PasteAllowed EnabledType

	// Specifies whether the user can print to the local device.
	PrintAllowed EnabledType

	// The configuration of the toolbar. This allows administrators to select the
	// toolbar type and visual mode, set maximum display resolution for sessions, and
	// choose which items are visible to end users during their sessions. If
	// administrators do not modify these settings, end users retain control over their
	// toolbar preferences.
	ToolbarConfiguration *ToolbarConfiguration

	// Specifies whether the user can upload files from the local device to the
	// streaming session.
	UploadAllowed EnabledType

	// Specifies whether the user can use WebAuthn redirection for passwordless login
	// to websites within the streaming session.
	WebAuthnAllowed EnabledType
	// contains filtered or unexported fields
}

The summary of user settings.

type ValidationException

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	Reason    ValidationExceptionReason
	FieldList []ValidationExceptionField
	// contains filtered or unexported fields
}

There is a validation error.

func (*ValidationException) Error

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage

func (e *ValidationException) ErrorMessage() string

type ValidationExceptionField

type ValidationExceptionField struct {

	// The message describing why the field failed validation.
	//
	// This member is required.
	Message *string

	// The name of the field that failed validation.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

Information about a field passed inside a request that resulted in an exception.

type ValidationExceptionReason

type ValidationExceptionReason string
const (
	ValidationExceptionReasonUnknownOperation      ValidationExceptionReason = "unknownOperation"
	ValidationExceptionReasonCannotParse           ValidationExceptionReason = "cannotParse"
	ValidationExceptionReasonFieldValidationFailed ValidationExceptionReason = "fieldValidationFailed"
	ValidationExceptionReasonOther                 ValidationExceptionReason = "other"
)

Enum values for ValidationExceptionReason

func (ValidationExceptionReason) Values

Values returns all known values for ValidationExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type VisualMode added in v1.26.0

type VisualMode string
const (
	VisualModeDark  VisualMode = "Dark"
	VisualModeLight VisualMode = "Light"
)

Enum values for VisualMode

func (VisualMode) Values added in v1.26.0

func (VisualMode) Values() []VisualMode

Values returns all known values for VisualMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type WallpaperImageInput added in v1.35.0

type WallpaperImageInput interface {
	// contains filtered or unexported methods
}

The input for a wallpaper image. Provide the image as either a binary image file or an S3 URI. Maximum 5 MB in JPEG or PNG format.

The following types satisfy this interface:

WallpaperImageInputMemberBlob
WallpaperImageInputMemberS3Uri
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/workspacesweb/types"
)

func main() {
	var union types.WallpaperImageInput
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.WallpaperImageInputMemberBlob:
		_ = v.Value // Value is []byte

	case *types.WallpaperImageInputMemberS3Uri:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type WallpaperImageInputMemberBlob added in v1.35.0

type WallpaperImageInputMemberBlob struct {
	Value []byte
	// contains filtered or unexported fields
}

The image provided as a binary image file.

This value conforms to the media type: image/*

type WallpaperImageInputMemberS3Uri added in v1.35.0

type WallpaperImageInputMemberS3Uri struct {
	Value string
	// contains filtered or unexported fields
}

The S3 URI pointing to the image file. The URI must use the format s3://bucket-name/key-name . You must have read access to the S3 object.

type WebContentFilteringPolicy added in v1.34.0

type WebContentFilteringPolicy struct {

	// URLs and domains that are always accessible to end users.
	AllowedUrls []string

	// Categories of websites that are blocked on the end user’s browsers.
	BlockedCategories []Category

	// URLs and domains that end users cannot access.
	BlockedUrls []string
	// contains filtered or unexported fields
}

The policy that specifies which URLs end users are allowed to access or which URLs or domain categories they are restricted from accessing for enhanced security.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL