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

Downloads one or more objects from an S3 bucket to the local file system.

Syntax

DownloadFile (Default)
Read-S3Object
-BucketName <String>
-Key <String>
-File <String>
-Version <String>
-ModifiedSinceDate <DateTime>
-UnmodifiedSinceDate <DateTime>
-UtcModifiedSinceDate <DateTime>
-UtcUnmodifiedSinceDate <DateTime>
-ServerSideEncryptionCustomerMethod <ServerSideEncryptionCustomerMethod>
-ServerSideEncryptionCustomerProvidedKey <String>
-ServerSideEncryptionCustomerProvidedKeyMD5 <String>
-ChecksumMode <ChecksumMode>
-ClientConfig <AmazonS3Config>
-UseAccelerateEndpoint <SwitchParameter>
-UseDualstackEndpoint <SwitchParameter>
-ForcePathStyleAddressing <Boolean>
DownloadFolder
Read-S3Object
-BucketName <String>
-KeyPrefix <String>
-Folder <String>
-DisableSlashCorrection <Boolean>
-ModifiedSinceDate <DateTime>
-UnmodifiedSinceDate <DateTime>
-UtcModifiedSinceDate <DateTime>
-UtcUnmodifiedSinceDate <DateTime>
-ClientConfig <AmazonS3Config>
-UseAccelerateEndpoint <SwitchParameter>
-UseDualstackEndpoint <SwitchParameter>
-ForcePathStyleAddressing <Boolean>
FromS3ObjectToFileOrFolder
Read-S3Object
-BucketName <String>
-File <String>
-Folder <String>
-S3Object <S3Object>
-ModifiedSinceDate <DateTime>
-UnmodifiedSinceDate <DateTime>
-UtcModifiedSinceDate <DateTime>
-UtcUnmodifiedSinceDate <DateTime>
-ServerSideEncryptionCustomerMethod <ServerSideEncryptionCustomerMethod>
-ServerSideEncryptionCustomerProvidedKey <String>
-ServerSideEncryptionCustomerProvidedKeyMD5 <String>
-ChecksumMode <ChecksumMode>
-ClientConfig <AmazonS3Config>
-UseAccelerateEndpoint <SwitchParameter>
-UseDualstackEndpoint <SwitchParameter>
-ForcePathStyleAddressing <Boolean>

Description

Downloads an S3 object, optionally including sub-objects, to a local file or folder location. Returns a FileInfo or DirectoryInfo instance to the downloaded file or the containing folder. Note that you can pipe an Amazon.S3.Model.S3Object instance to this cmdlet and its members will be used to satisfy the BucketName, Key and optionally VersionId (if an S3ObjectVersion instance is supplied), parameters.

Parameters

-BucketName <String>
Name of the bucket that holds the content to be downloadedWhen 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)
-ChecksumMode <ChecksumMode>
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)
-ClientConfig <AmazonS3Config>
Amazon.PowerShell.Cmdlets.S3.AmazonS3ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DisableSlashCorrection <Boolean>
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)
-File <String>
The full path to the local file that will be created.
Required?True (DownloadFile)
Position?3
Accept pipeline input?True (ByPropertyName)
-Folder <String>
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)
AliasesDirectory
-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)
-Key <String>
The key that identifies the single object in S3.
Required?True
Position?2
Accept pipeline input?True (ByPropertyName)
-KeyPrefix <String>
Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.KeyPrefix
Required?False
Position?2
Accept pipeline input?True (ByPropertyName)
AliasesPrefix
-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)
-S3Object <S3Object>
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)
-ServerSideEncryptionCustomerMethod <ServerSideEncryptionCustomerMethod>
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)
-UseAccelerateEndpoint <SwitchParameter>
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)
-UseDualstackEndpoint <SwitchParameter>
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)
-Version <String>
If specified, the specific version of the S3 object is returned.
Required?False
Position?4
Accept pipeline input?True (ByPropertyName)

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.IO.FileInfo instance if reading a single object or System.IO.DirectoryInfo instance for multi-object read.
Returns a System.IO.FileInfo instance representing the local file if reading a single object or a System.IO.DirectoryInfo instance to the root parent folder if reading multiple objects.

Examples

Example 1

Read-S3Object -BucketName test-files -Key sample.txt -File local-sample.txt
This command retrieves item "sample.txt" from bucket "test-files" and saves it to a file named "local-sample.txt" in the current location. The file "local-sample.txt" does not have to exist before this command is called.

Example 2

Read-S3Object -BucketName test-files -KeyPrefix DIR -Folder Local-DIR
This command retrieves virtual directory "DIR" from bucket "test-files" and saves it to a folder named "Local-DIR" in the current location. The folder "Local-DIR" does not have to exist before this command is called.

Example 3

Get-S3Bucket | ? { $_.BucketName -like '*config*' } | Get-S3Object | ? { $_.Key -like '*.json' } | Read-S3Object -Folder C:\ConfigObjects
Downloads all objects with keys ending in '.json' from buckets with 'config' in the bucket name to files in the specified folder. The object keys are used to set the filenames.
Getting Started Guide
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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