S3Control / Client / list_jobs

list_jobs#

S3Control.Client.list_jobs(**kwargs)#

Lists current S3 Batch Operations jobs as well as the 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.

Permissions

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

Related actions include:

See also: AWS API Documentation

Request Syntax

response = client.list_jobs(
    AccountId='string',
    JobStatuses=[
        'Active'|'Cancelled'|'Cancelling'|'Complete'|'Completing'|'Failed'|'Failing'|'New'|'Paused'|'Pausing'|'Preparing'|'Ready'|'Suspended',
    ],
    NextToken='string',
    MaxResults=123
)
Parameters:

  • AccountId (string) –

    [REQUIRED]

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

  • JobStatuses (list) –

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

    • (string) –

  • NextToken (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.

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

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Jobs': [
        {
            'JobId': 'string',
            'Description': 'string',
            'Operation': 'LambdaInvoke'|'S3PutObjectCopy'|'S3PutObjectAcl'|'S3PutObjectTagging'|'S3DeleteObjectTagging'|'S3InitiateRestoreObject'|'S3PutObjectLegalHold'|'S3PutObjectRetention'|'S3ReplicateObject',
            'Priority': 123,
            'Status': 'Active'|'Cancelled'|'Cancelling'|'Complete'|'Completing'|'Failed'|'Failing'|'New'|'Paused'|'Pausing'|'Preparing'|'Ready'|'Suspended',
            'CreationTime': datetime(2015, 1, 1),
            'TerminationDate': datetime(2015, 1, 1),
            'ProgressSummary': {
                'TotalNumberOfTasks': 123,
                'NumberOfTasksSucceeded': 123,
                'NumberOfTasksFailed': 123,
                'Timers': {
                    'ElapsedTimeInActiveSeconds': 123
                }
            }
        },
    ]
}

Response Structure

  • (dict) –

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

      • (dict) –

        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 (datetime) –

          A timestamp indicating when the specified job was created.

        • TerminationDate (datetime) –

          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 (dict) –

          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 (integer) –

          • NumberOfTasksSucceeded (integer) –

          • NumberOfTasksFailed (integer) –

          • Timers (dict) –

            The JobTimers attribute of a job’s progress summary.

            • ElapsedTimeInActiveSeconds (integer) –

              Indicates the elapsed time in seconds the job has been in the Active job state.

Exceptions

  • S3Control.Client.exceptions.InvalidRequestException

  • S3Control.Client.exceptions.InternalServiceException

  • S3Control.Client.exceptions.InvalidNextTokenException