Struct ListServiceJobsInput

#[non_exhaustive]
pub struct ListServiceJobsInput {
    pub job_queue: Option<String>,
    pub job_status: Option<ServiceJobStatus>,
    pub max_results: Option<i32>,
    pub next_token: Option<String>,
    pub filters: Option<Vec<KeyValuesPair>>,
}

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_queue: Option<String>

The name or ARN of the job queue with which to list service jobs.

job_status: Option<ServiceJobStatus>

The job status with which to filter service jobs.

max_results: Option<i32>

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

next_token: Option<String>

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

filters: Option<Vec<KeyValuesPair>>

The filters to apply to the service job list query. The filter names and values can be:

• name: JOB_STATUS

  values: SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING | SUCCEEDED | FAILED | SCHEDULED

• name: JOB_NAME

  values: case-insensitive matches for the job name. If a filter value ends with an asterisk (*), it matches any job name that begins with the string before the '*'.

Implementations

impl ListServiceJobsInput

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

The name or ARN of the job queue with which to list service jobs.

pub fn job_status(&self) -> Option<&ServiceJobStatus>

The job status with which to filter service jobs.

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

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

pub fn filters(&self) -> &[KeyValuesPair]

The filters to apply to the service job list query. The filter names and values can be:

• name: JOB_STATUS

  values: SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING | SUCCEEDED | FAILED | SCHEDULED

• name: JOB_NAME

  values: case-insensitive matches for the job name. If a filter value ends with an asterisk (*), it matches any job name that begins with the string before the '*'.

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

impl ListServiceJobsInput

pub fn builder() -> ListServiceJobsInputBuilder

Creates a new builder-style object to manufacture ListServiceJobsInput.

Trait Implementations

impl Clone for ListServiceJobsInput

fn clone(&self) -> ListServiceJobsInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListServiceJobsInput

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

Formats the value using the given formatter.

impl PartialEq for ListServiceJobsInput

fn eq(&self, other: &ListServiceJobsInput) -> 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 ListServiceJobsInput