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

GetResponderGateway

Retrieves information about a responder gateway.

Request Syntax


GET /responder-gateway/gatewayId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

gatewayId

The unique identifier of the gateway.

Length Constraints: Minimum length of 8. Maximum length of 32.

Pattern: rtb-gw-[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

{
   "activeLinksCount": number,
   "clientRoutingPolicy": "string",
   "createdAt": number,
   "description": "string",
   "domainName": "string",
   "externalInboundEndpoint": "string",
   "gatewayId": "string",
   "gatewayType": "string",
   "linksRequestedCount": number,
   "listenerConfig": { 
      "protocols": [ "string" ]
   },
   "managedEndpointConfiguration": { ... },
   "port": number,
   "protocol": "string",
   "securityGroupIds": [ "string" ],
   "status": "string",
   "subnetIds": [ "string" ],
   "tags": { 
      "string" : "string" 
   },
   "totalLinksCount": number,
   "trustStoreConfiguration": { 
      "certificateAuthorityCertificates": [ "string" ]
   },
   "updatedAt": number,
   "vpcId": "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.

activeLinksCount

The count of active links for the responder gateway.

Type: Integer

clientRoutingPolicy

The client routing policy of the gateway. This policy controls which Availability Zones RTB Fabric uses to reach the gateway for the requester gateways that send traffic to it. RTB Fabric omits this member if the gateway has never had a client routing policy. An omitted value means that the gateway uses AVAILABILITY_ZONE_AFFINITY. For more information, see Configuring Availability Zone affinity in the AWS RTB Fabric User Guide.

Type: String

Valid Values: AVAILABILITY_ZONE_AFFINITY | ANY_AVAILABILITY_ZONE

createdAt

The timestamp of when the responder gateway was created.

Type: Timestamp

description

The description of the responder gateway.

Type: String

Pattern: [A-Za-z0-9 ]+

domainName

The domain name of the responder gateway.

Type: String

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

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

externalInboundEndpoint

The external inbound endpoint for the responder gateway.

Type: String

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

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

gatewayId

The unique identifier of the gateway.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 32.

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

gatewayType

The type of gateway. Valid values are EXTERNAL or INTERNAL.

Type: String

Valid Values: EXTERNAL | INTERNAL

linksRequestedCount

The count of requested links waiting for the responder gateway to accept or reject.

Type: Integer

listenerConfig

The listener configuration for the responder gateway.

Type: ListenerConfig object

managedEndpointConfiguration

The configuration of the managed endpoint.

Type: ManagedEndpointConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

port

The networking port.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 65535.

protocol

The networking protocol.

Type: String

Valid Values: HTTP | HTTPS

securityGroupIds

The unique identifiers of the security groups.

Type: Array of strings

Array Members: Minimum number of 1 item.

Length Constraints: Minimum length of 11. Maximum length of 43.

Pattern: sg-[0-9a-f]{8,40}

status

The status of the request.

Type: String

subnetIds

The unique identifiers of the subnets.

Type: Array of strings

Array Members: Minimum number of 1 item.

Length Constraints: Minimum length of 15. Maximum length of 24.

Pattern: subnet-\w{8,17}

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|[a-zA-Z0-9+\-=._:/@]+)

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

totalLinksCount

The total count of links for the responder gateway.

Type: Integer

trustStoreConfiguration

The configuration of the trust store.

Type: TrustStoreConfiguration object

updatedAt

The timestamp of when the responder gateway was updated.

Type: Timestamp

vpcId

The unique identifier of the Virtual Private Cloud (VPC).

Type: String

Length Constraints: Minimum length of 12. Maximum length of 21.

Pattern: vpc-[a-f0-9]{8,17}

Errors

For information about the errors that are common to all actions, see Common Error Types.

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