Skip to content

create_in_app_template

create_in_app_template(
    template_name: __string,
    *,
    config_overrides: Optional[PinpointClientConfig] = None,
    in_app_template_request: Optional[InAppTemplateRequest] = None,
) -> CreateInAppTemplateResponse

Creates a new message template for messages using the in-app message channel.

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.

Raises:

Source code in docs_src/capo_pinpoint/_services/pinpoint.py
def create_in_app_template(
    self,
    template_name: "capo_pinpoint.types.__string.__string",
    *,
    config_overrides: Optional[PinpointClientConfig] = None,
    in_app_template_request: Optional[
        "capo_pinpoint.types.in_app_template_request.InAppTemplateRequest"
    ] = None,
) -> "capo_pinpoint.types.create_in_app_template_response.CreateInAppTemplateResponse":
    """<p>Creates a new message template for messages using the in-app message channel.</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>

    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.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.create_in_app_template_request.CreateInAppTemplateRequest]",
    ) -> OperationResponse[
        "capo_pinpoint.types.create_in_app_template_response.CreateInAppTemplateResponse"
    ]:
        import capo_pinpoint._operations.pinpoint.create_in_app_template

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateInAppTemplate")
    )
    input_: capo_pinpoint.types.create_in_app_template_request.CreateInAppTemplateRequest = {
        "template_name": template_name
    }
    if in_app_template_request is not None:
        input_["in_app_template_request"] = in_app_template_request

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