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

CreateInboundExternalLink

Creates an inbound external link.

Request Syntax


POST /responder-gateway/gatewayId/inbound-external-link HTTP/1.1
Content-type: application/json

{
   "attributes": { 
      "customerProvidedId": "string",
      "responderErrorMasking": [ 
         { 
            "action": "string",
            "httpCode": "string",
            "loggingTypes": [ "string" ],
            "responseLoggingPercentage": number
         }
      ]
   },
   "clientToken": "string",
   "tags": { 
      "string" : "string" 
   }
}

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

Request Body

The request accepts the following data in JSON format.

attributes

Attributes of the link.

Type: LinkAttributes object

Required: No

clientToken

The unique client token.

Type: String

Required: Yes

tags

A map of the key-value pairs of the tag or tags to assign to the 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.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "domainName": "string",
   "gatewayId": "string",
   "linkId": "string",
   "status": "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.

domainName

The domain name.

Type: String

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

Pattern: (?:[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?)(?:\.(?:[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?))+

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}

status

The status of the request.

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

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

ServiceQuotaExceededException

The request could not be completed because you exceeded a service quota.

HTTP Status Code: 402

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