Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListLinks

Lists links associated with an RTB application.

Returns a list of all links for the specified RTB application, including their status and configuration details.

Request Syntax


GET /gateway/gatewayId/links/?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

gatewayId

The unique identifier of the gateway.

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

Required: Yes

maxResults

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

nextToken

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "links": [ 
      { 
         "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",
         "tags": { 
            "string" : "string" 
         },
         "updatedAt": number
      }
   ],
   "nextToken": "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.

links

Information about created links.

Type: Array of ListLinksResponseStructure objects

nextToken

Type: String

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

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