SDK for PHP 3.x

S3MultiRegionClient extends MultiRegionClient
in package
implements S3ClientInterface Uses S3ClientTrait

Amazon Simple Storage Service multi-region client.

Table of Contents

Interfaces

S3ClientInterface
Represents an AWS client.

Methods

__call()  : mixed
__construct()  : mixed
The multi-region client constructor accepts the following options:
copy()  : mixed
copyAsync()  : mixed
createPresignedRequest()  : RequestInterface
Create a pre-signed URL for the given S3 command object.
deleteMatchingObjects()  : mixed
deleteMatchingObjectsAsync()  : mixed
determineBucketRegion()  : mixed
determineBucketRegionAsync()  : PromiseInterface
Returns a promise fulfilled with the region in which a given bucket is located.
doesBucketExist()  : mixed
doesBucketExistV2()  : mixed
doesObjectExist()  : mixed
doesObjectExistV2()  : mixed
downloadBucket()  : mixed
downloadBucketAsync()  : mixed
execute()  : mixed
executeAsync()  : mixed
getApi()  : Service
getArguments()  : mixed
getCommand()  : CommandInterface
getConfig()  : mixed|null
Get a client configuration value.
getCredentials()  : PromiseInterface
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
getEndpoint()  : UriInterface
Gets the default endpoint, or base URL, used by the client.
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getIterator()  : mixed
getObjectUrl()  : string
Returns the URL to an object identified by its bucket and key.
getPaginator()  : mixed
getRegion()  : string
Get the region to which the client is configured to send requests by default.
getWaiter()  : mixed
registerStreamWrapper()  : mixed
registerStreamWrapperV2()  : mixed
upload()  : mixed
uploadAsync()  : mixed
uploadDirectory()  : mixed
uploadDirectoryAsync()  : mixed
useCustomHandler()  : mixed
waitUntil()  : mixed

Methods

__call()

public __call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed>

__construct()

The multi-region client constructor accepts the following options:

public __construct(array<string|int, mixed> $args) : mixed
  • 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
$args : array<string|int, mixed>

Client configuration arguments.

copy()

public copy(mixed $fromB, mixed $fromK, mixed $destB, mixed $destK[, mixed $acl = 'private' ][, array<string|int, mixed> $opts = [] ]) : mixed
Parameters
$fromB : mixed
$fromK : mixed
$destB : mixed
$destK : mixed
$acl : mixed = 'private'
$opts : array<string|int, mixed> = []
Tags
see
S3ClientInterface::copy()

copyAsync()

public copyAsync(mixed $fromB, mixed $fromK, mixed $destB, mixed $destK[, mixed $acl = 'private' ][, array<string|int, mixed> $opts = [] ]) : mixed
Parameters
$fromB : mixed
$fromK : mixed
$destB : mixed
$destK : mixed
$acl : mixed = 'private'
$opts : array<string|int, mixed> = []
Tags
see
S3ClientInterface::copyAsync()

createPresignedRequest()

Create a pre-signed URL for the given S3 command object.

public createPresignedRequest(CommandInterface $command, mixed $expires[, array<string|int, mixed> $options = [] ]) : RequestInterface
Parameters
$command : CommandInterface

Command to create a pre-signed URL for.

$expires : mixed

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
RequestInterface

deleteMatchingObjects()

