Skip to content

create_relay

create_relay(
    relay_name: RelayName,
    server_name: RelayServerName,
    server_port: RelayServerPort,
    authentication: RelayAuthentication,
    *,
    config_overrides: Optional[MailManagerClientConfig] = None,
    client_token: Optional[IdempotencyToken] = None,
    tags: Optional[TagList] = None,
) -> CreateRelayResponse

Creates a relay resource which can be used in rules to relay incoming emails to defined relay destinations.

Parameters:

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

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

  • relay_name (RelayName) –

    The unique name of the relay resource.

  • server_name (RelayServerName) –

    The destination relay server address.

  • server_port (RelayServerPort) –

    The destination relay server port.

  • authentication (RelayAuthentication) –

    Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.

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

Source code in docs_src/capo_mailmanager/_services/mail_manager.py
def create_relay(
    self,
    relay_name: "capo_mailmanager.types.relay_name.RelayName",
    server_name: "capo_mailmanager.types.relay_server_name.RelayServerName",
    server_port: "capo_mailmanager.types.relay_server_port.RelayServerPort",
    authentication: "capo_mailmanager.types.relay_authentication.RelayAuthentication",
    *,
    config_overrides: Optional[MailManagerClientConfig] = None,
    client_token: Optional[
        "capo_mailmanager.types.idempotency_token.IdempotencyToken"
    ] = None,
    tags: Optional["capo_mailmanager.types.tag_list.TagList"] = None,
) -> "capo_mailmanager.types.create_relay_response.CreateRelayResponse":
    """<p>Creates a relay resource which can be used in rules to relay incoming emails to defined relay destinations. </p>

    Args:
        client_token: <p>A unique token that Amazon SES uses to recognize subsequent retries of the same request.</p>
        relay_name: <p>The unique name of the relay resource.</p>
        server_name: <p>The destination relay server address.</p>
        server_port: <p>The destination relay server port.</p>
        authentication: <p>Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.</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.
    """

    def _handler(
        req: "OperationRequest[capo_mailmanager.types.create_relay_request.CreateRelayRequest]",
    ) -> OperationResponse[
        "capo_mailmanager.types.create_relay_response.CreateRelayResponse"
    ]:
        import capo_mailmanager._operations.mail_manager_svc.create_relay

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateRelay")
    )
    input_: capo_mailmanager.types.create_relay_request.CreateRelayRequest = {
        "relay_name": relay_name,
        "server_name": server_name,
        "server_port": server_port,
        "authentication": authentication,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    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