update_fleet_metadata

WorkLink.Client.update_fleet_metadata(**kwargs)

Updates fleet metadata, such as DisplayName.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.update_fleet_metadata(
    FleetArn='string',
    DisplayName='string',
    OptimizeForEndUserLocation=True|False
)
Parameters
  • FleetArn (string) --

    [REQUIRED]

    The ARN of the fleet.

  • DisplayName (string) -- The fleet name to display. The existing DisplayName is unset if null is passed.
  • OptimizeForEndUserLocation (boolean) -- 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.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • WorkLink.Client.exceptions.UnauthorizedException
  • WorkLink.Client.exceptions.InternalServerErrorException
  • WorkLink.Client.exceptions.InvalidRequestException
  • WorkLink.Client.exceptions.ResourceNotFoundException
  • WorkLink.Client.exceptions.TooManyRequestsException