Class S3MultiRegionClient
- Aws\MultiRegionClient implements Aws\AwsClientInterface uses Aws\AwsClientTrait
-
Aws\S3\S3MultiRegionClient
implements
Aws\S3\S3ClientInterface
uses
Aws\S3\S3ClientTrait
- Namespace: Aws\S3
- Located at S3/S3MultiRegionClient.php
Amazon Simple Storage Service multi-region client.
Methods Summary
- static getArguments ( )
-
__construct ( array $args )
The multi-region client constructor accepts the following options:
-
createPresignedRequest ( Aws\CommandInterface $command, int|string|\DateTimeInterface $expires, array $options = [] )
Create a pre-signed URL for the given S3 command object.
-
getObjectUrl ( string $bucket, string $key )
Returns the URL to an object identified by its bucket and key.
-
determineBucketRegionAsync ( string $bucketName )
Returns a promise fulfilled with the region in which a given bucket is located.
Methods inherited from Aws\MultiRegionClient
getApi(),
getCommand(),
getConfig(),
getCredentials(),
getEndpoint(),
getHandlerList(),
getRegion(),
useCustomHandler()
Methods inherited from Aws\AwsClientInterface
Methods inherited from Aws\S3\S3ClientInterface
copy(),
copyAsync(),
deleteMatchingObjects(),
deleteMatchingObjectsAsync(),
determineBucketRegion(),
doesBucketExist(),
doesBucketExistV2(),
doesObjectExist(),
doesObjectExistV2(),
downloadBucket(),
downloadBucketAsync(),
registerStreamWrapper(),
registerStreamWrapperV2(),
upload(),
uploadAsync(),
uploadDirectory(),
uploadDirectoryAsync()
Methods used from Aws\S3\S3ClientTrait
copy(),
copyAsync(),
deleteMatchingObjects(),
deleteMatchingObjectsAsync(),
determineBucketRegion(),
doesBucketExist(),
doesBucketExistV2(),
doesObjectExist(),
doesObjectExistV2(),
downloadBucket(),
downloadBucketAsync(),
execute(),
getCommand(),
getHandlerList(),
getIterator(),
registerStreamWrapper(),
registerStreamWrapperV2(),
upload(),
uploadAsync(),
uploadDirectory(),
uploadDirectoryAsync()
Methods used from Aws\AwsClientTrait
Methods Details
static getArguments ( )
Overrides
__construct ( array $args )
The multi-region client constructor accepts the following options:
- client_factory: (callable) An optional callable that takes an array of client configuration arguments and returns a regionalized client.
- partition: (Aws\Endpoint\Partition|string) AWS partition to connect to. Valid partitions include "aws," "aws-cn," and "aws-us-gov." Used to restrict the scope of the mapRegions method.
- region: (string) Region to connect to when no override is provided. Used to create the default client factory and determine the appropriate AWS partition when present.
Parameters
| array | $args | Client configuration arguments. |
Overrides
RequestInterface
createPresignedRequest (
Aws\CommandInterface
$command,
integer|string|DateTimeInterface
$expires,
array
$options = []
)
Create a pre-signed URL for the given S3 command object.
Parameters
Aws\CommandInterface |
$command | Command to create a pre-signed URL for. |
| integer|string|DateTimeInterface | $expires | 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(). |
| array | $options = [] |
Returns
| RequestInterface |
Implementation of
string getObjectUrl ( string $bucket, string $key )
Returns the URL to an object identified by its bucket and key.
The URL returned by this method is not signed nor does it ensure that the bucket and key given to the method exist. If you need a signed URL, then use the \Aws\S3\S3Client::createPresignedRequest method and get the URI of the signed request.
Parameters
| string | $bucket | The name of the bucket where the object is located |
| string | $key | The key of the object |
Returns
| string The URL to the object |
Implementation of
PromiseInterface determineBucketRegionAsync ( string $bucketName )
Returns a promise fulfilled with the region in which a given bucket is located.
Parameters
| string | $bucketName |
Returns
| PromiseInterface |