Alexa For Business
Alexa for Business API (API Version 2017-11-09)

UpdateGateway

Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.

Request Syntax

{ "Description": "string", "GatewayArn": "string", "Name": "string", "SoftwareVersion": "string" }

Request Parameters

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

The request accepts the following data in JSON format.

Description

The updated description of the gateway.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 200.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*

Required: No

GatewayArn

The ARN of the gateway to update.

Type: String

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: Yes

Name

The updated name of the gateway.

Type: String

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

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*

Required: No

SoftwareVersion

The updated software version of the gateway. The gateway automatically updates its software version during normal operation.

Type: String

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

Required: No

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.

NameInUseException

The name sent in the request is already in use.

HTTP Status Code: 400

NotFoundException

The resource is not found.

HTTP Status Code: 400

See Also

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