GetCustomerGatewayAssociations - AWS Network Manager


Gets the association information for customer gateways that are associated with devices and links in your global network.

Request Syntax

GET /global-networks/globalNetworkId/customer-gateway-associations?customerGatewayArns=CustomerGatewayArns&maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


One or more customer gateway Amazon Resource Names (ARNs). For more information, see Resources Defined by Amazon EC2. The maximum is 10.


The ID of the global network.

Required: Yes


The maximum number of results to return.

Valid Range: Minimum value of 1. Maximum value of 500.


The token for the next page of results.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "CustomerGatewayAssociations": [ { "CustomerGatewayArn": "string", "DeviceId": "string", "GlobalNetworkId": "string", "LinkId": "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.


The customer gateway associations.

Type: Array of CustomerGatewayAssociation objects


The token for the next page of results.

Type: String


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


You do not have sufficient access to perform this action.

HTTP Status Code: 403


There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

HTTP Status Code: 409


The request has failed due to an internal error.

HTTP Status Code: 500


The specified resource could not be found.

HTTP Status Code: 404


The request was denied due to request throttling.

HTTP Status Code: 429


The input fails to satisfy the constraints.

HTTP Status Code: 400

See Also

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