Struct aws_sdk_batch::input::DescribeJobQueuesInput

#[non_exhaustive]
pub struct DescribeJobQueuesInput {
    pub job_queues: Option<Vec<String>>,
    pub max_results: Option<i32>,
    pub next_token: Option<String>,
}

Contains the parameters for DescribeJobQueues.

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_queues: Option<Vec<String>>

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

max_results: Option<i32>

The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues 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 DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.

next_token: Option<String>

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

Implementations

impl DescribeJobQueuesInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<DescribeJobQueues, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<DescribeJobQueues>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture DescribeJobQueuesInput.

impl DescribeJobQueuesInput

pub fn job_queues(&self) -> Option<&[String]>

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

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

The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues 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 DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.

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

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

fn clone(&self) -> DescribeJobQueuesInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeJobQueuesInput

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

Formats the value using the given formatter.

impl PartialEq<DescribeJobQueuesInput> for DescribeJobQueuesInput

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for DescribeJobQueuesInput