Table of Contents
WorkSpacesWeb.Client¶A low-level client representing Amazon WorkSpaces Web
WorkSpaces Web is a low cost, fully managed WorkSpace built specifically to facilitate secure, web-based workloads. WorkSpaces Web makes it easy for customers to safely provide their employees with access to internal websites and SaaS web applications without the administrative burden of appliances or specialized client software. WorkSpaces Web provides simple policy tools tailored for user interactions, while offloading common tasks like capacity management, scaling, and maintaining browser images.
import boto3
client = boto3.client('workspaces-web')
These are the available methods:
associate_browser_settings()associate_network_settings()associate_trust_store()associate_user_access_logging_settings()associate_user_settings()can_paginate()close()create_browser_settings()create_identity_provider()create_network_settings()create_portal()create_trust_store()create_user_access_logging_settings()create_user_settings()delete_browser_settings()delete_identity_provider()delete_network_settings()delete_portal()delete_trust_store()delete_user_access_logging_settings()delete_user_settings()disassociate_browser_settings()disassociate_network_settings()disassociate_trust_store()disassociate_user_access_logging_settings()disassociate_user_settings()get_browser_settings()get_identity_provider()get_network_settings()get_paginator()get_portal()get_portal_service_provider_metadata()get_trust_store()get_trust_store_certificate()get_user_access_logging_settings()get_user_settings()get_waiter()list_browser_settings()list_identity_providers()list_network_settings()list_portals()list_tags_for_resource()list_trust_store_certificates()list_trust_stores()list_user_access_logging_settings()list_user_settings()tag_resource()untag_resource()update_browser_settings()update_identity_provider()update_network_settings()update_portal()update_trust_store()update_user_access_logging_settings()update_user_settings()associate_browser_settings(**kwargs)¶Associates a browser settings resource with a web portal.
See also: AWS API Documentation
Request Syntax
response = client.associate_browser_settings(
browserSettingsArn='string',
portalArn='string'
)
[REQUIRED]
The ARN of the browser settings.
[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.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionWorkSpacesWeb.Client.exceptions.ConflictExceptionassociate_network_settings(**kwargs)¶Associates a network settings resource with a web portal.
See also: AWS API Documentation
Request Syntax
response = client.associate_network_settings(
networkSettingsArn='string',
portalArn='string'
)
[REQUIRED]
The ARN of the network settings.
[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.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionWorkSpacesWeb.Client.exceptions.ConflictExceptionassociate_trust_store(**kwargs)¶Associates a trust store with a web portal.
See also: AWS API Documentation
Request Syntax
response = client.associate_trust_store(
portalArn='string',
trustStoreArn='string'
)
[REQUIRED]
The ARN of the web portal.
[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.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionassociate_user_access_logging_settings(**kwargs)¶Associates a user access logging settings resource with a web portal.
See also: AWS API Documentation
Request Syntax
response = client.associate_user_access_logging_settings(
portalArn='string',
userAccessLoggingSettingsArn='string'
)
[REQUIRED]
The ARN of the web portal.
[REQUIRED]
The ARN of the user access logging settings.
dict
Response Syntax
{
'portalArn': 'string',
'userAccessLoggingSettingsArn': 'string'
}
Response Structure
(dict) --
portalArn (string) --
The ARN of the web portal.
userAccessLoggingSettingsArn (string) --
The ARN of the user access logging settings.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionWorkSpacesWeb.Client.exceptions.ConflictExceptionassociate_user_settings(**kwargs)¶Associates a user settings resource with a web portal.
See also: AWS API Documentation
Request Syntax
response = client.associate_user_settings(
portalArn='string',
userSettingsArn='string'
)
[REQUIRED]
The ARN of the web portal.
[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.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionWorkSpacesWeb.Client.exceptions.ConflictExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_browser_settings(**kwargs)¶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
response = client.create_browser_settings(
additionalEncryptionContext={
'string': 'string'
},
browserPolicy='string',
clientToken='string',
customerManagedKey='string',
tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
Additional encryption context of the browser settings.
[REQUIRED]
A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.
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.
The tags to add to the browser settings resource. A tag is a key-value pair.
The tag.
The key of the tag.
The value of the tag
dict
Response Syntax
{
'browserSettingsArn': 'string'
}
Response Structure
(dict) --
browserSettingsArn (string) --
The ARN of the browser settings.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ServiceQuotaExceededExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionWorkSpacesWeb.Client.exceptions.ConflictExceptioncreate_identity_provider(**kwargs)¶Creates an identity provider resource that is then associated with a web portal.
See also: AWS API Documentation
Request Syntax
response = client.create_identity_provider(
clientToken='string',
identityProviderDetails={
'string': 'string'
},
identityProviderName='string',
identityProviderType='SAML'|'Facebook'|'Google'|'LoginWithAmazon'|'SignInWithApple'|'OIDC',
portalArn='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.
[REQUIRED]
The identity provider details. The following list describes the provider detail keys for each identity provider type.
client_idclient_secretauthorize_scopesclient_idclient_secretauthorize_scopesapi_versionclient_idteam_idkey_idprivate_keyauthorize_scopesclient_idclient_secretattributes_request_methodoidc_issuerauthorize_scopesauthorize_url if not available from discovery URL specified by oidc_issuer keytoken_url if not available from discovery URL specified by oidc_issuer keyattributes_url if not available from discovery URL specified by oidc_issuer keyjwks_uri if not available from discovery URL specified by oidc_issuer keyMetadataFile OR MetadataURLIDPSignout (boolean) optional[REQUIRED]
The identity provider name.
[REQUIRED]
The identity provider type.
[REQUIRED]
The ARN of the web portal.
dict
Response Syntax
{
'identityProviderArn': 'string'
}
Response Structure
(dict) --
identityProviderArn (string) --
The ARN of the identity provider.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ServiceQuotaExceededExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionWorkSpacesWeb.Client.exceptions.ConflictExceptioncreate_network_settings(**kwargs)¶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
response = client.create_network_settings(
clientToken='string',
securityGroupIds=[
'string',
],
subnetIds=[
'string',
],
tags=[
{
'Key': 'string',
'Value': 'string'
},
],
vpcId='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.
[REQUIRED]
One or more security groups used to control access from streaming instances to your VPC.
[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.
The tags to add to the network settings resource. A tag is a key-value pair.
The tag.
The key of the tag.
The value of the tag
[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.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ServiceQuotaExceededExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionWorkSpacesWeb.Client.exceptions.ConflictExceptioncreate_portal(**kwargs)¶Creates a web portal.
See also: AWS API Documentation
Request Syntax
response = client.create_portal(
additionalEncryptionContext={
'string': 'string'
},
authenticationType='Standard'|'IAM_Identity_Center',
clientToken='string',
customerManagedKey='string',
displayName='string',
tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
The additional encryption context of the portal.
The type of authentication integration points used when signing into the web portal. Defaults to Standard .
Standardweb portals are authenticated directly through your identity provider. You need to callCreateIdentityProviderto integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.
IAM_Identity_Centerweb portals are authenticated through AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.
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.
The tags to add to the web portal. A tag is a key-value pair.
The tag.
The key of the tag.
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.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ServiceQuotaExceededExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionWorkSpacesWeb.Client.exceptions.ConflictExceptioncreate_trust_store(**kwargs)¶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
response = client.create_trust_store(
certificateList=[
b'bytes',
],
clientToken='string',
tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
A list of CA certificates to be added to the trust store.
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.
The tags to add to the trust store. A tag is a key-value pair.
The tag.
The key of the tag.
The value of the tag
dict
Response Syntax
{
'trustStoreArn': 'string'
}
Response Structure
(dict) --
trustStoreArn (string) --
The ARN of the trust store.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ServiceQuotaExceededExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionWorkSpacesWeb.Client.exceptions.ConflictExceptioncreate_user_access_logging_settings(**kwargs)¶Creates a user access logging settings resource that can be associated with a web portal.
See also: AWS API Documentation
Request Syntax
response = client.create_user_access_logging_settings(
clientToken='string',
kinesisStreamArn='string',
tags=[
{
'Key': 'string',
'Value': '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.
[REQUIRED]
The ARN of the Kinesis stream.
The tags to add to the user settings resource. A tag is a key-value pair.
The tag.
The key of the tag.
The value of the tag
dict
Response Syntax
{
'userAccessLoggingSettingsArn': 'string'
}
Response Structure
(dict) --
userAccessLoggingSettingsArn (string) --
The ARN of the user access logging settings.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ServiceQuotaExceededExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionWorkSpacesWeb.Client.exceptions.ConflictExceptioncreate_user_settings(**kwargs)¶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
response = client.create_user_settings(
clientToken='string',
copyAllowed='Disabled'|'Enabled',
disconnectTimeoutInMinutes=123,
downloadAllowed='Disabled'|'Enabled',
idleDisconnectTimeoutInMinutes=123,
pasteAllowed='Disabled'|'Enabled',
printAllowed='Disabled'|'Enabled',
tags=[
{
'Key': 'string',
'Value': 'string'
},
],
uploadAllowed='Disabled'|'Enabled'
)
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.
[REQUIRED]
Specifies whether the user can copy text from the streaming session to the local device.
[REQUIRED]
Specifies whether the user can download files from the streaming session to the local device.
[REQUIRED]
Specifies whether the user can paste text from the local device to the streaming session.
[REQUIRED]
Specifies whether the user can print to the local device.
The tags to add to the user settings resource. A tag is a key-value pair.
The tag.
The key of the tag.
The value of the tag
[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.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ServiceQuotaExceededExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionWorkSpacesWeb.Client.exceptions.ConflictExceptiondelete_browser_settings(**kwargs)¶Deletes browser settings.
See also: AWS API Documentation
Request Syntax
response = client.delete_browser_settings(
browserSettingsArn='string'
)
[REQUIRED]
The ARN of the browser settings.
{}
Response Structure
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionWorkSpacesWeb.Client.exceptions.ConflictExceptiondelete_identity_provider(**kwargs)¶Deletes the identity provider.
See also: AWS API Documentation
Request Syntax
response = client.delete_identity_provider(
identityProviderArn='string'
)
[REQUIRED]
The ARN of the identity provider.
{}
Response Structure
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionWorkSpacesWeb.Client.exceptions.ConflictExceptiondelete_network_settings(**kwargs)¶Deletes network settings.
See also: AWS API Documentation
Request Syntax
response = client.delete_network_settings(
networkSettingsArn='string'
)
[REQUIRED]
The ARN of the network settings.
{}
Response Structure
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionWorkSpacesWeb.Client.exceptions.ConflictExceptiondelete_portal(**kwargs)¶Deletes a web portal.
See also: AWS API Documentation
Request Syntax
response = client.delete_portal(
portalArn='string'
)
[REQUIRED]
The ARN of the web portal.
{}
Response Structure
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionWorkSpacesWeb.Client.exceptions.ConflictExceptiondelete_trust_store(**kwargs)¶Deletes the trust store.
See also: AWS API Documentation
Request Syntax
response = client.delete_trust_store(
trustStoreArn='string'
)
[REQUIRED]
The ARN of the trust store.
{}
Response Structure
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionWorkSpacesWeb.Client.exceptions.ConflictExceptiondelete_user_access_logging_settings(**kwargs)¶Deletes user access logging settings.
See also: AWS API Documentation
Request Syntax
response = client.delete_user_access_logging_settings(
userAccessLoggingSettingsArn='string'
)
[REQUIRED]
The ARN of the user access logging settings.
{}
Response Structure
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionWorkSpacesWeb.Client.exceptions.ConflictExceptiondelete_user_settings(**kwargs)¶Deletes user settings.
See also: AWS API Documentation
Request Syntax
response = client.delete_user_settings(
userSettingsArn='string'
)
[REQUIRED]
The ARN of the user settings.
{}
Response Structure
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionWorkSpacesWeb.Client.exceptions.ConflictExceptiondisassociate_browser_settings(**kwargs)¶Disassociates browser settings from a web portal.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_browser_settings(
portalArn='string'
)
[REQUIRED]
The ARN of the web portal.
{}
Response Structure
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptiondisassociate_network_settings(**kwargs)¶Disassociates network settings from a web portal.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_network_settings(
portalArn='string'
)
[REQUIRED]
The ARN of the web portal.
{}
Response Structure
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptiondisassociate_trust_store(**kwargs)¶Disassociates a trust store from a web portal.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_trust_store(
portalArn='string'
)
[REQUIRED]
The ARN of the web portal.
{}
Response Structure
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptiondisassociate_user_access_logging_settings(**kwargs)¶Disassociates user access logging settings from a web portal.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_user_access_logging_settings(
portalArn='string'
)
[REQUIRED]
The ARN of the web portal.
{}
Response Structure
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptiondisassociate_user_settings(**kwargs)¶Disassociates user settings from a web portal.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_user_settings(
portalArn='string'
)
[REQUIRED]
The ARN of the web portal.
{}
Response Structure
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionget_browser_settings(**kwargs)¶Gets browser settings.
See also: AWS API Documentation
Request Syntax
response = client.get_browser_settings(
browserSettingsArn='string'
)
[REQUIRED]
The ARN of the browser settings.
{
'browserSettings': {
'associatedPortalArns': [
'string',
],
'browserPolicy': 'string',
'browserSettingsArn': 'string'
}
}
Response Structure
The browser settings.
A list of web portal ARNs that this browser settings is associated with.
A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.
The ARN of the browser settings.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionget_identity_provider(**kwargs)¶Gets the identity provider.
See also: AWS API Documentation
Request Syntax
response = client.get_identity_provider(
identityProviderArn='string'
)
[REQUIRED]
The ARN of the identity provider.
{
'identityProvider': {
'identityProviderArn': 'string',
'identityProviderDetails': {
'string': 'string'
},
'identityProviderName': 'string',
'identityProviderType': 'SAML'|'Facebook'|'Google'|'LoginWithAmazon'|'SignInWithApple'|'OIDC'
}
}
Response Structure
The identity provider.
The ARN of the identity provider.
The identity provider details. The following list describes the provider detail keys for each identity provider type.
client_idclient_secretauthorize_scopesclient_idclient_secretauthorize_scopesapi_versionclient_idteam_idkey_idprivate_keyauthorize_scopesclient_idclient_secretattributes_request_methodoidc_issuerauthorize_scopesauthorize_url if not available from discovery URL specified by oidc_issuer keytoken_url if not available from discovery URL specified by oidc_issuer keyattributes_url if not available from discovery URL specified by oidc_issuer keyjwks_uri if not available from discovery URL specified by oidc_issuer keyMetadataFile OR MetadataURLIDPSignout optionalThe identity provider name.
The identity provider type.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionget_network_settings(**kwargs)¶Gets the network settings.
See also: AWS API Documentation
Request Syntax
response = client.get_network_settings(
networkSettingsArn='string'
)
[REQUIRED]
The ARN of the network settings.
{
'networkSettings': {
'associatedPortalArns': [
'string',
],
'networkSettingsArn': 'string',
'securityGroupIds': [
'string',
],
'subnetIds': [
'string',
],
'vpcId': 'string'
}
}
Response Structure
The network settings.
A list of web portal ARNs that this network settings is associated with.
The ARN of the network settings.
One or more security groups used to control access from streaming instances to your VPC.
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.
The VPC that streaming instances will connect to.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_portal(**kwargs)¶Gets the web portal.
See also: AWS API Documentation
Request Syntax
response = client.get_portal(
portalArn='string'
)
[REQUIRED]
The ARN of the web portal.
{
'portal': {
'authenticationType': 'Standard'|'IAM_Identity_Center',
'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',
'userAccessLoggingSettingsArn': 'string',
'userSettingsArn': 'string'
}
}
Response Structure
The web portal.
The type of authentication integration points used when signing into the web portal. Defaults to Standard .
Standardweb portals are authenticated directly through your identity provider. You need to callCreateIdentityProviderto integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.
IAM_Identity_Centerweb portals are authenticated through AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.
The ARN of the browser settings that is associated with this web portal.
The browser that users see when using a streaming session.
The creation date of the web portal.
The name of the web portal.
The ARN of the network settings that is associated with the web portal.
The ARN of the web portal.
The endpoint URL of the web portal that users access in order to start streaming sessions.
The status of the web portal.
The renderer that is used in streaming sessions.
A message that explains why the web portal is in its current status.
The ARN of the trust store that is associated with the web portal.
The ARN of the user access logging settings that is associated with the web portal.
The ARN of the user settings that is associated with the web portal.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionget_portal_service_provider_metadata(**kwargs)¶Gets the service provider metadata.
See also: AWS API Documentation
Request Syntax
response = client.get_portal_service_provider_metadata(
portalArn='string'
)
[REQUIRED]
The ARN of the web portal.
{
'portalArn': 'string',
'serviceProviderSamlMetadata': 'string'
}
Response Structure
The ARN of the web portal.
The service provider SAML metadata.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionget_trust_store(**kwargs)¶Gets the trust store.
See also: AWS API Documentation
Request Syntax
response = client.get_trust_store(
trustStoreArn='string'
)
[REQUIRED]
The ARN of the trust store.
{
'trustStore': {
'associatedPortalArns': [
'string',
],
'trustStoreArn': 'string'
}
}
Response Structure
The trust store.
A list of web portal ARNs that this trust store is associated with.
The ARN of the trust store.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionget_trust_store_certificate(**kwargs)¶Gets the trust store certificate.
See also: AWS API Documentation
Request Syntax
response = client.get_trust_store_certificate(
thumbprint='string',
trustStoreArn='string'
)
[REQUIRED]
The thumbprint of the trust store certificate.
[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.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionget_user_access_logging_settings(**kwargs)¶Gets user access logging settings.
See also: AWS API Documentation
Request Syntax
response = client.get_user_access_logging_settings(
userAccessLoggingSettingsArn='string'
)
[REQUIRED]
The ARN of the user access logging settings.
{
'userAccessLoggingSettings': {
'associatedPortalArns': [
'string',
],
'kinesisStreamArn': 'string',
'userAccessLoggingSettingsArn': 'string'
}
}
Response Structure
The user access logging settings.
A list of web portal ARNs that this user access logging settings is associated with.
The ARN of the Kinesis stream.
The ARN of the user access logging settings.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionget_user_settings(**kwargs)¶Gets user settings.
See also: AWS API Documentation
Request Syntax
response = client.get_user_settings(
userSettingsArn='string'
)
[REQUIRED]
The ARN of the user settings.
{
'userSettings': {
'associatedPortalArns': [
'string',
],
'copyAllowed': 'Disabled'|'Enabled',
'disconnectTimeoutInMinutes': 123,
'downloadAllowed': 'Disabled'|'Enabled',
'idleDisconnectTimeoutInMinutes': 123,
'pasteAllowed': 'Disabled'|'Enabled',
'printAllowed': 'Disabled'|'Enabled',
'uploadAllowed': 'Disabled'|'Enabled',
'userSettingsArn': 'string'
}
}
Response Structure
The user settings.
A list of web portal ARNs that this user settings is associated with.
Specifies whether the user can copy text from the streaming session to the local device.
The amount of time that a streaming session remains active after users disconnect.
Specifies whether the user can download files from the streaming session to the local device.
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
Specifies whether the user can paste text from the local device to the streaming session.
Specifies whether the user can print to the local device.
Specifies whether the user can upload files from the local device to the streaming session.
The ARN of the user settings.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_browser_settings(**kwargs)¶Retrieves a list of browser settings.
See also: AWS API Documentation
Request Syntax
response = client.list_browser_settings(
maxResults=123,
nextToken='string'
)
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.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionlist_identity_providers(**kwargs)¶Retrieves a list of identity providers for a specific web portal.
See also: AWS API Documentation
Request Syntax
response = client.list_identity_providers(
maxResults=123,
nextToken='string',
portalArn='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.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionlist_network_settings(**kwargs)¶Retrieves a list of network settings.
See also: AWS API Documentation
Request Syntax
response = client.list_network_settings(
maxResults=123,
nextToken='string'
)
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.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionlist_portals(**kwargs)¶Retrieves a list or web portals.
See also: AWS API Documentation
Request Syntax
response = client.list_portals(
maxResults=123,
nextToken='string'
)
dict
Response Syntax
{
'nextToken': 'string',
'portals': [
{
'authenticationType': 'Standard'|'IAM_Identity_Center',
'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',
'userAccessLoggingSettingsArn': '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.
authenticationType (string) --
The type of authentication integration points used when signing into the web portal. Defaults to Standard .
Standardweb portals are authenticated directly through your identity provider. You need to callCreateIdentityProviderto integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.
IAM_Identity_Centerweb portals are authenticated through AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.
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.
userAccessLoggingSettingsArn (string) --
The ARN of the user access logging settings that is associated with the web portal.
userSettingsArn (string) --
The ARN of the user settings that is associated with the web portal.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionRetrieves a list of tags for a resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The ARN of the resource.
{
'tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
The tags of the resource.
The tag.
The key of the tag.
The value of the tag
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionlist_trust_store_certificates(**kwargs)¶Retrieves a list of trust store certificates.
See also: AWS API Documentation
Request Syntax
response = client.list_trust_store_certificates(
maxResults=123,
nextToken='string',
trustStoreArn='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.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionlist_trust_stores(**kwargs)¶Retrieves a list of trust stores.
See also: AWS API Documentation
Request Syntax
response = client.list_trust_stores(
maxResults=123,
nextToken='string'
)
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.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionlist_user_access_logging_settings(**kwargs)¶Retrieves a list of user access logging settings.
See also: AWS API Documentation
Request Syntax
response = client.list_user_access_logging_settings(
maxResults=123,
nextToken='string'
)
dict
Response Syntax
{
'nextToken': 'string',
'userAccessLoggingSettings': [
{
'kinesisStreamArn': 'string',
'userAccessLoggingSettingsArn': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The pagination token used to retrieve the next page of results for this operation.
userAccessLoggingSettings (list) --
The user access logging settings.
(dict) --
The summary of user access logging settings.
kinesisStreamArn (string) --
The ARN of the Kinesis stream.
userAccessLoggingSettingsArn (string) --
The ARN of the user access logging settings.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionlist_user_settings(**kwargs)¶Retrieves a list of user settings.
See also: AWS API Documentation
Request Syntax
response = client.list_user_settings(
maxResults=123,
nextToken='string'
)
dict
Response Syntax
{
'nextToken': 'string',
'userSettings': [
{
'copyAllowed': 'Disabled'|'Enabled',
'disconnectTimeoutInMinutes': 123,
'downloadAllowed': 'Disabled'|'Enabled',
'idleDisconnectTimeoutInMinutes': 123,
'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.
disconnectTimeoutInMinutes (integer) --
The amount of time that a streaming session remains active after users disconnect.
downloadAllowed (string) --
Specifies whether the user can download files from the streaming session to the local device.
idleDisconnectTimeoutInMinutes (integer) --
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 (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.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptiontag_resource(**kwargs)¶Adds or overwrites one or more tags for the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
clientToken='string',
resourceArn='string',
tags=[
{
'Key': 'string',
'Value': '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.
[REQUIRED]
The ARN of the resource.
[REQUIRED]
The tags of the resource.
The tag.
The key of the tag.
The value of the tag
dict
Response Syntax
{}
Response Structure
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionWorkSpacesWeb.Client.exceptions.TooManyTagsExceptionuntag_resource(**kwargs)¶Removes one or more tags from the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The ARN of the resource.
[REQUIRED]
The list of tag keys to remove from the resource.
dict
Response Syntax
{}
Response Structure
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionupdate_browser_settings(**kwargs)¶Updates browser settings.
See also: AWS API Documentation
Request Syntax
response = client.update_browser_settings(
browserPolicy='string',
browserSettingsArn='string',
clientToken='string'
)
[REQUIRED]
The ARN of the browser settings.
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.
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.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionupdate_identity_provider(**kwargs)¶Updates the identity provider.
See also: AWS API Documentation
Request Syntax
response = client.update_identity_provider(
clientToken='string',
identityProviderArn='string',
identityProviderDetails={
'string': 'string'
},
identityProviderName='string',
identityProviderType='SAML'|'Facebook'|'Google'|'LoginWithAmazon'|'SignInWithApple'|'OIDC'
)
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.
[REQUIRED]
The ARN of the identity provider.
The details of the identity provider. The following list describes the provider detail keys for each identity provider type.
client_idclient_secretauthorize_scopesclient_idclient_secretauthorize_scopesapi_versionclient_idteam_idkey_idprivate_keyauthorize_scopesclient_idclient_secretattributes_request_methodoidc_issuerauthorize_scopesauthorize_url if not available from discovery URL specified by oidc_issuer keytoken_url if not available from discovery URL specified by oidc_issuer keyattributes_url if not available from discovery URL specified by oidc_issuer keyjwks_uri if not available from discovery URL specified by oidc_issuer keyMetadataFile OR MetadataURLIDPSignout (boolean) optionaldict
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.
client_idclient_secretauthorize_scopesclient_idclient_secretauthorize_scopesapi_versionclient_idteam_idkey_idprivate_keyauthorize_scopesclient_idclient_secretattributes_request_methodoidc_issuerauthorize_scopesauthorize_url if not available from discovery URL specified by oidc_issuer keytoken_url if not available from discovery URL specified by oidc_issuer keyattributes_url if not available from discovery URL specified by oidc_issuer keyjwks_uri if not available from discovery URL specified by oidc_issuer keyMetadataFile OR MetadataURLIDPSignout optionalidentityProviderName (string) --
The identity provider name.
identityProviderType (string) --
The identity provider type.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionupdate_network_settings(**kwargs)¶Updates network settings.
See also: AWS API Documentation
Request Syntax
response = client.update_network_settings(
clientToken='string',
networkSettingsArn='string',
securityGroupIds=[
'string',
],
subnetIds=[
'string',
],
vpcId='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.
[REQUIRED]
The ARN of the network settings.
One or more security groups used to control access from streaming instances to your VPC.
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.
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.
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.
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.
vpcId (string) --
The VPC that streaming instances will connect to.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionupdate_portal(**kwargs)¶Updates a web portal.
See also: AWS API Documentation
Request Syntax
response = client.update_portal(
authenticationType='Standard'|'IAM_Identity_Center',
displayName='string',
portalArn='string'
)
The type of authentication integration points used when signing into the web portal. Defaults to Standard .
Standardweb portals are authenticated directly through your identity provider. You need to callCreateIdentityProviderto integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.
IAM_Identity_Centerweb portals are authenticated through AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.
[REQUIRED]
The ARN of the web portal.
dict
Response Syntax
{
'portal': {
'authenticationType': 'Standard'|'IAM_Identity_Center',
'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',
'userAccessLoggingSettingsArn': 'string',
'userSettingsArn': 'string'
}
}
Response Structure
(dict) --
portal (dict) --
The web portal.
authenticationType (string) --
The type of authentication integration points used when signing into the web portal. Defaults to Standard .
Standardweb portals are authenticated directly through your identity provider. You need to callCreateIdentityProviderto integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.
IAM_Identity_Centerweb portals are authenticated through AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.
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.
userAccessLoggingSettingsArn (string) --
The ARN of the user access logging settings that is associated with the web portal.
userSettingsArn (string) --
The ARN of the user settings that is associated with the web portal.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionupdate_trust_store(**kwargs)¶Updates the trust store.
See also: AWS API Documentation
Request Syntax
response = client.update_trust_store(
certificatesToAdd=[
b'bytes',
],
certificatesToDelete=[
'string',
],
clientToken='string',
trustStoreArn='string'
)
A list of CA certificates to add to the trust store.
A list of CA certificates to delete from a trust store.
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.
[REQUIRED]
The ARN of the trust store.
dict
Response Syntax
{
'trustStoreArn': 'string'
}
Response Structure
(dict) --
trustStoreArn (string) --
The ARN of the trust store.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ServiceQuotaExceededExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionupdate_user_access_logging_settings(**kwargs)¶Updates the user access logging settings.
See also: AWS API Documentation
Request Syntax
response = client.update_user_access_logging_settings(
clientToken='string',
kinesisStreamArn='string',
userAccessLoggingSettingsArn='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.
[REQUIRED]
The ARN of the user access logging settings.
dict
Response Syntax
{
'userAccessLoggingSettings': {
'associatedPortalArns': [
'string',
],
'kinesisStreamArn': 'string',
'userAccessLoggingSettingsArn': 'string'
}
}
Response Structure
(dict) --
userAccessLoggingSettings (dict) --
The user access logging settings.
associatedPortalArns (list) --
A list of web portal ARNs that this user access logging settings is associated with.
kinesisStreamArn (string) --
The ARN of the Kinesis stream.
userAccessLoggingSettingsArn (string) --
The ARN of the user access logging settings.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionupdate_user_settings(**kwargs)¶Updates the user settings.
See also: AWS API Documentation
Request Syntax
response = client.update_user_settings(
clientToken='string',
copyAllowed='Disabled'|'Enabled',
disconnectTimeoutInMinutes=123,
downloadAllowed='Disabled'|'Enabled',
idleDisconnectTimeoutInMinutes=123,
pasteAllowed='Disabled'|'Enabled',
printAllowed='Disabled'|'Enabled',
uploadAllowed='Disabled'|'Enabled',
userSettingsArn='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.
[REQUIRED]
The ARN of the user settings.
dict
Response Syntax
{
'userSettings': {
'associatedPortalArns': [
'string',
],
'copyAllowed': 'Disabled'|'Enabled',
'disconnectTimeoutInMinutes': 123,
'downloadAllowed': 'Disabled'|'Enabled',
'idleDisconnectTimeoutInMinutes': 123,
'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.
copyAllowed (string) --
Specifies whether the user can copy text from the streaming session to the local device.
disconnectTimeoutInMinutes (integer) --
The amount of time that a streaming session remains active after users disconnect.
downloadAllowed (string) --
Specifies whether the user can download files from the streaming session to the local device.
idleDisconnectTimeoutInMinutes (integer) --
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 (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.
Exceptions
WorkSpacesWeb.Client.exceptions.InternalServerExceptionWorkSpacesWeb.Client.exceptions.ResourceNotFoundExceptionWorkSpacesWeb.Client.exceptions.AccessDeniedExceptionWorkSpacesWeb.Client.exceptions.ThrottlingExceptionWorkSpacesWeb.Client.exceptions.ValidationExceptionThe available paginators are: