aws_sdk_pinpointsmsvoicev2/client/
describe_keywords.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 [`DescribeKeywords`](crate::operation::describe_keywords::builders::DescribeKeywordsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_keywords::builders::DescribeKeywordsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`origination_identity(impl Into<String>)`](crate::operation::describe_keywords::builders::DescribeKeywordsFluentBuilder::origination_identity) / [`set_origination_identity(Option<String>)`](crate::operation::describe_keywords::builders::DescribeKeywordsFluentBuilder::set_origination_identity):<br>required: **true**<br><p>The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use <code>DescribePhoneNumbers</code> to find the values for PhoneNumberId and PhoneNumberArn while <code>DescribeSenderIds</code> can be used to get the values for SenderId and SenderIdArn.</p><important>  <p>If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).</p> </important><br>
8    ///   - [`keywords(impl Into<String>)`](crate::operation::describe_keywords::builders::DescribeKeywordsFluentBuilder::keywords) / [`set_keywords(Option<Vec::<String>>)`](crate::operation::describe_keywords::builders::DescribeKeywordsFluentBuilder::set_keywords):<br>required: **false**<br><p>An array of keywords to search for.</p><br>
9    ///   - [`filters(KeywordFilter)`](crate::operation::describe_keywords::builders::DescribeKeywordsFluentBuilder::filters) / [`set_filters(Option<Vec::<KeywordFilter>>)`](crate::operation::describe_keywords::builders::DescribeKeywordsFluentBuilder::set_filters):<br>required: **false**<br><p>An array of keyword filters to filter the results.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_keywords::builders::DescribeKeywordsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_keywords::builders::DescribeKeywordsFluentBuilder::set_next_token):<br>required: **false**<br><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><br>
11    ///   - [`max_results(i32)`](crate::operation::describe_keywords::builders::DescribeKeywordsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_keywords::builders::DescribeKeywordsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per each request.</p><br>
12    /// - On success, responds with [`DescribeKeywordsOutput`](crate::operation::describe_keywords::DescribeKeywordsOutput) with field(s):
13    ///   - [`origination_identity_arn(Option<String>)`](crate::operation::describe_keywords::DescribeKeywordsOutput::origination_identity_arn): <p>The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.</p>
14    ///   - [`origination_identity(Option<String>)`](crate::operation::describe_keywords::DescribeKeywordsOutput::origination_identity): <p>The PhoneNumberId or PoolId that is associated with the OriginationIdentity.</p>
15    ///   - [`keywords(Option<Vec::<KeywordInformation>>)`](crate::operation::describe_keywords::DescribeKeywordsOutput::keywords): <p>An array of KeywordInformation objects that contain the results.</p>
16    ///   - [`next_token(Option<String>)`](crate::operation::describe_keywords::DescribeKeywordsOutput::next_token): <p>The token to be used for the next set of paginated results. If this field is empty then there are no more results.</p>
17    /// - On failure, responds with [`SdkError<DescribeKeywordsError>`](crate::operation::describe_keywords::DescribeKeywordsError)
18    pub fn describe_keywords(&self) -> crate::operation::describe_keywords::builders::DescribeKeywordsFluentBuilder {
19        crate::operation::describe_keywords::builders::DescribeKeywordsFluentBuilder::new(self.handle.clone())
20    }
21}
aws_sdk_pinpointsmsvoicev2/client/describe_keywords.rs

aws_sdk_pinpointsmsvoicev2/client/
describe_keywords.rs
