WorkSpacesWeb

Client

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

client = session.create_client('workspaces-web')

These are the available methods:

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'
)
Parameters
  • browserSettingsArn (string) --

    [REQUIRED]

    The ARN of the browser settings.

  • portalArn (string) --

    [REQUIRED]

    The ARN of the web portal.

Return type

dict

Returns

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

associate_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'
)
Parameters
  • networkSettingsArn (string) --

    [REQUIRED]

    The ARN of the network settings.

  • portalArn (string) --

    [REQUIRED]

    The ARN of the web portal.

Return type

dict

Returns

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

associate_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'
)
Parameters
  • portalArn (string) --

    [REQUIRED]

    The ARN of the web portal.

  • trustStoreArn (string) --

    [REQUIRED]

    The ARN of the trust store.

Return type

dict

Returns

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

associate_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'
)
Parameters
  • portalArn (string) --

    [REQUIRED]

    The ARN of the web portal.

  • userSettingsArn (string) --

    [REQUIRED]

    The ARN of the user settings.

Return type

dict

Returns

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

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is 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").
Returns
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'
        },
    ]
)
Parameters
  • additionalEncryptionContext (dict) --

    Additional encryption context of the browser settings.

    • (string) --
      • (string) --
  • browserPolicy (string) --

    [REQUIRED]

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

  • clientToken (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.

  • customerManagedKey (string) -- The custom managed key of the browser settings.
  • tags (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

Return type

dict

Returns

Response Syntax

{
    'browserSettingsArn': 'string'
}

Response Structure

  • (dict) --

    • browserSettingsArn (string) --

      The ARN of the browser settings.

Exceptions

create_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'
)
Parameters
  • clientToken (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.

  • identityProviderDetails (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 (boolean) optional
    • (string) --
      • (string) --
  • identityProviderName (string) --

    [REQUIRED]

    The identity provider name.

  • identityProviderType (string) --

    [REQUIRED]

    The identity provider type.

  • portalArn (string) --

    [REQUIRED]

    The ARN of the web portal.

Return type

dict

Returns

Response Syntax

{
    'identityProviderArn': 'string'
}

Response Structure

  • (dict) --

    • identityProviderArn (string) --

      The ARN of the identity provider.

Exceptions

create_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'
)
Parameters
  • clientToken (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.

  • securityGroupIds (list) --

    [REQUIRED]

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

    • (string) --
  • subnetIds (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) --
  • tags (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

  • vpcId (string) --

    [REQUIRED]

    The VPC that streaming instances will connect to.

Return type

dict

Returns

Response Syntax

{
    'networkSettingsArn': 'string'
}

Response Structure

  • (dict) --

    • networkSettingsArn (string) --

      The ARN of the network settings.

Exceptions

create_portal(**kwargs)

Creates a web portal.

See also: AWS API Documentation

Request Syntax

response = client.create_portal(
    additionalEncryptionContext={
        'string': 'string'
    },
    clientToken='string',
    customerManagedKey='string',
    displayName='string',
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • additionalEncryptionContext (dict) --

    The additional encryption context of the portal.

    • (string) --
      • (string) --
  • clientToken (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.

  • customerManagedKey (string) -- The customer managed key of the web portal.
  • displayName (string) -- The name of the web portal. This is not visible to users who log into the web portal.
  • tags (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

Return type

dict

Returns

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

create_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'
        },
    ]
)
Parameters
  • certificateList (list) --

    [REQUIRED]

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

    • (bytes) --
  • clientToken (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.

  • tags (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

Return type

dict

Returns

Response Syntax

{
    'trustStoreArn': 'string'
}

Response Structure

  • (dict) --

    • trustStoreArn (string) --

      The ARN of the trust store.

Exceptions

create_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'
)
Parameters
  • clientToken (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.

  • copyAllowed (string) --

    [REQUIRED]

    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) --

    [REQUIRED]

    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) --

    [REQUIRED]

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

  • printAllowed (string) --

    [REQUIRED]

    Specifies whether the user can print to the local device.

  • tags (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

  • uploadAllowed (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'userSettingsArn': 'string'
}

Response Structure

  • (dict) --

    • userSettingsArn (string) --

      The ARN of the user settings.

Exceptions

delete_browser_settings(**kwargs)

Deletes browser settings.

See also: AWS API Documentation

Request Syntax

response = client.delete_browser_settings(
    browserSettingsArn='string'
)
Parameters
browserSettingsArn (string) --

[REQUIRED]

The ARN of the browser settings.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_identity_provider(**kwargs)

Deletes the identity provider.

See also: AWS API Documentation

Request Syntax

response = client.delete_identity_provider(
    identityProviderArn='string'
)
Parameters
identityProviderArn (string) --

[REQUIRED]

The ARN of the identity provider.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_network_settings(**kwargs)

Deletes network settings.

See also: AWS API Documentation

Request Syntax

response = client.delete_network_settings(
    networkSettingsArn='string'
)
Parameters
networkSettingsArn (string) --

[REQUIRED]

The ARN of the network settings.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_portal(**kwargs)

Deletes a web portal.

See also: AWS API Documentation

Request Syntax

response = client.delete_portal(
    portalArn='string'
)
Parameters
portalArn (string) --

[REQUIRED]

The ARN of the web portal.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_trust_store(**kwargs)

Deletes the trust store.

See also: AWS API Documentation

Request Syntax

response = client.delete_trust_store(
    trustStoreArn='string'
)
Parameters
trustStoreArn (string) --

[REQUIRED]

The ARN of the trust store.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_user_settings(**kwargs)

Deletes user settings.

See also: AWS API Documentation

Request Syntax

response = client.delete_user_settings(
    userSettingsArn='string'
)
Parameters
userSettingsArn (string) --

[REQUIRED]

The ARN of the user settings.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

disassociate_browser_settings(**kwargs)

Disassociates browser settings from a web portal.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_browser_settings(
    portalArn='string'
)
Parameters
portalArn (string) --

[REQUIRED]

The ARN of the web portal.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

disassociate_network_settings(**kwargs)

Disassociates network settings from a web portal.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_network_settings(
    portalArn='string'
)
Parameters
portalArn (string) --

[REQUIRED]

The ARN of the web portal.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

disassociate_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'
)
Parameters
portalArn (string) --

[REQUIRED]

The ARN of the web portal.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

disassociate_user_settings(**kwargs)

Disassociates user settings from a web portal.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_user_settings(
    portalArn='string'
)
Parameters
portalArn (string) --

[REQUIRED]

The ARN of the web portal.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

get_browser_settings(**kwargs)

Gets browser settings.

See also: AWS API Documentation

Request Syntax

response = client.get_browser_settings(
    browserSettingsArn='string'
)
Parameters
browserSettingsArn (string) --

[REQUIRED]

The ARN of the browser settings.

Return type
dict
Returns
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.

Exceptions

get_identity_provider(**kwargs)

Gets the identity provider.

See also: AWS API Documentation

Request Syntax

response = client.get_identity_provider(
    identityProviderArn='string'
)
Parameters
identityProviderArn (string) --

[REQUIRED]

The ARN of the identity provider.

Return type
dict
Returns
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.

Exceptions

get_network_settings(**kwargs)

Gets the network settings.

See also: AWS API Documentation

Request Syntax

response = client.get_network_settings(
    networkSettingsArn='string'
)
Parameters
networkSettingsArn (string) --

[REQUIRED]

The ARN of the network settings.

Return type
dict
Returns
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.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is 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").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_portal(**kwargs)

Gets the web portal.

See also: AWS API Documentation

Request Syntax

response = client.get_portal(
    portalArn='string'
)
Parameters
portalArn (string) --

[REQUIRED]

The ARN of the web portal.

Return type
dict
Returns
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.

Exceptions

get_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'
)
Parameters
portalArn (string) --

[REQUIRED]

The ARN of the web portal.

Return type
dict
Returns
Response Syntax
{
    'portalArn': 'string',
    'serviceProviderSamlMetadata': 'string'
}

Response Structure

  • (dict) --
    • portalArn (string) --

      The ARN of the web portal.

    • serviceProviderSamlMetadata (string) --

      The service provider SAML metadata.

Exceptions

get_trust_store(**kwargs)

Gets the trust store.

See also: AWS API Documentation

Request Syntax

response = client.get_trust_store(
    trustStoreArn='string'
)
Parameters
trustStoreArn (string) --

[REQUIRED]

The ARN of the trust store.

Return type
dict
Returns
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.

Exceptions

get_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'
)
Parameters
  • thumbprint (string) --

    [REQUIRED]

    The thumbprint of the trust store certificate.

  • trustStoreArn (string) --

    [REQUIRED]

    The ARN of the trust store certificate.

Return type

dict

Returns

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

get_user_settings(**kwargs)

Gets user settings.

See also: AWS API Documentation

Request Syntax

response = client.get_user_settings(
    userSettingsArn='string'
)
Parameters
userSettingsArn (string) --

[REQUIRED]

The ARN of the user settings.

Return type
dict
Returns
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.

        • (string) --
      • 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

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
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'
)
Parameters
  • maxResults (integer) -- The maximum number of results to be included in the next page.
  • nextToken (string) -- The pagination token used to retrieve the next page of results for this operation.
Return type

dict

Returns

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

list_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'
)
Parameters
  • maxResults (integer) -- The maximum number of results to be included in the next page.
  • nextToken (string) -- The pagination token used to retrieve the next page of results for this operation.
  • portalArn (string) --

    [REQUIRED]

    The ARN of the web portal.

Return type

dict

Returns

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

list_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'
)
Parameters
  • maxResults (integer) -- The maximum number of results to be included in the next page.
  • nextToken (string) -- The pagination token used to retrieve the next page of results for this operation.
Return type

dict

Returns

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

list_portals(**kwargs)

Retrieves a list or web portals.

See also: AWS API Documentation

Request Syntax

response = client.list_portals(
    maxResults=123,
    nextToken='string'
)
Parameters
  • maxResults (integer) -- The maximum number of results to be included in the next page.
  • nextToken (string) -- The pagination token used to retrieve the next page of results for this operation.
Return type

dict

Returns

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.

Exceptions

list_tags_for_resource(**kwargs)

Retrieves a list of tags for a resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    resourceArn='string'
)
Parameters
resourceArn (string) --

[REQUIRED]

The ARN of the resource.

Return type
dict
Returns
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

Exceptions

list_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'
)
Parameters
  • maxResults (integer) -- The maximum number of results to be included in the next page.
  • nextToken (string) -- The pagination token used to retrieve the next page of results for this operation.
  • trustStoreArn (string) --

    [REQUIRED]

    The ARN of the trust store

Return type

dict

Returns

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

list_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'
)
Parameters
  • maxResults (integer) -- The maximum number of results to be included in the next page.
  • nextToken (string) -- The pagination token used to retrieve the next page of results for this operation.
