The name of the bucket containing the source object.When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form
AccessPointName-
AccountId.s3-accesspoint.
Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see
Using Access Points in the
Amazon Simple Storage Service Developer Guide.
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Aliases | SourceBucket |
Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.CannedACLName
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see
Checking object integrity in the
Amazon S3 User Guide.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Specifies base64-encoded MD5 of the encryption key for Amazon S3 to use to decrypt the object. This field is optional, the SDK will calculate the MD5 if this is not set.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Amazon.PowerShell.Cmdlets.S3.AmazonS3ClientCmdlet.ClientConfig
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Sets the content type of the target object; if not specified an attempt is made to infer it using the destination or source object keys.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Specifies the server-side encryption algorithm used on the source object with the customer provided key. Allowable values: None or AES256.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-CopySourceServerSideEncryptionCustomerProvidedKey <
String>
Specifies base64-encoded encryption key for Amazon S3 used on the source object.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-CopySourceServerSideEncryptionCustomerProvidedKeyMD5 <
String>
Specifies base64-encoded MD5 of the encryption key for Amazon S3 used on the source object. This field is optional, the SDK will calculate the MD5 if this is not set.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The name of the bucket that will contain the copied object. If not specified, the copy is to another S3 object in the source bucket.When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form
AccessPointName-
AccountId.s3-accesspoint.
Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see
Using Access Points in the
Amazon Simple Storage Service Developer Guide.
Required? | False |
Position? | 4 |
Accept pipeline input? | True (ByPropertyName) |
The key for the copy of the source S3 object.
Required? | False |
Position? | 3 |
Accept pipeline input? | True (ByPropertyName) |
Copies the object if its entity tag (ETag) matches the specified tag; otherwise return a PreconditionFailed.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Copies the object if its entity tag (ETag) is different than the specified Etag; otherwise returns an error.
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) |
-ForcePathStyleAddressing <
Boolean>
S3 requests can be performed using one of two URI styles: Virtual or Path. When using Virtual style, the bucket is included as part of the hostname. When using Path style the bucket is included as part of the URI path. The default value is $true when the EndpointUrl parameter is specified, $false otherwise.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Response headers to set on the object.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Headers |
The key of the single source object to copy.
Required? | True (CopySingleObjectToLocalFile, CopyS3ObjectToS3Object) |
Position? | 2 |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceKey |
Used to download multiple objects to the specified local folder. The supplied prefix will be used to determine the set of objects to download that share the same key prefix. You must specify either this parameter, or the -Key parameter, to determine what object(s) to download.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourcePrefix |
The full path to the local file that will be created.
Required? | True |
Position? | 3 |
Accept pipeline input? | True (ByPropertyName) |
Aliases | File |
The path to a local folder that will contain the downloaded object. If a relative path is supplied, it will be resolved to a full path using the current session's location.When copying to a local folder the object key is used as the filename. Note that object keys that are not valid filenames for the host system could cause an exception to be thrown.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Folder |
Metadata headers to set on the object.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. Valid values are COPY or REPLACE. COPY is the default if not specified.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-ModifiedSinceDate <DateTime>
Copies the object if it has been modified since the specified time; otherwise returns an error. This parameter is deprecated.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
If set, applies an ACL making the bucket public with read-only permissions
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
If set, applies an ACL making the bucket public with read-write permissions
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Specifies S3 should use REDUCED_REDUNDANCY storage class for the object. This provides a reduced (99.99%) durability guarantee at a lower cost as compared to the STANDARD storage class. Use this storage class for non-mission critical data or for data that doesn’t require the higher level of durability that S3 provides with the STANDARD storage class.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Specifies the encryption used on the server to store the content. Allowable values: None, AES256, aws:kms.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Specifies the server-side encryption algorithm to be used with the customer provided key. Allowable values: None or AES256.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-ServerSideEncryptionCustomerProvidedKey <
String>
Specifies base64-encoded encryption key for Amazon S3 to use to decrypt the object.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-ServerSideEncryptionCustomerProvidedKeyMD5 <
String>
Specifies base64-encoded MD5 of the encryption key for Amazon S3 to use to decrypt the object. This field is optional, the SDK will calculate the MD5 if this is not set.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-ServerSideEncryptionKeyManagementServiceKeyId <
String>
Specifies the AWS KMS key for Amazon S3 to use to encrypt the object.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-SourceRegion <Object>
Specifies the Region that the source bucket resides in; If not specified an attempt is made to infer it using the Region set in your credential profile. The -Region parameter specifies the Destination Region.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Specifies the STANDARD storage class, which is the default storage class for S3 objects. Provides a 99.999999999% durability guarantee.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Specifies the storage class for the object. Please refer to
Storage Classes for information on S3 storage classes.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
One or more tags to apply to the object.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-UnmodifiedSinceDate <DateTime>
Copies the object if it hasn't been modified since the specified time; otherwise returns a PreconditionFailed. This parameter is deprecated.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.).
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-UtcModifiedSinceDate <DateTime>
Copies the object if it has been modified since the specified time; otherwise returns an error.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-UtcUnmodifiedSinceDate <DateTime>
Copies the object if it hasn't been modified since the specified time; otherwise returns a PreconditionFailed.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Specifies the version of the source object to copy.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceVersionId |
-WebsiteRedirectLocation <
String>
If this is set then when a GET request is made from the S3 website endpoint a 301 HTTP status code will be returned indicating a redirect with this value as the redirect location.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |