GetIngressPoint
Fetch ingress endpoint resource attributes.
Request Syntax
{
"IngressPointId": "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.
- IngressPointId
-
The identifier of an ingress endpoint.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
Response Syntax
{
"ARecord": "string",
"CreatedTimestamp": number,
"IngressPointArn": "string",
"IngressPointAuthConfiguration": {
"IngressPointPasswordConfiguration": {
"PreviousSmtpPasswordExpiryTimestamp": number,
"PreviousSmtpPasswordVersion": "string",
"SmtpPasswordVersion": "string"
},
"SecretArn": "string"
},
"IngressPointId": "string",
"IngressPointName": "string",
"LastUpdatedTimestamp": number,
"RuleSetId": "string",
"Status": "string",
"TrafficPolicyId": "string",
"Type": "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.
- ARecord
-
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.
Type: String
- CreatedTimestamp
-
The timestamp of when the ingress endpoint was created.
Type: Timestamp
- IngressPointArn
-
The Amazon Resource Name (ARN) of the ingress endpoint resource.
Type: String
- IngressPointAuthConfiguration
-
The authentication configuration of the ingress endpoint resource.
Type: IngressPointAuthConfiguration object
- IngressPointId
-
The identifier of an ingress endpoint resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
- IngressPointName
-
A user friendly name for the ingress endpoint.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern:
^[A-Za-z0-9_\-]+$ - LastUpdatedTimestamp
-
The timestamp of when the ingress endpoint was last updated.
Type: Timestamp
- RuleSetId
-
The identifier of a rule set resource associated with the ingress endpoint.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
- Status
-
The status of the ingress endpoint resource.
Type: String
Valid Values:
PROVISIONING | DEPROVISIONING | UPDATING | ACTIVE | CLOSED | FAILED - TrafficPolicyId
-
The identifier of the traffic policy resource associated with the ingress endpoint.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
- Type
-
The type of ingress endpoint.
Type: String
Valid Values:
OPEN | AUTH
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:
