aws_sdk_medialive/client/list_channel_placement_groups.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 [`ListChannelPlacementGroups`](crate::operation::list_channel_placement_groups::builders::ListChannelPlacementGroupsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_channel_placement_groups::builders::ListChannelPlacementGroupsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`cluster_id(impl Into<String>)`](crate::operation::list_channel_placement_groups::builders::ListChannelPlacementGroupsFluentBuilder::cluster_id) / [`set_cluster_id(Option<String>)`](crate::operation::list_channel_placement_groups::builders::ListChannelPlacementGroupsFluentBuilder::set_cluster_id):<br>required: **true**<br>The ID of the cluster<br>
8 /// - [`max_results(i32)`](crate::operation::list_channel_placement_groups::builders::ListChannelPlacementGroupsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_channel_placement_groups::builders::ListChannelPlacementGroupsFluentBuilder::set_max_results):<br>required: **false**<br>The maximum number of items to return.<br>
9 /// - [`next_token(impl Into<String>)`](crate::operation::list_channel_placement_groups::builders::ListChannelPlacementGroupsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_channel_placement_groups::builders::ListChannelPlacementGroupsFluentBuilder::set_next_token):<br>required: **false**<br>The token to retrieve the next page of results.<br>
10 /// - On success, responds with [`ListChannelPlacementGroupsOutput`](crate::operation::list_channel_placement_groups::ListChannelPlacementGroupsOutput) with field(s):
11 /// - [`channel_placement_groups(Option<Vec::<DescribeChannelPlacementGroupSummary>>)`](crate::operation::list_channel_placement_groups::ListChannelPlacementGroupsOutput::channel_placement_groups): An array of ChannelPlacementGroups that exist in the Cluster.
12 /// - [`next_token(Option<String>)`](crate::operation::list_channel_placement_groups::ListChannelPlacementGroupsOutput::next_token): Token for the next result.
13 /// - On failure, responds with [`SdkError<ListChannelPlacementGroupsError>`](crate::operation::list_channel_placement_groups::ListChannelPlacementGroupsError)
14 pub fn list_channel_placement_groups(
15 &self,
16 ) -> crate::operation::list_channel_placement_groups::builders::ListChannelPlacementGroupsFluentBuilder {
17 crate::operation::list_channel_placement_groups::builders::ListChannelPlacementGroupsFluentBuilder::new(self.handle.clone())
18 }
19}