Struct aws_sdk_ivs::client::fluent_builders::ListChannels

pub struct ListChannels<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to ListChannels.

Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException).

Implementations

impl<C, M, R> ListChannels<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<ListChannelsOutput, SdkError<ListChannelsError>> where
    R::Policy: SmithyRetryPolicy<ListChannelsInputOperationOutputAlias, ListChannelsOutput, ListChannelsError, ListChannelsInputOperationRetryAlias>, 

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 filter_by_name(self, inp: impl Into<String>) -> Self

Filters the channel list to match the specified name.

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

Filters the channel list to match the specified name.

pub fn filter_by_recording_configuration_arn(
    self,
    inp: impl Into<String>
) -> Self

Filters the channel list to match the specified recording-configuration ARN.

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

Filters the channel list to match the specified recording-configuration ARN.

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

The first channel to retrieve. This is used for pagination; see the nextToken response field.

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

The first channel to retrieve. This is used for pagination; see the nextToken response field.

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

Maximum number of channels to return. Default: 50.

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

Maximum number of channels to return. Default: 50.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for ListChannels<C, M, R>

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

Formats the value using the given formatter.