MailManager / Client / update_ingress_point

update_ingress_point

MailManager.Client.update_ingress_point(**kwargs)

Update attributes of a provisioned ingress endpoint resource.

See also: AWS API Documentation

Request Syntax

response = client.update_ingress_point(
    IngressPointId='string',
    IngressPointName='string',
    StatusToUpdate='ACTIVE'|'CLOSED',
    RuleSetId='string',
    TrafficPolicyId='string',
    IngressPointConfiguration={
        'SmtpPassword': 'string',
        'SecretArn': 'string',
        'TlsAuthConfiguration': {
            'TrustStore': {
                'CAContent': 'string',
                'CrlContent': 'string',
                'KmsKeyArn': 'string'
            }
        }
    },
    TlsPolicy='REQUIRED'|'OPTIONAL'|'FIPS'
)
Parameters:

  • IngressPointId (string) –

    [REQUIRED]

    The identifier for the ingress endpoint you want to update.

  • IngressPointName (string) – A user friendly name for the ingress endpoint resource.

  • StatusToUpdate (string) – The update status of an ingress endpoint.

  • RuleSetId (string) – The identifier of an existing rule set that you attach to an ingress endpoint resource.

  • TrafficPolicyId (string) – The identifier of an existing traffic policy that you attach to an ingress endpoint resource.

  • IngressPointConfiguration (dict) –

    If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: SmtpPassword, SecretArn, TlsAuthConfiguration.

    • SmtpPassword (string) –

      The password of the ingress endpoint resource.

    • SecretArn (string) –

      The SecretsManager::Secret ARN of the ingress endpoint resource.

    • TlsAuthConfiguration (dict) –

      The mutual TLS authentication configuration of the ingress endpoint resource.

      • TrustStore (dict) –

        The trust store configuration for mutual TLS authentication.

        • CAContent (string) – [REQUIRED]

          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.

  • TlsPolicy (string) – The Transport Layer Security (TLS) policy for the ingress point. Valid values are REQUIRED, OPTIONAL. Only ingress endpoints using REQUIRED or OPTIONAL as TlsPolicy can be updated.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions