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

Generates a pre-signed URL to an object in an Amazon S3 bucket.

Syntax

Get-S3PreSignedURL
-BucketName <String>
-Key <String>
-ResponseHeaderOverrides_CacheControl <String>
-ResponseHeaderOverrides_ContentDisposition <String>
-ResponseHeaderOverrides_ContentEncoding <String>
-ResponseHeaderOverrides_ContentLanguage <String>
-ContentType <String>
-ResponseHeaderOverrides_ContentType <String>
-Expire <DateTime>
-ResponseHeaderOverrides_Expire <String>
-Protocol <Protocol>
-ServerSideEncryptionCustomerMethod <ServerSideEncryptionCustomerMethod>
-ServerSideEncryptionKeyManagementServiceKeyId <String>
-ServerSideEncryptionMethod <ServerSideEncryptionMethod>
-Verb <HttpVerb>
-VersionId <String>
-RequestorPay <SwitchParameter>
-ClientConfig <AmazonS3Config>
-UseAccelerateEndpoint <SwitchParameter>
-UseDualstackEndpoint <SwitchParameter>
-ForcePathStyleAddressing <Boolean>

Description

Create a signed URL allowing access to a resource that would usually require authentication. 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>
The name of the bucket to create a pre-signed url to, or containing the object.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.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ClientConfig <AmazonS3Config>
Amazon.PowerShell.Cmdlets.S3.AmazonS3ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ContentType <String>
A standard MIME type describing the format of the contents. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type.
Required?False
Position?Named
Accept pipeline input?False
-Expire <DateTime>
The expiry date and time for the pre-signed url.
Required?False
Position?Named
Accept pipeline input?False
AliasesExpires
-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 to the object for which a pre-signed url should be created.
Required?False
Position?2
Accept pipeline input?True (ByPropertyName)
-Protocol <Protocol>
The requested protocol (http/https) for the pre-signed url.
Required?False
Position?Named
Accept pipeline input?False
-RequestorPay <SwitchParameter>
Confirms that the requester knows that they will be charged for the request. Bucket owners do not need to specify this parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResponseHeaderOverrides_CacheControl <String>
CacheControl header value.
Required?False
Position?Named
Accept pipeline input?False
-ResponseHeaderOverrides_ContentDisposition <String>
Specifies presentational information for the object. For more information, see https://www.rfc-editor.org/rfc/rfc6266#section-4.
Required?False
Position?Named
Accept pipeline input?False
-ResponseHeaderOverrides_ContentEncoding <String>
Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding.
Required?False
Position?Named
Accept pipeline input?False
-ResponseHeaderOverrides_ContentLanguage <String>
ContentLanguage header value.
Required?False
Position?Named
Accept pipeline input?False
-ResponseHeaderOverrides_ContentType <String>
A standard MIME type describing the format of the object data.
Required?False
Position?Named
Accept pipeline input?False
-ResponseHeaderOverrides_Expire <String>
Expiry header value.
Required?False
Position?Named
Accept pipeline input?False
AliasesResponseHeaderOverrides_Expires
-ServerSideEncryptionCustomerMethod <ServerSideEncryptionCustomerMethod>
The Server-side encryption algorithm to be used with the customer provided key.
Required?False
Position?Named
Accept pipeline input?False
-ServerSideEncryptionKeyManagementServiceKeyId <String>
The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. If a key id is not specified, the default key will be used for encryption and decryption.
Required?False
Position?Named
Accept pipeline input?False
-ServerSideEncryptionMethod <ServerSideEncryptionMethod>
Specifies the encryption used on the server to store the content.
Required?False
Position?Named
Accept pipeline input?False
-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)
-Verb <HttpVerb>
The verb for the pre-signed url.
Required?False
Position?Named
Accept pipeline input?False
-VersionId <String>
Version id for the object that the pre-signed url will reference. If not set, the url will reference the latest version of the object.
Required?False
Position?Named
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.String
This cmdlet returns a System.String object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

Get-S3PreSignedURL -BucketName 's3testbucket' -Key 'testkey' -Expires '2023-11-16'
The command returns pre-signed URL for a specified key and an expiration date.

Example 2

[Amazon.AWSConfigsS3]::UseSignatureVersion4 = $true
      Get-S3PreSignedURL -BucketName sampledirectorybucket--use1-az5--x-s3 -Key 'testkey' -Expire '2023-11-17' 
The command returns pre-signed URL for a Directory Bucket with specified key and an expiration date.
Getting Started Guide
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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