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),
    'NetworkConfiguration': {
        'PrivateNetworkConfiguration': {
            'VpcEndpointId': 'string'
        },
        'PublicNetworkConfiguration': {
            'IpType': 'IPV4'|'DUAL_STACK'
        }
    },
    '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.

    • NetworkConfiguration (dict) –

      The network configuration for the ingress point.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: PrivateNetworkConfiguration, PublicNetworkConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • PrivateNetworkConfiguration (dict) –

        Specifies the network configuration for the private ingress point.

        • VpcEndpointId (string) –

          The identifier of the VPC endpoint to associate with this private ingress point.

      • PublicNetworkConfiguration (dict) –

        Specifies the network configuration for the public ingress point.

        • IpType (string) –

          The IP address type for the public ingress point. Valid values are IPV4 and DUAL_STACK.

    • 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