UpdateFleetMetadata
Updates fleet metadata, such as DisplayName.
Request Syntax
POST /UpdateFleetMetadata HTTP/1.1
Content-type: application/json
{
"DisplayName": "string
",
"FleetArn": "string
",
"OptimizeForEndUserLocation": boolean
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- DisplayName
-
The fleet name to display. The existing DisplayName is unset if null is passed.
Type: String
Length Constraints: Maximum length of 100.
Required: No
- FleetArn
-
The ARN of the fleet.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Required: Yes
- OptimizeForEndUserLocation
-
The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region.
Type: Boolean
Required: No
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.
- InternalServerErrorException
-
The service is temporarily unavailable.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The requested resource was not found.
HTTP Status Code: 404
- TooManyRequestsException
-
The number of requests exceeds the limit.
HTTP Status Code: 429
- UnauthorizedException
-
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: