SDK for PHP 3.x
SignatureInterface
in
Interface used to provide interchangeable strategies for signing requests using the various AWS signature protocols.
Table of Contents
Methods
- presign() : RequestInterface
- Create a pre-signed request.
- signRequest() : RequestInterface
- 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
presign()
Create a pre-signed request.
public
presign(RequestInterface $request, CredentialsInterface $credentials, int|string|DateTimeInterface $expires[, array<string|int, mixed> $options = [] ]) : RequestInterface
Parameters
- $request : RequestInterface
-
Request to sign
- $credentials : CredentialsInterface
-
Credentials used to sign
- $expires : int|string|DateTimeInterface
-
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.
- $options : array<string|int, mixed> = []
Return values
RequestInterfacesignRequest()
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) : RequestInterface
Parameters
- $request : RequestInterface
-
Request to sign
- $credentials : CredentialsInterface
-
Signing credentials
Return values
RequestInterface —Returns the modified request.