update_template_active_version `async` ¶

update_template_active_version(
    template_name: __string,
    template_type: __string,
    *,
    config_overrides: Optional[AsyncPinpointClientConfig] = None,
    template_active_version_request: Optional[TemplateActiveVersionRequest] = None,
) -> UpdateTemplateActiveVersionResponse

Changes the status of a specific version of a message template to active.

Parameters:

template_name (__string) –

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
template_type (__string) –

The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.

Raises:

BadRequestException –

Provides information about an API request or response.
ForbiddenException –

Provides information about an API request or response.
InternalServerErrorException –

Provides information about an API request or response.
MethodNotAllowedException –

Provides information about an API request or response.
NotFoundException –

Provides information about an API request or response.
PayloadTooLargeException –

Provides information about an API request or response.
TooManyRequestsException –

Provides information about an API request or response.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_pinpoint/_services/async_pinpoint.py

async def update_template_active_version(
    self,
    template_name: "capo_pinpoint.types.__string.__string",
    template_type: "capo_pinpoint.types.__string.__string",
    *,
    config_overrides: Optional[AsyncPinpointClientConfig] = None,
    template_active_version_request: Optional[
        "capo_pinpoint.types.template_active_version_request.TemplateActiveVersionRequest"
    ] = None,
) -> "capo_pinpoint.types.update_template_active_version_response.UpdateTemplateActiveVersionResponse":
    """<p>Changes the status of a specific version of a message template to <i>active</i>.</p>

    Args:
        template_name: <p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>
        template_type: <p>The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_pinpoint.types.update_template_active_version_request.UpdateTemplateActiveVersionRequest]",
    ) -> AsyncOperationResponse[
        "capo_pinpoint.types.update_template_active_version_response.UpdateTemplateActiveVersionResponse"
    ]:
        import capo_pinpoint._operations.pinpoint.update_template_active_version

        (
            output,
            http_response,
        ) = await capo_pinpoint._operations.pinpoint.update_template_active_version.async_update_template_active_version(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateTemplateActiveVersion")
    )
    input_: capo_pinpoint.types.update_template_active_version_request.UpdateTemplateActiveVersionRequest = {
        "template_name": template_name,
        "template_type": template_type,
    }
    if template_active_version_request is not None:
        input_["template_active_version_request"] = template_active_version_request

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

update_template_active_version async ¶

update_template_active_version `async` ¶