UpdateDomainMetadata - Amazon WorkLink


Updates domain metadata, such as DisplayName.

Request Syntax

POST /updateDomainMetadata HTTP/1.1 Content-type: application/json { "DisplayName": "string", "DomainName": "string", "FleetArn": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.


The name to display.

Type: String

Length Constraints: Maximum length of 100.

Required: No


The name of the domain.

Type: String

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

Pattern: ^[a-zA-Z0-9]?((?!-)([A-Za-z0-9-]*[A-Za-z0-9])\.)+[a-zA-Z0-9]+$

Required: Yes


The ARN of the fleet.

Type: String

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

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.


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


The service is temporarily unavailable.

HTTP Status Code: 500


The request is not valid.

HTTP Status Code: 400


The requested resource was not found.

HTTP Status Code: 404


The number of requests exceeds the limit.

HTTP Status Code: 429


You are not authorized to perform this action.

HTTP Status Code: 403

See Also

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