UpdateGatewayInformation

Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.

Request Syntax


{
   "GatewayArn": "string",
   "GatewayDisplayName": "string"
}

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

The Amazon Resource Name (ARN) of the gateway to update.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 180.

Pattern: ^arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+$

Required: Yes

The updated display name of the gateway.

Type: String

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

Pattern: ^[a-zA-Z0-9-]*$

Required: No


{
   "GatewayArn": "string"
}

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

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

The Amazon Resource Name (ARN) of the gateway you updated.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 180.

Pattern: ^arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+$

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

ConflictException

The operation cannot proceed because it is not supported.

HTTP Status Code: 400

InternalServerException

The operation did not succeed because an internal error occurred. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

A resource that is required for the action wasn't found.

HTTP Status Code: 400

ThrottlingException

TPS has been limited to protect against intentional or unintentional high request volumes.

HTTP Status Code: 400

ValidationException

The operation did not succeed because a validation error occurred.

HTTP Status Code: 400