aws_sdk_pinpoint/client/
list_templates.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`ListTemplates`](crate::operation::list_templates::builders::ListTemplatesFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`next_token(impl Into<String>)`](crate::operation::list_templates::builders::ListTemplatesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_templates::builders::ListTemplatesFluentBuilder::set_next_token):<br>required: **false**<br><p>The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p><br>
7    ///   - [`page_size(impl Into<String>)`](crate::operation::list_templates::builders::ListTemplatesFluentBuilder::page_size) / [`set_page_size(Option<String>)`](crate::operation::list_templates::builders::ListTemplatesFluentBuilder::set_page_size):<br>required: **false**<br><p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p><br>
8    ///   - [`prefix(impl Into<String>)`](crate::operation::list_templates::builders::ListTemplatesFluentBuilder::prefix) / [`set_prefix(Option<String>)`](crate::operation::list_templates::builders::ListTemplatesFluentBuilder::set_prefix):<br>required: **false**<br><p>The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.</p><br>
9    ///   - [`template_type(impl Into<String>)`](crate::operation::list_templates::builders::ListTemplatesFluentBuilder::template_type) / [`set_template_type(Option<String>)`](crate::operation::list_templates::builders::ListTemplatesFluentBuilder::set_template_type):<br>required: **false**<br><p>The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.</p><br>
10    /// - On success, responds with [`ListTemplatesOutput`](crate::operation::list_templates::ListTemplatesOutput) with field(s):
11    ///   - [`templates_response(Option<TemplatesResponse>)`](crate::operation::list_templates::ListTemplatesOutput::templates_response): <p>Provides information about all the message templates that are associated with your Amazon Pinpoint account.</p>
12    /// - On failure, responds with [`SdkError<ListTemplatesError>`](crate::operation::list_templates::ListTemplatesError)
13    pub fn list_templates(&self) -> crate::operation::list_templates::builders::ListTemplatesFluentBuilder {
14        crate::operation::list_templates::builders::ListTemplatesFluentBuilder::new(self.handle.clone())
15    }
16}