AssociateTransitGatewayConnectPeer - AWS Network Manager

AssociateTransitGatewayConnectPeer

Associates a transit gateway Connect peer with a device, and optionally, with a link. If you specify a link, it must be associated with the specified device.

You can only associate transit gateway Connect peers that have been created on a transit gateway that's registered in your global network.

You cannot associate a transit gateway Connect peer with more than one device and link.

Request Syntax

POST /global-networks/globalNetworkId/transit-gateway-connect-peer-associations HTTP/1.1 Content-type: application/json { "DeviceId": "string", "LinkId": "string", "TransitGatewayConnectPeerArn": "string" }

URI Request Parameters

The request uses the following URI parameters.

globalNetworkId

The ID of the global network.

Required: Yes

Request Body

The request accepts the following data in JSON format.

DeviceId

The ID of the device.

Type: String

Required: Yes

LinkId

The ID of the link.

Type: String

Required: No

TransitGatewayConnectPeerArn

The Amazon Resource Name (ARN) of the Connect peer.

Type: String

Required: Yes

Response Syntax

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

TransitGatewayConnectPeerAssociation

The transit gateway Connect peer association.

Type: TransitGatewayConnectPeerAssociation object

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

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

HTTP Status Code: 409

InternalServerException

The request has failed due to an internal error.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource could not be found.

HTTP Status Code: 404

ServiceQuotaExceededException

A service limit was exceeded.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

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: