Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

GetRelay - Amazon SES Mail Manager API

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.