Amazon WorkSpaces Web 2020-07-08
- 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.
- AssociateNetworkSettings ( array $params = [] )
Associates a network settings resource with a web portal.
- AssociateTrustStore ( array $params = [] )
Associates a trust store 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.
- CreateIdentityProvider ( array $params = [] )
Creates an identity provider resource that is then 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.
- CreateUserSettings ( array $params = [] )
Creates a user settings resource that can be associated with a web portal.
- DeleteBrowserSettings ( array $params = [] )
Deletes browser settings.
- DeleteIdentityProvider ( array $params = [] )
Deletes the identity provider.
- DeleteNetworkSettings ( array $params = [] )
Deletes network settings.
- DeletePortal ( array $params = [] )
Deletes a web portal.
- DeleteTrustStore ( array $params = [] )
Deletes the trust store.
- DeleteUserSettings ( array $params = [] )
Deletes user settings.
- DisassociateBrowserSettings ( array $params = [] )
Disassociates browser 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.
- DisassociateUserSettings ( array $params = [] )
Disassociates user settings from a web portal.
- GetBrowserSettings ( array $params = [] )
Gets browser settings.
- GetIdentityProvider ( array $params = [] )
Gets the identity provider.
- GetNetworkSettings ( array $params = [] )
Gets the network settings.
- GetPortal ( array $params = [] )
Gets the web portal.
- GetPortalServiceProviderMetadata ( array $params = [] )
Gets the service provider metadata.
- GetTrustStore ( array $params = [] )
Gets the trust store.
- GetTrustStoreCertificate ( array $params = [] )
Gets the trust store certificate.
- GetUserSettings ( array $params = [] )
Gets user settings.
- ListBrowserSettings ( array $params = [] )
Retrieves a list of browser settings.
- ListIdentityProviders ( array $params = [] )
Retrieves a list of identity providers for a specific web portal.
- ListNetworkSettings ( array $params = [] )
Retrieves a list of network settings.
- ListPortals ( array $params = [] )
Retrieves a list or web portals.
- 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.
- 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.
- UpdateIdentityProvider ( array $params = [] )
Updates the identity provider.
- UpdateNetworkSettings ( array $params = [] )
Updates network settings.
- UpdatePortal ( array $params = [] )
Updates a web portal.
- UpdateTrustStore ( array $params = [] )
Updates the trust store.
- 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:
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
Result Syntax
[
'browserSettingsArn' => '<string>',
'portalArn' => '<string>',
]
Result Details
Members
Errors
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
There is a validation error.
-
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
Result Syntax
[
'networkSettingsArn' => '<string>',
'portalArn' => '<string>',
]
Result Details
Members
Errors
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
There is a validation error.
-
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
Result Syntax
[
'portalArn' => '<string>',
'trustStoreArn' => '<string>',
]
Result Details
Members
Errors
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
There is a validation error.
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
Result Syntax
[
'portalArn' => '<string>',
'userSettingsArn' => '<string>',
]
Result Details
Members
Errors
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
There is a validation error.
-
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 AWS 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
Errors
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
ServiceQuotaExceededException:
The service quota has been exceeded.
-
There is a validation error.
-
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
]);
Parameter Details
Members
- 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 AWS 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_urlif not available from discovery URL specified byoidc_issuerkey -
token_urlif not available from discovery URL specified byoidc_issuerkey -
attributes_urlif not available from discovery URL specified byoidc_issuerkey -
jwks_uriif not available from discovery URL specified byoidc_issuerkey
-
-
For SAML providers:
-
MetadataFileORMetadataURL -
IDPSignout(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.
Result Syntax
[
'identityProviderArn' => '<string>',
]
Result Details
Errors
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
ServiceQuotaExceededException:
The service quota has been exceeded.
-
There is a validation error.
-
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
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 AWS 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
Errors
-
There is an internal server error.
-
Access is denied.
-
There is a throttling error.
-
ServiceQuotaExceededException:
The service quota has been exceeded.
-
There is a validation error.
-
There is a conflict.
CreatePortal
$result = $client->createPortal([/* ... */]); $promise = $client->createPortalAsync([/* ... */]);
Creates a web portal.
Parameter Syntax
$result = $client->createPortal([
'additionalEncryptionContext' => ['<string>', ...],
'clientToken' => '<string>',
'customerManagedKey' => '<string>',
'displayName' => '<string>',
'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.
- 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 AWS 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.
- 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
Errors
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
ServiceQuotaExceededException:
The service quota has been exceeded.
-
There is a validation error.
-
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
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 AWS 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
Errors
-
There is an internal server error.
-
Access is denied.
-
There is a throttling error.
-
ServiceQuotaExceededException:
The service quota has been exceeded.
-
There is a validation error.
-
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([
'clientToken' => '<string>',
'copyAllowed' => 'Disabled|Enabled', // REQUIRED
'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
- 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 AWS SDK.
- copyAllowed
-
- Required: Yes
- Type: string
Specifies whether the user can copy text from the streaming session to the local device.
- 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
Errors
-
There is an internal server error.
-
Access is denied.
-
There is a throttling error.
-
ServiceQuotaExceededException:
The service quota has been exceeded.
-
There is a validation error.
-
There is a conflict.
DeleteBrowserSettings
$result = $client->deleteBrowserSettings([/* ... */]); $promise = $client->deleteBrowserSettingsAsync([/* ... */]);
Deletes browser settings.
Parameter Syntax
$result = $client->deleteBrowserSettings([
'browserSettingsArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
There is an internal server error.
-
Access is denied.
-
There is a throttling error.
-
There is a validation error.
-
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
Result Syntax
[]
Result Details
Errors
-
There is an internal server error.
-
Access is denied.
-
There is a throttling error.
-
There is a validation error.
-
There is a conflict.
DeleteNetworkSettings
$result = $client->deleteNetworkSettings([/* ... */]); $promise = $client->deleteNetworkSettingsAsync([/* ... */]);
Deletes network settings.
Parameter Syntax
$result = $client->deleteNetworkSettings([
'networkSettingsArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
There is an internal server error.
-
Access is denied.
-
There is a throttling error.
-
There is a validation error.
-
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
Result Syntax
[]
Result Details
Errors
-
There is an internal server error.
-
Access is denied.
-
There is a throttling error.
-
There is a validation error.
-
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
Result Syntax
[]
Result Details
Errors
-
There is an internal server error.
-
Access is denied.
-
There is a throttling error.
-
There is a validation error.
-
There is a conflict.
DeleteUserSettings
$result = $client->deleteUserSettings([/* ... */]); $promise = $client->deleteUserSettingsAsync([/* ... */]);
Deletes user settings.
Parameter Syntax
$result = $client->deleteUserSettings([
'userSettingsArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
There is an internal server error.
-
Access is denied.
-
There is a throttling error.
-
There is a validation error.
-
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
Result Syntax
[]
Result Details
Errors
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
There is a validation error.
DisassociateNetworkSettings
$result = $client->disassociateNetworkSettings([/* ... */]); $promise = $client->disassociateNetworkSettingsAsync([/* ... */]);
Disassociates network settings from a web portal.
Parameter Syntax
$result = $client->disassociateNetworkSettings([
'portalArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
There is a validation error.
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
Result Syntax
[]
Result Details
Errors
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
There is a validation error.
DisassociateUserSettings
$result = $client->disassociateUserSettings([/* ... */]); $promise = $client->disassociateUserSettingsAsync([/* ... */]);
Disassociates user settings from a web portal.
Parameter Syntax
$result = $client->disassociateUserSettings([
'portalArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
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
Result Syntax
[
'browserSettings' => [
'associatedPortalArns' => ['<string>', ...],
'browserPolicy' => '<string>',
'browserSettingsArn' => '<string>',
],
]
Result Details
Members
- browserSettings
-
- Type: BrowserSettings structure
The browser settings.
Errors
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
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
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
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
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
Result Syntax
[
'networkSettings' => [
'associatedPortalArns' => ['<string>', ...],
'networkSettingsArn' => '<string>',
'securityGroupIds' => ['<string>', ...],
'subnetIds' => ['<string>', ...],
'vpcId' => '<string>',
],
]
Result Details
Members
- networkSettings
-
- Type: NetworkSettings structure
The network settings.
Errors
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
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
Result Syntax
[
'portal' => [
'browserSettingsArn' => '<string>',
'browserType' => 'Chrome',
'creationDate' => <DateTime>,
'displayName' => '<string>',
'networkSettingsArn' => '<string>',
'portalArn' => '<string>',
'portalEndpoint' => '<string>',
'portalStatus' => 'Incomplete|Pending|Active',
'rendererType' => 'AppStream',
'statusReason' => '<string>',
'trustStoreArn' => '<string>',
'userSettingsArn' => '<string>',
],
]
Result Details
Members
- portal
-
- Type: Portal structure
The web portal.
Errors
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
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
Result Syntax
[
'portalArn' => '<string>',
'serviceProviderSamlMetadata' => '<string>',
]
Result Details
Members
Errors
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
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
Result Syntax
[
'trustStore' => [
'associatedPortalArns' => ['<string>', ...],
'trustStoreArn' => '<string>',
],
]
Result Details
Members
- trustStore
-
- Type: TrustStore structure
The trust store.
Errors
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
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
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
-
- Type: string
The ARN of the trust store certificate.
Errors
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
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
Result Syntax
[
'userSettings' => [
'associatedPortalArns' => ['<string>', ...],
'copyAllowed' => '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
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
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
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
-
There is an internal server error.
-
Access is denied.
-
There is a throttling error.
-
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
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
-
There is an internal server error.
-
Access is denied.
-
There is a throttling error.
-
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
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
-
There is an internal server error.
-
Access is denied.
-
There is a throttling error.
-
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
Result Syntax
[
'nextToken' => '<string>',
'portals' => [
[
'browserSettingsArn' => '<string>',
'browserType' => 'Chrome',
'creationDate' => <DateTime>,
'displayName' => '<string>',
'networkSettingsArn' => '<string>',
'portalArn' => '<string>',
'portalEndpoint' => '<string>',
'portalStatus' => 'Incomplete|Pending|Active',
'rendererType' => 'AppStream',
'trustStoreArn' => '<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
-
There is an internal server error.
-
Access is denied.
-
There is a throttling error.
-
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
Result Syntax
[
'tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- tags
-
- Type: Array of Tag structures
The tags of the resource.
Errors
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
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
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
-
- Type: string
The ARN of the trust store.
Errors
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
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
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
-
There is an internal server error.
-
Access is denied.
-
There is a throttling error.
-
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
Result Syntax
[
'nextToken' => '<string>',
'userSettings' => [
[
'copyAllowed' => '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
-
There is an internal server error.
-
Access is denied.
-
There is a throttling error.
-
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
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 AWS 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
Errors
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
There is a validation error.
-
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
Result Syntax
[]
Result Details
Errors
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
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
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 return the result from the original successful request.
If you do not specify a client token, one is automatically generated by the AWS SDK.
Result Syntax
[
'browserSettings' => [
'associatedPortalArns' => ['<string>', ...],
'browserPolicy' => '<string>',
'browserSettingsArn' => '<string>',
],
]
Result Details
Members
- browserSettings
-
- Required: Yes
- Type: BrowserSettings structure
The browser settings.
Errors
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
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
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 return the result from the original successful request.
If you do not specify a client token, one is automatically generated by the AWS 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_urlif not available from discovery URL specified byoidc_issuerkey -
token_urlif not available from discovery URL specified byoidc_issuerkey -
attributes_urlif not available from discovery URL specified byoidc_issuerkey -
jwks_uriif not available from discovery URL specified byoidc_issuerkey
-
-
For SAML providers:
-
MetadataFileORMetadataURL -
IDPSignout(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
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
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
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 return the result from the original successful request.
If you do not specify a client token, one is automatically generated by the AWS 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
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
There is a validation error.
UpdatePortal
$result = $client->updatePortal([/* ... */]); $promise = $client->updatePortalAsync([/* ... */]);
Updates a web portal.
Parameter Syntax
$result = $client->updatePortal([
'displayName' => '<string>',
'portalArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'portal' => [
'browserSettingsArn' => '<string>',
'browserType' => 'Chrome',
'creationDate' => <DateTime>,
'displayName' => '<string>',
'networkSettingsArn' => '<string>',
'portalArn' => '<string>',
'portalEndpoint' => '<string>',
'portalStatus' => 'Incomplete|Pending|Active',
'rendererType' => 'AppStream',
'statusReason' => '<string>',
'trustStoreArn' => '<string>',
'userSettingsArn' => '<string>',
],
]
Result Details
Members
- portal
-
- Type: Portal structure
The web portal.
Errors
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
There is a validation error.
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
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 return the result from the original successful request.
If you do not specify a client token, one is automatically generated by the AWS SDK.
- trustStoreArn
-
- Required: Yes
- Type: string
The ARN of the trust store.
Result Syntax
[
'trustStoreArn' => '<string>',
]
Result Details
Errors
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
ServiceQuotaExceededException:
The service quota has been exceeded.
-
There is a validation error.
UpdateUserSettings
$result = $client->updateUserSettings([/* ... */]); $promise = $client->updateUserSettingsAsync([/* ... */]);
Updates the user settings.
Parameter Syntax
$result = $client->updateUserSettings([
'clientToken' => '<string>',
'copyAllowed' => '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
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 return the result from the original successful request.
If you do not specify a client token, one is automatically generated by the AWS SDK.
- copyAllowed
-
- Type: string
Specifies whether the user can copy text from the streaming session to the local device.
- 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' => [
'associatedPortalArns' => ['<string>', ...],
'copyAllowed' => '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
-
There is an internal server error.
-
The resource cannot be found.
-
Access is denied.
-
There is a throttling error.
-
There is a validation error.
Shapes
AccessDeniedException
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
- 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.
BrowserSettingsSummary
Description
The summary for browser settings.
Members
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
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_urlif not available from discovery URL specified by oidc_issuer key -
token_urlif not available from discovery URL specified by oidc_issuer key -
attributes_urlif not available from discovery URL specified by oidc_issuer key -
jwks_uriif not available from discovery URL specified by oidc_issuer key
-
-
For SAML providers:
-
MetadataFileORMetadataURL -
IDPSignoutoptional
-
- identityProviderName
-
- Type: string
The identity provider name.
- identityProviderType
-
- Type: string
The identity provider type.
IdentityProviderSummary
Description
The summary of the identity provider.
Members
InternalServerException
Description
There is an internal server error.
Members
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
Portal
Description
The web portal.
Members
- 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.
- displayName
-
- Type: string
The name of the web portal.
- networkSettingsArn
-
- Type: string
The ARN of the network settings that is associated with the web portal.
- portalArn
-
- 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.
- userSettingsArn
-
- Type: string
The ARN of the trust store that is associated with the web portal.
PortalSummary
Description
The summary of the portal.
Members
- 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.
- displayName
-
- Type: string
The name of the web portal.
- networkSettingsArn
-
- Type: string
The ARN of the network settings that is associated with the web portal.
- portalArn
-
- 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.
- userSettingsArn
-
- Type: string
The ARN of the user settings that is associated with the web portal.
ResourceNotFoundException
Description
The resource cannot be found.
Members
ServiceQuotaExceededException
Description
The service quota has been exceeded.
Members
Tag
Description
The tag.
Members
ThrottlingException
Description
There is a throttling error.
Members
TooManyTagsException
Description
There are too many tags.
Members
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
TrustStoreSummary
Description
The summary of the trust store.
Members
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
- associatedPortalArns
-
- Type: Array of strings
A list of web portal ARNs that this user settings is associated with.
- copyAllowed
-
- Type: string
Specifies whether the user can copy text from the streaming session to the local device.
- 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
- copyAllowed
-
- Type: string
Specifies whether the user can copy text from the streaming session to the local device.
- 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
-
- 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