View a markdown version of this page

ListResiliencyGroups - Direct Connect

ListResiliencyGroups

Lists the resiliency groups owned by your AWS account in the current AWS Region.

Request Syntax

{ "maxResults": number, "nextToken": "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.

maxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

Type: Integer

Required: No

nextToken

The token for the next page of results.

Type: String

Required: No

Response Syntax

{ "items": [ { "ownerAccount": "string", "resiliencyGroupArn": "string", "resiliencyGroupId": "string", "resiliencyGroupName": "string", "resiliencyGroupType": "string", "state": "string" } ], "nextToken": "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.

items

Summary information about the resiliency groups.

Type: Array of ResiliencyGroupSummary objects

nextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

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: