ListTrustStoreCertiﬁcates

Retrieves a list of trust store certiﬁcates.

Request Syntax

GET /trustStores/trustStoreArn+/certificates?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults (p. 87)

The maximum number of results to be included in the next page.

Valid Range: Minimum value of 1.

nextToken (p. 87)

The pagination token used to retrieve the next page of results for this operation.

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

Pattern: ^\S+$

trustStoreArn (p. 87)

The ARN of the trust store

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

Response Elements

"nextToken": "string", "trustStoreArn": "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.

certiﬁcateList (p. 87) The certiﬁcate list.

Type: Array of CertiﬁcateSummary (p. 123) objects nextToken (p. 87)

The pagination token used to retrieve the next page of results for this operation.>

Type: String

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

Pattern: ^\S+$

trustStoreArn (p. 87)

The ARN of the trust store.

Type: String

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})+$

Errors

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

AccessDeniedException Access is denied.

HTTP Status Code: 403 InternalServerException

There is an internal server error.

HTTP Status Code: 500 ResourceNotFoundException

The resource cannot be found.

HTTP Status Code: 404 ThrottlingException

There is a throttling error.

See Also

HTTP Status Code: 429 ValidationException

There is a validation error.

HTTP Status Code: 400

Request Syntax

GET /trustStores?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults (p. 90)

The maximum number of results to be included in the next page.

Valid Range: Minimum value of 1.

nextToken (p. 90)

The pagination token used to retrieve the next page of results for this operation.

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

Pattern: ^\S+$

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

Content-type: application/json {

"nextToken": "string", "trustStores": [ {

"trustStoreArn": "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.

nextToken (p. 90)

The pagination token used to retrieve the next page of results for this operation.

Type: String

Errors

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

Pattern: ^\S+$

trustStores (p. 90) The trust stores.

Type: Array of TrustStoreSummary (p. 139) objects

Errors

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

AccessDeniedException Access is denied.

HTTP Status Code: 403 InternalServerException

There is an internal server error.

HTTP Status Code: 500 ThrottlingException

There is a throttling error.

HTTP Status Code: 429 ValidationException

There is a validation error.

HTTP Status Code: 400

Request Syntax

GET /userSettings?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults (p. 92)

The maximum number of results to be included in the next page.

Valid Range: Minimum value of 1.

nextToken (p. 92)

The pagination token used to retrieve the next page of results for this operation.

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

Pattern: ^\S+$

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

Content-type: application/json { "nextToken": "string", "userSettings": [

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

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

Errors

nextToken (p. 92)

The pagination token used to retrieve the next page of results for this operation.

Type: String

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

Pattern: ^\S+$

userSettings (p. 92) The user settings.

Type: Array of UserSettingsSummary (p. 142) objects

Errors

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

AccessDeniedException Access is denied.

HTTP Status Code: 403 InternalServerException

There is an internal server error.

HTTP Status Code: 500 ThrottlingException

There is a throttling error.

HTTP Status Code: 429 ValidationException

There is a validation error.

HTTP Status Code: 400

Request Syntax

POST /tags/resourceArn+ HTTP/1.1 Content-type: application/json { "clientToken": "string", "tags": [

URI Request Parameters

The request uses the following URI parameters.

resourceArn (p. 94)

The ARN of the resource.

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 accepts the following data in JSON format.

clientToken (p. 94)

A unique, case-sensitive identiﬁer 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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Required: No tags (p. 94)

The tags of the resource.

Response Syntax

Type: Array of Tag (p. 137) objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

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

Errors

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

AccessDeniedException Access is denied.

HTTP Status Code: 403 InternalServerException

There is an internal server error.

HTTP Status Code: 500 ResourceNotFoundException

The resource cannot be found.

HTTP Status Code: 404 ThrottlingException

There is a throttling error.

HTTP Status Code: 429 TooManyTagsException

There are too many tags.

HTTP Status Code: 400 ValidationException

There is a validation error.

HTTP Status Code: 400

Request Syntax

DELETE /tags/resourceArn+?tagKeys=tagKeys HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

resourceArn (p. 97)

The ARN of the resource.

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 tagKeys (p. 97)

The list of tag keys to remove from the resource.

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

Response Elements

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

Errors

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

AccessDeniedException Access is denied.

See Also

HTTP Status Code: 403 InternalServerException

There is an internal server error.

HTTP Status Code: 500 ResourceNotFoundException

The resource cannot be found.

HTTP Status Code: 404 ThrottlingException

There is a throttling error.

HTTP Status Code: 429 ValidationException

There is a validation error.

HTTP Status Code: 400

Request Syntax

PATCH /browserSettings/browserSettingsArn+ HTTP/1.1 Content-type: application/json

{ "browserPolicy": "string", "clientToken": "string"

}

URI Request Parameters

The request uses the following URI parameters.

browserSettingsArn (p. 99)

The ARN of the browser 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 accepts the following data in JSON format.

browserPolicy (p. 99)

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

Type: String

Length Constraints: Minimum length of 2. Maximum length of 131072.

Pattern: \{[\S\s]*\}\s*

Required: No clientToken (p. 99)

A unique, case-sensitive identiﬁer that you provide to ensure the idempotency of the request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Response Syntax

"browserSettings": {

"associatedPortalArns": [ "string" ], "browserPolicy": "string",

"browserSettingsArn": "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.

browserSettings (p. 100) The browser settings.

Type: BrowserSettings (p. 119) object

Errors

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

AccessDeniedException Access is denied.

HTTP Status Code: 403 InternalServerException

There is an internal server error.

HTTP Status Code: 500 ResourceNotFoundException

The resource cannot be found.

HTTP Status Code: 404 ThrottlingException

There is a throttling error.

HTTP Status Code: 429 ValidationException

There is a validation error.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

UpdateIdentityProvider

Updates the identity provider.

Request Syntax

PATCH /identityProviders/identityProviderArn+ HTTP/1.1 Content-type: application/json

{ "clientToken": "string", "identityProviderDetails": { "string" : "string"

"identityProviderName": "string", "identityProviderType": "string"

}

URI Request Parameters

The request uses the following URI parameters.

identityProviderArn (p. 102) The ARN of the identity provider.

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 accepts the following data in JSON format.

clientToken (p. 102)

A unique, case-sensitive identiﬁer that you provide to ensure the idempotency of the request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Required: No

identityProviderDetails (p. 102) The details of the identity provider.

Type: String to string map

Response Syntax

Key Length Constraints: Minimum length of 0. Maximum length of 131072.

Key Pattern: ^[\s\S]*$

Value Length Constraints: Minimum length of 0. Maximum length of 131072.

Value Pattern: ^[\s\S]*$

Required: No

identityProviderName (p. 102) The name of the identity provider.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: ^[^_][\p{L}\p{M}\p{S}\p{N}\p{P}][^_]+$

Required: No

identityProviderType (p. 102) The type of the identity provider.

Type: String

"identityProviderArn": "string", "identityProviderDetails": { "string" : "string"

"identityProviderName": "string", "identityProviderType": "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.

identityProvider (p. 103) The identity provider.

Type: IdentityProvider (p. 125) object

Errors

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

AccessDeniedException Access is denied.

HTTP Status Code: 403 InternalServerException

There is an internal server error.

HTTP Status Code: 500 ResourceNotFoundException

The resource cannot be found.

HTTP Status Code: 404 ThrottlingException

There is a throttling error.

HTTP Status Code: 429 ValidationException

There is a validation error.

HTTP Status Code: 400

Request Syntax

PATCH /networkSettings/networkSettingsArn+ HTTP/1.1 Content-type: application/json

{ "clientToken": "string",

"securityGroupIds": [ "string" ], "subnetIds": [ "string" ], "vpcId": "string"

}

URI Request Parameters

The request uses the following URI parameters.

networkSettingsArn (p. 105) The ARN of the network 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 accepts the following data in JSON format.

clientToken (p. 105)

A unique, case-sensitive identiﬁer that you provide to ensure the idempotency of the request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Required: No

securityGroupIds (p. 105)

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Response Syntax

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[\w+\-]+$

Required: No subnetIds (p. 105)

The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in diﬀerent availability zones.

Type: Array of strings

Array Members: Minimum number of 2 items. Maximum number of 3 items.

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: ^subnet-([0-9a-f]{8}|[0-9a-f]{17})$

Required: No vpcId (p. 105)

The VPC that streaming instances will connect to.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^vpc-[0-9a-z]*$

"associatedPortalArns": [ "string" ], "networkSettingsArn": "string", "securityGroupIds": [ "string" ], "subnetIds": [ "string" ], "vpcId": "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.

networkSettings (p. 106) The network settings.

Type: NetworkSettings (p. 128) object

Errors

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

AccessDeniedException Access is denied.

HTTP Status Code: 403 InternalServerException

There is an internal server error.

HTTP Status Code: 500 ResourceNotFoundException

The resource cannot be found.

HTTP Status Code: 404 ThrottlingException

There is a throttling error.

HTTP Status Code: 429 ValidationException

There is a validation error.

HTTP Status Code: 400

Request Syntax

PUT /portals/portalArn+ HTTP/1.1 Content-type: application/json { "displayName": "string"

}

URI Request Parameters

The request uses the following URI parameters.

portalArn (p. 108)

The ARN of the web portal.

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 accepts the following data in JSON format.

displayName (p. 108)

The name of the web portal. This is not visible to users who log into the web portal.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^.+$

Required: No

Response Syntax

HTTP/1.1 200

Content-type: application/json {

"portal": {

"browserSettingsArn": "string", "browserType": "string",

"creationDate": number, "displayName": "string",

Response Elements

"networkSettingsArn": "string", "portalArn": "string",

"portalEndpoint": "string", "portalStatus": "string", "rendererType": "string", "statusReason": "string", "trustStoreArn": "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.

portal (p. 108) The web portal.

Type: Portal (p. 131) object

Errors

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

AccessDeniedException Access is denied.

HTTP Status Code: 403 InternalServerException

There is an internal server error.

HTTP Status Code: 500 ResourceNotFoundException

The resource cannot be found.

HTTP Status Code: 404 ThrottlingException

There is a throttling error.

HTTP Status Code: 429 ValidationException

There is a validation error.

HTTP Status Code: 400

Request Syntax

PATCH /trustStores/trustStoreArn+ HTTP/1.1 Content-type: application/json

{

"certificatesToAdd": [ blob ], "certificatesToDelete": [ "string" ], "clientToken": "string"

}

URI Request Parameters

The request uses the following URI parameters.

trustStoreArn (p. 111)

The ARN of the trust store.

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 accepts the following data in JSON format.

certiﬁcatesToAdd (p. 111)

A list of CA certiﬁcates to add to the trust store.

Type: Array of Base64-encoded binary data objects Required: No

certiﬁcatesToDelete (p. 111)

A list of CA certiﬁcates to delete from a trust store.

Type: Array of strings

Length Constraints: Fixed length of 64.

Pattern: ^[A-Fa-f0-9]{64}$

Required: No clientToken (p. 111)

A unique, case-sensitive identiﬁer 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

Response Syntax

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Required: No

Response Syntax

HTTP/1.1 200

Content-type: application/json {

"trustStoreArn": "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.

trustStoreArn (p. 112)

The ARN of the trust store.

Type: String

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})+$

Errors

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

AccessDeniedException Access is denied.

HTTP Status Code: 403 InternalServerException

There is an internal server error.

HTTP Status Code: 500 ResourceNotFoundException

The resource cannot be found.

HTTP Status Code: 404

See Also

ServiceQuotaExceededException

The service quota has been exceeded.

HTTP Status Code: 402 ThrottlingException

There is a throttling error.

HTTP Status Code: 429 ValidationException

There is a validation error.

HTTP Status Code: 400

Request Syntax

PATCH /userSettings/userSettingsArn+ HTTP/1.1 Content-type: application/json

{

"clientToken": "string", "copyAllowed": "string", "downloadAllowed": "string", "pasteAllowed": "string", "printAllowed": "string", "uploadAllowed": "string"

}

URI Request Parameters

The request uses the following URI parameters.

userSettingsArn (p. 114)

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 accepts the following data in JSON format.

clientToken (p. 114)

A unique, case-sensitive identiﬁer that you provide to ensure the idempotency of the request.

在文檔中 API ReferenceAPI Version 2020-07-08 WorkSpacesWeb (頁 97-128)

ListTrustStoreCertiﬁcates