public deleteMatchingObjects(mixed $bucket[, mixed $prefix = '' ][, mixed $regex = '' ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$bucket : mixed
$prefix : mixed = ''
$regex : mixed = ''
$options : array<string|int, mixed> = []
Tags
see
S3ClientInterface::deleteMatchingObjects()

deleteMatchingObjectsAsync()

public deleteMatchingObjectsAsync(mixed $bucket[, mixed $prefix = '' ][, mixed $regex = '' ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$bucket : mixed
$prefix : mixed = ''
$regex : mixed = ''
$options : array<string|int, mixed> = []
Tags
see
S3ClientInterface::deleteMatchingObjectsAsync()

determineBucketRegionAsync()

Returns a promise fulfilled with the region in which a given bucket is located.

public determineBucketRegionAsync(mixed $bucketName) : PromiseInterface
Parameters
$bucketName : mixed
Return values
PromiseInterface

doesBucketExistV2()

public doesBucketExistV2(mixed $bucket[, mixed $accept403 = false ]) : mixed
Parameters
$bucket : mixed
$accept403 : mixed = false
Tags
see
S3ClientInterface::doesBucketExistV2()

doesObjectExist()

public doesObjectExist(mixed $bucket, mixed $key[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$bucket : mixed
$key : mixed
$options : array<string|int, mixed> = []
Tags
see
S3ClientInterface::doesObjectExist()

doesObjectExistV2()

public doesObjectExistV2(mixed $bucket, mixed $key[, mixed $includeDeleteMarkers = false ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$bucket : mixed
$key : mixed
$includeDeleteMarkers : mixed = false
$options : array<string|int, mixed> = []
Tags
see
S3ClientInterface::doesObjectExistV2()

downloadBucket()

public downloadBucket(mixed $directory, mixed $bucket[, mixed $keyPrefix = '' ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$directory : mixed
$bucket : mixed
$keyPrefix : mixed = ''
$options : array<string|int, mixed> = []
Tags
see
S3ClientInterface::downloadBucket()

downloadBucketAsync()

public downloadBucketAsync(mixed $directory, mixed $bucket[, mixed $keyPrefix = '' ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$directory : mixed
$bucket : mixed
$keyPrefix : mixed = ''
$options : array<string|int, mixed> = []
Tags
see
S3ClientInterface::downloadBucketAsync()

getArguments()

public static getArguments() : mixed

getCommand()

public abstract getCommand(string $name[, array<string|int, mixed> $args = [] ]) : CommandInterface
Parameters
$name : string
$args : array<string|int, mixed> = []
Return values
CommandInterface

getConfig()

Get a client configuration value.

public getConfig([mixed $option = null ]) : mixed|null
Parameters
$option : mixed = null

The option to retrieve. Pass null to retrieve all options.

Return values
mixed|null

getCredentials()

Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.

public getCredentials() : PromiseInterface

If you need the credentials synchronously, then call the wait() method on the returned promise.

Return values
PromiseInterface

getEndpoint()

Gets the default endpoint, or base URL, used by the client.

public getEndpoint() : UriInterface
Return values
UriInterface

getHandlerList()

Get the handler list used to transfer commands.

public getHandlerList() : HandlerList

This list can be modified to add middleware or to change the underlying handler used to send HTTP requests.

Return values
HandlerList

getIterator()

public getIterator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []

getObjectUrl()

Returns the URL to an object identified by its bucket and key.

public getObjectUrl(mixed $bucket, mixed $key) : string

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 S3Client::createPresignedRequest method and get the URI of the signed request.

Parameters
$bucket : mixed

The name of the bucket where the object is located

$key : mixed

The key of the object

Return values
string —

The URL to the object

getPaginator()

public getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []

getRegion()

Get the region to which the client is configured to send requests by default.

public getRegion() : string
Return values
string

getWaiter()

public getWaiter(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []

upload()

public upload(mixed $bucket, mixed $key, mixed $body[, mixed $acl = 'private' ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$bucket : mixed
$key : mixed
$body : mixed
$acl : mixed = 'private'
$options : array<string|int, mixed> = []
Tags
see
S3ClientInterface::upload()

uploadAsync()

public uploadAsync(mixed $bucket, mixed $key, mixed $body[, mixed $acl = 'private' ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$bucket : mixed
$key : mixed
$body : mixed
$acl : mixed = 'private'
$options : array<string|int, mixed> = []
Tags
see
S3ClientInterface::uploadAsync()

uploadDirectory()

public uploadDirectory(mixed $directory, mixed $bucket[, mixed $keyPrefix = null ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$directory : mixed
$bucket : mixed
$keyPrefix : mixed = null
$options : array<string|int, mixed> = []
Tags
see
S3ClientInterface::uploadDirectory()

uploadDirectoryAsync()

public uploadDirectoryAsync(mixed $directory, mixed $bucket[, mixed $keyPrefix = null ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$directory : mixed
$bucket : mixed
$keyPrefix : mixed = null
$options : array<string|int, mixed> = []
Tags
see
S3ClientInterface::uploadDirectoryAsync()

useCustomHandler()

public useCustomHandler(callable $handler) : mixed
Parameters
$handler : callable

waitUntil()

public waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
On this page