Skip to content

create_ingress_point

create_ingress_point(
    ingress_point_name: IngressPointName,
    type: IngressPointType,
    rule_set_id: RuleSetId,
    traffic_policy_id: TrafficPolicyId,
    *,
    config_overrides: Optional[MailManagerClientConfig] = None,
    client_token: Optional[IdempotencyToken] = None,
    ingress_point_configuration: Optional[IngressPointConfiguration] = None,
    network_configuration: Optional[NetworkConfiguration] = None,
    tls_policy: Optional[TlsPolicy] = None,
    tags: Optional[TagList] = None,
) -> CreateIngressPointResponse

Provision a new ingress endpoint resource.

Parameters:

  • client_token (Optional[IdempotencyToken], default: None ) –

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

  • ingress_point_name (IngressPointName) –

    A user friendly name for an ingress endpoint resource.

  • type (IngressPointType) –

    The type of the ingress endpoint to create.

  • rule_set_id (RuleSetId) –

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

  • traffic_policy_id (TrafficPolicyId) –

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

  • ingress_point_configuration (Optional[IngressPointConfiguration], default: None ) –

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

  • network_configuration (Optional[NetworkConfiguration], default: None ) –

    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.

  • tls_policy (Optional[TlsPolicy], default: None ) –

    The Transport Layer Security (TLS) policy for the ingress point. The FIPS value is only valid in US and Canada regions.

  • tags (Optional[TagList], default: None ) –

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

Raises:

Examples:

Create Open IngressPoint

>>> client.create_ingress_point(ingress_point_name='ingressPointName', type='OPEN', rule_set_id='rs-12345', traffic_policy_id='tp-12345', tags=[{'Key': 'key', 'Value': 'value'}])
Create Auth IngressPoint with Password
>>> client.create_ingress_point(ingress_point_name='ingressPointName', type='AUTH', rule_set_id='rs-12345', traffic_policy_id='tp-12345', ingress_point_configuration={'SmtpPassword': 'smtpPassword'}, tags=[{'Key': 'key', 'Value': 'value'}])
Create Auth IngressPoint with SecretsManager Secret
>>> client.create_ingress_point(ingress_point_name='ingressPointName', type='AUTH', rule_set_id='rs-12345', traffic_policy_id='tp-12345', ingress_point_configuration={'SecretArn': 'arn:aws:secretsmanager:us-west-2:123456789012:secret:abcde'}, tags=[{'Key': 'key', 'Value': 'value'}])
Source code in docs_src/capo_mailmanager/_services/mail_manager.py
def create_ingress_point(
    self,
    ingress_point_name: "capo_mailmanager.types.ingress_point_name.IngressPointName",
    type: "capo_mailmanager.types.ingress_point_type.IngressPointType",
    rule_set_id: "capo_mailmanager.types.rule_set_id.RuleSetId",
    traffic_policy_id: "capo_mailmanager.types.traffic_policy_id.TrafficPolicyId",
    *,
    config_overrides: Optional[MailManagerClientConfig] = None,
    client_token: Optional[
        "capo_mailmanager.types.idempotency_token.IdempotencyToken"
    ] = None,
    ingress_point_configuration: Optional[
        "capo_mailmanager.types.ingress_point_configuration.IngressPointConfiguration"
    ] = None,
    network_configuration: Optional[
        "capo_mailmanager.types.network_configuration.NetworkConfiguration"
    ] = None,
    tls_policy: Optional["capo_mailmanager.types.tls_policy.TlsPolicy"] = None,
    tags: Optional["capo_mailmanager.types.tag_list.TagList"] = None,
) -> "capo_mailmanager.types.create_ingress_point_response.CreateIngressPointResponse":
    """<p>Provision a new ingress endpoint resource.</p>

    Args:
        client_token: <p>A unique token that Amazon SES uses to recognize subsequent retries of the same request.</p>
        ingress_point_name: <p>A user friendly name for an ingress endpoint resource.</p>
        type: <p>The type of the ingress endpoint to create.</p>
        rule_set_id: <p>The identifier of an existing rule set that you attach to an ingress endpoint resource.</p>
        traffic_policy_id: <p>The identifier of an existing traffic policy that you attach to an ingress endpoint resource.</p>
        ingress_point_configuration: <p>If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.</p>
        network_configuration: <p>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. </p>
        tls_policy: <p>The Transport Layer Security (TLS) policy for the ingress point. The FIPS value is only valid in US and Canada regions.</p>
        tags: <p>The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>

    Raises:
        capo_mailmanager.errors.conflict_exception.ConflictException: <p>The request configuration has conflicts. For details, see the accompanying error message.</p>
        capo_mailmanager.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Occurs when an operation exceeds a predefined service quota or limit.</p>
        capo_mailmanager.errors.validation_exception.ValidationException: <p>The request validation has failed. For details, see the accompanying error message.</p>
        capo_mailmanager.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Create Open IngressPoint

        >>> client.create_ingress_point(ingress_point_name='ingressPointName', type='OPEN', rule_set_id='rs-12345', traffic_policy_id='tp-12345', tags=[{'Key': 'key', 'Value': 'value'}])
        Create Auth IngressPoint with Password

        >>> client.create_ingress_point(ingress_point_name='ingressPointName', type='AUTH', rule_set_id='rs-12345', traffic_policy_id='tp-12345', ingress_point_configuration={'SmtpPassword': 'smtpPassword'}, tags=[{'Key': 'key', 'Value': 'value'}])
        Create Auth IngressPoint with SecretsManager Secret

        >>> client.create_ingress_point(ingress_point_name='ingressPointName', type='AUTH', rule_set_id='rs-12345', traffic_policy_id='tp-12345', ingress_point_configuration={'SecretArn': 'arn:aws:secretsmanager:us-west-2:123456789012:secret:abcde'}, tags=[{'Key': 'key', 'Value': 'value'}])
    """

    def _handler(
        req: "OperationRequest[capo_mailmanager.types.create_ingress_point_request.CreateIngressPointRequest]",
    ) -> OperationResponse[
        "capo_mailmanager.types.create_ingress_point_response.CreateIngressPointResponse"
    ]:
        import capo_mailmanager._operations.mail_manager_svc.create_ingress_point

        output, http_response = (
            capo_mailmanager._operations.mail_manager_svc.create_ingress_point.create_ingress_point(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_mailmanager.types.create_ingress_point_request.CreateIngressPointRequest",
    ) -> dict[str, Any]:
        import capo_mailmanager.types.create_ingress_point_request

        return capo_mailmanager.types.create_ingress_point_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateIngressPoint", redact_input=_redact_input),
    )
    input_: capo_mailmanager.types.create_ingress_point_request.CreateIngressPointRequest = {
        "ingress_point_name": ingress_point_name,
        "type": type,
        "rule_set_id": rule_set_id,
        "traffic_policy_id": traffic_policy_id,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if ingress_point_configuration is not None:
        input_["ingress_point_configuration"] = ingress_point_configuration
    if network_configuration is not None:
        input_["network_configuration"] = network_configuration
    if tls_policy is not None:
        input_["tls_policy"] = tls_policy
    if tags is not None:
        input_["tags"] = tags

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output