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

Invokes the ListObjects call to return a collection of S3Object metadata instances describing S3 objects for a specified bucket. Repeated calls are made to retrieve metadata for all objects unless a specific object key or key prefix and instance count limiters are specified.

Syntax

GetMultipleObjects (Default)

Get-S3Object
-BucketName <String>
-KeyPrefix <String>
-Encoding <EncodingType>
-UseAccelerateEndpoint <SwitchParameter>
-UseDualstackEndpoint <SwitchParameter>
-Marker <String>
-MaxKey <Nullable<Int32>>
-Delimiter <String>

GetSingleObject

Get-S3Object
-BucketName <String>
-Key <String>
-Encoding <EncodingType>
-UseAccelerateEndpoint <SwitchParameter>
-UseDualstackEndpoint <SwitchParameter>

Description

Retrieves S3Object instances for one or more S3 objects.

Parameters

-BucketName <String>
The name of the bucket that holds the S3 object(s).
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Delimiter <String>
Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Encoding <EncodingType>
Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.
Required?False
Position?Named
Accept pipeline input?False
-Key <String>
Key value identifying a single object in S3 to return metadata for.
Required?True
Position?2
Accept pipeline input?True (ByPropertyName)
-KeyPrefix <String>
Limits the response to keys which begin with the indicated prefix. You can use prefixes to separate a bucket into different sets of keys in a way similar to how a file system uses folders. If not specified, all objects are processed.
Required?False
Position?2
Accept pipeline input?True (ByPropertyName)
-Marker <String>
Indicates where in the bucket to begin listing. The list will only include keys that occur lexicographically after marker. This is convenient for pagination: to get the next page of results use the last key of the current page as the marker.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaxKey <Nullable<Int32>>
The maximum number of keys to return (the cmdlet might return fewer than this many keys, but will not return more).Amazon S3 limits API calls to retrieve keys to a maximum of 1000 keys per call. If this parameter is specified and exceeds this limit the cmdlet will make multiple calls in batches of 1000 to retrieve up to the specified number of keys (or less, depending on how many objects the bucket contains).
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?False
-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?False

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? False
-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? False
-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

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? False
-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? False
-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? False
-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? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-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? False

Inputs

You can pipe a String object to this cmdlet for the BucketName parameter.

Outputs

This cmdlet returns 0 or more Amazon.S3.Model.S3Object instances. The service response (type Amazon.S3.Model.ListObjectsRequest) is added to the cmdlet entry in the $AWSHistory stack for each call to retrieve output. Additionally, the following properties are added as notes to the response instance: CommonPrefixes, Delimiter, MaxKeys, Prefix, NextMarker and IsTruncated.

Examples

Example 1

PS C:\>Get-S3Object -BucketName test-files
This command retrieves the information about all of the items in the bucket "test-files".

Example 2

PS C:\>Get-S3Object -BucketName test-files -Key sample.txt
This command retrieves the information about the item "sample.txt" from bucket "test-files".

Example 3

PS C:\>Get-S3Object -BucketName test-files -KeyPrefix sample
This command retrieves the information about all items with the prefix "sample" from bucket "test-files".

Supported Version

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