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',
    IngressPointName='string',
    Type='OPEN'|'AUTH',
    RuleSetId='string',
    TrafficPolicyId='string',
    IngressPointConfiguration={
        'SmtpPassword': 'string',
        'SecretArn': 'string'
    },
    NetworkConfiguration={
        'PublicNetworkConfiguration': {
            'IpType': 'IPV4'|'DUAL_STACK'
        },
        'PrivateNetworkConfiguration': {
            'VpcEndpointId': 'string'
        }
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

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.

• IngressPointName (string) –

  [REQUIRED]

  A user friendly name for an ingress endpoint resource.

• Type (string) –

  [REQUIRED]

  The type of the ingress endpoint to create.

• RuleSetId (string) –

  [REQUIRED]

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

• TrafficPolicyId (string) –

  [REQUIRED]

  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.

  • SmtpPassword (string) –

    The password of the ingress endpoint resource.

  • SecretArn (string) –

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

• NetworkConfiguration (dict) –

  Specifies the network configuration for the ingress point. This allows you to create an IPv4-only, Dual-Stack, or PrivateLink type of ingress point. If not specified, the default network type is IPv4-only.

  Note

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

  • PublicNetworkConfiguration (dict) –

    Specifies the network configuration for the public ingress point.

    • IpType (string) – [REQUIRED]

      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) – [REQUIRED]

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

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

Return type:

dict

Returns:

Response Syntax

{
    'IngressPointId': 'string'
}

Response Structure

• (dict) –

  • IngressPointId (string) –

    The unique identifier for a previously created ingress endpoint.

Exceptions

• MailManager.Client.exceptions.ValidationException

• MailManager.Client.exceptions.ServiceQuotaExceededException

• MailManager.Client.exceptions.ConflictException