Struct DescribeJobDefinitionsInput

#[non_exhaustive]
pub struct DescribeJobDefinitionsInput {
    pub job_definitions: Option<Vec<String>>,
    pub max_results: Option<i32>,
    pub job_definition_name: Option<String>,
    pub status: Option<String>,
    pub next_token: Option<String>,
}

Contains the parameters for DescribeJobDefinitions.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

job_definitions: Option<Vec<String>>

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}. This parameter can't be used with other parameters.

max_results: Option<i32>

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.

job_definition_name: Option<String>

The name of the job definition to describe.

status: Option<String>

The status used to filter job definitions.

next_token: Option<String>

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.

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

Implementations

impl DescribeJobDefinitionsInput

pub fn job_definitions(&self) -> &[String]

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}. This parameter can't be used with other parameters.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .job_definitions.is_none().

pub fn max_results(&self) -> Option<i32>

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.

pub fn job_definition_name(&self) -> Option<&str>

The name of the job definition to describe.

pub fn status(&self) -> Option<&str>

The status used to filter job definitions.

pub fn next_token(&self) -> Option<&str>

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.

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

impl DescribeJobDefinitionsInput

pub fn builder() -> DescribeJobDefinitionsInputBuilder

Creates a new builder-style object to manufacture DescribeJobDefinitionsInput.

Trait Implementations

impl Clone for DescribeJobDefinitionsInput

fn clone(&self) -> DescribeJobDefinitionsInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeJobDefinitionsInput

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

Formats the value using the given formatter.

impl PartialEq for DescribeJobDefinitionsInput

fn eq(&self, other: &DescribeJobDefinitionsInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DescribeJobDefinitionsInput