Lists current S3 Batch Operations jobs as well as the jobs that have ended within the last 90 days for the Amazon Web Services account making the request¶

Description¶

Lists current S3 Batch Operations jobs as well as the jobs that have ended within the last 90 days for the Amazon Web Services account making the request. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Permissions¶

To use the list_jobs operation, you must have permission to perform the s3:ListJobs action.

Related actions include:

Usage¶

s3control_list_jobs(AccountId, JobStatuses, NextToken, MaxResults)

Arguments¶

AccountId

[required] The Amazon Web Services account ID associated with the S3 Batch Operations job.
JobStatuses

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

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.
MaxResults

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.

Value¶

A list with the following syntax:

list(
  NextToken = "string",
  Jobs = list(
    list(
      JobId = "string",
      Description = "string",
      Operation = "LambdaInvoke"|"S3PutObjectCopy"|"S3PutObjectAcl"|"S3PutObjectTagging"|"S3DeleteObjectTagging"|"S3InitiateRestoreObject"|"S3PutObjectLegalHold"|"S3PutObjectRetention"|"S3ReplicateObject"|"S3ComputeObjectChecksum"|"S3UpdateObjectEncryption",
      Priority = 123,
      Status = "Active"|"Cancelled"|"Cancelling"|"Complete"|"Completing"|"Failed"|"Failing"|"New"|"Paused"|"Pausing"|"Preparing"|"Ready"|"Suspended",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      TerminationDate = as.POSIXct(
        "2015-01-01"
      ),
      ProgressSummary = list(
        TotalNumberOfTasks = 123,
        NumberOfTasksSucceeded = 123,
        NumberOfTasksFailed = 123,
        Timers = list(
          ElapsedTimeInActiveSeconds = 123
        )
      )
    )
  )
)

Request syntax¶

svc$list_jobs(
  AccountId = "string",
  JobStatuses = list(
    "Active"|"Cancelled"|"Cancelling"|"Complete"|"Completing"|"Failed"|"Failing"|"New"|"Paused"|"Pausing"|"Preparing"|"Ready"|"Suspended"
  ),
  NextToken = "string",
  MaxResults = 123
)