GetIngressPointCommand

Suggest an Edit

Fetch ingress endpoint resource attributes.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { MailManagerClient, GetIngressPointCommand } from "@aws-sdk/client-mailmanager"; // ES Modules import
// const { MailManagerClient, GetIngressPointCommand } = require("@aws-sdk/client-mailmanager"); // CommonJS import
const client = new MailManagerClient(config);
const input = { // GetIngressPointRequest
  IngressPointId: "STRING_VALUE", // required
};
const command = new GetIngressPointCommand(input);
const response = await client.send(command);
// { // GetIngressPointResponse
//   IngressPointId: "STRING_VALUE", // required
//   IngressPointName: "STRING_VALUE", // required
//   IngressPointArn: "STRING_VALUE",
//   Status: "PROVISIONING" || "DEPROVISIONING" || "UPDATING" || "ACTIVE" || "CLOSED" || "FAILED",
//   Type: "OPEN" || "AUTH",
//   ARecord: "STRING_VALUE",
//   RuleSetId: "STRING_VALUE",
//   TrafficPolicyId: "STRING_VALUE",
//   IngressPointAuthConfiguration: { // IngressPointAuthConfiguration
//     IngressPointPasswordConfiguration: { // IngressPointPasswordConfiguration
//       SmtpPasswordVersion: "STRING_VALUE",
//       PreviousSmtpPasswordVersion: "STRING_VALUE",
//       PreviousSmtpPasswordExpiryTimestamp: new Date("TIMESTAMP"),
//     },
//     SecretArn: "STRING_VALUE",
//   },
//   CreatedTimestamp: new Date("TIMESTAMP"),
//   LastUpdatedTimestamp: new Date("TIMESTAMP"),
// };

GetIngressPointCommand Input

See GetIngressPointCommandInput for more details

Parameter
Type
Description
IngressPointId
Required
string | undefined

The identifier of an ingress endpoint.

GetIngressPointCommand Output

See GetIngressPointCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
IngressPointId
Required
string | undefined

The identifier of an ingress endpoint resource.

IngressPointName
Required
string | undefined

A user friendly name for the ingress endpoint.

ARecord
string | undefined

The DNS A Record that identifies your ingress endpoint. Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager.

CreatedTimestamp
Date | undefined

The timestamp of when the ingress endpoint was created.

IngressPointArn
string | undefined

The Amazon Resource Name (ARN) of the ingress endpoint resource.

IngressPointAuthConfiguration
IngressPointAuthConfiguration | undefined

The authentication configuration of the ingress endpoint resource.

LastUpdatedTimestamp
Date | undefined

The timestamp of when the ingress endpoint was last updated.

RuleSetId
string | undefined

The identifier of a rule set resource associated with the ingress endpoint.

Status
IngressPointStatus | undefined

The status of the ingress endpoint resource.

TrafficPolicyId
string | undefined

The identifier of the traffic policy resource associated with the ingress endpoint.

Type
IngressPointType | undefined

The type of ingress endpoint.

Throws

Name
Fault
Details
ResourceNotFoundException
client

Occurs when a requested resource is not found.

ValidationException
client

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

MailManagerServiceException
Base exception class for all service exceptions from MailManager service.