MailManager / Client / create_ingress_point

create_ingress_point#

MailManager.Client.create_ingress_point(**kwargs)#

Provision a new ingress endpoint resource.

See also: AWS API Documentation

Request Syntax

response = client.create_ingress_point(
    ClientToken='string',
    IngressPointConfiguration={
        'SecretArn': 'string',
        'SmtpPassword': 'string'
    },
    IngressPointName='string',
    RuleSetId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    TrafficPolicyId='string',
    Type='OPEN'|'AUTH'
)
Parameters:

  • ClientToken (string) –

    A unique token that Amazon SES uses to recognize subsequent retries of the same request.

    This field is autopopulated if not provided.

  • 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: SecretArn, SmtpPassword.

    • SecretArn (string) –

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

    • SmtpPassword (string) –

      The password of the ingress endpoint resource.

  • IngressPointName (string) –

    [REQUIRED]

    A user friendly name for an ingress endpoint resource.

  • RuleSetId (string) –

    [REQUIRED]

    The identifier of an existing rule set that you attach to an ingress endpoint resource.

  • Tags (list) –

    The tags used to organize, track, or control access for the resource. For example, { “tags”: {“key1”:”value1”, “key2”:”value2”} }.

    • (dict) –

      A key-value pair (the value is optional), that you can define and assign to Amazon Web Services resources.

      • Key (string) – [REQUIRED]

        The key of the key-value tag.

      • Value (string) – [REQUIRED]

        The value of the key-value tag.

  • TrafficPolicyId (string) –

    [REQUIRED]

    The identifier of an existing traffic policy that you attach to an ingress endpoint resource.

  • Type (string) –

    [REQUIRED]

    The type of the ingress endpoint to create.

Return type:

dict

Returns:

Response Syntax

{
    'IngressPointId': 'string'
}

Response Structure

  • (dict) –

    • IngressPointId (string) –

      The unique identifier for a previously created ingress endpoint.

Exceptions