Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetRelay

Fetch the relay resource and it's attributes.

Request Syntax


{
   "RelayId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

RelayId

A unique relay identifier.

Type: String

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

Pattern: ^[a-zA-Z0-9-]+$

Required: Yes

Response Syntax


{
   "Authentication": { ... },
   "CreatedTimestamp": number,
   "LastModifiedTimestamp": number,
   "RelayArn": "string",
   "RelayId": "string",
   "RelayName": "string",
   "ServerName": "string",
   "ServerPort": 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.

Authentication

The authentication attribute—contains the secret ARN where the customer relay server credentials are stored.

Type: RelayAuthentication object

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

CreatedTimestamp

The timestamp of when the relay was created.

Type: Timestamp

LastModifiedTimestamp

The timestamp of when relay was last updated.

Type: Timestamp

RelayArn

The Amazon Resource Name (ARN) of the relay.

Type: String

RelayId

The unique relay identifier.

Type: String

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

Pattern: ^[a-zA-Z0-9-]+$

RelayName

The unique name of the relay.

Type: String

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

Pattern: ^[a-zA-Z0-9-_]+$

ServerName

The destination relay server address.

Type: String

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

Pattern: ^[a-zA-Z0-9-\.]+$

ServerPort

The destination relay server port.

Type: Integer

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

Errors

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

ResourceNotFoundException

Occurs when a requested resource is not found.

HTTP Status Code: 400

ValidationException

The request validation has failed. For details, see the accompanying error message.

HTTP Status Code: 400