2021/11/30 - Amazon WorkSpaces Web - 44 new api methods
Changes This is the initial SDK release for Amazon WorkSpaces Web. Amazon WorkSpaces Web is a low-cost, fully managed WorkSpace built to deliver secure web-based workloads and software-as-a-service (SaaS) application access to users within existing web browsers.
Updates the user settings.
See also: AWS API Documentation
Request Syntax
client.update_user_settings(
clientToken='string',
copyAllowed='Disabled'|'Enabled',
downloadAllowed='Disabled'|'Enabled',
pasteAllowed='Disabled'|'Enabled',
printAllowed='Disabled'|'Enabled',
uploadAllowed='Disabled'|'Enabled',
userSettingsArn='string'
)
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.
This field is autopopulated if not provided.
string
Specifies whether the user can copy text from the streaming session to the local device.
string
Specifies whether the user can download files from the streaming session to the local device.
string
Specifies whether the user can paste text from the local device to the streaming session.
string
Specifies whether the user can print to the local device.
string
Specifies whether the user can upload files from the local device to the streaming session.
string
[REQUIRED]
The ARN of the user settings.
dict
Response Syntax
{
'userSettings': {
'associatedPortalArns': [
'string',
],
'copyAllowed': 'Disabled'|'Enabled',
'downloadAllowed': 'Disabled'|'Enabled',
'pasteAllowed': 'Disabled'|'Enabled',
'printAllowed': 'Disabled'|'Enabled',
'uploadAllowed': 'Disabled'|'Enabled',
'userSettingsArn': 'string'
}
}
Response Structure
(dict) --
userSettings (dict) --
The user settings.
associatedPortalArns (list) --
A list of web portal ARNs that this user settings is associated with.
(string) --
copyAllowed (string) --
Specifies whether the user can copy text from the streaming session to the local device.
downloadAllowed (string) --
Specifies whether the user can download files from the streaming session to the local device.
pasteAllowed (string) --
Specifies whether the user can paste text from the local device to the streaming session.
printAllowed (string) --
Specifies whether the user can print to the local device.
uploadAllowed (string) --
Specifies whether the user can upload files from the local device to the streaming session.
userSettingsArn (string) --
The ARN of the user settings.
Updates a web portal.
See also: AWS API Documentation
Request Syntax
client.update_portal(
displayName='string',
portalArn='string'
)
string
The name of the web portal. This is not visible to users who log into the web portal.
string
[REQUIRED]
The ARN of the web portal.
dict
Response Syntax
{
'portal': {
'browserSettingsArn': 'string',
'browserType': 'Chrome',
'creationDate': datetime(2015, 1, 1),
'displayName': 'string',
'networkSettingsArn': 'string',
'portalArn': 'string',
'portalEndpoint': 'string',
'portalStatus': 'Incomplete'|'Pending'|'Active',
'rendererType': 'AppStream',
'statusReason': 'string',
'trustStoreArn': 'string',
'userSettingsArn': 'string'
}
}
Response Structure
(dict) --
portal (dict) --
The web portal.
browserSettingsArn (string) --
The ARN of the browser settings that is associated with this web portal.
browserType (string) --
The browser that users see when using a streaming session.
creationDate (datetime) --
The creation date of the web portal.
displayName (string) --
The name of the web portal.
networkSettingsArn (string) --
The ARN of the network settings that is associated with the web portal.
portalArn (string) --
The ARN of the web portal.
portalEndpoint (string) --
The endpoint URL of the web portal that users access in order to start streaming sessions.
portalStatus (string) --
The status of the web portal.
rendererType (string) --
The renderer that is used in streaming sessions.
statusReason (string) --
A message that explains why the web portal is in its current status.
trustStoreArn (string) --
The ARN of the trust store that is associated with the web portal.
userSettingsArn (string) --
The ARN of the trust store that is associated with the web portal.
Updates the identity provider.
See also: AWS API Documentation
Request Syntax
client.update_identity_provider(
clientToken='string',
identityProviderArn='string',
identityProviderDetails={
'string': 'string'
},
identityProviderName='string',
identityProviderType='SAML'|'Facebook'|'Google'|'LoginWithAmazon'|'SignInWithApple'|'OIDC'
)
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.
This field is autopopulated if not provided.
string
[REQUIRED]
The ARN of the identity provider.
dict
The details of the identity provider.
(string) --
(string) --
string
The name of the identity provider.
string
The type of the identity provider.
dict
Response Syntax
{
'identityProvider': {
'identityProviderArn': 'string',
'identityProviderDetails': {
'string': 'string'
},
'identityProviderName': 'string',
'identityProviderType': 'SAML'|'Facebook'|'Google'|'LoginWithAmazon'|'SignInWithApple'|'OIDC'
}
}
Response Structure
(dict) --
identityProvider (dict) --
The identity provider.
identityProviderArn (string) --
The ARN of the identity provider.
identityProviderDetails (dict) --
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 optional
(string) --
(string) --
identityProviderName (string) --
The identity provider name.
identityProviderType (string) --
The identity provider type.
Updates the trust store.
See also: AWS API Documentation
Request Syntax
client.update_trust_store(
certificatesToAdd=[
b'bytes',
],
certificatesToDelete=[
'string',
],
clientToken='string',
trustStoreArn='string'
)
list
A list of CA certificates to add to the trust store.
(bytes) --
list
A list of CA certificates to delete from a trust store.
(string) --
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.
This field is autopopulated if not provided.
string
[REQUIRED]
The ARN of the trust store.
dict
Response Syntax
{
'trustStoreArn': 'string'
}
Response Structure
(dict) --
trustStoreArn (string) --
The ARN of the trust store.
Gets the service provider metadata.
See also: AWS API Documentation
Request Syntax
client.get_portal_service_provider_metadata(
portalArn='string'
)
string
[REQUIRED]
The ARN of the web portal.
dict
Response Syntax
{
'portalArn': 'string',
'serviceProviderSamlMetadata': 'string'
}
Response Structure
(dict) --
portalArn (string) --
The ARN of the web portal.
serviceProviderSamlMetadata (string) --
The service provider SAML metadata.
Retrieves a list of trust stores.
See also: AWS API Documentation
Request Syntax
client.list_trust_stores(
maxResults=123,
nextToken='string'
)
integer
The maximum number of results to be included in the next page.
string
The pagination token used to retrieve the next page of results for this operation.
dict
Response Syntax
{
'nextToken': 'string',
'trustStores': [
{
'trustStoreArn': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The pagination token used to retrieve the next page of results for this operation.
trustStores (list) --
The trust stores.
(dict) --
The summary of the trust store.
trustStoreArn (string) --
The ARN of the trust store.
Updates network settings.
See also: AWS API Documentation
Request Syntax
client.update_network_settings(
clientToken='string',
networkSettingsArn='string',
securityGroupIds=[
'string',
],
subnetIds=[
'string',
],
vpcId='string'
)
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.
This field is autopopulated if not provided.
string
[REQUIRED]
The ARN of the network settings.
list
One or more security groups used to control access from streaming instances to your VPC.
(string) --
list
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.
(string) --
string
The VPC that streaming instances will connect to.
dict
Response Syntax
{
'networkSettings': {
'associatedPortalArns': [
'string',
],
'networkSettingsArn': 'string',
'securityGroupIds': [
'string',
],
'subnetIds': [
'string',
],
'vpcId': 'string'
}
}
Response Structure
(dict) --
networkSettings (dict) --
The network settings.
associatedPortalArns (list) --
A list of web portal ARNs that this network settings is associated with.
(string) --
networkSettingsArn (string) --
The ARN of the network settings.
securityGroupIds (list) --
One or more security groups used to control access from streaming instances to your VPC.
(string) --
subnetIds (list) --
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.
(string) --
vpcId (string) --
The VPC that streaming instances will connect to.
Gets the web portal.
See also: AWS API Documentation
Request Syntax
client.get_portal(
portalArn='string'
)
string
[REQUIRED]
The ARN of the web portal.
dict
Response Syntax
{
'portal': {
'browserSettingsArn': 'string',
'browserType': 'Chrome',
'creationDate': datetime(2015, 1, 1),
'displayName': 'string',
'networkSettingsArn': 'string',
'portalArn': 'string',
'portalEndpoint': 'string',
'portalStatus': 'Incomplete'|'Pending'|'Active',
'rendererType': 'AppStream',
'statusReason': 'string',
'trustStoreArn': 'string',
'userSettingsArn': 'string'
}
}
Response Structure
(dict) --
portal (dict) --
The web portal.
browserSettingsArn (string) --
The ARN of the browser settings that is associated with this web portal.
browserType (string) --
The browser that users see when using a streaming session.
creationDate (datetime) --
The creation date of the web portal.
displayName (string) --
The name of the web portal.
networkSettingsArn (string) --
The ARN of the network settings that is associated with the web portal.
portalArn (string) --
The ARN of the web portal.
portalEndpoint (string) --
The endpoint URL of the web portal that users access in order to start streaming sessions.
portalStatus (string) --
The status of the web portal.
rendererType (string) --
The renderer that is used in streaming sessions.
statusReason (string) --
A message that explains why the web portal is in its current status.
trustStoreArn (string) --
The ARN of the trust store that is associated with the web portal.
userSettingsArn (string) --
The ARN of the trust store that is associated with the web portal.
Deletes the trust store.
See also: AWS API Documentation
Request Syntax
client.delete_trust_store(
trustStoreArn='string'
)
string
[REQUIRED]
The ARN of the trust store.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a web portal.
See also: AWS API Documentation
Request Syntax
client.create_portal(
additionalEncryptionContext={
'string': 'string'
},
clientToken='string',
customerManagedKey='string',
displayName='string',
tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
dict
The additional encryption context of the portal.
(string) --
(string) --
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.
This field is autopopulated if not provided.
string
The customer managed key of the web portal.
string
The name of the web portal. This is not visible to users who log into the web portal.
list
The tags to add to the web portal. A tag is a key-value pair.
(dict) --
The tag.
Key (string) -- [REQUIRED]
The key of the tag.
Value (string) -- [REQUIRED]
The value of the tag
dict
Response Syntax
{
'portalArn': 'string',
'portalEndpoint': 'string'
}
Response Structure
(dict) --
portalArn (string) --
The ARN of the web portal.
portalEndpoint (string) --
The endpoint URL of the web portal that users access in order to start streaming sessions.
Retrieves a list of trust store certificates.
See also: AWS API Documentation
Request Syntax
client.list_trust_store_certificates(
maxResults=123,
nextToken='string',
trustStoreArn='string'
)
integer
The maximum number of results to be included in the next page.
string
The pagination token used to retrieve the next page of results for this operation.
string
[REQUIRED]
The ARN of the trust store
dict
Response Syntax
{
'certificateList': [
{
'issuer': 'string',
'notValidAfter': datetime(2015, 1, 1),
'notValidBefore': datetime(2015, 1, 1),
'subject': 'string',
'thumbprint': 'string'
},
],
'nextToken': 'string',
'trustStoreArn': 'string'
}
Response Structure
(dict) --
certificateList (list) --
The certificate list.
(dict) --
The summary of the certificate.
issuer (string) --
The entity that issued the certificate.
notValidAfter (datetime) --
The certificate is not valid after this date.
notValidBefore (datetime) --
The certificate is not valid before this date.
subject (string) --
The entity the certificate belongs to.
thumbprint (string) --
A hexadecimal identifier for the certificate.
nextToken (string) --
The pagination token used to retrieve the next page of results for this operation.>
trustStoreArn (string) --
The ARN of the trust store.
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.
See also: AWS API Documentation
Request Syntax
client.create_user_settings(
clientToken='string',
copyAllowed='Disabled'|'Enabled',
downloadAllowed='Disabled'|'Enabled',
pasteAllowed='Disabled'|'Enabled',
printAllowed='Disabled'|'Enabled',
tags=[
{
'Key': 'string',
'Value': 'string'
},
],
uploadAllowed='Disabled'|'Enabled'
)
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.
This field is autopopulated if not provided.
string
[REQUIRED]
Specifies whether the user can copy text from the streaming session to the local device.
string
[REQUIRED]
Specifies whether the user can download files from the streaming session to the local device.
string
[REQUIRED]
Specifies whether the user can paste text from the local device to the streaming session.
string
[REQUIRED]
Specifies whether the user can print to the local device.
list
The tags to add to the user settings resource. A tag is a key-value pair.
(dict) --
The tag.
Key (string) -- [REQUIRED]
The key of the tag.
Value (string) -- [REQUIRED]
The value of the tag
string
[REQUIRED]
Specifies whether the user can upload files from the local device to the streaming session.
dict
Response Syntax
{
'userSettingsArn': 'string'
}
Response Structure
(dict) --
userSettingsArn (string) --
The ARN of the user settings.
Deletes the identity provider.
See also: AWS API Documentation
Request Syntax
client.delete_identity_provider(
identityProviderArn='string'
)
string
[REQUIRED]
The ARN of the identity provider.
dict
Response Syntax
{}
Response Structure
(dict) --
Removes one or more tags from the specified resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
The ARN of the resource.
list
[REQUIRED]
The list of tag keys to remove from the resource.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
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.
See also: AWS API Documentation
Request Syntax
client.create_browser_settings(
additionalEncryptionContext={
'string': 'string'
},
browserPolicy='string',
clientToken='string',
customerManagedKey='string',
tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
dict
Additional encryption context of the browser settings.
(string) --
(string) --
string
[REQUIRED]
A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.
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.
This field is autopopulated if not provided.
string
The custom managed key of the browser settings.
list
The tags to add to the browser settings resource. A tag is a key-value pair.
(dict) --
The tag.
Key (string) -- [REQUIRED]
The key of the tag.
Value (string) -- [REQUIRED]
The value of the tag
dict
Response Syntax
{
'browserSettingsArn': 'string'
}
Response Structure
(dict) --
browserSettingsArn (string) --
The ARN of the browser settings.
Gets user settings.
See also: AWS API Documentation
Request Syntax
client.get_user_settings(
userSettingsArn='string'
)
string
[REQUIRED]
The ARN of the user settings.
dict
Response Syntax
{
'userSettings': {
'associatedPortalArns': [
'string',
],
'copyAllowed': 'Disabled'|'Enabled',
'downloadAllowed': 'Disabled'|'Enabled',
'pasteAllowed': 'Disabled'|'Enabled',
'printAllowed': 'Disabled'|'Enabled',
'uploadAllowed': 'Disabled'|'Enabled',
'userSettingsArn': 'string'
}
}
Response Structure
(dict) --
userSettings (dict) --
The user settings.
associatedPortalArns (list) --
A list of web portal ARNs that this user settings is associated with.
(string) --
copyAllowed (string) --
Specifies whether the user can copy text from the streaming session to the local device.
downloadAllowed (string) --
Specifies whether the user can download files from the streaming session to the local device.
pasteAllowed (string) --
Specifies whether the user can paste text from the local device to the streaming session.
printAllowed (string) --
Specifies whether the user can print to the local device.
uploadAllowed (string) --
Specifies whether the user can upload files from the local device to the streaming session.
userSettingsArn (string) --
The ARN of the user settings.
Disassociates browser settings from a web portal.
See also: AWS API Documentation
Request Syntax
client.disassociate_browser_settings(
portalArn='string'
)
string
[REQUIRED]
The ARN of the web portal.
dict
Response Syntax
{}
Response Structure
(dict) --
Disassociates network settings from a web portal.
See also: AWS API Documentation
Request Syntax
client.disassociate_network_settings(
portalArn='string'
)
string
[REQUIRED]
The ARN of the web portal.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes browser settings.
See also: AWS API Documentation
Request Syntax
client.delete_browser_settings(
browserSettingsArn='string'
)
string
[REQUIRED]
The ARN of the browser settings.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves a list of identity providers for a specific web portal.
See also: AWS API Documentation
Request Syntax
client.list_identity_providers(
maxResults=123,
nextToken='string',
portalArn='string'
)
integer
The maximum number of results to be included in the next page.
string
The pagination token used to retrieve the next page of results for this operation.
string
[REQUIRED]
The ARN of the web portal.
dict
Response Syntax
{
'identityProviders': [
{
'identityProviderArn': 'string',
'identityProviderName': 'string',
'identityProviderType': 'SAML'|'Facebook'|'Google'|'LoginWithAmazon'|'SignInWithApple'|'OIDC'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
identityProviders (list) --
The identity providers.
(dict) --
The summary of the identity provider.
identityProviderArn (string) --
The ARN of the identity provider.
identityProviderName (string) --
The identity provider name.
identityProviderType (string) --
The identity provider type.
nextToken (string) --
The pagination token used to retrieve the next page of results for this operation.
Associates a browser settings resource with a web portal.
See also: AWS API Documentation
Request Syntax
client.associate_browser_settings(
browserSettingsArn='string',
portalArn='string'
)
string
[REQUIRED]
The ARN of the browser settings.
string
[REQUIRED]
The ARN of the web portal.
dict
Response Syntax
{
'browserSettingsArn': 'string',
'portalArn': 'string'
}
Response Structure
(dict) --
browserSettingsArn (string) --
The ARN of the browser settings.
portalArn (string) --
The ARN of the web portal.
Adds or overwrites one or more tags for the specified resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
clientToken='string',
resourceArn='string',
tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
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.
This field is autopopulated if not provided.
string
[REQUIRED]
The ARN of the resource.
list
[REQUIRED]
The tags of the resource.
(dict) --
The tag.
Key (string) -- [REQUIRED]
The key of the tag.
Value (string) -- [REQUIRED]
The value of the tag
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves a list of user settings.
See also: AWS API Documentation
Request Syntax
client.list_user_settings(
maxResults=123,
nextToken='string'
)
integer
The maximum number of results to be included in the next page.
string
The pagination token used to retrieve the next page of results for this operation.
dict
Response Syntax
{
'nextToken': 'string',
'userSettings': [
{
'copyAllowed': 'Disabled'|'Enabled',
'downloadAllowed': 'Disabled'|'Enabled',
'pasteAllowed': 'Disabled'|'Enabled',
'printAllowed': 'Disabled'|'Enabled',
'uploadAllowed': 'Disabled'|'Enabled',
'userSettingsArn': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The pagination token used to retrieve the next page of results for this operation.
userSettings (list) --
The user settings.
(dict) --
The summary of user settings.
copyAllowed (string) --
Specifies whether the user can copy text from the streaming session to the local device.
downloadAllowed (string) --
Specifies whether the user can download files from the streaming session to the local device.
pasteAllowed (string) --
Specifies whether the user can paste text from the local device to the streaming session.
printAllowed (string) --
Specifies whether the user can print to the local device.
uploadAllowed (string) --
Specifies whether the user can upload files from the local device to the streaming session.
userSettingsArn (string) --
The ARN of the user settings.
Associates a network settings resource with a web portal.
See also: AWS API Documentation
Request Syntax
client.associate_network_settings(
networkSettingsArn='string',
portalArn='string'
)
string
[REQUIRED]
The ARN of the network settings.
string
[REQUIRED]
The ARN of the web portal.
dict
Response Syntax
{
'networkSettingsArn': 'string',
'portalArn': 'string'
}
Response Structure
(dict) --
networkSettingsArn (string) --
The ARN of the network settings.
portalArn (string) --
The ARN of the web portal.
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.
See also: AWS API Documentation
Request Syntax
client.create_trust_store(
certificateList=[
b'bytes',
],
clientToken='string',
tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
list
[REQUIRED]
A list of CA certificates to be added to the trust store.
(bytes) --
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.
This field is autopopulated if not provided.
list
The tags to add to the trust store. A tag is a key-value pair.
(dict) --
The tag.
Key (string) -- [REQUIRED]
The key of the tag.
Value (string) -- [REQUIRED]
The value of the tag
dict
Response Syntax
{
'trustStoreArn': 'string'
}
Response Structure
(dict) --
trustStoreArn (string) --
The ARN of the trust store.
Associates a user settings resource with a web portal.
See also: AWS API Documentation
Request Syntax
client.associate_user_settings(
portalArn='string',
userSettingsArn='string'
)
string
[REQUIRED]
The ARN of the web portal.
string
[REQUIRED]
The ARN of the user settings.
dict
Response Syntax
{
'portalArn': 'string',
'userSettingsArn': 'string'
}
Response Structure
(dict) --
portalArn (string) --
The ARN of the web portal.
userSettingsArn (string) --
The ARN of the user settings.
Gets the network settings.
See also: AWS API Documentation
Request Syntax
client.get_network_settings(
networkSettingsArn='string'
)
string
[REQUIRED]
The ARN of the network settings.
dict
Response Syntax
{
'networkSettings': {
'associatedPortalArns': [
'string',
],
'networkSettingsArn': 'string',
'securityGroupIds': [
'string',
],
'subnetIds': [
'string',
],
'vpcId': 'string'
}
}
Response Structure
(dict) --
networkSettings (dict) --
The network settings.
associatedPortalArns (list) --
A list of web portal ARNs that this network settings is associated with.
(string) --
networkSettingsArn (string) --
The ARN of the network settings.
securityGroupIds (list) --
One or more security groups used to control access from streaming instances to your VPC.
(string) --
subnetIds (list) --
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.
(string) --
vpcId (string) --
The VPC that streaming instances will connect to.
Retrieves a list of browser settings.
See also: AWS API Documentation
Request Syntax
client.list_browser_settings(
maxResults=123,
nextToken='string'
)
integer
The maximum number of results to be included in the next page.
string
The pagination token used to retrieve the next page of results for this operation.
dict
Response Syntax
{
'browserSettings': [
{
'browserSettingsArn': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
browserSettings (list) --
The browser settings.
(dict) --
The summary for browser settings.
browserSettingsArn (string) --
The ARN of the browser settings.
nextToken (string) --
The pagination token used to retrieve the next page of results for this operation.
Updates browser settings.
See also: AWS API Documentation
Request Syntax
client.update_browser_settings(
browserPolicy='string',
browserSettingsArn='string',
clientToken='string'
)
string
A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.
string
[REQUIRED]
The ARN of the browser settings.
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.
This field is autopopulated if not provided.
dict
Response Syntax
{
'browserSettings': {
'associatedPortalArns': [
'string',
],
'browserPolicy': 'string',
'browserSettingsArn': 'string'
}
}
Response Structure
(dict) --
browserSettings (dict) --
The browser settings.
associatedPortalArns (list) --
A list of web portal ARNs that this browser settings is associated with.
(string) --
browserPolicy (string) --
A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.
browserSettingsArn (string) --
The ARN of the browser settings.
Disassociates a trust store from a web portal.
See also: AWS API Documentation
Request Syntax
client.disassociate_trust_store(
portalArn='string'
)
string
[REQUIRED]
The ARN of the web portal.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes network settings.
See also: AWS API Documentation
Request Syntax
client.delete_network_settings(
networkSettingsArn='string'
)
string
[REQUIRED]
The ARN of the network settings.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates an identity provider resource that is then associated with a web portal.
See also: AWS API Documentation
Request Syntax
client.create_identity_provider(
clientToken='string',
identityProviderDetails={
'string': 'string'
},
identityProviderName='string',
identityProviderType='SAML'|'Facebook'|'Google'|'LoginWithAmazon'|'SignInWithApple'|'OIDC',
portalArn='string'
)
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.
This field is autopopulated if not provided.
dict
[REQUIRED]
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 optional
(string) --
(string) --
string
[REQUIRED]
The identity provider name.
string
[REQUIRED]
The identity provider type.
string
[REQUIRED]
The ARN of the web portal.
dict
Response Syntax
{
'identityProviderArn': 'string'
}
Response Structure
(dict) --
identityProviderArn (string) --
The ARN of the identity provider.
Disassociates user settings from a web portal.
See also: AWS API Documentation
Request Syntax
client.disassociate_user_settings(
portalArn='string'
)
string
[REQUIRED]
The ARN of the web portal.
dict
Response Syntax
{}
Response Structure
(dict) --
Gets the trust store.
See also: AWS API Documentation
Request Syntax
client.get_trust_store(
trustStoreArn='string'
)
string
[REQUIRED]
The ARN of the trust store.
dict
Response Syntax
{
'trustStore': {
'associatedPortalArns': [
'string',
],
'trustStoreArn': 'string'
}
}
Response Structure
(dict) --
trustStore (dict) --
The trust store.
associatedPortalArns (list) --
A list of web portal ARNs that this trust store is associated with.
(string) --
trustStoreArn (string) --
The ARN of the trust store.
Associates a trust store with a web portal.
See also: AWS API Documentation
Request Syntax
client.associate_trust_store(
portalArn='string',
trustStoreArn='string'
)
string
[REQUIRED]
The ARN of the web portal.
string
[REQUIRED]
The ARN of the trust store.
dict
Response Syntax
{
'portalArn': 'string',
'trustStoreArn': 'string'
}
Response Structure
(dict) --
portalArn (string) --
The ARN of the web portal.
trustStoreArn (string) --
The ARN of the trust store.
Deletes user settings.
See also: AWS API Documentation
Request Syntax
client.delete_user_settings(
userSettingsArn='string'
)
string
[REQUIRED]
The ARN of the user settings.
dict
Response Syntax
{}
Response Structure
(dict) --
Gets browser settings.
See also: AWS API Documentation
Request Syntax
client.get_browser_settings(
browserSettingsArn='string'
)
string
[REQUIRED]
The ARN of the browser settings.
dict
Response Syntax
{
'browserSettings': {
'associatedPortalArns': [
'string',
],
'browserPolicy': 'string',
'browserSettingsArn': 'string'
}
}
Response Structure
(dict) --
browserSettings (dict) --
The browser settings.
associatedPortalArns (list) --
A list of web portal ARNs that this browser settings is associated with.
(string) --
browserPolicy (string) --
A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.
browserSettingsArn (string) --
The ARN of the browser settings.
Deletes a web portal.
See also: AWS API Documentation
Request Syntax
client.delete_portal(
portalArn='string'
)
string
[REQUIRED]
The ARN of the web portal.
dict
Response Syntax
{}
Response Structure
(dict) --
Gets the identity provider.
See also: AWS API Documentation
Request Syntax
client.get_identity_provider(
identityProviderArn='string'
)
string
[REQUIRED]
The ARN of the identity provider.
dict
Response Syntax
{
'identityProvider': {
'identityProviderArn': 'string',
'identityProviderDetails': {
'string': 'string'
},
'identityProviderName': 'string',
'identityProviderType': 'SAML'|'Facebook'|'Google'|'LoginWithAmazon'|'SignInWithApple'|'OIDC'
}
}
Response Structure
(dict) --
identityProvider (dict) --
The identity provider.
identityProviderArn (string) --
The ARN of the identity provider.
identityProviderDetails (dict) --
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 optional
(string) --
(string) --
identityProviderName (string) --
The identity provider name.
identityProviderType (string) --
The identity provider type.
Retrieves a list of network settings.
See also: AWS API Documentation
Request Syntax
client.list_network_settings(
maxResults=123,
nextToken='string'
)
integer
The maximum number of results to be included in the next page.
string
The pagination token used to retrieve the next page of results for this operation.
dict
Response Syntax
{
'networkSettings': [
{
'networkSettingsArn': 'string',
'vpcId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
networkSettings (list) --
The network settings.
(dict) --
The summary of network settings.
networkSettingsArn (string) --
The ARN of the network settings.
vpcId (string) --
The VPC ID of the network settings.
nextToken (string) --
The pagination token used to retrieve the next page of results for this operation.
Gets the trust store certificate.
See also: AWS API Documentation
Request Syntax
client.get_trust_store_certificate(
thumbprint='string',
trustStoreArn='string'
)
string
[REQUIRED]
The thumbprint of the trust store certificate.
string
[REQUIRED]
The ARN of the trust store certificate.
dict
Response Syntax
{
'certificate': {
'body': b'bytes',
'issuer': 'string',
'notValidAfter': datetime(2015, 1, 1),
'notValidBefore': datetime(2015, 1, 1),
'subject': 'string',
'thumbprint': 'string'
},
'trustStoreArn': 'string'
}
Response Structure
(dict) --
certificate (dict) --
The certificate of the trust store certificate.
body (bytes) --
The body of the certificate.
issuer (string) --
The entity that issued the certificate.
notValidAfter (datetime) --
The certificate is not valid after this date.
notValidBefore (datetime) --
The certificate is not valid before this date.
subject (string) --
The entity the certificate belongs to.
thumbprint (string) --
A hexadecimal identifier for the certificate.
trustStoreArn (string) --
The ARN of the trust store certificate.
Retrieves a list or web portals.
See also: AWS API Documentation
Request Syntax
client.list_portals(
maxResults=123,
nextToken='string'
)
integer
The maximum number of results to be included in the next page.
string
The pagination token used to retrieve the next page of results for this operation.
dict
Response Syntax
{
'nextToken': 'string',
'portals': [
{
'browserSettingsArn': 'string',
'browserType': 'Chrome',
'creationDate': datetime(2015, 1, 1),
'displayName': 'string',
'networkSettingsArn': 'string',
'portalArn': 'string',
'portalEndpoint': 'string',
'portalStatus': 'Incomplete'|'Pending'|'Active',
'rendererType': 'AppStream',
'trustStoreArn': 'string',
'userSettingsArn': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The pagination token used to retrieve the next page of results for this operation.
portals (list) --
The portals in the list.
(dict) --
The summary of the portal.
browserSettingsArn (string) --
The ARN of the browser settings that is associated with the web portal.
browserType (string) --
The browser type of the web portal.
creationDate (datetime) --
The creation date of the web portal.
displayName (string) --
The name of the web portal.
networkSettingsArn (string) --
The ARN of the network settings that is associated with the web portal.
portalArn (string) --
The ARN of the web portal.
portalEndpoint (string) --
The endpoint URL of the web portal that users access in order to start streaming sessions.
portalStatus (string) --
The status of the web portal.
rendererType (string) --
The renderer that is used in streaming sessions.
trustStoreArn (string) --
The ARN of the trust that is associated with this web portal.
userSettingsArn (string) --
The ARN of the user settings that is associated with the web portal.
Retrieves a list of tags for a resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
resourceArn='string'
)
string
[REQUIRED]
The ARN of the resource.
dict
Response Syntax
{
'tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
tags (list) --
The tags of the resource.
(dict) --
The tag.
Key (string) --
The key of the tag.
Value (string) --
The value of the tag
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.
See also: AWS API Documentation
Request Syntax
client.create_network_settings(
clientToken='string',
securityGroupIds=[
'string',
],
subnetIds=[
'string',
],
tags=[
{
'Key': 'string',
'Value': 'string'
},
],
vpcId='string'
)
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.
This field is autopopulated if not provided.
list
[REQUIRED]
One or more security groups used to control access from streaming instances to your VPC.
(string) --
list
[REQUIRED]
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.
(string) --
list
The tags to add to the network settings resource. A tag is a key-value pair.
(dict) --
The tag.
Key (string) -- [REQUIRED]
The key of the tag.
Value (string) -- [REQUIRED]
The value of the tag
string
[REQUIRED]
The VPC that streaming instances will connect to.
dict
Response Syntax
{
'networkSettingsArn': 'string'
}
Response Structure
(dict) --
networkSettingsArn (string) --
The ARN of the network settings.