View a markdown version of this page

DisassociateConnectionsFromResiliencyGroup - Direct Connect

DisassociateConnectionsFromResiliencyGroup

Disassociates one or more connections from the specified resiliency group. This operation is atomic: either all of the specified connections are disassociated, or the operation fails and no changes are made.

Request Syntax

{ "clientToken": "string", "connectionIdentifiers": [ "string" ], "resiliencyGroupId": "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

connectionIdentifiers

The IDs or ARNs of the connections to disassociate from the resiliency group.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 50 items.

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

Required: Yes

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

Response Syntax

{ "resiliencyGroupAssociations": [ { "connectionArn": "string", "resiliencyGroupId": "string", "state": "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.

resiliencyGroupAssociations

The connection associations for the resiliency group.

Type: Array of ResiliencyGroupAssociation objects

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: