Struct aws_sdk_batch::client::fluent_builders::DescribeComputeEnvironments

pub struct DescribeComputeEnvironments { /* private fields */ }

Fluent builder constructing a request to DescribeComputeEnvironments.

Describes one or more of your compute environments.

If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances into.

Implementations

impl DescribeComputeEnvironments

pub async fn send(
    self
) -> Result<DescribeComputeEnvironmentsOutput, SdkError<DescribeComputeEnvironmentsError>>

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) -> DescribeComputeEnvironmentsPaginator

Create a paginator for this request

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

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

Appends an item to computeEnvironments.

To override the contents of this collection use set_compute_environments.

A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.

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

A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.

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

The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output. When this parameter is used, DescribeComputeEnvironments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeComputeEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeComputeEnvironments returns up to 100 results and a nextToken value if applicable.

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

The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output. When this parameter is used, DescribeComputeEnvironments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeComputeEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeComputeEnvironments returns up to 100 results and a nextToken value if applicable.

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

The nextToken value returned from a previous paginated DescribeComputeEnvironments request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

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

The nextToken value returned from a previous paginated DescribeComputeEnvironments request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

Trait Implementations

impl Clone for DescribeComputeEnvironments

fn clone(&self) -> DescribeComputeEnvironments

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeComputeEnvironments

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

Formats the value using the given formatter.