describe_notify_templates ¶

def describe_notify_templates(
    self,
    *,
    config_overrides: Optional[PinpointSMSVoiceV2ClientConfig] = None,
    template_ids: Optional[
        "capo_pinpoint_sms_voice_v2.types.notify_template_id_list.NotifyTemplateIdList"
    ] = None,
    filters: Optional[
        "capo_pinpoint_sms_voice_v2.types.notify_template_filter_list.NotifyTemplateFilterList"
    ] = None,
    next_token: Optional[
        "capo_pinpoint_sms_voice_v2.types.next_token.NextToken"
    ] = None,
    max_results: Optional[
        "capo_pinpoint_sms_voice_v2.types.max_results.MaxResults"
    ] = None,
) -> "capo_pinpoint_sms_voice_v2.types.describe_notify_templates_result.DescribeNotifyTemplatesResult":
    """<p>Describes the specified notify templates or all notify templates in your account.</p> <p>If you specify template IDs, the output includes information for only the specified notify templates. If you specify filters, the output includes information for only those notify templates that meet the filter criteria. If you don't specify template IDs or filters, the output includes information for all notify templates.</p> <p>If you specify a template ID that isn't valid, an error is returned.</p>

    Args:
        template_ids: <p>An array of template IDs to describe.</p>
        filters: <p>An array of NotifyTemplateFilter objects to filter the results on.</p>
        next_token: <p>The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.</p>
        max_results: <p>The maximum number of results to return per each request.</p>

    Raises:
        capo_pinpoint_sms_voice_v2.errors.access_denied_exception.AccessDeniedException: <p>The request was denied because you don't have sufficient permissions to access the resource.</p>
        capo_pinpoint_sms_voice_v2.errors.internal_server_exception.InternalServerException: <p>The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.</p>
        capo_pinpoint_sms_voice_v2.errors.resource_not_found_exception.ResourceNotFoundException: <p>A requested resource couldn't be found.</p>
        capo_pinpoint_sms_voice_v2.errors.throttling_exception.ThrottlingException: <p>An error that occurred because too many requests were sent during a certain amount of time.</p>
        capo_pinpoint_sms_voice_v2.errors.validation_exception.ValidationException: <p>A validation exception for a field.</p>
        capo_pinpoint_sms_voice_v2.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        DescribeNotifyTemplates
        Describe available notify templates for OTP verification over SMS.

        >>> client.describe_notify_templates(filters=[{'Name': 'template-type', 'Values': ['OTP_VERIFICATION']}, {'Name': 'channels', 'Values': ['SMS']}], max_results=10)
    """

    def _handler(
        req: "OperationRequest[capo_pinpoint_sms_voice_v2.types.describe_notify_templates_request.DescribeNotifyTemplatesRequest]",
    ) -> OperationResponse[
        "capo_pinpoint_sms_voice_v2.types.describe_notify_templates_result.DescribeNotifyTemplatesResult"
    ]:
        import capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.describe_notify_templates

        output, http_response = (
            capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.describe_notify_templates.describe_notify_templates(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeNotifyTemplates")
    )
    input_: capo_pinpoint_sms_voice_v2.types.describe_notify_templates_request.DescribeNotifyTemplatesRequest = {}
    if template_ids is not None:
        input_["template_ids"] = template_ids
    if filters is not None:
        input_["filters"] = filters
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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