RegisterTransitGateway
Registers a transit gateway in your global network. Not all Regions support transit gateways for global networks. For a list of the supported Regions, see Region Availability in the AWS Transit Gateways for Global Networks User Guide. The transit gateway can be in any of the supported AWS Regions, but it must be owned by the same AWS account that owns the global network. You cannot register a transit gateway in more than one global network.
Request Syntax
POST /global-networks/globalNetworkId/transit-gateway-registrations HTTP/1.1
Content-type: application/json
{
"TransitGatewayArn": "string"
}URI Request Parameters
The request uses the following URI parameters.
- globalNetworkId
-
The ID of the global network.
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern:
[\s\S]*Required: Yes
Request Body
The request accepts the following data in JSON format.
- TransitGatewayArn
-
The Amazon Resource Name (ARN) of the transit gateway.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
Pattern:
[\s\S]*Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"TransitGatewayRegistration": {
"GlobalNetworkId": "string",
"State": {
"Code": "string",
"Message": "string"
},
"TransitGatewayArn": "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.
- TransitGatewayRegistration
-
Information about the transit gateway registration.
Type: TransitGatewayRegistration 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
- 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:
