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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb

Overview

Note:

When making an API call, you may pass ListJobsRequest data as a 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,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_idString

The Amazon Web Services account ID associated with the S3 Batch Operations job.

Returns:

  • (String)


3700
3701
3702
3703
3704
3705
3706
3707
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3700

class ListJobsRequest < Struct.new(
  :account_id,
  :job_statuses,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#job_statusesArray<String>

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

Returns:

  • (Array<String>)


3700
3701
3702
3703
3704
3705
3706
3707
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3700

class ListJobsRequest < Struct.new(
  :account_id,
  :job_statuses,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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)


3700
3701
3702
3703
3704
3705
3706
3707
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3700

class ListJobsRequest < Struct.new(
  :account_id,
  :job_statuses,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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)


3700
3701
3702
3703
3704
3705
3706
3707
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3700

class ListJobsRequest < Struct.new(
  :account_id,
  :job_statuses,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end