The name of the bucket that contains the object.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format
bucket_base_name--az-id--x-s3 (for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see
Directory bucket naming rules in the
Amazon S3 User Guide.
Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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.Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - 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? | False |
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) |
ETag to be matched as a pre-condition for returning the object, otherwise a PreconditionFailed signal is returned.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
ETag that should not be matched as a pre-condition for returning the object, otherwise a NotModified (304) signal is returned.
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) |
The key of the object.
Required? | False |
Position? | 2 |
Accept pipeline input? | True (ByPropertyName) |
-ModifiedSinceDate <DateTime>
This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use ModifiedSinceDateUtc instead. Setting either ModifiedSinceDate or ModifiedSinceDateUtc results in both ModifiedSinceDate and ModifiedSinceDateUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. ModifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service. Returns the object only if it has been modified since the specified time, otherwise returns a PreconditionFailed.This parameter is deprecated.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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) |
Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-ResponseCacheControl <
String>
Sets the Cache-Control header of the response.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-ResponseContentDisposition <
String>
Sets the Content-Disposition header of the response.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-ResponseContentEncoding <
String>
Sets the Content-Encoding header of the response.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-ResponseContentLanguage <
String>
Sets the Content-Language header of the response.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Sets the Content-Type header of the response.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-ResponseExpire <DateTime>
Sets the Expires header of the response.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ResponseExpires |
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.GetObjectMetadataResponse). Specifying the name of a property of type Amazon.S3.Model.GetObjectMetadataResponse 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) |
The Server-side encryption algorithm to be used with the customer provided key.
This functionality is not supported for directory buckets.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-ServerSideEncryptionCustomerProvidedKey <
String>
The base64-encoded encryption key for Amazon S3 to use to decrypt the object Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only thing you do is manage the encryption keys you provide.When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies the encryption key you provided matches, and then decrypts the object before returning the object data to you.Important: Amazon S3 does not store the encryption key you provide.This functionality is not supported for directory buckets.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-ServerSideEncryptionCustomerProvidedKeyMD5 <
String>
The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is base 64 encoded. 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>
This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use UnmodifiedSinceDateUtc instead. Setting either UnmodifiedSinceDate or UnmodifiedSinceDateUtc results in both UnmodifiedSinceDate and UnmodifiedSinceDateUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. UnmodifiedSinceDate is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service. Returns the object only if it has not 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>
Returns the object only if it has been modified since the specified time, otherwise returns a PreconditionFailed.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-UtcUnmodifiedSinceDate <DateTime>
Returns the object only if it has not been modified since the specified time, otherwise returns a PreconditionFailed.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Version ID used to reference a specific version of the object.For directory buckets in this API operation, only the null value of the version ID is supported.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |