aws_sdk_ivs/client/
list_stream_keys.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 [`ListStreamKeys`](crate::operation::list_stream_keys::builders::ListStreamKeysFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_stream_keys::builders::ListStreamKeysFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`channel_arn(impl Into<String>)`](crate::operation::list_stream_keys::builders::ListStreamKeysFluentBuilder::channel_arn) / [`set_channel_arn(Option<String>)`](crate::operation::list_stream_keys::builders::ListStreamKeysFluentBuilder::set_channel_arn):<br>required: **true**<br><p>Channel ARN used to filter the list.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_stream_keys::builders::ListStreamKeysFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_stream_keys::builders::ListStreamKeysFluentBuilder::set_next_token):<br>required: **false**<br><p>The first stream key to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_stream_keys::builders::ListStreamKeysFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_stream_keys::builders::ListStreamKeysFluentBuilder::set_max_results):<br>required: **false**<br><p>Maximum number of streamKeys to return. Default: 1.</p><br>
10    /// - On success, responds with [`ListStreamKeysOutput`](crate::operation::list_stream_keys::ListStreamKeysOutput) with field(s):
11    ///   - [`stream_keys(Vec::<StreamKeySummary>)`](crate::operation::list_stream_keys::ListStreamKeysOutput::stream_keys): <p>List of stream keys.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_stream_keys::ListStreamKeysOutput::next_token): <p>If there are more stream keys than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set.</p>
13    /// - On failure, responds with [`SdkError<ListStreamKeysError>`](crate::operation::list_stream_keys::ListStreamKeysError)
14    pub fn list_stream_keys(&self) -> crate::operation::list_stream_keys::builders::ListStreamKeysFluentBuilder {
15        crate::operation::list_stream_keys::builders::ListStreamKeysFluentBuilder::new(self.handle.clone())
16    }
17}