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',
    IncludeTrustStoreContents='EXCLUDE'|'INCLUDE'
)

Parameters:

• IngressPointId (string) –

  [REQUIRED]

  The identifier of an ingress endpoint.

• IncludeTrustStoreContents (string) – Whether to include the trust store contents in the response. Use INCLUDE to retrieve trust store certificate and CRL contents.

Return type:

dict

Returns:

Response Syntax

{
    'IngressPointId': 'string',
    'IngressPointName': 'string',
    'IngressPointArn': 'string',
    'Status': 'PROVISIONING'|'DEPROVISIONING'|'UPDATING'|'ACTIVE'|'CLOSED'|'FAILED'|'ASSOCIATED_VPC_ENDPOINT_DOES_NOT_EXIST',
    'Type': 'OPEN'|'AUTH'|'MTLS',
    'ARecord': 'string',
    'RuleSetId': 'string',
    'TrafficPolicyId': 'string',
    'IngressPointAuthConfiguration': {
        'IngressPointPasswordConfiguration': {
            'SmtpPasswordVersion': 'string',
            'PreviousSmtpPasswordVersion': 'string',
            'PreviousSmtpPasswordExpiryTimestamp': datetime(2015, 1, 1)
        },
        'SecretArn': 'string',
        'TlsAuthConfiguration': {
            'TrustStore': {
                'CAContent': 'string',
                'CrlContent': 'string',
                'KmsKeyArn': 'string'
            }
        }
    },
    'NetworkConfiguration': {
        'PublicNetworkConfiguration': {
            'IpType': 'IPV4'|'DUAL_STACK'
        },
        'PrivateNetworkConfiguration': {
            'VpcEndpointId': 'string'
        }
    },
    'TlsPolicy': 'REQUIRED'|'OPTIONAL'|'FIPS',
    'CreatedTimestamp': datetime(2015, 1, 1),
    'LastUpdatedTimestamp': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • IngressPointId (string) –

    The identifier of an ingress endpoint resource.

  • IngressPointName (string) –

    A user friendly name for the ingress endpoint.

  • IngressPointArn (string) –

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

  • Status (string) –

    The status of the ingress endpoint resource.

  • Type (string) –

    The type of ingress endpoint.

  • 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.

  • RuleSetId (string) –

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

  • TrafficPolicyId (string) –

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

  • IngressPointAuthConfiguration (dict) –

    The authentication configuration of the ingress endpoint resource.

    • IngressPointPasswordConfiguration (dict) –

      The ingress endpoint password configuration for the ingress endpoint resource.

      • SmtpPasswordVersion (string) –

        The current password expiry timestamp of the ingress endpoint resource.

      • PreviousSmtpPasswordVersion (string) –

        The previous password version of the ingress endpoint resource.

      • PreviousSmtpPasswordExpiryTimestamp (datetime) –

        The previous password expiry timestamp of the ingress endpoint resource.

    • SecretArn (string) –

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

    • TlsAuthConfiguration (dict) –

      The mutual TLS authentication configuration for the ingress endpoint resource.

      • TrustStore (dict) –

        The trust store configuration for mutual TLS authentication.

        • CAContent (string) –

          The PEM-encoded certificate authority (CA) certificates bundle for the trust store.

        • CrlContent (string) –

          The PEM-encoded certificate revocation lists (CRLs) for the trust store. There can be one CRL per certificate authority (CA) in the trust store.

        • KmsKeyArn (string) –

          The Amazon Resource Name (ARN) of the KMS key used to encrypt the trust store contents.

  • 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: PublicNetworkConfiguration, PrivateNetworkConfiguration. 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'}
    

    • 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.

    • 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.

  • TlsPolicy (string) –

    The selected Transport Layer Security (TLS) policy of the ingress point.

  • CreatedTimestamp (datetime) –

    The timestamp of when the ingress endpoint was created.

  • LastUpdatedTimestamp (datetime) –

    The timestamp of when the ingress endpoint was last updated.

Exceptions

• MailManager.Client.exceptions.ValidationException

• MailManager.Client.exceptions.ResourceNotFoundException