describe-job¶

Description¶

Retrieves the configuration parameters and status for a Batch Operations job. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.

Related actions include:

CreateJob
ListJobs
UpdateJobPriority
UpdateJobStatus

Synopsis¶

  describe-job
--account-id <value>
--job-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--account-id (string)

--job-id (string)

The ID for the job whose information you want to retrieve.

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To describe an Amazon S3 batch operations job

The following describe-job provides configuration parameters and status for the specified batch operations job.

aws s3control describe-job \
    --account-id 123456789012 \
    --job-id 93735294-df46-44d5-8638-6356f335324e

Output:

{
    "Job": {
        "TerminationDate": "2019-10-03T21:49:53.944Z",
        "JobId": "93735294-df46-44d5-8638-6356f335324e",
        "FailureReasons": [],
        "Manifest": {
            "Spec": {
                "Fields": [
                    "Bucket",
                    "Key"
                ],
                "Format": "S3BatchOperations_CSV_20180820"
            },
            "Location": {
                "ETag": "69f52a4e9f797e987155d9c8f5880897",
                "ObjectArn": "arn:aws:s3:::employee-records-logs/inv-report/7a6a9be4-072c-407e-85a2-ec3e982f773e.csv"
            }
        },
        "Operation": {
            "S3PutObjectTagging": {
                "TagSet": [
                    {
                        "Value": "true",
                        "Key": "confidential"
                    }
                ]
            }
        },
        "RoleArn": "arn:aws:iam::123456789012:role/S3BatchJobRole",
        "ProgressSummary": {
            "TotalNumberOfTasks": 8,
            "NumberOfTasksFailed": 0,
            "NumberOfTasksSucceeded": 8
        },
        "Priority": 42,
        "Report": {
            "ReportScope": "AllTasks",
            "Format": "Report_CSV_20180820",
            "Enabled": true,
            "Prefix": "batch-op-create-job",
            "Bucket": "arn:aws:s3:::employee-records-logs"
        },
        "JobArn": "arn:aws:s3:us-west-2:123456789012:job/93735294-df46-44d5-8638-6356f335324e",
        "CreationTime": "2019-10-03T21:48:48.048Z",
        "Status": "Complete"
    }
}

Output¶

Job -> (structure)

Contains the configuration parameters and status for the job specified in the Describe Job request.

JobId -> (string)

The ID for the specified job.

ConfirmationRequired -> (boolean)

Indicates whether confirmation is required before Amazon S3 begins running the specified job. Confirmation is required only for jobs created through the Amazon S3 console.

Description -> (string)

The description for this job, if one was provided in this job’s Create Job request.

JobArn -> (string)

The Amazon Resource Name (ARN) for this job.

Status -> (string)

The current status of the specified job.

Manifest -> (structure)

The configuration information for the specified job’s manifest object.

Spec -> (structure)

Describes the format of the specified job’s manifest. If the manifest is in CSV format, also describes the columns contained within the manifest.

Format -> (string)

Indicates which of the available formats the specified manifest uses.

Fields -> (list)

If the specified manifest object is in the S3BatchOperations_CSV_20180820 format, this element describes which columns contain the required data.

(string)

Location -> (structure)

Contains the information required to locate the specified job’s manifest.

ObjectArn -> (string)

The Amazon Resource Name (ARN) for a manifest object.

ObjectVersionId -> (string)

The optional version ID to identify a specific version of the manifest object.

ETag -> (string)

The ETag for the specified manifest object.

Operation -> (structure)

The operation that the specified job is configured to execute on the objects listed in the manifest.

LambdaInvoke -> (structure)

Directs the specified job to invoke an AWS Lambda function on each object in the manifest.

FunctionArn -> (string)

The Amazon Resource Name (ARN) for the AWS Lambda function that the specified job will invoke for each object in the manifest.

S3PutObjectCopy -> (structure)

Directs the specified job to execute a PUT Copy object call on each object in the manifest.

TargetResource -> (string)

CannedAccessControlList -> (string)

AccessControlGrants -> (list)

(structure)

Grantee -> (structure)

TypeIdentifier -> (string)

Identifier -> (string)

DisplayName -> (string)

Permission -> (string)

MetadataDirective -> (string)

ModifiedSinceConstraint -> (timestamp)

NewObjectMetadata -> (structure)

CacheControl -> (string)

ContentDisposition -> (string)

ContentEncoding -> (string)

ContentLanguage -> (string)

UserMetadata -> (map)