Return type

dict

Returns

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

list_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'
)
Parameters
  • maxResults (integer) -- The maximum number of results to be included in the next page.
  • nextToken (string) -- The pagination token used to retrieve the next page of results for this operation.
Return type

dict

Returns

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

tag_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'
        },
    ]
)
Parameters
  • clientToken (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.

  • resourceArn (string) --

    [REQUIRED]

    The ARN of the resource.

  • tags (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

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_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',
    ]
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The ARN of the resource.

  • tagKeys (list) --

    [REQUIRED]

    The list of tag keys to remove from the resource.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_browser_settings(**kwargs)

Updates browser settings.

See also: AWS API Documentation

Request Syntax

response = client.update_browser_settings(
    browserPolicy='string',
    browserSettingsArn='string',
    clientToken='string'
)
Parameters
  • browserPolicy (string) -- A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.
  • browserSettingsArn (string) --

    [REQUIRED]

    The ARN of the browser settings.

  • clientToken (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.

Return type

dict

Returns

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.

Exceptions

update_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'
)
Parameters
  • clientToken (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.

  • identityProviderArn (string) --

    [REQUIRED]

    The ARN of the identity provider.

  • identityProviderDetails (dict) --

    The details of the identity provider. The following list describes the provider detail keys for each identity provider type.

    • For Google and Login with Amazon:
      • client_id
      • client_secret
      • authorize_scopes
    • For Facebook:
      • client_id
      • client_secret
      • authorize_scopes
      • api_version
    • For Sign in with Apple:
      • client_id
      • team_id
      • key_id
      • private_key
      • authorize_scopes
    • For OIDC providers:
      • client_id
      • client_secret
      • attributes_request_method
      • oidc_issuer
      • authorize_scopes
      • authorize_url if not available from discovery URL specified by ``oidc_issuer`` key
      • token_url if not available from discovery URL specified by ``oidc_issuer`` key
      • attributes_url if not available from discovery URL specified by ``oidc_issuer`` key
      • jwks_uri if not available from discovery URL specified by ``oidc_issuer`` key
    • For SAML providers:
      • MetadataFile OR MetadataURL
      • IDPSignout (boolean) optional
    • (string) --
      • (string) --
  • identityProviderName (string) -- The name of the identity provider.
  • identityProviderType (string) -- The type of the identity provider.
Return type

dict

Returns

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.

Exceptions

update_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'
)
Parameters
  • clientToken (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.

  • networkSettingsArn (string) --

    [REQUIRED]

    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.
Return type

dict

Returns

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.

Exceptions

update_portal(**kwargs)

Updates a web portal.

See also: AWS API Documentation

Request Syntax

response = client.update_portal(
    displayName='string',
    portalArn='string'
)
Parameters
  • displayName (string) -- The name of the web portal. This is not visible to users who log into the web portal.
  • portalArn (string) --

    [REQUIRED]

    The ARN of the web portal.

Return type

dict

Returns

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.

Exceptions

update_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'
)
Parameters
  • certificatesToAdd (list) --

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

    • (bytes) --
  • certificatesToDelete (list) --

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

    • (string) --
  • clientToken (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.

  • trustStoreArn (string) --

    [REQUIRED]

    The ARN of the trust store.

Return type

dict

Returns

Response Syntax

{
    'trustStoreArn': 'string'
}

Response Structure

  • (dict) --

    • trustStoreArn (string) --

      The ARN of the trust store.

Exceptions

update_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'
)
Parameters
  • clientToken (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.

  • 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) --

    [REQUIRED]

    The ARN of the user settings.

Return type

dict

Returns

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.

        • (string) --
      • 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

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class WorkSpacesWeb.Client.exceptions.AccessDeniedException

Access is denied.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Access is denied.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class WorkSpacesWeb.Client.exceptions.ConflictException

There is a conflict.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'resourceId': 'string',
    'resourceType': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    There is a conflict.

    • message (string) --

    • resourceId (string) --

      Identifier of the resource affected.

    • resourceType (string) --

      Type of the resource affected.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class WorkSpacesWeb.Client.exceptions.InternalServerException

There is an internal server error.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'retryAfterSeconds': 123,
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    There is an internal server error.

    • message (string) --

    • retryAfterSeconds (integer) --

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

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class WorkSpacesWeb.Client.exceptions.ResourceNotFoundException

The resource cannot be found.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'resourceId': 'string',
    'resourceType': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The resource cannot be found.

    • message (string) --

    • resourceId (string) --

      Hypothetical identifier of the resource affected.

    • resourceType (string) --

      Hypothetical type of the resource affected.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class WorkSpacesWeb.Client.exceptions.ServiceQuotaExceededException

The service quota has been exceeded.

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'quotaCode': 'string',
    'resourceId': 'string',
    'resourceType': 'string',
    'serviceCode': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The service quota has been exceeded.

    • message (string) --

    • quotaCode (string) --

      The originating quota.

    • resourceId (string) --

      Identifier of the resource affected.

    • resourceType (string) --

      Type of the resource affected.

    • serviceCode (string) --

      The originating service.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class WorkSpacesWeb.Client.exceptions.ThrottlingException

There is a throttling error.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'quotaCode': 'string',
    'retryAfterSeconds': 123,
    'serviceCode': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    There is a throttling error.

    • message (string) --

    • quotaCode (string) --

      The originating quota.

    • retryAfterSeconds (integer) --

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

    • serviceCode (string) --

      The originating service.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class WorkSpacesWeb.Client.exceptions.TooManyTagsException

There are too many tags.

Example

try:
  ...
except client.exceptions.TooManyTagsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'resourceName': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    There are too many tags.

    • message (string) --

    • resourceName (string) --

      Name of the resource affected.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class WorkSpacesWeb.Client.exceptions.ValidationException

There is a validation error.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'fieldList': [
        {
            'message': 'string',
            'name': 'string'
        },
    ],
    'message': 'string',
    'reason': 'unknownOperation'|'cannotParse'|'fieldValidationFailed'|'other',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    There is a validation error.

    • fieldList (list) --

      The field that caused the error.

      • (dict) --

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

        • message (string) --

          The message describing why the field failed validation.

        • name (string) --

          The name of the field that failed validation.

    • message (string) --

    • reason (string) --

      Reason the request failed validation

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are: