Struct aws_sdk_chime::operation::list_channels::builders::ListChannelsFluentBuilder

pub struct ListChannelsFluentBuilder { /* private fields */ }

👎Deprecated: Replaced by ListChannels in the Amazon Chime SDK Messaging Namespace

Fluent builder constructing a request to ListChannels.

Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.

Functionality & restrictions

• Use privacy = PUBLIC to retrieve all public channels in the account.

• Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannels, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Implementations

impl ListChannelsFluentBuilder

pub fn as_input(&self) -> &ListChannelsInputBuilder

Access the ListChannels as a reference.

pub async fn send( self ) -> Result<ListChannelsOutput, SdkError<ListChannelsError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<ListChannelsOutput, ListChannelsError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn into_paginator(self) -> ListChannelsPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a PaginationStream.

pub fn app_instance_arn(self, input: impl Into<String>) -> Self

The ARN of the AppInstance.

pub fn set_app_instance_arn(self, input: Option<String>) -> Self

The ARN of the AppInstance.

pub fn get_app_instance_arn(&self) -> &Option<String>

The ARN of the AppInstance.

pub fn privacy(self, input: ChannelPrivacy) -> Self

The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.

pub fn set_privacy(self, input: Option<ChannelPrivacy>) -> Self

The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.

pub fn get_privacy(&self) -> &Option<ChannelPrivacy>

The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.

pub fn max_results(self, input: i32) -> Self

The maximum number of channels that you want to return.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of channels that you want to return.

pub fn get_max_results(&self) -> &Option<i32>

The maximum number of channels that you want to return.

pub fn next_token(self, input: impl Into<String>) -> Self

The token passed by previous API calls until all requested channels are returned.

pub fn set_next_token(self, input: Option<String>) -> Self

The token passed by previous API calls until all requested channels are returned.

pub fn get_next_token(&self) -> &Option<String>

The token passed by previous API calls until all requested channels are returned.

pub fn chime_bearer(self, input: impl Into<String>) -> Self

The AppInstanceUserArn of the user that makes the API call.

pub fn set_chime_bearer(self, input: Option<String>) -> Self

The AppInstanceUserArn of the user that makes the API call.

pub fn get_chime_bearer(&self) -> &Option<String>

The AppInstanceUserArn of the user that makes the API call.

Trait Implementations

impl Clone for ListChannelsFluentBuilder

fn clone(&self) -> ListChannelsFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListChannelsFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.