:doc:`MailManager <../../mailmanager>` / Client / create_ingress_point

********************
create_ingress_point
********************



.. py:method:: MailManager.Client.create_ingress_point(**kwargs)

  

  Provision a new ingress endpoint resource.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/CreateIngressPoint>`_  


  **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'
            },
        ]
    )
    
  :type ClientToken: string
  :param ClientToken: 

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

    This field is autopopulated if not provided.

  
  :type IngressPointName: string
  :param IngressPointName: **[REQUIRED]** 

    A user friendly name for an ingress endpoint resource.

    

  
  :type Type: string
  :param Type: **[REQUIRED]** 

    The type of the ingress endpoint to create.

    

  
  :type RuleSetId: string
  :param RuleSetId: **[REQUIRED]** 

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

    

  
  :type TrafficPolicyId: string
  :param TrafficPolicyId: **[REQUIRED]** 

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

    

  
  :type IngressPointConfiguration: dict
  :param IngressPointConfiguration: 

    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.

      

    
  
  :type NetworkConfiguration: dict
  :param NetworkConfiguration: 

    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.

        

      
    
  
  :type Tags: list
  :param Tags: 

    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.

        

      
    

  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'IngressPointId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **IngressPointId** *(string) --* 

        The unique identifier for a previously created ingress endpoint.

        
  
  **Exceptions**
  
  *   :py:class:`MailManager.Client.exceptions.ValidationException`

  
  *   :py:class:`MailManager.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`MailManager.Client.exceptions.ConflictException`

  