WorkSpacesWeb / Client / create_browser_settings

create_browser_settings#

WorkSpacesWeb.Client.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

  • WorkSpacesWeb.Client.exceptions.InternalServerException

  • WorkSpacesWeb.Client.exceptions.ResourceNotFoundException

  • WorkSpacesWeb.Client.exceptions.AccessDeniedException

  • WorkSpacesWeb.Client.exceptions.ThrottlingException

  • WorkSpacesWeb.Client.exceptions.ServiceQuotaExceededException

  • WorkSpacesWeb.Client.exceptions.ValidationException

  • WorkSpacesWeb.Client.exceptions.ConflictException