AWS SDK for PHP 3.x

Client: Aws\WorkSpacesWeb\WorkSpacesWebClient

Service ID: workspaces-web

Version: 2020-07-08

This page describes the parameters and results for the operations of the Amazon WorkSpaces Web (2020-07-08), and shows how to use the Aws\WorkSpacesWeb\WorkSpacesWebClient object to call the described operations. This documentation is specific to the 2020-07-08 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AssociateBrowserSettings ( array $params = [] ): Associates a browser settings resource with a web portal.
AssociateDataProtectionSettings ( array $params = [] ): Associates a data protection settings resource with a web portal.
AssociateIpAccessSettings ( array $params = [] ): Associates an IP access settings resource with a web portal.
AssociateNetworkSettings ( array $params = [] ): Associates a network settings resource with a web portal.
AssociateTrustStore ( array $params = [] ): Associates a trust store with a web portal.
AssociateUserAccessLoggingSettings ( array $params = [] ): Associates a user access logging settings resource with a web portal.
AssociateUserSettings ( array $params = [] ): Associates a user settings resource with a web portal.
CreateBrowserSettings ( array $params = [] ): Creates a browser settings resource that can be associated with a web portal.
CreateDataProtectionSettings ( array $params = [] ): Creates a data protection settings resource that can be associated with a web portal.
CreateIdentityProvider ( array $params = [] ): Creates an identity provider resource that is then associated with a web portal.
CreateIpAccessSettings ( array $params = [] ): Creates an IP access settings resource that can be associated with a web portal.
CreateNetworkSettings ( array $params = [] ): Creates a network settings resource that can be associated with a web portal.
CreatePortal ( array $params = [] ): Creates a web portal.
CreateTrustStore ( array $params = [] ): Creates a trust store that can be associated with a web portal.
CreateUserAccessLoggingSettings ( array $params = [] ): Creates a user access logging settings resource that can be associated with a web portal.
CreateUserSettings ( array $params = [] ): Creates a user settings resource that can be associated with a web portal.
DeleteBrowserSettings ( array $params = [] ): Deletes browser settings.
DeleteDataProtectionSettings ( array $params = [] ): Deletes data protection settings.
DeleteIdentityProvider ( array $params = [] ): Deletes the identity provider.
DeleteIpAccessSettings ( array $params = [] ): Deletes IP access settings.
DeleteNetworkSettings ( array $params = [] ): Deletes network settings.
DeletePortal ( array $params = [] ): Deletes a web portal.
DeleteTrustStore ( array $params = [] ): Deletes the trust store.
DeleteUserAccessLoggingSettings ( array $params = [] ): Deletes user access logging settings.
DeleteUserSettings ( array $params = [] ): Deletes user settings.
DisassociateBrowserSettings ( array $params = [] ): Disassociates browser settings from a web portal.
DisassociateDataProtectionSettings ( array $params = [] ): Disassociates data protection settings from a web portal.
DisassociateIpAccessSettings ( array $params = [] ): Disassociates IP access settings from a web portal.
DisassociateNetworkSettings ( array $params = [] ): Disassociates network settings from a web portal.
DisassociateTrustStore ( array $params = [] ): Disassociates a trust store from a web portal.
DisassociateUserAccessLoggingSettings ( array $params = [] ): Disassociates user access logging settings from a web portal.
DisassociateUserSettings ( array $params = [] ): Disassociates user settings from a web portal.
ExpireSession ( array $params = [] ): Expires an active secure browser session.
GetBrowserSettings ( array $params = [] ): Gets browser settings.
GetDataProtectionSettings ( array $params = [] ): Gets the data protection settings.
GetIdentityProvider ( array $params = [] ): Gets the identity provider.
GetIpAccessSettings ( array $params = [] ): Gets the IP access settings.
GetNetworkSettings ( array $params = [] ): Gets the network settings.
GetPortal ( array $params = [] ): Gets the web portal.
GetPortalServiceProviderMetadata ( array $params = [] ): Gets the service provider metadata.
GetSession ( array $params = [] ): Gets information for a secure browser session.
GetTrustStore ( array $params = [] ): Gets the trust store.
GetTrustStoreCertificate ( array $params = [] ): Gets the trust store certificate.
GetUserAccessLoggingSettings ( array $params = [] ): Gets user access logging settings.
GetUserSettings ( array $params = [] ): Gets user settings.
ListBrowserSettings ( array $params = [] ): Retrieves a list of browser settings.
ListDataProtectionSettings ( array $params = [] ): Retrieves a list of data protection settings.
ListIdentityProviders ( array $params = [] ): Retrieves a list of identity providers for a specific web portal.
ListIpAccessSettings ( array $params = [] ): Retrieves a list of IP access settings.
ListNetworkSettings ( array $params = [] ): Retrieves a list of network settings.
ListPortals ( array $params = [] ): Retrieves a list or web portals.
ListSessions ( array $params = [] ): Lists information for multiple secure browser sessions from a specific portal.
ListTagsForResource ( array $params = [] ): Retrieves a list of tags for a resource.
ListTrustStoreCertificates ( array $params = [] ): Retrieves a list of trust store certificates.
ListTrustStores ( array $params = [] ): Retrieves a list of trust stores.
ListUserAccessLoggingSettings ( array $params = [] ): Retrieves a list of user access logging settings.
ListUserSettings ( array $params = [] ): Retrieves a list of user settings.
TagResource ( array $params = [] ): Adds or overwrites one or more tags for the specified resource.
UntagResource ( array $params = [] ): Removes one or more tags from the specified resource.
UpdateBrowserSettings ( array $params = [] ): Updates browser settings.
UpdateDataProtectionSettings ( array $params = [] ): Updates data protection settings.
UpdateIdentityProvider ( array $params = [] ): Updates the identity provider.
UpdateIpAccessSettings ( array $params = [] ): Updates IP access settings.
UpdateNetworkSettings ( array $params = [] ): Updates network settings.
UpdatePortal ( array $params = [] ): Updates a web portal.
UpdateTrustStore ( array $params = [] ): Updates the trust store.
UpdateUserAccessLoggingSettings ( array $params = [] ): Updates the user access logging settings.
UpdateUserSettings ( array $params = [] ): Updates the user settings.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListBrowserSettings
ListDataProtectionSettings
ListIdentityProviders
ListIpAccessSettings
ListNetworkSettings
ListPortals
ListSessions
ListTrustStoreCertificates
ListTrustStores
ListUserAccessLoggingSettings
ListUserSettings

Operations

AssociateBrowserSettings

$result = $client->associateBrowserSettings([/* ... */]);
$promise = $client->associateBrowserSettingsAsync([/* ... */]);

Associates a browser settings resource with a web portal.

Parameter Syntax

$result = $client->associateBrowserSettings([
    'browserSettingsArn' => '<string>', // REQUIRED
    'portalArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

browserSettingsArn

: Required: Yes
: Type: string

The ARN of the browser settings.

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

Result Syntax

[
    'browserSettingsArn' => '<string>',
    'portalArn' => '<string>',
]

Result Details

Members

browserSettingsArn

: Required: Yes
: Type: string

The ARN of the browser settings.

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

AssociateDataProtectionSettings

$result = $client->associateDataProtectionSettings([/* ... */]);
$promise = $client->associateDataProtectionSettingsAsync([/* ... */]);

Associates a data protection settings resource with a web portal.

Parameter Syntax

$result = $client->associateDataProtectionSettings([
    'dataProtectionSettingsArn' => '<string>', // REQUIRED
    'portalArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

dataProtectionSettingsArn

: Required: Yes
: Type: string

The ARN of the data protection settings.

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

Result Syntax

[
    'dataProtectionSettingsArn' => '<string>',
    'portalArn' => '<string>',
]

Result Details

Members

dataProtectionSettingsArn

: Required: Yes
: Type: string

The ARN of the data protection settings resource.

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

AssociateIpAccessSettings

$result = $client->associateIpAccessSettings([/* ... */]);
$promise = $client->associateIpAccessSettingsAsync([/* ... */]);

Associates an IP access settings resource with a web portal.

Parameter Syntax

$result = $client->associateIpAccessSettings([
    'ipAccessSettingsArn' => '<string>', // REQUIRED
    'portalArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ipAccessSettingsArn

: Required: Yes
: Type: string

The ARN of the IP access settings.

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

Result Syntax

[
    'ipAccessSettingsArn' => '<string>',
    'portalArn' => '<string>',
]

Result Details

Members

ipAccessSettingsArn

: Required: Yes
: Type: string

The ARN of the IP access settings resource.

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

AssociateNetworkSettings

$result = $client->associateNetworkSettings([/* ... */]);
$promise = $client->associateNetworkSettingsAsync([/* ... */]);

Associates a network settings resource with a web portal.

Parameter Syntax

$result = $client->associateNetworkSettings([
    'networkSettingsArn' => '<string>', // REQUIRED
    'portalArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

networkSettingsArn

: Required: Yes
: Type: string

The ARN of the network settings.

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

Result Syntax

[
    'networkSettingsArn' => '<string>',
    'portalArn' => '<string>',
]

Result Details

Members

networkSettingsArn

: Required: Yes
: Type: string

The ARN of the network settings.

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

AssociateTrustStore

$result = $client->associateTrustStore([/* ... */]);
$promise = $client->associateTrustStoreAsync([/* ... */]);

Associates a trust store with a web portal.

Parameter Syntax

$result = $client->associateTrustStore([
    'portalArn' => '<string>', // REQUIRED
    'trustStoreArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

trustStoreArn

: Required: Yes
: Type: string

The ARN of the trust store.

Result Syntax

[
    'portalArn' => '<string>',
    'trustStoreArn' => '<string>',
]

Result Details

Members

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

trustStoreArn

: Required: Yes
: Type: string

The ARN of the trust store.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

AssociateUserAccessLoggingSettings

$result = $client->associateUserAccessLoggingSettings([/* ... */]);
$promise = $client->associateUserAccessLoggingSettingsAsync([/* ... */]);

Associates a user access logging settings resource with a web portal.

Parameter Syntax

$result = $client->associateUserAccessLoggingSettings([
    'portalArn' => '<string>', // REQUIRED
    'userAccessLoggingSettingsArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

userAccessLoggingSettingsArn

: Required: Yes
: Type: string

The ARN of the user access logging settings.

Result Syntax

[
    'portalArn' => '<string>',
    'userAccessLoggingSettingsArn' => '<string>',
]

Result Details

Members

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

userAccessLoggingSettingsArn

: Required: Yes
: Type: string

The ARN of the user access logging settings.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

AssociateUserSettings

$result = $client->associateUserSettings([/* ... */]);
$promise = $client->associateUserSettingsAsync([/* ... */]);

Associates a user settings resource with a web portal.

Parameter Syntax

$result = $client->associateUserSettings([
    'portalArn' => '<string>', // REQUIRED
    'userSettingsArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

userSettingsArn

: Required: Yes
: Type: string

The ARN of the user settings.

Result Syntax

[
    'portalArn' => '<string>',
    'userSettingsArn' => '<string>',
]

Result Details

Members

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

userSettingsArn

: Required: Yes
: Type: string

The ARN of the user settings.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

CreateBrowserSettings

$result = $client->createBrowserSettings([/* ... */]);
$promise = $client->createBrowserSettingsAsync([/* ... */]);

Creates a 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.

Parameter Syntax

$result = $client->createBrowserSettings([
    'additionalEncryptionContext' => ['<string>', ...],
    'browserPolicy' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'customerManagedKey' => '<string>',
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

additionalEncryptionContext

: Type: Associative array of custom strings keys (StringType) to strings

Additional encryption context of the browser settings.

browserPolicy

: Required: Yes
: Type: string

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

clientToken

: Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

customerManagedKey

: Type: string

The custom managed key of the browser settings.

tags

: Type: Array of Tag structures

The tags to add to the browser settings resource. A tag is a key-value pair.

Result Syntax

[
    'browserSettingsArn' => '<string>',
]

Result Details

Members

browserSettingsArn

: Required: Yes
: Type: string

The ARN of the browser settings.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ServiceQuotaExceededException:: The service quota has been exceeded.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

CreateDataProtectionSettings

$result = $client->createDataProtectionSettings([/* ... */]);
$promise = $client->createDataProtectionSettingsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createDataProtectionSettings([
    'additionalEncryptionContext' => ['<string>', ...],
    'clientToken' => '<string>',
    'customerManagedKey' => '<string>',
    'description' => '<string>',
    'displayName' => '<string>',
    'inlineRedactionConfiguration' => [
        'globalConfidenceLevel' => <integer>,
        'globalEnforcedUrls' => ['<string>', ...],
        'globalExemptUrls' => ['<string>', ...],
        'inlineRedactionPatterns' => [ // REQUIRED
            [
                'builtInPatternId' => '<string>',
                'confidenceLevel' => <integer>,
                'customPattern' => [
                    'keywordRegex' => '<string>',
                    'patternDescription' => '<string>',
                    'patternName' => '<string>', // REQUIRED
                    'patternRegex' => '<string>', // REQUIRED
                ],
                'enforcedUrls' => ['<string>', ...],
                'exemptUrls' => ['<string>', ...],
                'redactionPlaceHolder' => [ // REQUIRED
                    'redactionPlaceHolderText' => '<string>',
                    'redactionPlaceHolderType' => 'CustomText', // REQUIRED
                ],
            ],
            // ...
        ],
    ],
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

additionalEncryptionContext

: Type: Associative array of custom strings keys (StringType) to strings

Additional encryption context of the data protection settings.

clientToken

: Type: string

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

customerManagedKey

: Type: string

The custom managed key of the data protection settings.

description

: Type: string

The description of the data protection settings.

displayName

: Type: string

The display name of the data protection settings.

inlineRedactionConfiguration

: Type: InlineRedactionConfiguration structure

The inline redaction configuration of the data protection settings that will be applied to all sessions.

tags

: Type: Array of Tag structures

The tags to add to the data protection settings resource. A tag is a key-value pair.

Result Syntax

[
    'dataProtectionSettingsArn' => '<string>',
]

Result Details

Members

dataProtectionSettingsArn

: Required: Yes
: Type: string

The ARN of the data protection settings resource.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ServiceQuotaExceededException:: The service quota has been exceeded.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

CreateIdentityProvider

$result = $client->createIdentityProvider([/* ... */]);
$promise = $client->createIdentityProviderAsync([/* ... */]);

Creates an identity provider resource that is then associated with a web portal.

Parameter Syntax

$result = $client->createIdentityProvider([
    'clientToken' => '<string>',
    'identityProviderDetails' => ['<string>', ...], // REQUIRED
    'identityProviderName' => '<string>', // REQUIRED
    'identityProviderType' => 'SAML|Facebook|Google|LoginWithAmazon|SignInWithApple|OIDC', // REQUIRED
    'portalArn' => '<string>', // REQUIRED
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

clientToken

: Type: string

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

identityProviderDetails

: Required: Yes
: Type: Associative array of custom strings keys (StringType) to strings

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

identityProviderName

: Required: Yes
: Type: string

The identity provider name.

identityProviderType

: Required: Yes
: Type: string

The identity provider type.

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

tags

: Type: Array of Tag structures

The tags to add to the identity provider resource. A tag is a key-value pair.

Result Syntax

[
    'identityProviderArn' => '<string>',
]

Result Details

Members

identityProviderArn

: Required: Yes
: Type: string

The ARN of the identity provider.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ServiceQuotaExceededException:: The service quota has been exceeded.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

CreateIpAccessSettings

$result = $client->createIpAccessSettings([/* ... */]);
$promise = $client->createIpAccessSettingsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createIpAccessSettings([
    'additionalEncryptionContext' => ['<string>', ...],
    'clientToken' => '<string>',
    'customerManagedKey' => '<string>',
    'description' => '<string>',
    'displayName' => '<string>',
    'ipRules' => [ // REQUIRED
        [
            'description' => '<string>',
            'ipRange' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

additionalEncryptionContext

: Type: Associative array of custom strings keys (StringType) to strings

Additional encryption context of the IP access settings.

clientToken

: Type: string

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

customerManagedKey

: Type: string

The custom managed key of the IP access settings.

description

: Type: string

The description of the IP access settings.

displayName

: Type: string

The display name of the IP access settings.

ipRules

: Required: Yes
: Type: Array of IpRule structures

The IP rules of the IP access settings.

tags

: Type: Array of Tag structures

The tags to add to the IP access settings resource. A tag is a key-value pair.

Result Syntax

[
    'ipAccessSettingsArn' => '<string>',
]

Result Details

Members

ipAccessSettingsArn

: Required: Yes
: Type: string

The ARN of the IP access settings resource.

Errors

InternalServerException:: There is an internal server error.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ServiceQuotaExceededException:: The service quota has been exceeded.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

CreateNetworkSettings

$result = $client->createNetworkSettings([/* ... */]);
$promise = $client->createNetworkSettingsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createNetworkSettings([
    'clientToken' => '<string>',
    'securityGroupIds' => ['<string>', ...], // REQUIRED
    'subnetIds' => ['<string>', ...], // REQUIRED
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'vpcId' => '<string>', // REQUIRED
]);

Parameter Details

Members

clientToken

: Type: string

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

securityGroupIds

: Required: Yes
: Type: Array of strings

One or more security groups used to control access from streaming instances to your VPC.

subnetIds

: Required: Yes
: Type: Array of strings

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.

tags

: Type: Array of Tag structures

The tags to add to the network settings resource. A tag is a key-value pair.

vpcId

: Required: Yes
: Type: string

The VPC that streaming instances will connect to.

Result Syntax

[
    'networkSettingsArn' => '<string>',
]

Result Details

Members

networkSettingsArn

: Required: Yes
: Type: string

The ARN of the network settings.

Errors

InternalServerException:: There is an internal server error.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ServiceQuotaExceededException:: The service quota has been exceeded.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

CreatePortal

$result = $client->createPortal([/* ... */]);
$promise = $client->createPortalAsync([/* ... */]);

Creates a web portal.

Parameter Syntax

$result = $client->createPortal([
    'additionalEncryptionContext' => ['<string>', ...],
    'authenticationType' => 'Standard|IAM_Identity_Center',
    'clientToken' => '<string>',
    'customerManagedKey' => '<string>',
    'displayName' => '<string>',
    'instanceType' => 'standard.regular|standard.large|standard.xlarge',
    'maxConcurrentSessions' => <integer>,
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

additionalEncryptionContext

: Type: Associative array of custom strings keys (StringType) to strings

The additional encryption context of the portal.

authenticationType

: Type: 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.

clientToken

: Type: string

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

customerManagedKey

: Type: string

The customer managed key of the web portal.

displayName

: Type: string

The name of the web portal. This is not visible to users who log into the web portal.

instanceType

: Type: string

The type and resources of the underlying instance.

maxConcurrentSessions

: Type: int

The maximum number of concurrent sessions for the portal.

tags

: Type: Array of Tag structures

The tags to add to the web portal. A tag is a key-value pair.

Result Syntax

[
    'portalArn' => '<string>',
    'portalEndpoint' => '<string>',
]

Result Details

Members

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

portalEndpoint

: Required: Yes
: Type: string

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

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ServiceQuotaExceededException:: The service quota has been exceeded.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

CreateTrustStore

$result = $client->createTrustStore([/* ... */]);
$promise = $client->createTrustStoreAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createTrustStore([
    'certificateList' => [<string || resource || Psr\Http\Message\StreamInterface>, ...], // REQUIRED
    'clientToken' => '<string>',
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

certificateList

: Required: Yes
: Type: Array of blob (string|resource|Psr\Http\Message\StreamInterface)s

A list of CA certificates to be added to the trust store.

clientToken

: Type: string

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

tags

: Type: Array of Tag structures

The tags to add to the trust store. A tag is a key-value pair.

Result Syntax

[
    'trustStoreArn' => '<string>',
]

Result Details

Members

trustStoreArn

: Required: Yes
: Type: string

The ARN of the trust store.

Errors

InternalServerException:: There is an internal server error.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ServiceQuotaExceededException:: The service quota has been exceeded.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

CreateUserAccessLoggingSettings

$result = $client->createUserAccessLoggingSettings([/* ... */]);
$promise = $client->createUserAccessLoggingSettingsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createUserAccessLoggingSettings([
    'clientToken' => '<string>',
    'kinesisStreamArn' => '<string>', // REQUIRED
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

clientToken

: Type: string

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

kinesisStreamArn

: Required: Yes
: Type: string

The ARN of the Kinesis stream.

tags

: Type: Array of Tag structures

The tags to add to the user settings resource. A tag is a key-value pair.

Result Syntax

[
    'userAccessLoggingSettingsArn' => '<string>',
]

Result Details

Members

userAccessLoggingSettingsArn

: Required: Yes
: Type: string

The ARN of the user access logging settings.

Errors

InternalServerException:: There is an internal server error.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ServiceQuotaExceededException:: The service quota has been exceeded.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

CreateUserSettings

$result = $client->createUserSettings([/* ... */]);
$promise = $client->createUserSettingsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createUserSettings([
    'additionalEncryptionContext' => ['<string>', ...],
    'clientToken' => '<string>',
    'cookieSynchronizationConfiguration' => [
        'allowlist' => [ // REQUIRED
            [
                'domain' => '<string>', // REQUIRED
                'name' => '<string>',
                'path' => '<string>',
            ],
            // ...
        ],
        'blocklist' => [
            [
                'domain' => '<string>', // REQUIRED
                'name' => '<string>',
                'path' => '<string>',
            ],
            // ...
        ],
    ],
    'copyAllowed' => 'Disabled|Enabled', // REQUIRED
    'customerManagedKey' => '<string>',
    'deepLinkAllowed' => 'Disabled|Enabled',
    'disconnectTimeoutInMinutes' => <integer>,
    'downloadAllowed' => 'Disabled|Enabled', // REQUIRED
    'idleDisconnectTimeoutInMinutes' => <integer>,
    'pasteAllowed' => 'Disabled|Enabled', // REQUIRED
    'printAllowed' => 'Disabled|Enabled', // REQUIRED
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'uploadAllowed' => 'Disabled|Enabled', // REQUIRED
]);

Parameter Details

Members

additionalEncryptionContext

: Type: Associative array of custom strings keys (StringType) to strings

The additional encryption context of the user settings.

clientToken

: Type: string

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

cookieSynchronizationConfiguration

: Type: CookieSynchronizationConfiguration structure

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

copyAllowed

: Required: Yes
: Type: string

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

customerManagedKey

: Type: string

The customer managed key used to encrypt sensitive information in the user settings.

deepLinkAllowed

: Type: string

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

disconnectTimeoutInMinutes

: Type: int

The amount of time that a streaming session remains active after users disconnect.

downloadAllowed

: Required: Yes
: Type: string

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

idleDisconnectTimeoutInMinutes

: Type: int

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

pasteAllowed

: Required: Yes
: Type: string

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

printAllowed

: Required: Yes
: Type: string

Specifies whether the user can print to the local device.

tags

: Type: Array of Tag structures

The tags to add to the user settings resource. A tag is a key-value pair.

uploadAllowed

: Required: Yes
: Type: string

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

Result Syntax

[
    'userSettingsArn' => '<string>',
]

Result Details

Members

userSettingsArn

: Required: Yes
: Type: string

The ARN of the user settings.

Errors

InternalServerException:: There is an internal server error.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ServiceQuotaExceededException:: The service quota has been exceeded.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

DeleteBrowserSettings

$result = $client->deleteBrowserSettings([/* ... */]);
$promise = $client->deleteBrowserSettingsAsync([/* ... */]);

Deletes browser settings.

Parameter Syntax

$result = $client->deleteBrowserSettings([
    'browserSettingsArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

browserSettingsArn

: Required: Yes
: Type: string

The ARN of the browser settings.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: There is an internal server error.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

DeleteDataProtectionSettings

$result = $client->deleteDataProtectionSettings([/* ... */]);
$promise = $client->deleteDataProtectionSettingsAsync([/* ... */]);

Deletes data protection settings.

Parameter Syntax

$result = $client->deleteDataProtectionSettings([
    'dataProtectionSettingsArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

dataProtectionSettingsArn

: Required: Yes
: Type: string

The ARN of the data protection settings.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: There is an internal server error.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

DeleteIdentityProvider

$result = $client->deleteIdentityProvider([/* ... */]);
$promise = $client->deleteIdentityProviderAsync([/* ... */]);

Deletes the identity provider.

Parameter Syntax

$result = $client->deleteIdentityProvider([
    'identityProviderArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

identityProviderArn

: Required: Yes
: Type: string

The ARN of the identity provider.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: There is an internal server error.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

DeleteIpAccessSettings

$result = $client->deleteIpAccessSettings([/* ... */]);
$promise = $client->deleteIpAccessSettingsAsync([/* ... */]);

Deletes IP access settings.

Parameter Syntax

$result = $client->deleteIpAccessSettings([
    'ipAccessSettingsArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ipAccessSettingsArn

: Required: Yes
: Type: string

The ARN of the IP access settings.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: There is an internal server error.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

DeleteNetworkSettings

$result = $client->deleteNetworkSettings([/* ... */]);
$promise = $client->deleteNetworkSettingsAsync([/* ... */]);

Deletes network settings.

Parameter Syntax

$result = $client->deleteNetworkSettings([
    'networkSettingsArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

networkSettingsArn

: Required: Yes
: Type: string

The ARN of the network settings.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: There is an internal server error.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

DeletePortal

$result = $client->deletePortal([/* ... */]);
$promise = $client->deletePortalAsync([/* ... */]);

Deletes a web portal.

Parameter Syntax

$result = $client->deletePortal([
    'portalArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: There is an internal server error.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

DeleteTrustStore

$result = $client->deleteTrustStore([/* ... */]);
$promise = $client->deleteTrustStoreAsync([/* ... */]);

Deletes the trust store.

Parameter Syntax

$result = $client->deleteTrustStore([
    'trustStoreArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

trustStoreArn

: Required: Yes
: Type: string

The ARN of the trust store.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: There is an internal server error.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

DeleteUserAccessLoggingSettings

$result = $client->deleteUserAccessLoggingSettings([/* ... */]);
$promise = $client->deleteUserAccessLoggingSettingsAsync([/* ... */]);

Deletes user access logging settings.

Parameter Syntax

$result = $client->deleteUserAccessLoggingSettings([
    'userAccessLoggingSettingsArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

userAccessLoggingSettingsArn

: Required: Yes
: Type: string

The ARN of the user access logging settings.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: There is an internal server error.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

DeleteUserSettings

$result = $client->deleteUserSettings([/* ... */]);
$promise = $client->deleteUserSettingsAsync([/* ... */]);

Deletes user settings.

Parameter Syntax

$result = $client->deleteUserSettings([
    'userSettingsArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

userSettingsArn

: Required: Yes
: Type: string

The ARN of the user settings.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: There is an internal server error.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

DisassociateBrowserSettings

$result = $client->disassociateBrowserSettings([/* ... */]);
$promise = $client->disassociateBrowserSettingsAsync([/* ... */]);

Disassociates browser settings from a web portal.

Parameter Syntax

$result = $client->disassociateBrowserSettings([
    'portalArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

DisassociateDataProtectionSettings

$result = $client->disassociateDataProtectionSettings([/* ... */]);
$promise = $client->disassociateDataProtectionSettingsAsync([/* ... */]);

Disassociates data protection settings from a web portal.

Parameter Syntax

$result = $client->disassociateDataProtectionSettings([
    'portalArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

DisassociateIpAccessSettings

$result = $client->disassociateIpAccessSettings([/* ... */]);
$promise = $client->disassociateIpAccessSettingsAsync([/* ... */]);

Disassociates IP access settings from a web portal.

Parameter Syntax

$result = $client->disassociateIpAccessSettings([
    'portalArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

DisassociateNetworkSettings

$result = $client->disassociateNetworkSettings([/* ... */]);
$promise = $client->disassociateNetworkSettingsAsync([/* ... */]);

Disassociates network settings from a web portal.

Parameter Syntax

$result = $client->disassociateNetworkSettings([
    'portalArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

DisassociateTrustStore

$result = $client->disassociateTrustStore([/* ... */]);
$promise = $client->disassociateTrustStoreAsync([/* ... */]);

Disassociates a trust store from a web portal.

Parameter Syntax

$result = $client->disassociateTrustStore([
    'portalArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

DisassociateUserAccessLoggingSettings

$result = $client->disassociateUserAccessLoggingSettings([/* ... */]);
$promise = $client->disassociateUserAccessLoggingSettingsAsync([/* ... */]);

Disassociates user access logging settings from a web portal.

Parameter Syntax

$result = $client->disassociateUserAccessLoggingSettings([
    'portalArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

DisassociateUserSettings

$result = $client->disassociateUserSettings([/* ... */]);
$promise = $client->disassociateUserSettingsAsync([/* ... */]);

Disassociates user settings from a web portal.

Parameter Syntax

$result = $client->disassociateUserSettings([
    'portalArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

ExpireSession

$result = $client->expireSession([/* ... */]);
$promise = $client->expireSessionAsync([/* ... */]);

Expires an active secure browser session.

Parameter Syntax

$result = $client->expireSession([
    'portalId' => '<string>', // REQUIRED
    'sessionId' => '<string>', // REQUIRED
]);

Parameter Details

Members

portalId

: Required: Yes
: Type: string

The ID of the web portal for the session.

sessionId

: Required: Yes
: Type: string

The ID of the session to expire.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

GetBrowserSettings

$result = $client->getBrowserSettings([/* ... */]);
$promise = $client->getBrowserSettingsAsync([/* ... */]);

Gets browser settings.

Parameter Syntax

$result = $client->getBrowserSettings([
    'browserSettingsArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

browserSettingsArn

: Required: Yes
: Type: string

The ARN of the browser settings.

Result Syntax

[
    'browserSettings' => [
        'additionalEncryptionContext' => ['<string>', ...],
        'associatedPortalArns' => ['<string>', ...],
        'browserPolicy' => '<string>',
        'browserSettingsArn' => '<string>',
        'customerManagedKey' => '<string>',
    ],
]

Result Details

Members

browserSettings

: Type: BrowserSettings structure

The browser settings.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

GetDataProtectionSettings

$result = $client->getDataProtectionSettings([/* ... */]);
$promise = $client->getDataProtectionSettingsAsync([/* ... */]);

Gets the data protection settings.

Parameter Syntax

$result = $client->getDataProtectionSettings([
    'dataProtectionSettingsArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

dataProtectionSettingsArn

: Required: Yes
: Type: string

The ARN of the data protection settings.

Result Syntax

[
    'dataProtectionSettings' => [
        'additionalEncryptionContext' => ['<string>', ...],
        'associatedPortalArns' => ['<string>', ...],
        'creationDate' => <DateTime>,
        'customerManagedKey' => '<string>',
        'dataProtectionSettingsArn' => '<string>',
        'description' => '<string>',
        'displayName' => '<string>',
        'inlineRedactionConfiguration' => [
            'globalConfidenceLevel' => <integer>,
            'globalEnforcedUrls' => ['<string>', ...],
            'globalExemptUrls' => ['<string>', ...],
            'inlineRedactionPatterns' => [
                [
                    'builtInPatternId' => '<string>',
                    'confidenceLevel' => <integer>,
                    'customPattern' => [
                        'keywordRegex' => '<string>',
                        'patternDescription' => '<string>',
                        'patternName' => '<string>',
                        'patternRegex' => '<string>',
                    ],
                    'enforcedUrls' => ['<string>', ...],
                    'exemptUrls' => ['<string>', ...],
                    'redactionPlaceHolder' => [
                        'redactionPlaceHolderText' => '<string>',
                        'redactionPlaceHolderType' => 'CustomText',
                    ],
                ],
                // ...
            ],
        ],
    ],
]

Result Details

Members

dataProtectionSettings

: Type: DataProtectionSettings structure

The data protection settings.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

GetIdentityProvider

$result = $client->getIdentityProvider([/* ... */]);
$promise = $client->getIdentityProviderAsync([/* ... */]);

Gets the identity provider.

Parameter Syntax

$result = $client->getIdentityProvider([
    'identityProviderArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

identityProviderArn

: Required: Yes
: Type: string

The ARN of the identity provider.

Result Syntax

[
    'identityProvider' => [
        'identityProviderArn' => '<string>',
        'identityProviderDetails' => ['<string>', ...],
        'identityProviderName' => '<string>',
        'identityProviderType' => 'SAML|Facebook|Google|LoginWithAmazon|SignInWithApple|OIDC',
    ],
]

Result Details

Members

identityProvider

: Type: IdentityProvider structure

The identity provider.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

GetIpAccessSettings

$result = $client->getIpAccessSettings([/* ... */]);
$promise = $client->getIpAccessSettingsAsync([/* ... */]);

Gets the IP access settings.

Parameter Syntax

$result = $client->getIpAccessSettings([
    'ipAccessSettingsArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ipAccessSettingsArn

: Required: Yes
: Type: string

The ARN of the IP access settings.

Result Syntax

[
    'ipAccessSettings' => [
        'additionalEncryptionContext' => ['<string>', ...],
        'associatedPortalArns' => ['<string>', ...],
        'creationDate' => <DateTime>,
        'customerManagedKey' => '<string>',
        'description' => '<string>',
        'displayName' => '<string>',
        'ipAccessSettingsArn' => '<string>',
        'ipRules' => [
            [
                'description' => '<string>',
                'ipRange' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

ipAccessSettings

: Type: IpAccessSettings structure

The IP access settings.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

GetNetworkSettings

$result = $client->getNetworkSettings([/* ... */]);
$promise = $client->getNetworkSettingsAsync([/* ... */]);

Gets the network settings.

Parameter Syntax

$result = $client->getNetworkSettings([
    'networkSettingsArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

networkSettingsArn

: Required: Yes
: Type: string

The ARN of the network settings.

Result Syntax

[
    'networkSettings' => [
        'associatedPortalArns' => ['<string>', ...],
        'networkSettingsArn' => '<string>',
        'securityGroupIds' => ['<string>', ...],
        'subnetIds' => ['<string>', ...],
        'vpcId' => '<string>',
    ],
]

Result Details

Members

networkSettings

: Type: NetworkSettings structure

The network settings.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

GetPortal

$result = $client->getPortal([/* ... */]);
$promise = $client->getPortalAsync([/* ... */]);

Gets the web portal.

Parameter Syntax

$result = $client->getPortal([
    'portalArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

Result Syntax

[
    'portal' => [
        'additionalEncryptionContext' => ['<string>', ...],
        'authenticationType' => 'Standard|IAM_Identity_Center',
        'browserSettingsArn' => '<string>',
        'browserType' => 'Chrome',
        'creationDate' => <DateTime>,
        'customerManagedKey' => '<string>',
        'dataProtectionSettingsArn' => '<string>',
        'displayName' => '<string>',
        'instanceType' => 'standard.regular|standard.large|standard.xlarge',
        'ipAccessSettingsArn' => '<string>',
        'maxConcurrentSessions' => <integer>,
        'networkSettingsArn' => '<string>',
        'portalArn' => '<string>',
        'portalEndpoint' => '<string>',
        'portalStatus' => 'Incomplete|Pending|Active',
        'rendererType' => 'AppStream',
        'statusReason' => '<string>',
        'trustStoreArn' => '<string>',
        'userAccessLoggingSettingsArn' => '<string>',
        'userSettingsArn' => '<string>',
    ],
]

Result Details

Members

portal

: Type: Portal structure

The web portal.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

GetPortalServiceProviderMetadata

$result = $client->getPortalServiceProviderMetadata([/* ... */]);
$promise = $client->getPortalServiceProviderMetadataAsync([/* ... */]);

Gets the service provider metadata.

Parameter Syntax

$result = $client->getPortalServiceProviderMetadata([
    'portalArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

Result Syntax

[
    'portalArn' => '<string>',
    'serviceProviderSamlMetadata' => '<string>',
]

Result Details

Members

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

serviceProviderSamlMetadata

: Type: string

The service provider SAML metadata.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

GetSession

$result = $client->getSession([/* ... */]);
$promise = $client->getSessionAsync([/* ... */]);

Gets information for a secure browser session.

Parameter Syntax

$result = $client->getSession([
    'portalId' => '<string>', // REQUIRED
    'sessionId' => '<string>', // REQUIRED
]);

Parameter Details

Members

portalId

: Required: Yes
: Type: string

The ID of the web portal for the session.

sessionId

: Required: Yes
: Type: string

The ID of the session.

Result Syntax

[
    'session' => [
        'clientIpAddresses' => ['<string>', ...],
        'endTime' => <DateTime>,
        'portalArn' => '<string>',
        'sessionId' => '<string>',
        'startTime' => <DateTime>,
        'status' => 'Active|Terminated',
        'username' => '<string>',
    ],
]

Result Details

Members

session

: Type: Session structure

The sessions in a list.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

GetTrustStore

$result = $client->getTrustStore([/* ... */]);
$promise = $client->getTrustStoreAsync([/* ... */]);

Gets the trust store.

Parameter Syntax

$result = $client->getTrustStore([
    'trustStoreArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

trustStoreArn

: Required: Yes
: Type: string

The ARN of the trust store.

Result Syntax

[
    'trustStore' => [
        'associatedPortalArns' => ['<string>', ...],
        'trustStoreArn' => '<string>',
    ],
]

Result Details

Members

trustStore

: Type: TrustStore structure

The trust store.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

GetTrustStoreCertificate

$result = $client->getTrustStoreCertificate([/* ... */]);
$promise = $client->getTrustStoreCertificateAsync([/* ... */]);

Gets the trust store certificate.

Parameter Syntax

$result = $client->getTrustStoreCertificate([
    'thumbprint' => '<string>', // REQUIRED
    'trustStoreArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

thumbprint

: Required: Yes
: Type: string

The thumbprint of the trust store certificate.

trustStoreArn

: Required: Yes
: Type: string

The ARN of the trust store certificate.

Result Syntax

[
    'certificate' => [
        'body' => <string || resource || Psr\Http\Message\StreamInterface>,
        'issuer' => '<string>',
        'notValidAfter' => <DateTime>,
        'notValidBefore' => <DateTime>,
        'subject' => '<string>',
        'thumbprint' => '<string>',
    ],
    'trustStoreArn' => '<string>',
]

Result Details

Members

certificate

: Type: Certificate structure

The certificate of the trust store certificate.

trustStoreArn

: Required: Yes
: Type: string

The ARN of the trust store certificate.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

GetUserAccessLoggingSettings

$result = $client->getUserAccessLoggingSettings([/* ... */]);
$promise = $client->getUserAccessLoggingSettingsAsync([/* ... */]);

Gets user access logging settings.

Parameter Syntax

$result = $client->getUserAccessLoggingSettings([
    'userAccessLoggingSettingsArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

userAccessLoggingSettingsArn

: Required: Yes
: Type: string

The ARN of the user access logging settings.

Result Syntax

[
    'userAccessLoggingSettings' => [
        'associatedPortalArns' => ['<string>', ...],
        'kinesisStreamArn' => '<string>',
        'userAccessLoggingSettingsArn' => '<string>',
    ],
]

Result Details

Members

userAccessLoggingSettings

: Type: UserAccessLoggingSettings structure

The user access logging settings.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

GetUserSettings

$result = $client->getUserSettings([/* ... */]);
$promise = $client->getUserSettingsAsync([/* ... */]);

Gets user settings.

Parameter Syntax

$result = $client->getUserSettings([
    'userSettingsArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

userSettingsArn

: Required: Yes
: Type: string

The ARN of the user settings.

Result Syntax

[
    'userSettings' => [
        'additionalEncryptionContext' => ['<string>', ...],
        'associatedPortalArns' => ['<string>', ...],
        'cookieSynchronizationConfiguration' => [
            'allowlist' => [
                [
                    'domain' => '<string>',
                    'name' => '<string>',
                    'path' => '<string>',
                ],
                // ...
            ],
            'blocklist' => [
                [
                    'domain' => '<string>',
                    'name' => '<string>',
                    'path' => '<string>',
                ],
                // ...
            ],
        ],
        'copyAllowed' => 'Disabled|Enabled',
        'customerManagedKey' => '<string>',
        'deepLinkAllowed' => 'Disabled|Enabled',
        'disconnectTimeoutInMinutes' => <integer>,
        'downloadAllowed' => 'Disabled|Enabled',
        'idleDisconnectTimeoutInMinutes' => <integer>,
        'pasteAllowed' => 'Disabled|Enabled',
        'printAllowed' => 'Disabled|Enabled',
        'uploadAllowed' => 'Disabled|Enabled',
        'userSettingsArn' => '<string>',
    ],
]

Result Details

Members

userSettings

: Type: UserSettings structure

The user settings.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

ListBrowserSettings

$result = $client->listBrowserSettings([/* ... */]);
$promise = $client->listBrowserSettingsAsync([/* ... */]);

Retrieves a list of browser settings.

Parameter Syntax

$result = $client->listBrowserSettings([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

maxResults

: Type: int

The maximum number of results to be included in the next page.

nextToken

: Type: string

The pagination token used to retrieve the next page of results for this operation.

Result Syntax

[
    'browserSettings' => [
        [
            'browserSettingsArn' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

browserSettings

: Type: Array of BrowserSettingsSummary structures

The browser settings.

nextToken

: Type: string

The pagination token used to retrieve the next page of results for this operation.

Errors

InternalServerException:: There is an internal server error.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

ListDataProtectionSettings

$result = $client->listDataProtectionSettings([/* ... */]);
$promise = $client->listDataProtectionSettingsAsync([/* ... */]);

Retrieves a list of data protection settings.

Parameter Syntax

$result = $client->listDataProtectionSettings([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

maxResults

: Type: int

The maximum number of results to be included in the next page.

nextToken

: Type: string

The pagination token used to retrieve the next page of results for this operation.

Result Syntax

[
    'dataProtectionSettings' => [
        [
            'creationDate' => <DateTime>,
            'dataProtectionSettingsArn' => '<string>',
            'description' => '<string>',
            'displayName' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

dataProtectionSettings

: Type: Array of DataProtectionSettingsSummary structures

The data protection settings.

nextToken

: Type: string

The pagination token used to retrieve the next page of results for this operation.

Errors

InternalServerException:: There is an internal server error.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

ListIdentityProviders

$result = $client->listIdentityProviders([/* ... */]);
$promise = $client->listIdentityProvidersAsync([/* ... */]);

Retrieves a list of identity providers for a specific web portal.

Parameter Syntax

$result = $client->listIdentityProviders([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'portalArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

maxResults

: Type: int

The maximum number of results to be included in the next page.

nextToken

: Type: string

The pagination token used to retrieve the next page of results for this operation.

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

Result Syntax

[
    'identityProviders' => [
        [
            'identityProviderArn' => '<string>',
            'identityProviderName' => '<string>',
            'identityProviderType' => 'SAML|Facebook|Google|LoginWithAmazon|SignInWithApple|OIDC',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

identityProviders

: Type: Array of IdentityProviderSummary structures

The identity providers.

nextToken

: Type: string

The pagination token used to retrieve the next page of results for this operation.

Errors

InternalServerException:: There is an internal server error.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

ListIpAccessSettings

$result = $client->listIpAccessSettings([/* ... */]);
$promise = $client->listIpAccessSettingsAsync([/* ... */]);

Retrieves a list of IP access settings.

Parameter Syntax

$result = $client->listIpAccessSettings([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

maxResults

: Type: int

The maximum number of results to be included in the next page.

nextToken

: Type: string

The pagination token used to retrieve the next page of results for this operation.

Result Syntax

[
    'ipAccessSettings' => [
        [
            'creationDate' => <DateTime>,
            'description' => '<string>',
            'displayName' => '<string>',
            'ipAccessSettingsArn' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

ipAccessSettings

: Type: Array of IpAccessSettingsSummary structures

The IP access settings.

nextToken

: Type: string

The pagination token used to retrieve the next page of results for this operation.

Errors

InternalServerException:: There is an internal server error.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

ListNetworkSettings

$result = $client->listNetworkSettings([/* ... */]);
$promise = $client->listNetworkSettingsAsync([/* ... */]);

Retrieves a list of network settings.

Parameter Syntax

$result = $client->listNetworkSettings([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

maxResults

: Type: int

The maximum number of results to be included in the next page.

nextToken

: Type: string

The pagination token used to retrieve the next page of results for this operation.

Result Syntax

[
    'networkSettings' => [
        [
            'networkSettingsArn' => '<string>',
            'vpcId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

networkSettings

: Type: Array of NetworkSettingsSummary structures

The network settings.

nextToken

: Type: string

The pagination token used to retrieve the next page of results for this operation.

Errors

InternalServerException:: There is an internal server error.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

ListPortals

$result = $client->listPortals([/* ... */]);
$promise = $client->listPortalsAsync([/* ... */]);

Retrieves a list or web portals.

Parameter Syntax

$result = $client->listPortals([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

maxResults

: Type: int

The maximum number of results to be included in the next page.

nextToken

: Type: string

The pagination token used to retrieve the next page of results for this operation.

Result Syntax

[
    'nextToken' => '<string>',
    'portals' => [
        [
            'authenticationType' => 'Standard|IAM_Identity_Center',
            'browserSettingsArn' => '<string>',
            'browserType' => 'Chrome',
            'creationDate' => <DateTime>,
            'dataProtectionSettingsArn' => '<string>',
            'displayName' => '<string>',
            'instanceType' => 'standard.regular|standard.large|standard.xlarge',
            'ipAccessSettingsArn' => '<string>',
            'maxConcurrentSessions' => <integer>,
            'networkSettingsArn' => '<string>',
            'portalArn' => '<string>',
            'portalEndpoint' => '<string>',
            'portalStatus' => 'Incomplete|Pending|Active',
            'rendererType' => 'AppStream',
            'trustStoreArn' => '<string>',
            'userAccessLoggingSettingsArn' => '<string>',
            'userSettingsArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

nextToken

: Type: string

The pagination token used to retrieve the next page of results for this operation.

portals

: Type: Array of PortalSummary structures

The portals in the list.

Errors

InternalServerException:: There is an internal server error.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

ListSessions

$result = $client->listSessions([/* ... */]);
$promise = $client->listSessionsAsync([/* ... */]);

Lists information for multiple secure browser sessions from a specific portal.

Parameter Syntax

$result = $client->listSessions([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'portalId' => '<string>', // REQUIRED
    'sessionId' => '<string>',
    'sortBy' => 'StartTimeAscending|StartTimeDescending',
    'status' => 'Active|Terminated',
    'username' => '<string>',
]);

Parameter Details

Members

maxResults

: Type: int

The maximum number of results to be included in the next page.

nextToken

: Type: string

The pagination token used to retrieve the next page of results for this operation.

portalId

: Required: Yes
: Type: string

The ID of the web portal for the sessions.

sessionId

: Type: string

The ID of the session.

sortBy

: Type: string

The method in which the returned sessions should be sorted.

status

: Type: string

The status of the session.

username

: Type: string

The username of the session.

Result Syntax

[
    'nextToken' => '<string>',
    'sessions' => [
        [
            'endTime' => <DateTime>,
            'portalArn' => '<string>',
            'sessionId' => '<string>',
            'startTime' => <DateTime>,
            'status' => 'Active|Terminated',
            'username' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

nextToken

: Type: string

The pagination token used to retrieve the next page of results for this operation.

sessions

: Required: Yes
: Type: Array of SessionSummary structures

The sessions in a list.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Retrieves a list of tags for a resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

The ARN of the resource.

Result Syntax

[
    'tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

tags

: Type: Array of Tag structures

The tags of the resource.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

ListTrustStoreCertificates

$result = $client->listTrustStoreCertificates([/* ... */]);
$promise = $client->listTrustStoreCertificatesAsync([/* ... */]);

Retrieves a list of trust store certificates.

Parameter Syntax

$result = $client->listTrustStoreCertificates([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'trustStoreArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

maxResults

: Type: int

The maximum number of results to be included in the next page.

nextToken

: Type: string

The pagination token used to retrieve the next page of results for this operation.

trustStoreArn

: Required: Yes
: Type: string

The ARN of the trust store

Result Syntax

[
    'certificateList' => [
        [
            'issuer' => '<string>',
            'notValidAfter' => <DateTime>,
            'notValidBefore' => <DateTime>,
            'subject' => '<string>',
            'thumbprint' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'trustStoreArn' => '<string>',
]

Result Details

Members

certificateList

: Type: Array of CertificateSummary structures

The certificate list.

nextToken

: Type: string

The pagination token used to retrieve the next page of results for this operation.>

trustStoreArn

: Required: Yes
: Type: string

The ARN of the trust store.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

ListTrustStores

$result = $client->listTrustStores([/* ... */]);
$promise = $client->listTrustStoresAsync([/* ... */]);

Retrieves a list of trust stores.

Parameter Syntax

$result = $client->listTrustStores([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

maxResults

: Type: int

The maximum number of results to be included in the next page.

nextToken

: Type: string

The pagination token used to retrieve the next page of results for this operation.

Result Syntax

[
    'nextToken' => '<string>',
    'trustStores' => [
        [
            'trustStoreArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

nextToken

: Type: string

The pagination token used to retrieve the next page of results for this operation.

trustStores

: Type: Array of TrustStoreSummary structures

The trust stores.

Errors

InternalServerException:: There is an internal server error.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

ListUserAccessLoggingSettings

$result = $client->listUserAccessLoggingSettings([/* ... */]);
$promise = $client->listUserAccessLoggingSettingsAsync([/* ... */]);

Retrieves a list of user access logging settings.

Parameter Syntax

$result = $client->listUserAccessLoggingSettings([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

maxResults

: Type: int

The maximum number of results to be included in the next page.

nextToken

: Type: string

The pagination token used to retrieve the next page of results for this operation.

Result Syntax

[
    'nextToken' => '<string>',
    'userAccessLoggingSettings' => [
        [
            'kinesisStreamArn' => '<string>',
            'userAccessLoggingSettingsArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

nextToken

: Type: string

The pagination token used to retrieve the next page of results for this operation.

userAccessLoggingSettings

: Type: Array of UserAccessLoggingSettingsSummary structures

The user access logging settings.

Errors

InternalServerException:: There is an internal server error.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

ListUserSettings

$result = $client->listUserSettings([/* ... */]);
$promise = $client->listUserSettingsAsync([/* ... */]);

Retrieves a list of user settings.

Parameter Syntax

$result = $client->listUserSettings([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

maxResults

: Type: int

The maximum number of results to be included in the next page.

nextToken

: Type: string

The pagination token used to retrieve the next page of results for this operation.

Result Syntax

[
    'nextToken' => '<string>',
    'userSettings' => [
        [
            'cookieSynchronizationConfiguration' => [
                'allowlist' => [
                    [
                        'domain' => '<string>',
                        'name' => '<string>',
                        'path' => '<string>',
                    ],
                    // ...
                ],
                'blocklist' => [
                    [
                        'domain' => '<string>',
                        'name' => '<string>',
                        'path' => '<string>',
                    ],
                    // ...
                ],
            ],
            'copyAllowed' => 'Disabled|Enabled',
            'deepLinkAllowed' => 'Disabled|Enabled',
            'disconnectTimeoutInMinutes' => <integer>,
            'downloadAllowed' => 'Disabled|Enabled',
            'idleDisconnectTimeoutInMinutes' => <integer>,
            'pasteAllowed' => 'Disabled|Enabled',
            'printAllowed' => 'Disabled|Enabled',
            'uploadAllowed' => 'Disabled|Enabled',
            'userSettingsArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

nextToken

: Type: string

The pagination token used to retrieve the next page of results for this operation.

userSettings

: Type: Array of UserSettingsSummary structures

The user settings.

Errors

InternalServerException:: There is an internal server error.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds or overwrites one or more tags for the specified resource.

Parameter Syntax

$result = $client->tagResource([
    'clientToken' => '<string>',
    'resourceArn' => '<string>', // REQUIRED
    'tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

clientToken

: Type: string

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

resourceArn

: Required: Yes
: Type: string

The ARN of the resource.

tags

: Required: Yes
: Type: Array of Tag structures

The tags of the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.
TooManyTagsException:: There are too many tags.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags from the specified resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

The ARN of the resource.

tagKeys

: Required: Yes
: Type: Array of strings

The list of tag keys to remove from the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

UpdateBrowserSettings

$result = $client->updateBrowserSettings([/* ... */]);
$promise = $client->updateBrowserSettingsAsync([/* ... */]);

Updates browser settings.

Parameter Syntax

$result = $client->updateBrowserSettings([
    'browserPolicy' => '<string>',
    'browserSettingsArn' => '<string>', // REQUIRED
    'clientToken' => '<string>',
]);

Parameter Details

Members

browserPolicy

: Type: string

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

browserSettingsArn

: Required: Yes
: Type: string

The ARN of the browser settings.

clientToken

: Type: string

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

Result Syntax

[
    'browserSettings' => [
        'additionalEncryptionContext' => ['<string>', ...],
        'associatedPortalArns' => ['<string>', ...],
        'browserPolicy' => '<string>',
        'browserSettingsArn' => '<string>',
        'customerManagedKey' => '<string>',
    ],
]

Result Details

Members

browserSettings

: Required: Yes
: Type: BrowserSettings structure

The browser settings.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

UpdateDataProtectionSettings

$result = $client->updateDataProtectionSettings([/* ... */]);
$promise = $client->updateDataProtectionSettingsAsync([/* ... */]);

Updates data protection settings.

Parameter Syntax

$result = $client->updateDataProtectionSettings([
    'clientToken' => '<string>',
    'dataProtectionSettingsArn' => '<string>', // REQUIRED
    'description' => '<string>',
    'displayName' => '<string>',
    'inlineRedactionConfiguration' => [
        'globalConfidenceLevel' => <integer>,
        'globalEnforcedUrls' => ['<string>', ...],
        'globalExemptUrls' => ['<string>', ...],
        'inlineRedactionPatterns' => [ // REQUIRED
            [
                'builtInPatternId' => '<string>',
                'confidenceLevel' => <integer>,
                'customPattern' => [
                    'keywordRegex' => '<string>',
                    'patternDescription' => '<string>',
                    'patternName' => '<string>', // REQUIRED
                    'patternRegex' => '<string>', // REQUIRED
                ],
                'enforcedUrls' => ['<string>', ...],
                'exemptUrls' => ['<string>', ...],
                'redactionPlaceHolder' => [ // REQUIRED
                    'redactionPlaceHolderText' => '<string>',
                    'redactionPlaceHolderType' => 'CustomText', // REQUIRED
                ],
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members

clientToken

: Type: string

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

dataProtectionSettingsArn

: Required: Yes
: Type: string

The ARN of the data protection settings.

description

: Type: string

The description of the data protection settings.

displayName

: Type: string

The display name of the data protection settings.

inlineRedactionConfiguration

: Type: InlineRedactionConfiguration structure

The inline redaction configuration of the data protection settings that will be applied to all sessions.

Result Syntax

[
    'dataProtectionSettings' => [
        'additionalEncryptionContext' => ['<string>', ...],
        'associatedPortalArns' => ['<string>', ...],
        'creationDate' => <DateTime>,
        'customerManagedKey' => '<string>',
        'dataProtectionSettingsArn' => '<string>',
        'description' => '<string>',
        'displayName' => '<string>',
        'inlineRedactionConfiguration' => [
            'globalConfidenceLevel' => <integer>,
            'globalEnforcedUrls' => ['<string>', ...],
            'globalExemptUrls' => ['<string>', ...],
            'inlineRedactionPatterns' => [
                [
                    'builtInPatternId' => '<string>',
                    'confidenceLevel' => <integer>,
                    'customPattern' => [
                        'keywordRegex' => '<string>',
                        'patternDescription' => '<string>',
                        'patternName' => '<string>',
                        'patternRegex' => '<string>',
                    ],
                    'enforcedUrls' => ['<string>', ...],
                    'exemptUrls' => ['<string>', ...],
                    'redactionPlaceHolder' => [
                        'redactionPlaceHolderText' => '<string>',
                        'redactionPlaceHolderType' => 'CustomText',
                    ],
                ],
                // ...
            ],
        ],
    ],
]

Result Details

Members

dataProtectionSettings

: Required: Yes
: Type: DataProtectionSettings structure

The data protection settings.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

UpdateIdentityProvider

$result = $client->updateIdentityProvider([/* ... */]);
$promise = $client->updateIdentityProviderAsync([/* ... */]);

Updates the identity provider.

Parameter Syntax

$result = $client->updateIdentityProvider([
    'clientToken' => '<string>',
    'identityProviderArn' => '<string>', // REQUIRED
    'identityProviderDetails' => ['<string>', ...],
    'identityProviderName' => '<string>',
    'identityProviderType' => 'SAML|Facebook|Google|LoginWithAmazon|SignInWithApple|OIDC',
]);

Parameter Details

Members

clientToken

: Type: string

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

identityProviderArn

: Required: Yes
: Type: string

The ARN of the identity provider.

identityProviderDetails

: Type: Associative array of custom strings keys (StringType) to strings

The details of the identity provider. 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

identityProviderName

: Type: string

The name of the identity provider.

identityProviderType

: Type: string

The type of the identity provider.

Result Syntax

[
    'identityProvider' => [
        'identityProviderArn' => '<string>',
        'identityProviderDetails' => ['<string>', ...],
        'identityProviderName' => '<string>',
        'identityProviderType' => 'SAML|Facebook|Google|LoginWithAmazon|SignInWithApple|OIDC',
    ],
]

Result Details

Members

identityProvider

: Required: Yes
: Type: IdentityProvider structure

The identity provider.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

UpdateIpAccessSettings

$result = $client->updateIpAccessSettings([/* ... */]);
$promise = $client->updateIpAccessSettingsAsync([/* ... */]);

Updates IP access settings.

Parameter Syntax

$result = $client->updateIpAccessSettings([
    'clientToken' => '<string>',
    'description' => '<string>',
    'displayName' => '<string>',
    'ipAccessSettingsArn' => '<string>', // REQUIRED
    'ipRules' => [
        [
            'description' => '<string>',
            'ipRange' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

clientToken

: Type: string

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

description

: Type: string

The description of the IP access settings.

displayName

: Type: string

The display name of the IP access settings.

ipAccessSettingsArn

: Required: Yes
: Type: string

The ARN of the IP access settings.

ipRules

: Type: Array of IpRule structures

The updated IP rules of the IP access settings.

Result Syntax

[
    'ipAccessSettings' => [
        'additionalEncryptionContext' => ['<string>', ...],
        'associatedPortalArns' => ['<string>', ...],
        'creationDate' => <DateTime>,
        'customerManagedKey' => '<string>',
        'description' => '<string>',
        'displayName' => '<string>',
        'ipAccessSettingsArn' => '<string>',
        'ipRules' => [
            [
                'description' => '<string>',
                'ipRange' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

ipAccessSettings

: Required: Yes
: Type: IpAccessSettings structure

The IP access settings.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

UpdateNetworkSettings

$result = $client->updateNetworkSettings([/* ... */]);
$promise = $client->updateNetworkSettingsAsync([/* ... */]);

Updates network settings.

Parameter Syntax

$result = $client->updateNetworkSettings([
    'clientToken' => '<string>',
    'networkSettingsArn' => '<string>', // REQUIRED
    'securityGroupIds' => ['<string>', ...],
    'subnetIds' => ['<string>', ...],
    'vpcId' => '<string>',
]);

Parameter Details

Members

clientToken

: Type: string

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

networkSettingsArn

: Required: Yes
: Type: string

The ARN of the network settings.

securityGroupIds

: Type: Array of strings

One or more security groups used to control access from streaming instances to your VPC.

subnetIds

: Type: Array of strings

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.

vpcId

: Type: string

The VPC that streaming instances will connect to.

Result Syntax

[
    'networkSettings' => [
        'associatedPortalArns' => ['<string>', ...],
        'networkSettingsArn' => '<string>',
        'securityGroupIds' => ['<string>', ...],
        'subnetIds' => ['<string>', ...],
        'vpcId' => '<string>',
    ],
]

Result Details

Members

networkSettings

: Required: Yes
: Type: NetworkSettings structure

The network settings.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

UpdatePortal

$result = $client->updatePortal([/* ... */]);
$promise = $client->updatePortalAsync([/* ... */]);

Updates a web portal.

Parameter Syntax

$result = $client->updatePortal([
    'authenticationType' => 'Standard|IAM_Identity_Center',
    'displayName' => '<string>',
    'instanceType' => 'standard.regular|standard.large|standard.xlarge',
    'maxConcurrentSessions' => <integer>,
    'portalArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

authenticationType

: Type: string

The type of authentication integration points used when signing into the web portal. Defaults to Standard.

displayName

: Type: string

The name of the web portal. This is not visible to users who log into the web portal.

instanceType

: Type: string

The type and resources of the underlying instance.

maxConcurrentSessions

: Type: int

The maximum number of concurrent sessions for the portal.

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

Result Syntax

[
    'portal' => [
        'additionalEncryptionContext' => ['<string>', ...],
        'authenticationType' => 'Standard|IAM_Identity_Center',
        'browserSettingsArn' => '<string>',
        'browserType' => 'Chrome',
        'creationDate' => <DateTime>,
        'customerManagedKey' => '<string>',
        'dataProtectionSettingsArn' => '<string>',
        'displayName' => '<string>',
        'instanceType' => 'standard.regular|standard.large|standard.xlarge',
        'ipAccessSettingsArn' => '<string>',
        'maxConcurrentSessions' => <integer>,
        'networkSettingsArn' => '<string>',
        'portalArn' => '<string>',
        'portalEndpoint' => '<string>',
        'portalStatus' => 'Incomplete|Pending|Active',
        'rendererType' => 'AppStream',
        'statusReason' => '<string>',
        'trustStoreArn' => '<string>',
        'userAccessLoggingSettingsArn' => '<string>',
        'userSettingsArn' => '<string>',
    ],
]

Result Details

Members

portal

: Type: Portal structure

The web portal.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ServiceQuotaExceededException:: The service quota has been exceeded.
ValidationException:: There is a validation error.
ConflictException:: There is a conflict.

UpdateTrustStore

$result = $client->updateTrustStore([/* ... */]);
$promise = $client->updateTrustStoreAsync([/* ... */]);

Updates the trust store.

Parameter Syntax

$result = $client->updateTrustStore([
    'certificatesToAdd' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
    'certificatesToDelete' => ['<string>', ...],
    'clientToken' => '<string>',
    'trustStoreArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

certificatesToAdd

: Type: Array of blob (string|resource|Psr\Http\Message\StreamInterface)s

A list of CA certificates to add to the trust store.

certificatesToDelete

: Type: Array of strings

A list of CA certificates to delete from a trust store.

clientToken

: Type: string

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

trustStoreArn

: Required: Yes
: Type: string

The ARN of the trust store.

Result Syntax

[
    'trustStoreArn' => '<string>',
]

Result Details

Members

trustStoreArn

: Required: Yes
: Type: string

The ARN of the trust store.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ServiceQuotaExceededException:: The service quota has been exceeded.
ValidationException:: There is a validation error.

UpdateUserAccessLoggingSettings

$result = $client->updateUserAccessLoggingSettings([/* ... */]);
$promise = $client->updateUserAccessLoggingSettingsAsync([/* ... */]);

Updates the user access logging settings.

Parameter Syntax

$result = $client->updateUserAccessLoggingSettings([
    'clientToken' => '<string>',
    'kinesisStreamArn' => '<string>',
    'userAccessLoggingSettingsArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

clientToken

: Type: string

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

kinesisStreamArn

: Type: string

The ARN of the Kinesis stream.

userAccessLoggingSettingsArn

: Required: Yes
: Type: string

The ARN of the user access logging settings.

Result Syntax

[
    'userAccessLoggingSettings' => [
        'associatedPortalArns' => ['<string>', ...],
        'kinesisStreamArn' => '<string>',
        'userAccessLoggingSettingsArn' => '<string>',
    ],
]

Result Details

Members

userAccessLoggingSettings

: Required: Yes
: Type: UserAccessLoggingSettings structure

The user access logging settings.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

UpdateUserSettings

$result = $client->updateUserSettings([/* ... */]);
$promise = $client->updateUserSettingsAsync([/* ... */]);

Updates the user settings.

Parameter Syntax

$result = $client->updateUserSettings([
    'clientToken' => '<string>',
    'cookieSynchronizationConfiguration' => [
        'allowlist' => [ // REQUIRED
            [
                'domain' => '<string>', // REQUIRED
                'name' => '<string>',
                'path' => '<string>',
            ],
            // ...
        ],
        'blocklist' => [
            [
                'domain' => '<string>', // REQUIRED
                'name' => '<string>',
                'path' => '<string>',
            ],
            // ...
        ],
    ],
    'copyAllowed' => 'Disabled|Enabled',
    'deepLinkAllowed' => 'Disabled|Enabled',
    'disconnectTimeoutInMinutes' => <integer>,
    'downloadAllowed' => 'Disabled|Enabled',
    'idleDisconnectTimeoutInMinutes' => <integer>,
    'pasteAllowed' => 'Disabled|Enabled',
    'printAllowed' => 'Disabled|Enabled',
    'uploadAllowed' => 'Disabled|Enabled',
    'userSettingsArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

clientToken

: Type: string

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

cookieSynchronizationConfiguration

: Type: CookieSynchronizationConfiguration structure

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

If the allowlist and blocklist are empty, the configuration becomes null.

copyAllowed

: Type: string

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

deepLinkAllowed

: Type: string

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

disconnectTimeoutInMinutes

: Type: int

The amount of time that a streaming session remains active after users disconnect.

downloadAllowed

: Type: string

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

idleDisconnectTimeoutInMinutes

: Type: int

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

pasteAllowed

: Type: string

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

printAllowed

: Type: string

Specifies whether the user can print to the local device.

uploadAllowed

: Type: string

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

userSettingsArn

: Required: Yes
: Type: string

The ARN of the user settings.

Result Syntax

[
    'userSettings' => [
        'additionalEncryptionContext' => ['<string>', ...],
        'associatedPortalArns' => ['<string>', ...],
        'cookieSynchronizationConfiguration' => [
            'allowlist' => [
                [
                    'domain' => '<string>',
                    'name' => '<string>',
                    'path' => '<string>',
                ],
                // ...
            ],
            'blocklist' => [
                [
                    'domain' => '<string>',
                    'name' => '<string>',
                    'path' => '<string>',
                ],
                // ...
            ],
        ],
        'copyAllowed' => 'Disabled|Enabled',
        'customerManagedKey' => '<string>',
        'deepLinkAllowed' => 'Disabled|Enabled',
        'disconnectTimeoutInMinutes' => <integer>,
        'downloadAllowed' => 'Disabled|Enabled',
        'idleDisconnectTimeoutInMinutes' => <integer>,
        'pasteAllowed' => 'Disabled|Enabled',
        'printAllowed' => 'Disabled|Enabled',
        'uploadAllowed' => 'Disabled|Enabled',
        'userSettingsArn' => '<string>',
    ],
]

Result Details

Members

userSettings

: Required: Yes
: Type: UserSettings structure

The user settings.

Errors

InternalServerException:: There is an internal server error.
ResourceNotFoundException:: The resource cannot be found.
AccessDeniedException:: Access is denied.
ThrottlingException:: There is a throttling error.
ValidationException:: There is a validation error.

Shapes

AccessDeniedException

Description

Access is denied.

Members

message

: Type: string

BrowserSettings

Description

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.

Members

additionalEncryptionContext

: Type: Associative array of custom strings keys (StringType) to strings

The additional encryption context of the browser settings.

associatedPortalArns

: Type: Array of strings

A list of web portal ARNs that this browser settings is associated with.

browserPolicy

: Type: string

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

browserSettingsArn

: Required: Yes
: Type: string

The ARN of the browser settings.

customerManagedKey

: Type: string

The customer managed key used to encrypt sensitive information in the browser settings.

BrowserSettingsSummary

Description

The summary for browser settings.

Members

browserSettingsArn

: Required: Yes
: Type: string

The ARN of the browser settings.

Certificate

Description

The certificate.

Members

body

: Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The body of the certificate.

issuer

: Type: string

The entity that issued the certificate.

notValidAfter

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The certificate is not valid after this date.

notValidBefore

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The certificate is not valid before this date.

subject

: Type: string

The entity the certificate belongs to.

thumbprint

: Type: string

A hexadecimal identifier for the certificate.

CertificateSummary

Description

The summary of the certificate.

Members

issuer

: Type: string

The entity that issued the certificate.

notValidAfter

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The certificate is not valid after this date.

notValidBefore

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The certificate is not valid before this date.

subject

: Type: string

The entity the certificate belongs to.

thumbprint

: Type: string

A hexadecimal identifier for the certificate.

ConflictException

Description

There is a conflict.

Members

message

: Type: string

resourceId

: Type: string

Identifier of the resource affected.

resourceType

: Type: string

Type of the resource affected.

CookieSpecification

Description

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

Members

domain

: Required: Yes
: Type: string

The domain of the cookie.

name

: Type: string

The name of the cookie.

path

: Type: string

The path of the cookie.

CookieSynchronizationConfiguration

Description

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

Members

allowlist

: Required: Yes
: Type: Array of CookieSpecification structures

The list of cookie specifications that are allowed to be synchronized to the remote browser.

blocklist

: Type: Array of CookieSpecification structures

The list of cookie specifications that are blocked from being synchronized to the remote browser.

CustomPattern

Description

The pattern configuration for redacting custom data types in session.

Members

keywordRegex

: Type: 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”

patternDescription

: Type: string

The pattern description for the customer pattern.

patternName

: Required: Yes
: Type: string

The pattern name for the custom pattern.

patternRegex

: Required: Yes
: Type: 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”.

DataProtectionSettings

Description

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

Members

additionalEncryptionContext

: Type: Associative array of custom strings keys (StringType) to strings

The additional encryption context of the data protection settings.

associatedPortalArns

: Type: Array of strings

A list of web portal ARNs that this data protection settings resource is associated with.

creationDate

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation date timestamp of the data protection settings.

customerManagedKey

: Type: string

The customer managed key used to encrypt sensitive information in the data protection settings.

dataProtectionSettingsArn

: Required: Yes
: Type: string

The ARN of the data protection settings resource.

description

: Type: string

The description of the data protection settings.

displayName

: Type: string

The display name of the data protection settings.

inlineRedactionConfiguration

: Type: InlineRedactionConfiguration structure

The inline redaction configuration for the data protection settings.

DataProtectionSettingsSummary

Description

The summary of the data protection settings.

Members

creationDate

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation date timestamp of the data protection settings.

dataProtectionSettingsArn

: Required: Yes
: Type: string

The ARN of the data protection settings.

description

: Type: string

The description of the data protection settings.

displayName

: Type: string

The display name of the data protection settings.

IdentityProvider

Description

The identity provider.

Members

identityProviderArn

: Required: Yes
: Type: string

The ARN of the identity provider.

identityProviderDetails

: Type: Associative array of custom strings keys (StringType) to strings

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

identityProviderName

: Type: string

The identity provider name.

identityProviderType

: Type: string

The identity provider type.

IdentityProviderSummary

Description

The summary of the identity provider.

Members

identityProviderArn

: Required: Yes
: Type: string

The ARN of the identity provider.

identityProviderName

: Type: string

The identity provider name.

identityProviderType

: Type: string

The identity provider type.

InlineRedactionConfiguration

Description

The configuration for in-session inline redaction.

Members

globalConfidenceLevel

: Type: int

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.

globalEnforcedUrls

: Type: Array of strings

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.

globalExemptUrls

: Type: Array of strings

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.

inlineRedactionPatterns

: Required: Yes
: Type: Array of InlineRedactionPattern structures

The inline redaction patterns to be enabled for the inline redaction configuration.

InlineRedactionPattern

Description

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

Members

builtInPatternId

: Type: string

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

confidenceLevel

: Type: int

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.

customPattern

: Type: CustomPattern structure

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

enforcedUrls

: Type: Array of strings

The enforced URL configuration for the inline redaction pattern. This will override the global enforced URL configuration.

exemptUrls

: Type: Array of strings

The exempt URL configuration for the inline redaction pattern. This will override the global exempt URL configuration for the inline redaction pattern.

redactionPlaceHolder

: Required: Yes
: Type: RedactionPlaceHolder structure

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

InternalServerException

Description

There is an internal server error.

Members

message

: Type: string

retryAfterSeconds

: Type: int

Advice to clients on when the call can be safely retried.

IpAccessSettings

Description

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

Members

additionalEncryptionContext

: Type: Associative array of custom strings keys (StringType) to strings

The additional encryption context of the IP access settings.

associatedPortalArns

: Type: Array of strings

A list of web portal ARNs that this IP access settings resource is associated with.

creationDate

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation date timestamp of the IP access settings.

customerManagedKey

: Type: string

The customer managed key used to encrypt sensitive information in the IP access settings.

description

: Type: string

The description of the IP access settings.

displayName

: Type: string

The display name of the IP access settings.

ipAccessSettingsArn

: Required: Yes
: Type: string

The ARN of the IP access settings resource.

ipRules

: Type: Array of IpRule structures

The IP rules of the IP access settings.

IpAccessSettingsSummary

Description

The summary of IP access settings.

Members

creationDate

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation date timestamp of the IP access settings.

description

: Type: string

The description of the IP access settings.

displayName

: Type: string

The display name of the IP access settings.

ipAccessSettingsArn

: Required: Yes
: Type: string

The ARN of IP access settings.

IpRule

Description

The IP rules of the IP access settings.

Members

description

: Type: string

The description of the IP rule.

ipRange

: Required: Yes
: Type: string

The IP range of the IP rule.

NetworkSettings

Description

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.

Members

associatedPortalArns

: Type: Array of strings

A list of web portal ARNs that this network settings is associated with.

networkSettingsArn

: Required: Yes
: Type: string

The ARN of the network settings.

securityGroupIds

: Type: Array of strings

One or more security groups used to control access from streaming instances to your VPC.

subnetIds

: Type: Array of strings

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.

vpcId

: Type: string

The VPC that streaming instances will connect to.

NetworkSettingsSummary

Description

The summary of network settings.

Members

networkSettingsArn

: Required: Yes
: Type: string

The ARN of the network settings.

vpcId

: Type: string

The VPC ID of the network settings.

Portal

Description

The web portal.

Members

additionalEncryptionContext

: Type: Associative array of custom strings keys (StringType) to strings

The additional encryption context of the portal.

authenticationType

: Type: string

The type of authentication integration points used when signing into the web portal. Defaults to Standard.

browserSettingsArn

: Type: string

The ARN of the browser settings that is associated with this web portal.

browserType

: Type: string

The browser that users see when using a streaming session.

creationDate

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation date of the web portal.

customerManagedKey

: Type: string

The customer managed key used to encrypt sensitive information in the portal.

dataProtectionSettingsArn

: Type: string

The ARN of the data protection settings.

displayName

: Type: string

The name of the web portal.

instanceType

: Type: string

The type and resources of the underlying instance.

ipAccessSettingsArn

: Type: string

The ARN of the IP access settings.

maxConcurrentSessions

: Type: int

The maximum number of concurrent sessions for the portal.

networkSettingsArn

: Type: string

The ARN of the network settings that is associated with the web portal.

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

portalEndpoint

: Type: string

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

portalStatus

: Type: string

The status of the web portal.

rendererType

: Type: string

The renderer that is used in streaming sessions.

statusReason

: Type: string

A message that explains why the web portal is in its current status.

trustStoreArn

: Type: string

The ARN of the trust store that is associated with the web portal.

userAccessLoggingSettingsArn

: Type: string

The ARN of the user access logging settings that is associated with the web portal.

userSettingsArn

: Type: string

The ARN of the user settings that is associated with the web portal.

PortalSummary

Description

The summary of the portal.

Members

authenticationType

: Type: string

The type of authentication integration points used when signing into the web portal. Defaults to Standard.

browserSettingsArn

: Type: string

The ARN of the browser settings that is associated with the web portal.

browserType

: Type: string

The browser type of the web portal.

creationDate

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation date of the web portal.

dataProtectionSettingsArn

: Type: string

The ARN of the data protection settings.

displayName

: Type: string

The name of the web portal.

instanceType

: Type: string

The type and resources of the underlying instance.

ipAccessSettingsArn

: Type: string

The ARN of the IP access settings.

maxConcurrentSessions

: Type: int

The maximum number of concurrent sessions for the portal.

networkSettingsArn

: Type: string

The ARN of the network settings that is associated with the web portal.

portalArn

: Required: Yes
: Type: string

The ARN of the web portal.

portalEndpoint

: Type: string

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

portalStatus

: Type: string

The status of the web portal.

rendererType

: Type: string

The renderer that is used in streaming sessions.

trustStoreArn

: Type: string

The ARN of the trust that is associated with this web portal.

userAccessLoggingSettingsArn

: Type: string

The ARN of the user access logging settings that is associated with the web portal.

userSettingsArn

: Type: string

The ARN of the user settings that is associated with the web portal.

RedactionPlaceHolder

Description

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

Members

redactionPlaceHolderText

: Type: string

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

redactionPlaceHolderType

: Required: Yes
: Type: string

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

ResourceNotFoundException

Description

The resource cannot be found.

Members

message

: Type: string

resourceId

: Type: string

Hypothetical identifier of the resource affected.

resourceType

: Type: string

Hypothetical type of the resource affected.

ServiceQuotaExceededException

Description

The service quota has been exceeded.

Members

message

: Type: string

quotaCode

: Type: string

The originating quota.

resourceId

: Type: string

Identifier of the resource affected.

resourceType

: Type: string

Type of the resource affected.

serviceCode

: Type: string

The originating service.

Session

Description

Information about a secure browser session.

Members

clientIpAddresses

: Type: Array of strings

The IP address of the client.

endTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The end time of the session.

portalArn

: Type: string

The ARN of the web portal.

sessionId

: Type: string

The ID of the session.

startTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The start time of the session.

status

: Type: string

The status of the session.

username

: Type: string

The username of the session.

SessionSummary

Description

Summary information about a secure browser session.

Members

endTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The end time of the session.

portalArn

: Type: string

The ARN of the web portal.

sessionId

: Type: string

The ID of the session.

startTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The start time of the session.

status

: Type: string

The status of the session.

username

: Type: string

The username of the session.

ThrottlingException

Description

There is a throttling error.

Members

message

: Type: string

quotaCode

: Type: string

The originating quota.

retryAfterSeconds

: Type: int

Advice to clients on when the call can be safely retried.

serviceCode

: Type: string

The originating service.

TooManyTagsException

Description

There are too many tags.

Members

message

: Type: string

resourceName

: Type: string

Name of the resource affected.

TrustStore

Description

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.

Members

associatedPortalArns

: Type: Array of strings

A list of web portal ARNs that this trust store is associated with.

trustStoreArn

: Required: Yes
: Type: string

The ARN of the trust store.

TrustStoreSummary

Description

The summary of the trust store.

Members

trustStoreArn

: Type: string

The ARN of the trust store.

UserAccessLoggingSettings

Description

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

Members

associatedPortalArns

: Type: Array of strings

A list of web portal ARNs that this user access logging settings is associated with.

kinesisStreamArn

: Type: string

The ARN of the Kinesis stream.

userAccessLoggingSettingsArn

: Required: Yes
: Type: string

The ARN of the user access logging settings.

UserAccessLoggingSettingsSummary

Description

The summary of user access logging settings.

Members

kinesisStreamArn

: Type: string

The ARN of the Kinesis stream.

userAccessLoggingSettingsArn

: Required: Yes
: Type: string

The ARN of the user access logging settings.

UserSettings

Description

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.

Members

additionalEncryptionContext

: Type: Associative array of custom strings keys (StringType) to strings

The additional encryption context of the user settings.

associatedPortalArns

: Type: Array of strings

A list of web portal ARNs that this user settings is associated with.

cookieSynchronizationConfiguration

: Type: CookieSynchronizationConfiguration structure

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

copyAllowed

: Type: string

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

customerManagedKey

: Type: string

The customer managed key used to encrypt sensitive information in the user settings.

deepLinkAllowed

: Type: string

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

disconnectTimeoutInMinutes

: Type: int

The amount of time that a streaming session remains active after users disconnect.

downloadAllowed

: Type: string

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

idleDisconnectTimeoutInMinutes

: Type: int

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

pasteAllowed

: Type: string

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

printAllowed

: Type: string

Specifies whether the user can print to the local device.

uploadAllowed

: Type: string

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

userSettingsArn

: Required: Yes
: Type: string

The ARN of the user settings.

UserSettingsSummary

Description

The summary of user settings.

Members

cookieSynchronizationConfiguration

: Type: CookieSynchronizationConfiguration structure

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

copyAllowed

: Type: string

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

deepLinkAllowed

: Type: string

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

disconnectTimeoutInMinutes

: Type: int

The amount of time that a streaming session remains active after users disconnect.

downloadAllowed

: Type: string

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

idleDisconnectTimeoutInMinutes

: Type: int

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

pasteAllowed

: Type: string

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

printAllowed

: Type: string

Specifies whether the user can print to the local device.

uploadAllowed

: Type: string

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

userSettingsArn

: Required: Yes
: Type: string

The ARN of the user settings.

ValidationException

Description

There is a validation error.

Members

fieldList

: Type: Array of ValidationExceptionField structures

The field that caused the error.

message

: Type: string

reason

: Type: string

Reason the request failed validation

ValidationExceptionField

Description

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

Members

message

: Required: Yes
: Type: string

The message describing why the field failed validation.

name

: Required: Yes
: Type: string

The name of the field that failed validation.

Amazon WorkSpaces Web 2020-07-08

Operation Summary

Paginators

Operations

AssociateBrowserSettings

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AssociateDataProtectionSettings

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AssociateIpAccessSettings

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AssociateNetworkSettings

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AssociateTrustStore

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AssociateUserAccessLoggingSettings

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AssociateUserSettings

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateBrowserSettings

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateDataProtectionSettings

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateIdentityProvider

Parameter Syntax

Parameter Details

Members