You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::S3Control::Types::ListJobsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListJobsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  account_id: "AccountId", # required
  job_statuses: ["Active"], # accepts Active, Cancelled, Cancelling, Complete, Completing, Failed, Failing, New, Paused, Pausing, Preparing, Ready, Suspended
  next_token: "StringForNextToken",
  max_results: 1,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#account_id ⇒ String

Returns:

  • (String)

#job_statuses ⇒ Array<String>

The List Jobs request returns jobs that match the statuses listed in this element.

Returns:

  • (Array<String>) —

    The List Jobs request returns jobs that match the statuses listed in this element.

#max_results ⇒ Integer

The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are more jobs than this number, the response will include a pagination token in the NextToken field to enable you to retrieve the next page of results.

Returns:

  • (Integer) —

    The maximum number of jobs that Amazon S3 will include in the List Jobs response.

#next_token ⇒ String

A pagination token to request the next page of results. Use the token that Amazon S3 returned in the NextToken element of the ListJobsResult from the previous List Jobs request.

Returns:

  • (String) —

    A pagination token to request the next page of results.