key -> (string)

value -> (string)

ContentLength -> (long)

ContentMD5 -> (string)

ContentType -> (string)

HttpExpiresDate -> (timestamp)

RequesterCharged -> (boolean)

SSEAlgorithm -> (string)

NewObjectTagging -> (list)

(structure)

Key -> (string)

Value -> (string)

RedirectLocation -> (string)

RequesterPays -> (boolean)

StorageClass -> (string)

UnModifiedSinceConstraint -> (timestamp)

SSEAwsKmsKeyId -> (string)

TargetKeyPrefix -> (string)

ObjectLockLegalHoldStatus -> (string)

The Legal Hold status to be applied to all objects in the Batch Operations job.

ObjectLockMode -> (string)

The Retention mode to be applied to all objects in the Batch Operations job.

ObjectLockRetainUntilDate -> (timestamp)

The date when the applied Object Retention configuration will expire on all objects in the Batch Operations job.

S3PutObjectAcl -> (structure)

Directs the specified job to execute a PUT Object acl call on each object in the manifest.

AccessControlPolicy -> (structure)

AccessControlList -> (structure)

Owner -> (structure)

ID -> (string)

DisplayName -> (string)

Grants -> (list)

(structure)

Grantee -> (structure)

TypeIdentifier -> (string)

Identifier -> (string)

DisplayName -> (string)

Permission -> (string)

CannedAccessControlList -> (string)

S3PutObjectTagging -> (structure)

Directs the specified job to execute a PUT Object tagging call on each object in the manifest.

TagSet -> (list)

(structure)

Key -> (string)

Value -> (string)

S3InitiateRestoreObject -> (structure)

Directs the specified job to execute an Initiate Glacier Restore call on each object in the manifest.

ExpirationInDays -> (integer)

GlacierJobTier -> (string)

S3PutObjectLegalHold -> (structure)

Contains the configuration parameters for a Set Object Legal Hold operation. Amazon S3 Batch Operations passes each value through to the underlying PUT Object Legal Hold API. For more information about the parameters for this operation, see PUT Object Legal Hold .

LegalHold -> (structure)

The Legal Hold contains the status to be applied to all objects in the Batch Operations job.

Status -> (string)

The Legal Hold status to be applied to all objects in the Batch Operations job.

S3PutObjectRetention -> (structure)

Contains the configuration parameters for a Set Object Retention operation. Amazon S3 Batch Operations passes each value through to the underlying PUT Object Retention API. For more information about the parameters for this operation, see PUT Object Retention .

BypassGovernanceRetention -> (boolean)

Indicates if the operation should be applied to objects in the Batch Operations job even if they have Governance-type Object Lock in place.

Retention -> (structure)

Amazon S3 object lock Retention contains the retention mode to be applied to all objects in the Batch Operations job.

RetainUntilDate -> (timestamp)

The date when the applied Object Retention will expire on all objects in the Batch Operations job.

Mode -> (string)

The Retention mode to be applied to all objects in the Batch Operations job.

Priority -> (integer)

The priority of the specified job.

ProgressSummary -> (structure)

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

TotalNumberOfTasks -> (long)

NumberOfTasksSucceeded -> (long)

NumberOfTasksFailed -> (long)

StatusUpdateReason -> (string)

FailureReasons -> (list)

If the specified job failed, this field contains information describing the failure.

(structure)

If this job failed, this element indicates why the job failed.

FailureCode -> (string)

The failure code, if any, for the specified job.

FailureReason -> (string)

The failure reason, if any, for the specified job.

Report -> (structure)

Contains the configuration information for the job-completion report if you requested one in the Create Job request.

Bucket -> (string)

The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

Format -> (string)

The format of the specified job-completion report.

Enabled -> (boolean)

Indicates whether the specified job will generate a job-completion report.

Prefix -> (string)

An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 will store the job-completion report at <prefix>/job-<job-id>/report.json.

ReportScope -> (string)

Indicates whether the job-completion report will include details of all tasks or only failed tasks.

CreationTime -> (timestamp)

A timestamp indicating when this job was created.

TerminationDate -> (timestamp)

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

RoleArn -> (string)

The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to execute the tasks for this job.

SuspendedDate -> (timestamp)

The timestamp when this job was suspended, if it has been suspended.

SuspendedCause -> (string)

The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters the Suspended state to await confirmation before running. After you confirm the job, it automatically exits the Suspended state.

Table of Contents

Feedback

User Guide