list-jobs¶

Description¶

Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account making the request. For more information, see S3 Batch Operations in the Amazon Simple Storage Service User Guide .

Related actions include:

Synopsis¶

  list-jobs
--account-id <value>
[--job-statuses <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--account-id (string)

The AWS account ID associated with the S3 Batch Operations job.

--job-statuses (list)

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

(string)

Syntax:

"string" "string" ...

Where valid values are:
  Active
  Cancelled
  Cancelling
  Complete
  Completing
  Failed
  Failing
  New
  Paused
  Pausing
  Preparing
  Ready
  Suspended

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

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To list an accounts Amazon S3 batch operations jobs

The following list-jobs example lists all recent batch operations jobs for the specified account.

aws s3control list-jobs \
    --account-id 123456789012

Output:

{
    "Jobs": [
        {
            "Operation": "S3PutObjectTagging",
            "ProgressSummary": {
                "NumberOfTasksFailed": 0,
                "NumberOfTasksSucceeded": 8,
                "TotalNumberOfTasks": 8
            },
            "CreationTime": "2019-10-03T21:48:48.048Z",
            "Status": "Complete",
            "JobId": "93735294-df46-44d5-8638-6356f335324e",
            "Priority": 42
        },
        {
            "Operation": "S3PutObjectTagging",
            "ProgressSummary": {
                "NumberOfTasksFailed": 0,
                "NumberOfTasksSucceeded": 0,
                "TotalNumberOfTasks": 0
            },
            "CreationTime": "2019-10-03T21:46:07.084Z",
            "Status": "Failed",
            "JobId": "3f3c7619-02d3-4779-97f6-1d98dd313108",
            "Priority": 42
        },
    ]
}

Output¶

NextToken -> (string)

If the List Jobs request produced more than the maximum number of results, you can pass this value into a subsequent List Jobs request in order to retrieve the next page of results.

Jobs -> (list)

The list of current jobs and jobs that have ended within the last 30 days.

(structure)

Contains the configuration and status information for a single job retrieved as part of a job list.

JobId -> (string)

The ID for the specified job.

Description -> (string)

The user-specified description that was included in the specified job’s Create Job request.

Operation -> (string)

The operation that the specified job is configured to run on every object listed in the manifest.

Priority -> (integer)

The current priority for the specified job.

Status -> (string)

The specified job’s current status.

CreationTime -> (timestamp)

A timestamp indicating when the specified job was created.

TerminationDate -> (timestamp)

A timestamp indicating when the specified job terminated. A job’s termination date is the date and time when it succeeded, failed, or was canceled.

ProgressSummary -> (structure)

Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.

TotalNumberOfTasks -> (long)

NumberOfTasksSucceeded -> (long)

NumberOfTasksFailed -> (long)

Table of Contents

Feedback

User Guide