pinpointsmsvoicev2/aws.sdk.kotlin.services.pinpointsmsvoicev2/describeNotifyTemplates

describeNotifyTemplates

inline suspend fun PinpointSmsVoiceV2Client.describeNotifyTemplates(crossinline block: DescribeNotifyTemplatesRequest.Builder.() -> Unit): DescribeNotifyTemplatesResponse

Describes the specified notify templates or all notify templates in your account.

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.

If you specify a template ID that isn't valid, an error is returned.

Samples

import aws.sdk.kotlin.services.pinpointsmsvoicev2.model.NotifyTemplateFilter
import aws.sdk.kotlin.services.pinpointsmsvoicev2.model.NotifyTemplateFilterName

fun main() { 
   //sampleStart 
   // Describe available notify templates for OTP verification over SMS.
val resp = pinpointSmsVoiceV2Client.describeNotifyTemplates {
    filters = listOf<NotifyTemplateFilter>(
        NotifyTemplateFilter {
            name = NotifyTemplateFilterName.fromValue("template-type")
            values = listOf<String>(
                "OTP_VERIFICATION"
            )
        },
        NotifyTemplateFilter {
            name = NotifyTemplateFilterName.fromValue("channels")
            values = listOf<String>(
                "SMS"
            )
        }            
    )
    maxResults = 10
} 
   //sampleEnd
}