MailManager / Client / get_ingress_point

get_ingress_point

MailManager.Client.get_ingress_point(**kwargs)

Fetch ingress endpoint resource attributes.

See also: AWS API Documentation

Request Syntax

response = client.get_ingress_point(
    IngressPointId='string'
)

Parameters:

IngressPointId (string) –

[REQUIRED]

The identifier of an ingress endpoint.

Return type:

dict

Returns:

Response Syntax

{
    'ARecord': 'string',
    'CreatedTimestamp': datetime(2015, 1, 1),
    'IngressPointArn': 'string',
    'IngressPointAuthConfiguration': {
        'IngressPointPasswordConfiguration': {
            'PreviousSmtpPasswordExpiryTimestamp': datetime(2015, 1, 1),
            'PreviousSmtpPasswordVersion': 'string',
            'SmtpPasswordVersion': 'string'
        },
        'SecretArn': 'string'
    },
    'IngressPointId': 'string',
    'IngressPointName': 'string',
    'LastUpdatedTimestamp': datetime(2015, 1, 1),
    'RuleSetId': 'string',
    'Status': 'PROVISIONING'|'DEPROVISIONING'|'UPDATING'|'ACTIVE'|'CLOSED'|'FAILED',
    'TrafficPolicyId': 'string',
    'Type': 'OPEN'|'AUTH'
}

Response Structure

• (dict) –

  • ARecord (string) –

    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 (datetime) –

    The timestamp of when the ingress endpoint was created.

  • IngressPointArn (string) –

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

  • IngressPointAuthConfiguration (dict) –

    The authentication configuration of the ingress endpoint resource.

    • IngressPointPasswordConfiguration (dict) –

      The ingress endpoint password configuration for the ingress endpoint resource.

      • PreviousSmtpPasswordExpiryTimestamp (datetime) –

        The previous password expiry timestamp of the ingress endpoint resource.

      • PreviousSmtpPasswordVersion (string) –

        The previous password version of the ingress endpoint resource.

      • SmtpPasswordVersion (string) –

        The current password expiry timestamp of the ingress endpoint resource.

    • SecretArn (string) –

      The ingress endpoint SecretsManager::Secret ARN configuration for the ingress endpoint resource.

  • IngressPointId (string) –

    The identifier of an ingress endpoint resource.

  • IngressPointName (string) –

    A user friendly name for the ingress endpoint.

  • LastUpdatedTimestamp (datetime) –

    The timestamp of when the ingress endpoint was last updated.

  • RuleSetId (string) –

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

  • Status (string) –

    The status of the ingress endpoint resource.

  • TrafficPolicyId (string) –

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

  • Type (string) –

    The type of ingress endpoint.

Exceptions

• MailManager.Client.exceptions.ValidationException

• MailManager.Client.exceptions.ResourceNotFoundException