GetLink - AWS RTB Fabric
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

GetLink

Retrieves information about a link between RTB applications.

Returns detailed information about the link configuration, status, and associated RTB applications.

GET /gateway/gatewayId/link/linkId HTTP/1.1

The request uses the following URI parameters.

The unique identifier of the gateway.

Pattern: rtb-gw-[a-z0-9-]{1,25}

Required: Yes

The unique identifier of the link.

Pattern: link-[a-z0-9-]{1,25}

Required: Yes

The request does not have a request body.

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",
   "logSettings": { 
      "applicationLogs": { 
         "sampling": { 
            "errorLog": number,
            "filterLog": number
         }
      }
   },
   "peerGatewayId": "string",
   "pendingFlowModules": [ 
      { 
         "dependsOn": [ "string" ],
         "moduleParameters": { ... },
         "name": "string",
         "version": "string"
      }
   ],
   "status": "string",
   "tags": { 
      "string" : "string" 
   },
   "updatedAt": number
}

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 of the link.

Type: LinkAttributes object

The timestamp of when the link was created.

Type: Timestamp

The direction of the link.

Type: String

Valid Values: RESPONSE | REQUEST

The configuration of flow modules.

Type: Array of ModuleConfiguration objects

The unique identifier of the gateway.

Type: String

Pattern: rtb-gw-[a-z0-9-]{1,25}

The unique identifier of the link.

Type: String

Pattern: link-[a-z0-9-]{1,25}

Settings for the application logs.

Type: LinkLogSettings object

The unique identifier of the peer gateway.

Type: String

Pattern: rtb-gw-[a-z0-9-]{1,25}

The configuration of pending flow modules.

Type: Array of ModuleConfiguration objects

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

A map of the key-value pairs for the tag or tags assigned to the specified resource.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: (resourceArn|internalId|(?!aws:)[a-zA-Z0-9+\-=._:/@]+)

Value Length Constraints: Minimum length of 0. Maximum length of 1600.

The timestamp of when the link was updated.

Type: Timestamp

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

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