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

GetOutboundExternalLink

Retrieves information about an outbound external link.

Request Syntax


GET /requester-gateway/gatewayId/outbound-external-link/linkId 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

linkId

The unique identifier of the link.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "gatewayId": "string",
   "linkId": "string",
   "publicEndpoint": "string",
   "status": "string",
   "tags": { 
      "string" : "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.

createdAt

The timestamp of when the outbound external link was created.

Type: Timestamp

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}

publicEndpoint

The public endpoint for the link.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Pattern: (https|http)://.+

status

The status of the request.

Type: String

tags

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.

updatedAt

The timestamp of when the outbound external 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

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