Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetUserSettings

Gets user settings.

Request Syntax


GET /userSettings/userSettingsArn+ HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

userSettingsArn

The ARN of the user settings.

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "userSettings": { 
      "additionalEncryptionContext": { 
         "string" : "string" 
      },
      "associatedPortalArns": [ "string" ],
      "cookieSynchronizationConfiguration": { 
         "allowlist": [ 
            { 
               "domain": "string",
               "name": "string",
               "path": "string"
            }
         ],
         "blocklist": [ 
            { 
               "domain": "string",
               "name": "string",
               "path": "string"
            }
         ]
      },
      "copyAllowed": "string",
      "customerManagedKey": "string",
      "deepLinkAllowed": "string",
      "disconnectTimeoutInMinutes": number,
      "downloadAllowed": "string",
      "idleDisconnectTimeoutInMinutes": number,
      "pasteAllowed": "string",
      "printAllowed": "string",
      "toolbarConfiguration": { 
         "hiddenToolbarItems": [ "string" ],
         "maxDisplayResolution": "string",
         "toolbarType": "string",
         "visualMode": "string"
      },
      "uploadAllowed": "string",
      "userSettingsArn": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

userSettings

The user settings.

Type: UserSettings object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access is denied.

HTTP Status Code: 403

InternalServerException

There is an internal server error.

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

HTTP Status Code: 500

ResourceNotFoundException

The resource cannot be found.

resourceId: Hypothetical identifier of the resource affected.
resourceType: Hypothetical type of the resource affected.

HTTP Status Code: 404

ThrottlingException

There is a throttling error.

quotaCode: The originating quota.
retryAfterSeconds: Advice to clients on when the call can be safely retried.
serviceCode: The originating service.

HTTP Status Code: 429

ValidationException

There is a validation error.

fieldList: The field that caused the error.
reason: Reason the request failed validation

HTTP Status Code: 400