Skip to content
AWS for Query.Farm

aws.s3control.describe_job

Example SQL Queries

SELECT * FROM
aws.s3control.describe_job
WHERE
"account_id" = 'VALUE'
AND "job_id" = 'VALUE';

Description

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

Permissions

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

Related actions include:

Table Definition

Column NameColumn Data Type
account_id Required Input Column

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

VARCHAR
job_id Required Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

job

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

STRUCT(
    "job_id" VARCHAR,
    "confirmation_required" BOOLEAN,
    "description" VARCHAR,
    "job_arn" VARCHAR,
    "status" VARCHAR,
    "manifest" STRUCT(
        "spec" STRUCT(
            "format" VARCHAR,
            "fields" VARCHAR[]
        ),
        "location" STRUCT(
            "object_arn" VARCHAR,
            "object_version_id" VARCHAR,
            "e_tag" VARCHAR
        )
    ),
    "operation" STRUCT(
        "lambda_invoke" STRUCT(
            "function_arn" VARCHAR,
            "invocation_schema_version" VARCHAR,
            "user_arguments" MAP(VARCHAR, VARCHAR)
        ),
        "s3_put_object_copy" STRUCT(
            "target_resource" VARCHAR,
            "canned_access_control_list" VARCHAR,
            "access_control_grants" STRUCT(
                "grantee" STRUCT(
                    "type_identifier" VARCHAR,
                    "identifier" VARCHAR,
                    "display_name" VARCHAR
                ),
                "permission" VARCHAR
            )[],
            "metadata_directive" VARCHAR,
            "modified_since_constraint" TIMESTAMP_S,
            "new_object_metadata" STRUCT(
                "cache_control" VARCHAR,
                "content_disposition" VARCHAR,
                "content_encoding" VARCHAR,
                "content_language" VARCHAR,
                "user_metadata" MAP(VARCHAR, VARCHAR),
                "content_length" BIGINT,
                "content_md5" VARCHAR,
                "content_type" VARCHAR,
                "http_expires_date" TIMESTAMP_S,
                "requester_charged" BOOLEAN,
                "sse_algorithm" VARCHAR
            ),
            "new_object_tagging" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[],
            "redirect_location" VARCHAR,
            "requester_pays" BOOLEAN,
            "storage_class" VARCHAR,
            "un_modified_since_constraint" TIMESTAMP_S,
            "sse_aws_kms_key_id" VARCHAR,
            "target_key_prefix" VARCHAR,
            "object_lock_legal_hold_status" VARCHAR,
            "object_lock_mode" VARCHAR,
            "object_lock_retain_until_date" TIMESTAMP_S,
            "bucket_key_enabled" BOOLEAN,
            "checksum_algorithm" VARCHAR
        ),
        "s3_put_object_acl" STRUCT(
            "access_control_policy" STRUCT(
                "access_control_list" STRUCT(
                    "owner" STRUCT(
                        "id" VARCHAR,
                        "display_name" VARCHAR
                    ),
                    "grants" STRUCT(
                        "grantee" STRUCT(
                            "type_identifier" VARCHAR,
                            "identifier" VARCHAR,
                            "display_name" VARCHAR
                        ),
                        "permission" VARCHAR
                    )[]
                ),
                "canned_access_control_list" VARCHAR
            )
        ),
        "s3_put_object_tagging" STRUCT(
            "tag_set" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        ),
        "s3_delete_object_tagging" BOOLEAN,
        "s3_initiate_restore_object" STRUCT(
            "expiration_in_days" BIGINT,
            "glacier_job_tier" VARCHAR
        ),
        "s3_put_object_legal_hold" STRUCT(
            "legal_hold" STRUCT(
                "status" VARCHAR
            )
        ),
        "s3_put_object_retention" STRUCT(
            "bypass_governance_retention" BOOLEAN,
            "retention" STRUCT(
                "retain_until_date" TIMESTAMP_S,
                "mode" VARCHAR
            )
        ),
        "s3_replicate_object" BOOLEAN
    ),
    "priority" BIGINT,
    "progress_summary" STRUCT(
        "total_number_of_tasks" BIGINT,
        "number_of_tasks_succeeded" BIGINT,
        "number_of_tasks_failed" BIGINT,
        "timers" STRUCT(
            "elapsed_time_in_active_seconds" BIGINT
        )
    ),
    "status_update_reason" VARCHAR,
    "failure_reasons" STRUCT(
        "failure_code" VARCHAR,
        "failure_reason" VARCHAR
    )[],
    "report" STRUCT(
        "bucket" VARCHAR,
        "format" VARCHAR,
        "enabled" BOOLEAN,
        "prefix" VARCHAR,
        "report_scope" VARCHAR
    ),
    "creation_time" TIMESTAMP_S,
    "termination_date" TIMESTAMP_S,
    "role_arn" VARCHAR,
    "suspended_date" TIMESTAMP_S,
    "suspended_cause" VARCHAR,
    "manifest_generator" STRUCT(
        "s3_job_manifest_generator" STRUCT(
            "expected_bucket_owner" VARCHAR,
            "source_bucket" VARCHAR,
            "manifest_output_location" STRUCT(
                "expected_manifest_bucket_owner" VARCHAR,
                "bucket" VARCHAR,
                "manifest_prefix" VARCHAR,
                "manifest_encryption" STRUCT(
                    "sses3" BOOLEAN,
                    "ssekms" STRUCT(
                        "key_id" VARCHAR
                    )
                ),
                "manifest_format" VARCHAR
            ),
            "filter" STRUCT(
                "eligible_for_replication" BOOLEAN,
                "created_after" TIMESTAMP_S,
                "created_before" TIMESTAMP_S,
                "object_replication_statuses" VARCHAR[],
                "key_name_constraint" STRUCT(
                    "match_any_prefix" VARCHAR[],
                    "match_any_suffix" VARCHAR[],
                    "match_any_substring" VARCHAR[]
                ),
                "object_size_greater_than_bytes" BIGINT,
                "object_size_less_than_bytes" BIGINT,
                "match_any_storage_class" VARCHAR[]
            ),
            "enable_manifest_output" BOOLEAN
        )
    ),
    "generated_manifest_descriptor" STRUCT(
        "format" VARCHAR,
        "location" STRUCT(
            "object_arn" VARCHAR,
            "object_version_id" VARCHAR,
            "e_tag" VARCHAR
        )
    )
)
Show child fields
job.confirmation_required

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.

job.creation_time

A timestamp indicating when this job was created.

job.description

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

job.failure_reasons[]
Show child fields
job.failure_reasons[].failure_code

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

job.failure_reasons[].failure_reason

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

job.generated_manifest_descriptor

The attribute of the JobDescriptor containing details about the job's generated manifest.

Show child fields
job.generated_manifest_descriptor.format

The format of the generated manifest.

job.generated_manifest_descriptor.location

Contains the information required to locate a manifest object. Manifests can't be imported from directory buckets. For more information, see Directory buckets.

Show child fields
job.generated_manifest_descriptor.location.e_tag

The ETag for the specified manifest object.

job.generated_manifest_descriptor.location.object_arn

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

When you're using XML requests, you must replace special characters (such as carriage returns) in object keys with their equivalent XML entity codes. For more information, see XML-related object key constraints in the Amazon S3 User Guide.

job.generated_manifest_descriptor.location.object_version_id

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

job.job_arn

The Amazon Resource Name (ARN) for this job.

job.job_id

The ID for the specified job.

job.manifest

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

Show child fields
job.manifest.location

Contains the information required to locate the specified job's manifest. Manifests can't be imported from directory buckets. For more information, see Directory buckets.

Show child fields
job.manifest.location.e_tag

The ETag for the specified manifest object.

job.manifest.location.object_arn

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

When you're using XML requests, you must replace special characters (such as carriage returns) in object keys with their equivalent XML entity codes. For more information, see XML-related object key constraints in the Amazon S3 User Guide.

job.manifest.location.object_version_id

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

job.manifest.spec

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

Show child fields
job.manifest.spec.fields[]
job.manifest.spec.format

Indicates which of the available formats the specified manifest uses.

job.manifest_generator

The manifest generator that was used to generate a job manifest for this job.

Show child fields
job.manifest_generator.s3_job_manifest_generator

The S3 job ManifestGenerator's configuration details.

Show child fields
job.manifest_generator.s3_job_manifest_generator.enable_manifest_output

Determines whether or not to write the job's generated manifest to a bucket.

job.manifest_generator.s3_job_manifest_generator.expected_bucket_owner

The Amazon Web Services account ID that owns the bucket the generated manifest is written to. If provided the generated manifest bucket's owner Amazon Web Services account ID must match this value, else the job fails.

job.manifest_generator.s3_job_manifest_generator.filter

Specifies rules the S3JobManifestGenerator should use to decide whether an object in the source bucket should or should not be included in the generated job manifest.

Show child fields
job.manifest_generator.s3_job_manifest_generator.filter.created_after

If provided, the generated manifest includes only source bucket objects that were created after this time.

job.manifest_generator.s3_job_manifest_generator.filter.created_before

If provided, the generated manifest includes only source bucket objects that were created before this time.

job.manifest_generator.s3_job_manifest_generator.filter.eligible_for_replication

Include objects in the generated manifest only if they are eligible for replication according to the Replication configuration on the source bucket.

job.manifest_generator.s3_job_manifest_generator.filter.key_name_constraint

If provided, the generated manifest includes only source bucket objects whose object keys match the string constraints specified for MatchAnyPrefix, MatchAnySuffix, and MatchAnySubstring.

Show child fields
job.manifest_generator.s3_job_manifest_generator.filter.key_name_constraint.match_any_prefix[]
job.manifest_generator.s3_job_manifest_generator.filter.key_name_constraint.match_any_substring[]
job.manifest_generator.s3_job_manifest_generator.filter.key_name_constraint.match_any_suffix[]
job.manifest_generator.s3_job_manifest_generator.filter.match_any_storage_class[]
job.manifest_generator.s3_job_manifest_generator.filter.object_replication_statuses[]
job.manifest_generator.s3_job_manifest_generator.filter.object_size_greater_than_bytes

If provided, the generated manifest includes only source bucket objects whose file size is greater than the specified number of bytes.

job.manifest_generator.s3_job_manifest_generator.filter.object_size_less_than_bytes

If provided, the generated manifest includes only source bucket objects whose file size is less than the specified number of bytes.

job.manifest_generator.s3_job_manifest_generator.manifest_output_location

Specifies the location the generated manifest will be written to. Manifests can't be written to directory buckets. For more information, see Directory buckets.

Show child fields
job.manifest_generator.s3_job_manifest_generator.manifest_output_location.bucket

The bucket ARN the generated manifest should be written to.

Directory buckets - Directory buckets aren't supported as the buckets to store the generated manifest.

job.manifest_generator.s3_job_manifest_generator.manifest_output_location.expected_manifest_bucket_owner

The Account ID that owns the bucket the generated manifest is written to.

job.manifest_generator.s3_job_manifest_generator.manifest_output_location.manifest_encryption

Specifies what encryption should be used when the generated manifest objects are written.

Show child fields
job.manifest_generator.s3_job_manifest_generator.manifest_output_location.manifest_encryption.ssekms

Configuration details on how SSE-KMS is used to encrypt generated manifest objects.

Show child fields
job.manifest_generator.s3_job_manifest_generator.manifest_output_location.manifest_encryption.ssekms.key_id

Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption customer managed key to use for encrypting generated manifest objects.

job.manifest_generator.s3_job_manifest_generator.manifest_output_location.manifest_encryption.sses3

Specifies the use of SSE-S3 to encrypt generated manifest objects.

job.manifest_generator.s3_job_manifest_generator.manifest_output_location.manifest_format

The format of the generated manifest.

job.manifest_generator.s3_job_manifest_generator.manifest_output_location.manifest_prefix

Prefix identifying one or more objects to which the manifest applies.

job.manifest_generator.s3_job_manifest_generator.source_bucket

The source bucket used by the ManifestGenerator.

Directory buckets - Directory buckets aren't supported as the source buckets used by S3JobManifestGenerator to generate the job manifest.

job.operation

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

Show child fields
job.operation.lambda_invoke

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

Show child fields
job.operation.lambda_invoke.function_arn

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

job.operation.lambda_invoke.invocation_schema_version

Specifies the schema version for the payload that Batch Operations sends when invoking an Lambda function. Version 1.0 is the default. Version 2.0 is required when you use Batch Operations to invoke Lambda functions that act on directory buckets, or if you need to specify UserArguments. For more information, see Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and Lambda in the Amazon Web Services Storage Blog.

Ensure that your Lambda function code expects InvocationSchemaVersion 2.0 and uses bucket name rather than bucket ARN. If the InvocationSchemaVersion does not match what your Lambda function expects, your function might not work as expected.

Directory buckets - To initiate Amazon Web Services Lambda function to perform custom actions on objects in directory buckets, you must specify 2.0.

job.operation.lambda_invoke.user_arguments

Key-value pairs that are passed in the payload that Batch Operations sends when invoking an Lambda function. You must specify InvocationSchemaVersion 2.0 for LambdaInvoke operations that include UserArguments. For more information, see Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and Lambda in the Amazon Web Services Storage Blog.

job.operation.s3_delete_object_tagging

Directs the specified job to execute a DELETE Object tagging call on every object in the manifest.

This functionality is not supported by directory buckets.

job.operation.s3_initiate_restore_object

Directs the specified job to initiate restore requests for every archived object in the manifest.

This functionality is not supported by directory buckets.

Show child fields
job.operation.s3_initiate_restore_object.expiration_in_days

This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains available in Amazon S3. S3 Initiate Restore Object jobs that target S3 Glacier and S3 Glacier Deep Archive objects require ExpirationInDays set to 1 or greater.

Conversely, do not set ExpirationInDays when creating S3 Initiate Restore Object jobs that target S3 Intelligent-Tiering Archive Access and Deep Archive Access tier objects. Objects in S3 Intelligent-Tiering archive access tiers are not subject to restore expiry, so specifying ExpirationInDays results in restore request failure.

S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class objects or on S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier objects, but not both types in the same job. If you need to restore objects of both types you must create separate Batch Operations jobs.

job.operation.s3_initiate_restore_object.glacier_job_tier

S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the EXPEDITED retrieval tier.

job.operation.s3_put_object_acl

Directs the specified job to run a PutObjectAcl call on every object in the manifest.

This functionality is not supported by directory buckets.

Show child fields
job.operation.s3_put_object_acl.access_control_policy

Show child fields
job.operation.s3_put_object_acl.access_control_policy.access_control_list

Show child fields
job.operation.s3_put_object_acl.access_control_policy.access_control_list.grants[]
Show child fields
job.operation.s3_put_object_acl.access_control_policy.access_control_list.grants[].grantee

Show child fields
job.operation.s3_put_object_acl.access_control_policy.access_control_list.grants[].grantee.display_name

job.operation.s3_put_object_acl.access_control_policy.access_control_list.grants[].grantee.identifier

job.operation.s3_put_object_acl.access_control_policy.access_control_list.grants[].grantee.type_identifier

job.operation.s3_put_object_acl.access_control_policy.access_control_list.grants[].permission

job.operation.s3_put_object_acl.access_control_policy.access_control_list.owner

Show child fields
job.operation.s3_put_object_acl.access_control_policy.access_control_list.owner.display_name

job.operation.s3_put_object_acl.access_control_policy.access_control_list.owner.id

job.operation.s3_put_object_acl.access_control_policy.canned_access_control_list

job.operation.s3_put_object_copy

Directs the specified job to run a PUT Copy object call on every object in the manifest.

Show child fields
job.operation.s3_put_object_copy.access_control_grants[]
Show child fields
job.operation.s3_put_object_copy.access_control_grants[].grantee

Show child fields
job.operation.s3_put_object_copy.access_control_grants[].grantee.display_name

job.operation.s3_put_object_copy.access_control_grants[].grantee.identifier

job.operation.s3_put_object_copy.access_control_grants[].grantee.type_identifier

job.operation.s3_put_object_copy.access_control_grants[].permission

job.operation.s3_put_object_copy.bucket_key_enabled

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Amazon Web Services KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.

This functionality is not supported by directory buckets.

job.operation.s3_put_object_copy.canned_access_control_list

This functionality is not supported by directory buckets.

job.operation.s3_put_object_copy.checksum_algorithm

Indicates the algorithm that you want Amazon S3 to use to create the checksum. For more information, see Checking object integrity in the Amazon S3 User Guide.

job.operation.s3_put_object_copy.metadata_directive

job.operation.s3_put_object_copy.modified_since_constraint

job.operation.s3_put_object_copy.new_object_metadata

If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects. If you specify an empty set, the new objects will have no tags. Otherwise, Amazon S3 assigns the supplied tags to the new objects.

Show child fields
job.operation.s3_put_object_copy.new_object_metadata.cache_control

job.operation.s3_put_object_copy.new_object_metadata.content_disposition

job.operation.s3_put_object_copy.new_object_metadata.content_encoding

job.operation.s3_put_object_copy.new_object_metadata.content_language

job.operation.s3_put_object_copy.new_object_metadata.content_length

This member has been deprecated.

job.operation.s3_put_object_copy.new_object_metadata.content_md5

This member has been deprecated.

job.operation.s3_put_object_copy.new_object_metadata.content_type

job.operation.s3_put_object_copy.new_object_metadata.http_expires_date

job.operation.s3_put_object_copy.new_object_metadata.requester_charged

This member has been deprecated.

job.operation.s3_put_object_copy.new_object_metadata.sse_algorithm

For directory buckets, only the server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.

job.operation.s3_put_object_copy.new_object_metadata.user_metadata

job.operation.s3_put_object_copy.new_object_tagging[]
Show child fields
job.operation.s3_put_object_copy.new_object_tagging[].key

Key of the tag

job.operation.s3_put_object_copy.new_object_tagging[].value

Value of the tag

job.operation.s3_put_object_copy.object_lock_legal_hold_status

The legal hold status to be applied to all objects in the Batch Operations job.

This functionality is not supported by directory buckets.

job.operation.s3_put_object_copy.object_lock_mode

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

This functionality is not supported by directory buckets.

job.operation.s3_put_object_copy.object_lock_retain_until_date

The date when the applied object retention configuration expires on all objects in the Batch Operations job.

This functionality is not supported by directory buckets.

job.operation.s3_put_object_copy.redirect_location

If the destination bucket is configured as a website, specifies an optional metadata property for website redirects, x-amz-website-redirect-location. Allows webpage redirects if the object copy is accessed through a website endpoint.

This functionality is not supported by directory buckets.

job.operation.s3_put_object_copy.requester_pays

This functionality is not supported by directory buckets.

job.operation.s3_put_object_copy.sse_aws_kms_key_id

This functionality is not supported by directory buckets.

job.operation.s3_put_object_copy.storage_class

Specify the storage class for the destination objects in a Copy operation.

Directory buckets - This functionality is not supported by directory buckets.

job.operation.s3_put_object_copy.target_key_prefix

Specifies the folder prefix that you want the objects to be copied into. For example, to copy objects into a folder named Folder1 in the destination bucket, set the TargetKeyPrefix property to Folder1.

job.operation.s3_put_object_copy.target_resource

Specifies the destination bucket Amazon Resource Name (ARN) for the batch copy operation.

  • General purpose buckets - For example, to copy objects to a general purpose bucket named destinationBucket, set the TargetResource property to arn:aws:s3:::destinationBucket.

  • Directory buckets - For example, to copy objects to a directory bucket named destinationBucket in the Availability Zone; identified by the AZ ID usw2-az1, set the TargetResource property to arn:aws:s3express:region:account_id:/bucket/destination_bucket_base_name--usw2-az1--x-s3.

job.operation.s3_put_object_copy.un_modified_since_constraint

job.operation.s3_put_object_legal_hold

Contains the configuration for an S3 Object Lock legal hold operation that an S3 Batch Operations job passes to every object to the underlying PutObjectLegalHold API operation. For more information, see Using S3 Object Lock legal hold with S3 Batch Operations in the Amazon S3 User Guide.

This functionality is not supported by directory buckets.

Show child fields
job.operation.s3_put_object_legal_hold.legal_hold

Contains the Object Lock legal hold status to be applied to all objects in the Batch Operations job.

Show child fields
job.operation.s3_put_object_legal_hold.legal_hold.status

The Object Lock legal hold status to be applied to all objects in the Batch Operations job.

job.operation.s3_put_object_retention

Contains the configuration parameters for the Object Lock retention action for an S3 Batch Operations job. Batch Operations passes every object to the underlying PutObjectRetention API operation. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

This functionality is not supported by directory buckets.

Show child fields
job.operation.s3_put_object_retention.bypass_governance_retention

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

job.operation.s3_put_object_retention.retention

Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

Show child fields
job.operation.s3_put_object_retention.retention.mode

The Object Lock retention mode to be applied to all objects in the Batch Operations job.

job.operation.s3_put_object_retention.retention.retain_until_date

The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.

job.operation.s3_put_object_tagging

Directs the specified job to run a PUT Object tagging call on every object in the manifest.

This functionality is not supported by directory buckets.

Show child fields
job.operation.s3_put_object_tagging.tag_set[]
Show child fields
job.operation.s3_put_object_tagging.tag_set[].key

Key of the tag

job.operation.s3_put_object_tagging.tag_set[].value

Value of the tag

job.operation.s3_replicate_object

Directs the specified job to invoke ReplicateObject on every object in the job's manifest.

This functionality is not supported by directory buckets.

job.priority

The priority of the specified job.

job.progress_summary

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.

Show child fields
job.progress_summary.number_of_tasks_failed

job.progress_summary.number_of_tasks_succeeded

job.progress_summary.timers

The JobTimers attribute of a job's progress summary.

Show child fields
job.progress_summary.timers.elapsed_time_in_active_seconds

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

job.progress_summary.total_number_of_tasks

job.report

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

Show child fields
job.report.bucket

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

Directory buckets - Directory buckets aren't supported as a location for Batch Operations to store job completion reports.

job.report.enabled

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

job.report.format

The format of the specified job-completion report.

job.report.prefix

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

job.report.report_scope

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

job.role_arn

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

job.status

The current status of the specified job.

job.status_update_reason

The reason for updating the job.

job.suspended_cause

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.

job.suspended_date

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

job.termination_date

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