Struct aws_sdk_batch::client::fluent_builders::DescribeJobDefinitions

source · [−]

pub struct DescribeJobDefinitions<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Expand description

Fluent builder constructing a request to DescribeJobDefinitions.

Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status.

Implementations

source

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

source

pub async fn send(
self
) -> Result<DescribeJobDefinitionsOutput, SdkError<DescribeJobDefinitionsError>> where
R::Policy: SmithyRetryPolicy<DescribeJobDefinitionsInputOperationOutputAlias, DescribeJobDefinitionsOutput, DescribeJobDefinitionsError, DescribeJobDefinitionsInputOperationRetryAlias>,

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.

source

pub fn into_paginator(self) -> DescribeJobDefinitionsPaginator<C, M, R>

Create a paginator for this request

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

source

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

Appends an item to jobDefinitions.

To override the contents of this collection use set_job_definitions.

A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} or a short version using the form ${JobDefinitionName}:${Revision}.

source

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

A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} or a short version using the form ${JobDefinitionName}:${Revision}.

source

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

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

source

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

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

source

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

The name of the job definition to describe.

source

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

The name of the job definition to describe.

source

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

The status used to filter job definitions.

source

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

The status used to filter job definitions.

source

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

The nextToken value returned from a previous paginated DescribeJobDefinitions 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.

source

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

The nextToken value returned from a previous paginated DescribeJobDefinitions 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.