AcceptLink
Accepts a link request between gateways.
When a requester gateway requests to link with a responder gateway, the responder can use this operation to accept the link request and establish the connection.
Request Syntax
POST /gateway/gatewayId/link/linkId/accept HTTP/1.1
Content-type: application/json
{
"attributes": {
"customerProvidedId": "string",
"responderErrorMasking": [
{
"action": "string",
"httpCode": "string",
"loggingTypes": [ "string" ],
"responseLoggingPercentage": number
}
]
},
"logSettings": {
"applicationLogs": {
"sampling": {
"errorLog": number,
"filterLog": number
}
}
}
}URI Request Parameters
The request uses the following URI parameters.
Request Body
The request accepts the following data in JSON format.
- attributes
-
Attributes of the link.
Type: LinkAttributes object
Required: No
- logSettings
-
Settings for the application logs.
Type: LinkLogSettings object
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"attributes": {
"customerProvidedId": "string",
"responderErrorMasking": [
{
"action": "string",
"httpCode": "string",
"loggingTypes": [ "string" ],
"responseLoggingPercentage": number
}
]
},
"createdAt": number,
"direction": "string",
"flowModules": [
{
"dependsOn": [ "string" ],
"moduleParameters": { ... },
"name": "string",
"version": "string"
}
],
"gatewayId": "string",
"linkId": "string",
"peerGatewayId": "string",
"pendingFlowModules": [
{
"dependsOn": [ "string" ],
"moduleParameters": { ... },
"name": "string",
"version": "string"
}
],
"status": "string",
"updatedAt": number
}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.
- attributes
-
Attributes of the link.
Type: LinkAttributes object
- createdAt
-
The timestamp of when the link was created.
Type: Timestamp
- direction
-
The direction of the link.
Type: String
Valid Values:
RESPONSE | REQUEST - flowModules
-
The configuration of flow modules.
Type: Array of ModuleConfiguration objects
- gatewayId
-
The unique identifier of the gateway.
Type: String
Pattern:
rtb-gw-[a-z0-9-]{1,25} - linkId
-
The unique identifier of the link.
Type: String
Pattern:
link-[a-z0-9-]{1,25} - peerGatewayId
-
The unique identifier of the peer gateway.
Type: String
Pattern:
rtb-gw-[a-z0-9-]{1,25} - pendingFlowModules
-
The configuration of pending flow modules.
Type: Array of ModuleConfiguration objects
- status
-
The status of the link.
Type: String
Valid Values:
PENDING_CREATION | PENDING_REQUEST | REQUESTED | ACCEPTED | ACTIVE | REJECTED | FAILED | PENDING_DELETION | DELETED | PENDING_UPDATE | PENDING_ISOLATION | ISOLATED | PENDING_RESTORATION - updatedAt
-
The timestamp of when the link was updated.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request could not be completed because you do not have sufficient access to perform this action.
HTTP Status Code: 403
- ConflictException
-
The request could not be completed because of a conflict in the current state of the resource.
HTTP Status Code: 409
- InternalServerException
-
The request could not be completed because of an internal server error. Try your call again.
HTTP Status Code: 500
- ResourceNotFoundException
-
The request could not be completed because the resource does not exist.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The request could not be completed because it fails satisfy the constraints specified by the service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
