AssociateContextStore
Associates a transit gateway with a context store. The transit gateway must be registered with the global network of the context store, and can't be associated with more than one context store. The context store must be in the AVAILABLE state.
The association is in the ASSOCIATING state when it's created, and changes to ASSOCIATED when it's complete.
Request Syntax
POST /context-stores/contextStoreId/associations HTTP/1.1
Content-type: application/json
{
"TransitGatewayArn": "string"
}
URI Request Parameters
The request uses the following URI parameters.
- contextStoreId
-
The ID of the context store.
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern:
^context-store-([0-9a-f]{8,17})$Required: Yes
Request Body
The request accepts the following data in JSON format.
- TransitGatewayArn
-
The Amazon Resource Name (ARN) of the transit gateway to associate with the context store.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
Pattern:
[\s\S]*Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ContextStoreAssociation": {
"ContextStoreId": "string",
"CreatedAt": number,
"State": "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.
- ContextStoreAssociation
-
Information about the context store association.
Type: ContextStoreAssociation object
Errors
For information about the errors that are common to all actions, see Common Error Types.
- 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.
- ResourceId
-
The ID of the resource.
- ResourceType
-
The resource type.
HTTP Status Code: 409
- InternalServerException
-
The request has failed due to an internal error.
- RetryAfterSeconds
-
Indicates when to retry the request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource could not be found.
- Context
-
The specified resource could not be found.
- ResourceId
-
The ID of the resource.
- ResourceType
-
The resource type.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
- RetryAfterSeconds
-
Indicates when to retry the request.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints.
- Fields
-
The fields that caused the error, if applicable.
- Reason
-
The reason for the error.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: