Name of the bucket that holds the content to be downloaded.When using this action 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 action with an access point through the Amazon Web Services 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 S3 User Guide.When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see
What is S3 on Outposts in the
Amazon S3 User Guide.
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
This must be enabled to retrieve the checksum. In addition, if you enable ChecksumMode
and the object is KMS encrypted, you must have permission to the kms:Decrypt
action for the request to succeed.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Amazon.PowerShell.Cmdlets.S3.AmazonS3ClientCmdlet.ClientConfig
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
By default if KeyPrefix doesn't have a trailing '/' then a '/' is appended to mimic a virtual S3 directory. If the KeyPrefix is not meant to be S3 virtual directory set DisableSlashCorrection to true to disable the behavior for adding a trailing '/' to the KeyPrefix value.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The full path to the local file that will be created.
Required? | True (DownloadFile) |
Position? | 3 |
Accept pipeline input? | True (ByPropertyName) |
The full path to a local folder; all downloaded content will be placed under this folder, with subfolders maintaining the S3 object key hierarchies.
Required? | True (DownloadFolder) |
Position? | 3 |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Directory |
-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) |
The key that identifies the single object in S3.
Required? | True |
Position? | 2 |
Accept pipeline input? | True (ByPropertyName) |
Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.KeyPrefix
Required? | False |
Position? | 2 |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Prefix |
-ModifiedSinceDate <DateTime>
If specified, only objects that have been modified since this date will be downloaded. This parameter is deprecated.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Amazon.S3.Model.S3Object instance containing the bucketname and key of the object to download. If the supplied object is an Amazon.S3.Model.S3ObjectVersion instance (derived from S3Object), the version of the object to download will be inferred automatically. The object identified by the supplied S3Object can be downloaded to a specific file (by supplying a value for the -File parameter) or to a folder (specified using the -Folder parameter). When downloading to a 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 (ByValue, 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) |
-UnmodifiedSinceDate <DateTime>
If specified, only objects that have not been modified since this date will be downloaded. 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>
If specified, only objects that have been modified since this date will be downloaded.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-UtcUnmodifiedSinceDate <DateTime>
If specified, only objects that have not been modified since this date will be downloaded.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
If specified, the specific version of the S3 object is returned.
Required? | False |
Position? | 4 |
Accept pipeline input? | True (ByPropertyName) |