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[]>
-Report_Bucket <String>
-NewObjectMetadata_CacheControl <String>
-AccessControlPolicy_CannedAccessControlList <S3CannedAccessControlList>
-S3PutObjectCopy_CannedAccessControlList <S3CannedAccessControlList>
-ClientRequestToken <String>
-ConfirmationRequired <Boolean>
-NewObjectMetadata_ContentDisposition <String>
-NewObjectMetadata_ContentEncoding <String>
-NewObjectMetadata_ContentLanguage <String>
-NewObjectMetadata_ContentLength <Int64>
-NewObjectMetadata_ContentMD5 <String>
-NewObjectMetadata_ContentType <String>
-Description <String>
-Owner_DisplayName <String>
-Report_Enabled <Boolean>
-Location_ETag <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>
-S3PutObjectCopy_MetadataDirective <S3MetadataDirective>
-S3PutObjectCopy_ModifiedSinceConstraint <DateTime>
-S3PutObjectCopy_NewObjectTagging <S3Tag[]>
-Location_ObjectArn <String>
-S3PutObjectCopy_ObjectLockLegalHoldStatus <S3ObjectLockLegalHoldStatus>
-S3PutObjectCopy_ObjectLockMode <S3ObjectLockMode>
-S3PutObjectCopy_ObjectLockRetainUntilDate <DateTime>
-Location_ObjectVersionId <String>
-Report_Prefix <String>
-Priority <Int32>
-S3PutObjectCopy_RedirectLocation <String>
-Report_ReportScope <JobReportScope>
-NewObjectMetadata_RequesterCharged <Boolean>
-S3PutObjectCopy_RequesterPay <Boolean>
-RoleArn <String>
-NewObjectMetadata_SSEAlgorithm <S3SSEAlgorithm>
-S3PutObjectCopy_SSEAwsKmsKeyId <String>
-S3PutObjectCopy_StorageClass <S3StorageClass>
-S3PutObjectTagging_TagSet <S3Tag[]>
-S3PutObjectCopy_TargetKeyPrefix <String>
-S3PutObjectCopy_TargetResource <String>
-S3PutObjectCopy_UnModifiedSinceConstraint <DateTime>
-NewObjectMetadata_UserMetadata <Hashtable>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Creates an Amazon S3 batch operations job.

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 service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?True
Position?1
Accept pipeline input?True (ByValue, 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)
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)
-LambdaInvoke_FunctionArn <String>
The Amazon Resource Name (ARN) for the AWS Lambda function that the specified job will invoke for each object in the manifest.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOperation_LambdaInvoke_FunctionArn
-Location_ETag <String>
The ETag for the specified manifest object.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifest_Location_ETag
-Location_ObjectArn <String>
The Amazon Resource Name (ARN) for a manifest object.
Required?True
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
-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>
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_ContentLength
-NewObjectMetadata_ContentMD5 <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_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>
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_RequesterCharged
-NewObjectMetadata_SSEAlgorithm <S3SSEAlgorithm>
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_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
-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.
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 will store 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)
-RoleArn <String>
The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) Role that batch operations will use to execute this job's operation on each object in the manifest.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3InitiateRestoreObject_ExpirationInDay <Int32>
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_S3InitiateRestoreObject_ExpirationInDays
-S3InitiateRestoreObject_GlacierJobTier <S3GlacierJobTier>
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_S3InitiateRestoreObject_GlacierJobTier
-S3PutObjectCopy_AccessControlGrant <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_S3PutObjectCopy_AccessControlGrants
-S3PutObjectCopy_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_S3PutObjectCopy_CannedAccessControlList
-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[]>
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_NewObjectTagging
-S3PutObjectCopy_ObjectLockLegalHoldStatus <S3ObjectLockLegalHoldStatus>
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_ObjectLockLegalHoldStatus
-S3PutObjectCopy_ObjectLockMode <S3ObjectLockMode>
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_ObjectLockMode
-S3PutObjectCopy_ObjectLockRetainUntilDate <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_ObjectLockRetainUntilDate
-S3PutObjectCopy_RedirectLocation <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_RedirectLocation
-S3PutObjectCopy_RequesterPay <Boolean>
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_RequesterPays
-S3PutObjectCopy_SSEAwsKmsKeyId <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_SSEAwsKmsKeyId
-S3PutObjectCopy_StorageClass <S3StorageClass>
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_StorageClass
-S3PutObjectCopy_TargetKeyPrefix <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_TargetKeyPrefix
-S3PutObjectCopy_TargetResource <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_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
-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?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesManifest_Spec_Format

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

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.

Supported Version

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