AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon S3 Control CreateJob API operation.

Syntax

New-S3CJob
-AccountId <String>
-S3PutObjectCopy_AccessControlGrant <S3Grant[]>
-ManifestOutputLocation_Bucket <String>
-Report_Bucket <String>
-S3PutObjectCopy_BucketKeyEnabled <Boolean>
-S3PutObjectRetention_BypassGovernanceRetention <Boolean>
-NewObjectMetadata_CacheControl <String>
-AccessControlPolicy_CannedAccessControlList <S3CannedAccessControlList>
-S3PutObjectCopy_CannedAccessControlList <S3CannedAccessControlList>
-S3PutObjectCopy_ChecksumAlgorithm <S3ChecksumAlgorithm>
-ClientRequestToken <String>
-ConfirmationRequired <Boolean>
-NewObjectMetadata_ContentDisposition <String>
-NewObjectMetadata_ContentEncoding <String>
-NewObjectMetadata_ContentLanguage <String>
-NewObjectMetadata_ContentLength <Int64>
-NewObjectMetadata_ContentMD5 <String>
-NewObjectMetadata_ContentType <String>
-Filter_CreatedAfter <DateTime>
-Filter_CreatedBefore <DateTime>
-Description <String>
-Owner_DisplayName <String>
-Filter_EligibleForReplication <Boolean>
-Report_Enabled <Boolean>
-S3JobManifestGenerator_EnableManifestOutput <Boolean>
-Location_ETag <String>
-S3JobManifestGenerator_ExpectedBucketOwner <String>
-ManifestOutputLocation_ExpectedManifestBucketOwner <String>
-S3InitiateRestoreObject_ExpirationInDay <Int32>
-Spec_Field <String[]>
-Spec_Format <JobManifestFormat>
-Report_Format <JobReportFormat>
-LambdaInvoke_FunctionArn <String>
-S3InitiateRestoreObject_GlacierJobTier <S3GlacierJobTier>
-AccessControlList_Grant <S3Grant[]>
-NewObjectMetadata_HttpExpiresDate <DateTime>
-Owner_ID <String>
-LambdaInvoke_InvocationSchemaVersion <String>
-SSEKMS_KeyId <String>
-ManifestOutputLocation_ManifestFormat <GeneratedManifestFormat>
-ManifestOutputLocation_ManifestPrefix <String>
-KeyNameConstraint_MatchAnyPrefix <String[]>
-Filter_MatchAnyStorageClass <String[]>
-KeyNameConstraint_MatchAnySubstring <String[]>
-KeyNameConstraint_MatchAnySuffix <String[]>
-S3PutObjectCopy_MetadataDirective <S3MetadataDirective>
-Retention_Mode <S3ObjectLockRetentionMode>
-S3PutObjectCopy_ModifiedSinceConstraint <DateTime>
-S3PutObjectCopy_NewObjectTagging <S3Tag[]>
-Location_ObjectArn <String>
-S3PutObjectCopy_ObjectLockLegalHoldStatus <S3ObjectLockLegalHoldStatus>
-S3PutObjectCopy_ObjectLockMode <S3ObjectLockMode>
-S3PutObjectCopy_ObjectLockRetainUntilDate <DateTime>
-Filter_ObjectReplicationStatus <String[]>
-Filter_ObjectSizeGreaterThanByte <Int64>
-Filter_ObjectSizeLessThanByte <Int64>
-Location_ObjectVersionId <String>
-Report_Prefix <String>
-Priority <Int32>
-S3PutObjectCopy_RedirectLocation <String>
-Report_ReportScope <JobReportScope>
-NewObjectMetadata_RequesterCharged <Boolean>
-S3PutObjectCopy_RequesterPay <Boolean>
-Retention_RetainUntilDate <DateTime>
-RoleArn <String>
-Operation_S3DeleteObjectTagging <S3DeleteObjectTaggingOperation>
-Operation_S3ReplicateObject <S3ReplicateObjectOperation>
-S3JobManifestGenerator_SourceBucket <String>
-NewObjectMetadata_SSEAlgorithm <S3SSEAlgorithm>
-S3PutObjectCopy_SSEAwsKmsKeyId <String>
-ManifestEncryption_SSES3 <SSES3Encryption>
-LegalHold_Status <S3ObjectLockLegalHoldStatus>
-S3PutObjectCopy_StorageClass <S3StorageClass>
-Tag <S3Tag[]>
-S3PutObjectTagging_TagSet <S3Tag[]>
-S3PutObjectCopy_TargetKeyPrefix <String>
-S3PutObjectCopy_TargetResource <String>
-S3PutObjectCopy_UnModifiedSinceConstraint <DateTime>
-LambdaInvoke_UserArgument <Hashtable>
-NewObjectMetadata_UserMetadata <Hashtable>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonS3ControlConfig>

Description

This operation creates an S3 Batch Operations job. You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects. Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
Permissions
For information about permissions required to use the Batch Operations, see Granting permissions for S3 Batch Operations in the Amazon S3 User Guide.
Related actions include:

Parameters

-AccessControlList_Grant <S3Grant[]>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectAcl_AccessControlPolicy_AccessControlList_Grants
-AccessControlPolicy_CannedAccessControlList <S3CannedAccessControlList>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectAcl_AccessControlPolicy_CannedAccessControlList
-AccountId <String>
The Amazon Web Services account ID that creates the job.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ClientConfig <AmazonS3ControlConfig>
Amazon.PowerShell.Cmdlets.S3C.AmazonS3ControlClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientRequestToken <String>
An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConfirmationRequired <Boolean>
Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Filter_CreatedAfter <DateTime>
If provided, the generated manifest includes only source bucket objects that were created after this time.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifestGenerator_S3JobManifestGenerator_Filter_CreatedAfter
-Filter_CreatedBefore <DateTime>
If provided, the generated manifest includes only source bucket objects that were created before this time.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifestGenerator_S3JobManifestGenerator_Filter_CreatedBefore
-Filter_EligibleForReplication <Boolean>
Include objects in the generated manifest only if they are eligible for replication according to the Replication configuration on the source bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifestGenerator_S3JobManifestGenerator_Filter_EligibleForReplication
-Filter_MatchAnyStorageClass <String[]>
If provided, the generated manifest includes only source bucket objects that are stored with the specified storage class.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifestGenerator_S3JobManifestGenerator_Filter_MatchAnyStorageClass
-Filter_ObjectReplicationStatus <String[]>
If provided, the generated manifest includes only source bucket objects that have one of the specified Replication statuses.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifestGenerator_S3JobManifestGenerator_Filter_ObjectReplicationStatuses
-Filter_ObjectSizeGreaterThanByte <Int64>
If provided, the generated manifest includes only source bucket objects whose file size is greater than the specified number of bytes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifestGenerator_S3JobManifestGenerator_Filter_ObjectSizeGreaterThanBytes
-Filter_ObjectSizeLessThanByte <Int64>
If provided, the generated manifest includes only source bucket objects whose file size is less than the specified number of bytes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifestGenerator_S3JobManifestGenerator_Filter_ObjectSizeLessThanBytes
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KeyNameConstraint_MatchAnyPrefix <String[]>
If provided, the generated manifest includes objects where the specified string appears at the start of the object key string. Each KeyNameConstraint filter accepts an array of strings with a length of 1 string.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifestGenerator_S3JobManifestGenerator_Filter_KeyNameConstraint_MatchAnyPrefix
-KeyNameConstraint_MatchAnySubstring <String[]>
If provided, the generated manifest includes objects where the specified string appears anywhere within the object key string. Each KeyNameConstraint filter accepts an array of strings with a length of 1 string.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifestGenerator_S3JobManifestGenerator_Filter_KeyNameConstraint_MatchAnySubstring
-KeyNameConstraint_MatchAnySuffix <String[]>
If provided, the generated manifest includes objects where the specified string appears at the end of the object key string. Each KeyNameConstraint filter accepts an array of strings with a length of 1 string.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifestGenerator_S3JobManifestGenerator_Filter_KeyNameConstraint_MatchAnySuffix
-LambdaInvoke_FunctionArn <String>
The Amazon Resource Name (ARN) for the Lambda function that the specified job will invoke on every object in the manifest.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_LambdaInvoke_FunctionArn
-LambdaInvoke_InvocationSchemaVersion <String>
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 InvocationSchemaVersion2.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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_LambdaInvoke_InvocationSchemaVersion
-LambdaInvoke_UserArgument <Hashtable>
Key-value pairs that are passed in the payload that Batch Operations sends when invoking an Lambda function. You must specify InvocationSchemaVersion2.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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_LambdaInvoke_UserArguments
-LegalHold_Status <S3ObjectLockLegalHoldStatus>
The Object Lock legal hold status to be applied to all objects in the Batch Operations job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectLegalHold_LegalHold_Status
-Location_ETag <String>
The ETag for the specified manifest object.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifest_Location_ETag
-Location_ObjectArn <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifest_Location_ObjectArn
-Location_ObjectVersionId <String>
The optional version ID to identify a specific version of the manifest object.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifest_Location_ObjectVersionId
-ManifestEncryption_SSES3 <SSES3Encryption>
Specifies the use of SSE-S3 to encrypt generated manifest objects.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifestGenerator_S3JobManifestGenerator_ManifestOutputLocation_ManifestEncryption_SSES3
-ManifestOutputLocation_Bucket <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifestGenerator_S3JobManifestGenerator_ManifestOutputLocation_Bucket
-ManifestOutputLocation_ExpectedManifestBucketOwner <String>
The Account ID that owns the bucket the generated manifest is written to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifestGenerator_S3JobManifestGenerator_ManifestOutputLocation_ExpectedManifestBucketOwner
-ManifestOutputLocation_ManifestFormat <GeneratedManifestFormat>
The format of the generated manifest.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifestGenerator_S3JobManifestGenerator_ManifestOutputLocation_ManifestFormat
-ManifestOutputLocation_ManifestPrefix <String>
Prefix identifying one or more objects to which the manifest applies.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifestGenerator_S3JobManifestGenerator_ManifestOutputLocation_ManifestPrefix
-NewObjectMetadata_CacheControl <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_NewObjectMetadata_CacheControl
-NewObjectMetadata_ContentDisposition <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_NewObjectMetadata_ContentDisposition
-NewObjectMetadata_ContentEncoding <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_NewObjectMetadata_ContentEncoding
-NewObjectMetadata_ContentLanguage <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_NewObjectMetadata_ContentLanguage
-NewObjectMetadata_ContentLength <Int64>
This member has been deprecated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_NewObjectMetadata_ContentLength
-NewObjectMetadata_ContentMD5 <String>
This member has been deprecated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_NewObjectMetadata_ContentMD5
-NewObjectMetadata_ContentType <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_NewObjectMetadata_ContentType
-NewObjectMetadata_HttpExpiresDate <DateTime>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_NewObjectMetadata_HttpExpiresDate
-NewObjectMetadata_RequesterCharged <Boolean>
This member has been deprecated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_NewObjectMetadata_RequesterCharged
-NewObjectMetadata_SSEAlgorithm <S3SSEAlgorithm>
For directory buckets, only the server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_NewObjectMetadata_SSEAlgorithm
-NewObjectMetadata_UserMetadata <Hashtable>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_NewObjectMetadata_UserMetadata
-Operation_S3DeleteObjectTagging <S3DeleteObjectTaggingOperation>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Operation_S3ReplicateObject <S3ReplicateObjectOperation>
Directs the specified job to invoke ReplicateObject on every object in the job's manifest.This functionality is not supported by directory buckets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Owner_DisplayName <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectAcl_AccessControlPolicy_AccessControlList_Owner_DisplayName
-Owner_ID <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectAcl_AccessControlPolicy_AccessControlList_Owner_ID
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the AccountId parameter. The -PassThru parameter is deprecated, use -Select '^AccountId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Priority <Int32>
The numerical priority for this job. Higher numbers indicate higher priority.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Report_Bucket <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Report_Enabled <Boolean>
Indicates whether the specified job will generate a job-completion report.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Report_Format <JobReportFormat>
The format of the specified job-completion report.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Report_Prefix <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Report_ReportScope <JobReportScope>
Indicates whether the job-completion report will include details of all tasks or only failed tasks.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Retention_Mode <S3ObjectLockRetentionMode>
The Object Lock retention mode to be applied to all objects in the Batch Operations job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectRetention_Retention_Mode
-Retention_RetainUntilDate <DateTime>
The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectRetention_Retention_RetainUntilDate
-RoleArn <String>
The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3InitiateRestoreObject_ExpirationInDay <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3InitiateRestoreObject_ExpirationInDays
-S3InitiateRestoreObject_GlacierJobTier <S3GlacierJobTier>
S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the EXPEDITED retrieval tier.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3InitiateRestoreObject_GlacierJobTier
-S3JobManifestGenerator_EnableManifestOutput <Boolean>
Determines whether or not to write the job's generated manifest to a bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifestGenerator_S3JobManifestGenerator_EnableManifestOutput
-S3JobManifestGenerator_ExpectedBucketOwner <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifestGenerator_S3JobManifestGenerator_ExpectedBucketOwner
-S3JobManifestGenerator_SourceBucket <String>
The ARN of 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifestGenerator_S3JobManifestGenerator_SourceBucket
-S3PutObjectCopy_AccessControlGrant <S3Grant[]>
This functionality is not supported by directory buckets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_AccessControlGrants
-S3PutObjectCopy_BucketKeyEnabled <Boolean>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_BucketKeyEnabled
-S3PutObjectCopy_CannedAccessControlList <S3CannedAccessControlList>
This functionality is not supported by directory buckets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_CannedAccessControlList
-S3PutObjectCopy_ChecksumAlgorithm <S3ChecksumAlgorithm>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_ChecksumAlgorithm
-S3PutObjectCopy_MetadataDirective <S3MetadataDirective>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_MetadataDirective
-S3PutObjectCopy_ModifiedSinceConstraint <DateTime>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_ModifiedSinceConstraint
-S3PutObjectCopy_NewObjectTagging <S3Tag[]>
Specifies a list of tags to add to the destination objects after they are copied. If NewObjectTagging is not specified, the tags of the source objects are copied to destination objects by default.Directory buckets - Tags aren't supported by directory buckets. If your source objects have tags and your destination bucket is a directory bucket, specify an empty tag set in the NewObjectTagging field to prevent copying the source object tags to the directory bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_NewObjectTagging
-S3PutObjectCopy_ObjectLockLegalHoldStatus <S3ObjectLockLegalHoldStatus>
The legal hold status to be applied to all objects in the Batch Operations job.This functionality is not supported by directory buckets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_ObjectLockLegalHoldStatus
-S3PutObjectCopy_ObjectLockMode <S3ObjectLockMode>
The retention mode to be applied to all objects in the Batch Operations job.This functionality is not supported by directory buckets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_ObjectLockMode
-S3PutObjectCopy_ObjectLockRetainUntilDate <DateTime>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_ObjectLockRetainUntilDate
-S3PutObjectCopy_RedirectLocation <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_RedirectLocation
-S3PutObjectCopy_RequesterPay <Boolean>
This functionality is not supported by directory buckets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_RequesterPays
-S3PutObjectCopy_SSEAwsKmsKeyId <String>
This functionality is not supported by directory buckets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_SSEAwsKmsKeyId
-S3PutObjectCopy_StorageClass <S3StorageClass>
Specify the storage class for the destination objects in a Copy operation.Directory buckets - This functionality is not supported by directory buckets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_StorageClass
-S3PutObjectCopy_TargetKeyPrefix <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_TargetKeyPrefix
-S3PutObjectCopy_TargetResource <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_TargetResource
-S3PutObjectCopy_UnModifiedSinceConstraint <DateTime>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectCopy_UnModifiedSinceConstraint
-S3PutObjectRetention_BypassGovernanceRetention <Boolean>
Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock GOVERNANCE type in place.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectRetention_BypassGovernanceRetention
-S3PutObjectTagging_TagSet <S3Tag[]>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_S3PutObjectTagging_TagSet
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'JobId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Control.Model.CreateJobResponse). Specifying the name of a property of type Amazon.S3Control.Model.CreateJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Spec_Field <String[]>
If the specified manifest object is in the S3BatchOperations_CSV_20180820 format, this element describes which columns contain the required data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifest_Spec_Fields
-Spec_Format <JobManifestFormat>
Indicates which of the available formats the specified manifest uses.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifest_Spec_Format
-SSEKMS_KeyId <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifestGenerator_S3JobManifestGenerator_ManifestOutputLocation_ManifestEncryption_SSEKMS_KeyId
-Tag <S3Tag[]>
A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.S3Control.Model.CreateJobResponse
This cmdlet returns a System.String object. The service call response (type Amazon.S3Control.Model.CreateJobResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z