Struct aws_sdk_opsworks::client::fluent_builders::DescribeEcsClusters

pub struct DescribeEcsClusters { /* private fields */ }

Fluent builder constructing a request to DescribeEcsClusters.

Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the MaxResults and NextToken parameters to paginate the response. However, AWS OpsWorks Stacks currently supports only one cluster per layer, so the result set has a maximum of one element.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information about user permissions, see Managing User Permissions.

This call accepts only one resource-identifying parameter.

Implementations

impl DescribeEcsClusters

pub async fn send(
    self
) -> Result<DescribeEcsClustersOutput, SdkError<DescribeEcsClustersError>>

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 into_paginator(self) -> DescribeEcsClustersPaginator

Create a paginator for this request

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

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

Appends an item to EcsClusterArns.

To override the contents of this collection use set_ecs_cluster_arns.

A list of ARNs, one for each cluster to be described.

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

A list of ARNs, one for each cluster to be described.

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

A stack ID. DescribeEcsClusters returns a description of the cluster that is registered with the stack.

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

A stack ID. DescribeEcsClusters returns a description of the cluster that is registered with the stack.

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

If the previous paginated request did not return all of the remaining results, the response object'sNextToken parameter value is set to a token. To retrieve the next set of results, call DescribeEcsClusters again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

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

If the previous paginated request did not return all of the remaining results, the response object'sNextToken parameter value is set to a token. To retrieve the next set of results, call DescribeEcsClusters again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

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

To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

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

To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

Trait Implementations

impl Clone for DescribeEcsClusters

fn clone(&self) -> DescribeEcsClusters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeEcsClusters

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

Formats the value using the given formatter.