Skip to content

update_email_channel

update_email_channel(
    application_id: __string,
    *,
    config_overrides: Optional[PinpointClientConfig] = None,
    email_channel_request: Optional[EmailChannelRequest] = None,
) -> UpdateEmailChannelResponse

Enables the email channel for an application or updates the status and settings of the email channel for an application.

Parameters:

  • application_id (__string) –

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Raises:

Source code in docs_src/capo_pinpoint/_services/pinpoint.py
def update_email_channel(
    self,
    application_id: "capo_pinpoint.types.__string.__string",
    *,
    config_overrides: Optional[PinpointClientConfig] = None,
    email_channel_request: Optional[
        "capo_pinpoint.types.email_channel_request.EmailChannelRequest"
    ] = None,
) -> "capo_pinpoint.types.update_email_channel_response.UpdateEmailChannelResponse":
    """<p>Enables the email channel for an application or updates the status and settings of the email channel for an application.</p>

    Args:
        application_id: <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>

    Raises:
        capo_pinpoint.errors.bad_request_exception.BadRequestException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.forbidden_exception.ForbiddenException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.internal_server_error_exception.InternalServerErrorException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.method_not_allowed_exception.MethodNotAllowedException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.not_found_exception.NotFoundException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.payload_too_large_exception.PayloadTooLargeException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.too_many_requests_exception.TooManyRequestsException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_pinpoint.types.update_email_channel_request.UpdateEmailChannelRequest]",
    ) -> OperationResponse[
        "capo_pinpoint.types.update_email_channel_response.UpdateEmailChannelResponse"
    ]:
        import capo_pinpoint._operations.pinpoint.update_email_channel

        output, http_response = (
            capo_pinpoint._operations.pinpoint.update_email_channel.update_email_channel(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateEmailChannel")
    )
    input_: capo_pinpoint.types.update_email_channel_request.UpdateEmailChannelRequest = {
        "application_id": application_id
    }
    if email_channel_request is not None:
        input_["email_channel_request"] = email_channel_request

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