S3SignatureInterface
extends
SignatureInterface
in
Interface used to provide interchangeable strategies for signing requests using the various AWS signature protocols.
Table of Contents
Methods
- createPresignedUrl() : string
- Create a pre-signed URL
- signRequest() : mixed
- Signs the specified request with an AWS signing protocol by using the provided AWS account credentials and adding the required headers to the request.
Methods
createPresignedUrl()
Create a pre-signed URL
public
createPresignedUrl(RequestInterface $request, CredentialsInterface $credentials, int|string|DateTime $expires) : string
Parameters
- $request : RequestInterface
-
Request to sign
- $credentials : CredentialsInterface
-
Credentials used to sign
- $expires : int|string|DateTime
-
The time at which the URL should expire. This can be a Unix timestamp, a PHP DateTime object, or a string that can be evaluated by strtotime
Return values
stringsignRequest()
Signs the specified request with an AWS signing protocol by using the provided AWS account credentials and adding the required headers to the request.
public
signRequest(RequestInterface $request, CredentialsInterface $credentials) : mixed
Parameters
- $request : RequestInterface
-
Request to add a signature to
- $credentials : CredentialsInterface
-
Signing credentials