Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the Amazon Web Services account making the request. For more information, see S3 Batch Operations in the Amazon S3 User Guide .
Related actions include:
See also: AWS API Documentation
list-jobs
--account-id <value>
[--job-statuses <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--account-id
(string)
The Amazon Web Services 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 theListJobsResult
from the previousList 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 theNextToken
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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command’s default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination.
--output
(string)
The formatting style for command output.
json
text
table
yaml
yaml-stream
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
on
off
auto
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format
(string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb://
will always be treated as binary and use the file contents directly regardless of the cli-binary-format
setting. When using file://
the file contents will need to properly formatted for the configured cli-binary-format
.
base64
raw-in-base64-out
--no-cli-pager
(boolean)
Disable cli pager for output.
--cli-auto-prompt
(boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)
Disable automatically prompt for CLI input parameters.
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
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
},
]
}
NextToken -> (string)
If the
List Jobs
request produced more than the maximum number of results, you can pass this value into a subsequentList 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)
Timers -> (structure)
The JobTimers attribute of a job’s progress summary.
ElapsedTimeInActiveSeconds -> (long)
Indicates the elapsed time in seconds the job has been in the Active job state.