Amazon WorkSpaces Web · JSON Structure

Workspaces Web Create Browser Settings Request Structure

CreateBrowserSettingsRequest schema from Amazon WorkSpaces Web API

Type: object Properties: 5 Required: 1
End User ComputingSecure BrowserVirtual DesktopZero Trust

CreateBrowserSettingsRequest is a JSON Structure definition published by Amazon WorkSpaces Web, describing 5 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

additionalEncryptionContext browserPolicy clientToken customerManagedKey tags

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "type": "object",
  "required": [
    "browserPolicy"
  ],
  "name": "CreateBrowserSettingsRequest",
  "properties": {
    "additionalEncryptionContext": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EncryptionContextMap"
        },
        {
          "description": "Additional encryption context of the browser settings."
        }
      ]
    },
    "browserPolicy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BrowserPolicy"
        },
        {
          "description": "A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions."
        }
      ]
    },
    "clientToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientToken"
        },
        {
          "description": "<p>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.</p> <p>If you do not specify a client token, one is automatically generated by the AWS SDK. </p>"
        }
      ]
    },
    "customerManagedKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/keyArn"
        },
        {
          "description": "The custom managed key of the browser settings."
        }
      ]
    },
    "tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagList"
        },
        {
          "description": "The tags to add to the browser settings resource. A tag is a key-value pair."
        }
      ]
    }
  },
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces-web/refs/heads/main/json-structure/workspaces-web-create-browser-settings-request-structure.json",
  "description": "CreateBrowserSettingsRequest schema from Amazon WorkSpaces Web API"
}