The bucket name that contains the objects.
Required? | False |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Amazon.PowerShell.Cmdlets.S3.AmazonS3ClientCmdlet.ClientConfig
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix
and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes
. These groups are counted as one result against the max-keys
limitation. These keys are not returned elsewhere in the response.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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? | True (ByPropertyName) |
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden
(access denied).
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) |
Specifies the key to start with when listing objects in a bucket.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because max-keys
was exceeded, the response contains <isTruncated>true</isTruncated>
. To return the additional keys, see key-marker
and version-id-marker
.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | MaxKeys |
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | OptionalObjectAttributes |
Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix
to make groups in the same way that you'd use a folder in a file system.) You can use prefix
with delimiter
to roll up numerous objects into a single result under CommonPrefixes
.
Required? | False |
Position? | 2 |
Accept pipeline input? | True (ByPropertyName) |
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) |
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3.Model.ListVersionsResponse). Specifying the name of a property of type Amazon.S3.Model.ListVersionsResponse 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) |
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) |
Specifies the object version you want to start listing from.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |