aws_sdk_mediaconnect/client/

list_gateway_instances.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListGatewayInstances`](crate::operation::list_gateway_instances::builders::ListGatewayInstancesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_gateway_instances::builders::ListGatewayInstancesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`filter_arn(impl Into<String>)`](crate::operation::list_gateway_instances::builders::ListGatewayInstancesFluentBuilder::filter_arn) / [`set_filter_arn(Option<String>)`](crate::operation::list_gateway_instances::builders::ListGatewayInstancesFluentBuilder::set_filter_arn):<br>required: **false**<br><p>Filter the list results to display only the instances associated with the selected Gateway ARN.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_gateway_instances::builders::ListGatewayInstancesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_gateway_instances::builders::ListGatewayInstancesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per API request.</p> <p>For example, you submit a ListInstances request with <code>MaxResults</code> set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a <code>NextToken</code> value that you can use to fetch the next batch of results.)</p> <p>The service might return fewer results than the <code>MaxResults</code> value. If <code>MaxResults</code> is not included in the request, the service defaults to pagination with a maximum of 10 results per page.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_gateway_instances::builders::ListGatewayInstancesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_gateway_instances::builders::ListGatewayInstancesFluentBuilder::set_next_token):<br>required: **false**<br><p>The token that identifies the batch of results that you want to see.</p> <p>For example, you submit a <code>ListInstances</code> request with <code>MaxResults</code> set at 5. The service returns the first batch of results (up to 5) and a <code>NextToken</code> value. To see the next batch of results, you can submit the <code>ListInstances</code> request a second time and specify the <code>NextToken</code> value.</p><br>
    /// - On success, responds with [`ListGatewayInstancesOutput`](crate::operation::list_gateway_instances::ListGatewayInstancesOutput) with field(s):
    ///   - [`instances(Option<Vec::<ListedGatewayInstance>>)`](crate::operation::list_gateway_instances::ListGatewayInstancesOutput::instances): <p>A list of instance summaries.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_gateway_instances::ListGatewayInstancesOutput::next_token): <p>The token that identifies the batch of results that you want to see.</p> <p>For example, you submit a <code>ListInstances</code> request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a <code>NextToken</code> value. To see the next batch of results, you can submit the <code>ListInstances</code> request a second time and specify the <code>NextToken</code> value.</p>
    /// - On failure, responds with [`SdkError<ListGatewayInstancesError>`](crate::operation::list_gateway_instances::ListGatewayInstancesError)
    pub fn list_gateway_instances(&self) -> crate::operation::list_gateway_instances::builders::ListGatewayInstancesFluentBuilder {
        crate::operation::list_gateway_instances::builders::ListGatewayInstancesFluentBuilder::new(self.handle.clone())
    }
}