View a markdown version of this page

UpdateResiliencyGroup - Direct Connect

UpdateResiliencyGroup

Updates the name of the specified resiliency group.

Request Syntax

{ "clientToken": "string", "resiliencyGroupId": "string", "resiliencyGroupName": "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.

clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Type: String

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

Required: No

resiliencyGroupId

The ID of the resiliency group.

Type: String

Length Constraints: Fixed length of 22.

Pattern: ^(dxrg|DXRG)-[0-9a-zA-Z]{17}$

Required: Yes

resiliencyGroupName

The new name of the resiliency group.

Type: String

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

Pattern: ^[a-zA-Z0-9_\-]+$

Required: Yes

Response Syntax

{ "resiliencyGroup": { "ownerAccount": "string", "resiliencyGroupArn": "string", "resiliencyGroupId": "string", "resiliencyGroupName": "string", "resiliencyGroupType": "string", "state": "string", "tags": [ { "key": "string", "value": "string" } ] } }

Response Elements

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

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

resiliencyGroup

Information about the resiliency group.

Type: ResiliencyGroup object

Errors

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

DirectConnectClientException

One or more parameters are not valid.

HTTP Status Code: 400

DirectConnectServerException

A server-side error occurred.

HTTP Status Code: 400

See Also

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