NOTE: For Version 3 of the AWS SDK for PHP, please see the V3 User Guide and V3 API Reference.

# Class S3Client

Client to interact with Amazon Simple Storage Service

  Guzzle\Common\AbstractHasDispatcher implements Guzzle\Common\HasDispatcherInterface
  Guzzle\Http\Client implements Guzzle\Http\ClientInterface
  Guzzle\Service\Client implements Guzzle\Service\ClientInterface
  Aws\Common\Client\AbstractClient implements Aws\Common\Client\AwsClientInterface
  Aws\S3\S3Client

Namespace: Aws\S3
Link: User guide
Link: API docs
Located at Aws/S3/S3Client.php

## Methods summary

- `public static` `factory ( array|Collection $config = array() )`

  Factory method to create a new Amazon S3 client using an array of configuration options.

- `public static` `isValidBucketName ( string $bucket )`

  Determine if a string is a valid name for a DNS compatible Amazon S3 bucket, meaning the bucket can be used as a subdomain in a URL (e.g., "<bucket>.s3.amazonaws.com").

- `public` `createPresignedUrl ( Guzzle\Http\Message\RequestInterface $request, int|string|\DateTime $expires )`

  Create a pre-signed URL for a request

- `public` `getObjectUrl ( string $bucket, string $key, mixed $expires = null, array $args = array() )`

  Returns the URL to an object identified by its bucket and key. If an expiration time is provided, the URL will be signed and set to expire at the provided time.

- `public` `clearBucket ( string $bucket )`

  Helper used to clear the contents of a bucket. Use the `Aws\S3\Model\ClearBucket` object directly for more advanced options and control.

- `public` `doesBucketExist ( string $bucket, bool $accept403 = true, array $options = array() )`

  Determines whether or not a bucket exists by name

- `public` `doesObjectExist ( string $bucket, string $key, array $options = array() )`

  Determines whether or not an object exists by name

- `public` `doesBucketPolicyExist ( string $bucket, array $options = array() )`

  Determines whether or not a bucket policy exists for a bucket

- `public static` `encodeKey ( string $key )`

  Raw URL encode a key and allow for '/' characters

- `public static` `explodeKey ( string $key )`

  Explode a prefixed key into an array of values

- `public` `registerStreamWrapper ( )`

  Register the Amazon S3 stream wrapper and associates it with this client object

- `public` `upload ( string $bucket, string $key, mixed $body, string $acl = 'private', array $options = array() )`

  Upload a file, stream, or string to a bucket. If the upload size exceeds the specified threshold, the upload will be performed using parallel multipart uploads.

- `public` `uploadDirectory ( string $directory, string $bucket, string $keyPrefix = null, array $options = array() )`

  Recursively uploads all files in a given directory to a given bucket.

- `public` `downloadBucket ( string $directory, string $bucket, string $keyPrefix = '', array $options = array() )`

  Downloads a bucket to the local filesystem

- `public` `deleteMatchingObjects ( string $bucket, string $prefix = '', string $regex = '', array $options = array() )`

  Deletes objects from Amazon S3 that match the result of a ListObjects operation. For example, this allows you to do things like delete all objects that match a specific key prefix.

- `protected` `checkExistenceWithCommand ( Guzzle\Service\Command\CommandInterface $command, bool $accept403 = false )`

  Determines whether or not a resource exists using a command

- `public` `getSignature ( )`

  Returns the signature implementation used with the client

- `public` `abortMultipartUpload ( array $args = array() )`

  Executes the AbortMultipartUpload operation.

- `public` `completeMultipartUpload ( array $args = array() )`

  Executes the CompleteMultipartUpload operation.

- `public` `copyObject ( array $args = array() )`

  Executes the CopyObject operation.

- `public` `createBucket ( array $args = array() )`

  Executes the CreateBucket operation.

- `public` `createMultipartUpload ( array $args = array() )`

  Executes the CreateMultipartUpload operation.

- `public` `deleteBucket ( array $args = array() )`

  Executes the DeleteBucket operation.

- `public` `deleteBucketCors ( array $args = array() )`

  Executes the DeleteBucketCors operation.

- `public` `deleteBucketLifecycle ( array $args = array() )`

  Executes the DeleteBucketLifecycle operation.

- `public` `deleteBucketPolicy ( array $args = array() )`

  Executes the DeleteBucketPolicy operation.

- `public` `deleteBucketReplication ( array $args = array() )`

  Executes the DeleteBucketReplication operation.

- `public` `deleteBucketTagging ( array $args = array() )`

  Executes the DeleteBucketTagging operation.

- `public` `deleteBucketWebsite ( array $args = array() )`

  Executes the DeleteBucketWebsite operation.

- `public` `deleteObject ( array $args = array() )`

  Executes the DeleteObject operation.

- `public` `deleteObjects ( array $args = array() )`

  Executes the DeleteObjects operation.

- `public` `getBucketAcl ( array $args = array() )`

  Executes the GetBucketAcl operation.

- `public` `getBucketCors ( array $args = array() )`

  Executes the GetBucketCors operation.

- `public` `getBucketLifecycle ( array $args = array() )`

  Executes the GetBucketLifecycle operation.

- `public` `getBucketLifecycleConfiguration ( array $args = array() )`

  Executes the GetBucketLifecycleConfiguration operation.

- `public` `getBucketLocation ( array $args = array() )`

  Executes the GetBucketLocation operation.

- `public` `getBucketLogging ( array $args = array() )`

  Executes the GetBucketLogging operation.

- `public` `getBucketNotification ( array $args = array() )`

  Executes the GetBucketNotification operation.

- `public` `getBucketNotificationConfiguration ( array $args = array() )`

  Executes the GetBucketNotificationConfiguration operation.

- `public` `getBucketPolicy ( array $args = array() )`

  Executes the GetBucketPolicy operation.

- `public` `getBucketReplication ( array $args = array() )`

  Executes the GetBucketReplication operation.

- `public` `getBucketRequestPayment ( array $args = array() )`

  Executes the GetBucketRequestPayment operation.

- `public` `getBucketTagging ( array $args = array() )`

  Executes the GetBucketTagging operation.

- `public` `getBucketVersioning ( array $args = array() )`

  Executes the GetBucketVersioning operation.

- `public` `getBucketWebsite ( array $args = array() )`

  Executes the GetBucketWebsite operation.

- `public` `getObject ( array $args = array() )`

  Executes the GetObject operation.

- `public` `getObjectAcl ( array $args = array() )`

  Executes the GetObjectAcl operation.

- `public` `getObjectTorrent ( array $args = array() )`

  Executes the GetObjectTorrent operation.

- `public` `headBucket ( array $args = array() )`

  Executes the HeadBucket operation.

- `public` `headObject ( array $args = array() )`

  Executes the HeadObject operation.

- `public` `listBuckets ( array $args = array() )`

  Executes the ListBuckets operation.

- `public` `listMultipartUploads ( array $args = array() )`

  Executes the ListMultipartUploads operation.

- `public` `listObjectVersions ( array $args = array() )`

  Executes the ListObjectVersions operation.

- `public` `listObjects ( array $args = array() )`

  Executes the ListObjects operation.

- `public` `listParts ( array $args = array() )`

  Executes the ListParts operation.

- `public` `putBucketAcl ( array $args = array() )`

  Executes the PutBucketAcl operation.

- `public` `putBucketCors ( array $args = array() )`

  Executes the PutBucketCors operation.

- `public` `putBucketLifecycle ( array $args = array() )`

  Executes the PutBucketLifecycle operation.

- `public` `putBucketLifecycleConfiguration ( array $args = array() )`

  Executes the PutBucketLifecycleConfiguration operation.

- `public` `putBucketLogging ( array $args = array() )`

  Executes the PutBucketLogging operation.

- `public` `putBucketNotification ( array $args = array() )`

  Executes the PutBucketNotification operation.

- `public` `putBucketNotificationConfiguration ( array $args = array() )`

  Executes the PutBucketNotificationConfiguration operation.

- `public` `putBucketPolicy ( array $args = array() )`

  Executes the PutBucketPolicy operation.

- `public` `putBucketReplication ( array $args = array() )`

  Executes the PutBucketReplication operation.

- `public` `putBucketRequestPayment ( array $args = array() )`

  Executes the PutBucketRequestPayment operation.

- `public` `putBucketTagging ( array $args = array() )`

  Executes the PutBucketTagging operation.

- `public` `putBucketVersioning ( array $args = array() )`

  Executes the PutBucketVersioning operation.

- `public` `putBucketWebsite ( array $args = array() )`

  Executes the PutBucketWebsite operation.

- `public` `putObject ( array $args = array() )`

  Executes the PutObject operation.

- `public` `putObjectAcl ( array $args = array() )`

  Executes the PutObjectAcl operation.

- `public` `restoreObject ( array $args = array() )`

  Executes the RestoreObject operation.

- `public` `uploadPart ( array $args = array() )`

  Executes the UploadPart operation.

- `public` `uploadPartCopy ( array $args = array() )`

  Executes the UploadPartCopy operation.

- `public` `waitUntilBucketExists ( array $input )`

  Wait until a bucket exists. The input array uses the parameters of the HeadBucket operation and waiter specific settings

- `public` `waitUntilBucketNotExists ( array $input )`

  Wait until a bucket does not exist. The input array uses the parameters of the HeadBucket operation and waiter specific settings

- `public` `waitUntilObjectExists ( array $input )`

  Wait until an object exists. The input array uses the parameters of the HeadObject operation and waiter specific settings

- `public` `getListBucketsIterator ( array $args = array() )`

  The input array uses the parameters of the ListBuckets operation

- `public` `getListMultipartUploadsIterator ( array $args = array() )`

  The input array uses the parameters of the ListMultipartUploads operation

- `public` `getListObjectVersionsIterator ( array $args = array() )`

  The input array uses the parameters of the ListObjectVersions operation

- `public` `getListObjectsIterator ( array $args = array() )`

  The input array uses the parameters of the ListObjects operation

- `public` `getListPartsIterator ( array $args = array() )`

  The input array uses the parameters of the ListParts operation

## Methods detail

# `public static `Aws\S3\S3Client``
`factory( array|`Guzzle\Common\Collection` $config = array() )`

Factory method to create a new Amazon S3 client using an array of configuration options.

#### Parameters

$config
  `array|`Guzzle\Common\Collection``
  $config Client configuration data

#### Returns

``Aws\S3\S3Client``

#### Link

http://docs.aws.amazon.com/aws-sdk-php/v2/guide/configuration.html#client-configuration-options

#### Overrides

`Guzzle\Service\Client::factory`
# `public static boolean`
`isValidBucketName( string $bucket )`

Determine if a string is a valid name for a DNS compatible Amazon S3 bucket, meaning the bucket can be used as a subdomain in a URL (e.g., "<bucket>.s3.amazonaws.com").

#### Parameters

$bucket
  `string`
  $bucket The name of the bucket to check.

#### Returns

`boolean`
TRUE if the bucket name is valid or FALSE if it is invalid.
# `public string`
`createPresignedUrl( `Guzzle\Http\Message\RequestInterface` $request, integer|string|`DateTime` $expires )`

Create a pre-signed URL for a request

#### Examples

- Create a presigned URL with a command object

      // Get a command object from the client and pass in any options
      // available in the GetObject command (e.g. ResponseContentDisposition)
      $command = $client->getCommand('GetObject', array(
          'Bucket' => $bucket,
          'Key' => 'data.txt',
          'ResponseContentDisposition' => 'attachment; filename="data.txt"'
      ));

      // Create a signed URL from the command object that will last for
      // 10 minutes from the current time
      $signedUrl = $command->createPresignedUrl('+10 minutes');

      echo file_get_contents($signedUrl);
      // > Hello!

- Create a presigned URL from a custom request object

      $key = 'data.txt';
      $url = "{$bucket}/{$key}";

      // get() returns a Guzzle\Http\Message\Request object
      $request = $client->get($url);

      // Create a signed URL from a completely custom HTTP request that
      // will last for 10 minutes from the current time
      $signedUrl = $client->createPresignedUrl($request, '+10 minutes');

      echo file_get_contents($signedUrl);
      // > Hello!

#### Parameters

$request
  ``Guzzle\Http\Message\RequestInterface``
  $request Request to generate the URL for. Use the factory methods of the client to create this request object
$expires
  `integer|string|`DateTime``
  $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

#### Returns

`string`

#### Throws

``Aws\Common\Exception\InvalidArgumentException``
if the request is not associated with this client object
# `public string`
`getObjectUrl( string $bucket, string $key, mixed $expires = null, array $args = array() )`

Returns the URL to an object identified by its bucket and key. If an expiration time is provided, the URL will be signed and set to expire at the provided time.

Note: This method does not ensure that the generated URL is valid. For example, the bucket referenced may not exist, the key referenced may not exist, and the URL might include parameters that require it to be signed. If you need to use parameters that require a signed URL (e.g., ResponseCacheControl), then you must sign the URL either by providing an $expires argument or by signing the URL returned by this method in some other manner.

#### Examples

- Create plain and presigned URLs for an object

      // Get a plain URL for an Amazon S3 object
      $plainUrl = $client->getObjectUrl($bucket, 'data.txt');
      // > https://my-bucket.s3.amazonaws.com/data.txt

      // Get a pre-signed URL for an Amazon S3 object
      $signedUrl = $client->getObjectUrl($bucket, 'data.txt', '+10 minutes');
      // > https://my-bucket.s3.amazonaws.com/data.txt?AWSAccessKeyId=[...]&Expires=[...]&Signature=[...]

      // Create a vanilla Guzzle HTTP client for accessing the URLs
      $http = new \Guzzle\Http\Client;

      // Try to get the plain URL. This should result in a 403 since the object is private
      try {
          $response = $http->get($plainUrl)->send();
      } catch (\Guzzle\Http\Exception\ClientErrorResponseException $e) {
          $response = $e->getResponse();
      }
      echo $response->getStatusCode();
      // > 403

      // Get the contents of the object using the pre-signed URL
      $response = $http->get($signedUrl)->send();
      echo $response->getBody();
      // > Hello!

- Create presigned URLs for an object with temporary credentials

      // Create a credentials object using temporary credentials retrieved from STS
      $tempCredentials = $stsClient->createCredentials($stsClient->getSessionToken());

      // Create an S3 client using the temporary credentials
      $s3Client = \Aws\S3\S3Client::factory()->setCredentials($tempCredentials);

      // Get a presigned URL for an Amazon S3 object
      $signedUrl = $s3Client->getObjectUrl($bucket, 'data.txt', '+10 minutes');

      echo file_get_contents($signedUrl);
      // > Hello!

#### Parameters

$bucket
  `string`
  $bucket The name of the bucket where the object is located
$key
  `string`
  $key The key of the object
$expires
  `mixed`
  $expires The time at which the URL should expire
$args
  `array`
  $args Arguments to the GetObject command. Additionally you can specify a "Scheme" if you would like the URL to use a different scheme than what the client is configured to use

#### Returns

`string`
The URL to the object
# `public integer`
`clearBucket( string $bucket )`

Helper used to clear the contents of a bucket. Use the `Aws\S3\Model\ClearBucket` object directly for more advanced options and control.

#### Examples

- Clear the contents and delete a bucket

      // Delete the objects in the bucket before attempting to delete
      // the bucket
      $clear = new ClearBucket($client, $bucket);
      $clear->clear();

      // Delete the bucket
      $client->deleteBucket(array('Bucket' => $bucket));

      // Wait until the bucket is not accessible
      $client->waitUntil('BucketNotExists', array('Bucket' => $bucket));

#### Parameters

$bucket
  `string`
  $bucket Name of the bucket to clear.

#### Returns

`integer`
Returns the number of deleted keys
# `public boolean`
`doesBucketExist( string $bucket, boolean $accept403 = true, array $options = array() )`

Determines whether or not a bucket exists by name

#### Parameters

$bucket
  `string`
  $bucket The name of the bucket
$accept403
  `boolean`
  $accept403 Set to true if 403s are acceptable
$options
  `array`
  $options Additional options to add to the executed command

#### Returns

`boolean`
# `public boolean`
`doesObjectExist( string $bucket, string $key, array $options = array() )`

Determines whether or not an object exists by name

#### Parameters

$bucket
  `string`
  $bucket The name of the bucket
$key
  `string`
  $key The key of the object
$options
  `array`
  $options Additional options to add to the executed command

#### Returns

`boolean`
# `public boolean`
`doesBucketPolicyExist( string $bucket, array $options = array() )`

Determines whether or not a bucket policy exists for a bucket

#### Parameters

$bucket
  `string`
  $bucket The name of the bucket
$options
  `array`
  $options Additional options to add to the executed command

#### Returns

`boolean`
# `public static string`
`encodeKey( string $key )`

Raw URL encode a key and allow for '/' characters

#### Parameters

$key
  `string`
  $key Key to encode

#### Returns

`string`
Returns the encoded key
# `public static array`
`explodeKey( string $key )`

Explode a prefixed key into an array of values

#### Parameters

$key
  `string`
  $key Key to explode

#### Returns

`array`
Returns the exploded
# `public mixed`
`registerStreamWrapper( )`

Register the Amazon S3 stream wrapper and associates it with this client object

#### Returns

`mixed`
$this
# `public `Guzzle\Service\Resource\Model``
`upload( string $bucket, string $key, mixed $body, string $acl = 'private', array $options = array() )`

Upload a file, stream, or string to a bucket. If the upload size exceeds the specified threshold, the upload will be performed using parallel multipart uploads.

#### Parameters

$bucket
  `string`
  $bucket Bucket to upload the object
$key
  `string`
  $key Key of the object
$body
  `mixed`
  $body Object data to upload. Can be a Guzzle\Http\EntityBodyInterface, stream resource, or string of data to upload.
$acl
  `string`
  $acl ACL to apply to the object
$options
  `array`
  $options Custom options used when executing commands: - params: Custom parameters to use with the upload. The parameters must map to a PutObject or InitiateMultipartUpload operation parameters. - min_part_size: Minimum size to allow for each uploaded part when performing a multipart upload. - concurrency: Maximum number of concurrent multipart uploads. - before_upload: Callback to invoke before each multipart upload. The callback will receive a Guzzle\Common\Event object with context.

#### Returns

``Guzzle\Service\Resource\Model``
Returns the modeled result of the performed operation

#### See

Aws\S3\Model\MultipartUpload\UploadBuilder for more options and customization
# `public`
`uploadDirectory( string $directory, string $bucket, string $keyPrefix = null, array $options = array() )`

Recursively uploads all files in a given directory to a given bucket.

#### Parameters

$directory
  `string`
  $directory Full path to a directory to upload
$bucket
  `string`
  $bucket Name of the bucket
$keyPrefix
  `string`
  $keyPrefix Virtual directory key prefix to add to each upload
$options
  `array`
  $options Associative array of upload options - params: Array of parameters to use with each PutObject operation performed during the transfer - base_dir: Base directory to remove from each object key - force: Set to true to upload every file, even if the file is already in Amazon S3 and has not changed - concurrency: Maximum number of parallel uploads (defaults to 10) - debug: Set to true or an fopen resource to enable debug mode to print information about each upload - multipart_upload_size: When the size of a file exceeds this value, the file will be uploaded using a multipart upload.

#### See

Aws\S3\S3Sync\S3Sync for more options and customization
# `public`
`downloadBucket( string $directory, string $bucket, string $keyPrefix = '', array $options = array() )`

Downloads a bucket to the local filesystem

#### Parameters

$directory
  `string`
  $directory Directory to download to
$bucket
  `string`
  $bucket Bucket to download from
$keyPrefix
  `string`
  $keyPrefix Only download objects that use this key prefix
$options
  `array`
  $options Associative array of download options - params: Array of parameters to use with each GetObject operation performed during the transfer - base_dir: Base directory to remove from each object key when storing in the local filesystem - force: Set to true to download every file, even if the file is already on the local filesystem and has not changed - concurrency: Maximum number of parallel downloads (defaults to 10) - debug: Set to true or a fopen resource to enable debug mode to print information about each download - allow_resumable: Set to true to allow previously interrupted downloads to be resumed using a Range GET

# `public integer`
`deleteMatchingObjects( string $bucket, string $prefix = '', string $regex = '', array $options = array() )`

Deletes objects from Amazon S3 that match the result of a ListObjects operation. For example, this allows you to do things like delete all objects that match a specific key prefix.

#### Parameters

$bucket
  `string`
  $bucket Bucket that contains the object keys
$prefix
  `string`
  $prefix Optionally delete only objects under this key prefix
$regex
  `string`
  $regex Delete only objects that match this regex
$options
  `array`
  $options Options used when deleting the object: - before_delete: Callback to invoke before each delete. The callback will receive a Guzzle\Common\Event object with context.

#### Returns

`integer`
Returns the number of deleted keys

#### Throws

``Aws\Common\Exception\RuntimeException``
if no prefix and no regex is given

#### See

``Aws\S3\S3Client::listObjects()``
Aws\S3\Model\ClearBucket For more options or customization
# `protected boolean`
`checkExistenceWithCommand( `Guzzle\Service\Command\CommandInterface` $command, boolean $accept403 = false )`

Determines whether or not a resource exists using a command

#### Parameters

$command
  ``Guzzle\Service\Command\CommandInterface``
  $command Command used to poll for the resource
$accept403
  `boolean`
  $accept403 Set to true if 403s are acceptable

#### Returns

`boolean`

#### Throws

``Aws\S3\Exception\S3Exception`|`Exception``
if there is an unhandled exception
# `public S3SignatureInterface`
`getSignature( )`

Returns the signature implementation used with the client

#### Returns

`S3SignatureInterface`

#### Overrides

`Aws\Common\Client\AbstractClient::getSignature`
# `public `Guzzle\Service\Resource\Model``
`abortMultipartUpload( array $args = array() )`

Executes the AbortMultipartUpload operation.

Aborts a multipart upload.

To verify that all parts have been removed, so you don't get charged for the part storage, you should call the List Parts operation and ensure the parts list is empty.

#### Examples

- Basic formatting example

      $result = $client->abortMultipartUpload(array(
          // Bucket is required
          'Bucket' => 'string',
          // Key is required
          'Key' => 'string',
          // UploadId is required
          'UploadId' => 'string',
          'RequestPayer' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
  - Key => (string)
  - UploadId => (string)
  - RequestPayer => (string: requester )
    Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- RequestCharged => (string)
  If present, indicates that the requester was successfully charged for the request.
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`completeMultipartUpload( array $args = array() )`

Executes the CompleteMultipartUpload operation.

Completes a multipart upload by assembling previously uploaded parts.

#### Examples

- Basic formatting example

      $result = $client->completeMultipartUpload(array(
          // Bucket is required
          'Bucket' => 'string',
          // Key is required
          'Key' => 'string',
          'Parts' => array(
              array(
                  'ETag' => 'string',
                  'PartNumber' => integer,
              ),
              // ... repeated
          ),
          // UploadId is required
          'UploadId' => 'string',
          'RequestPayer' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
  - Key => (string)
  - Parts => (array<associative-array>)
    - (associative-array)
      - ETag => (string)
        Entity tag returned when the part was uploaded.
      - PartNumber => (int)
        Part number that identifies the part. This is a positive integer between 1 and 10,000.
  - UploadId => (string)
  - RequestPayer => (string: requester )
    Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Location => (string)
- Bucket => (string)
- Key => (string)
- Expiration => (string)
  If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.
- ETag => (string)
  Entity tag of the object.
- ServerSideEncryption => (string)
  The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
- VersionId => (string)
  Version of the object.
- SSEKMSKeyId => (string)
  If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.
- RequestCharged => (string)
  If present, indicates that the requester was successfully charged for the request.
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`copyObject( array $args = array() )`

Executes the CopyObject operation.

Creates a copy of an object that is already stored in Amazon S3.

#### Examples

- Basic formatting example

      $result = $client->copyObject(array(
          'ACL' => 'string',
          // Bucket is required
          'Bucket' => 'string',
          'CacheControl' => 'string',
          'ContentDisposition' => 'string',
          'ContentEncoding' => 'string',
          'ContentLanguage' => 'string',
          'ContentType' => 'string',
          // CopySource is required
          'CopySource' => 'string',
          'CopySourceIfMatch' => 'string',
          'CopySourceIfModifiedSince' => 'mixed type: string (date format)|int (unix timestamp)|\DateTime',
          'CopySourceIfNoneMatch' => 'string',
          'CopySourceIfUnmodifiedSince' => 'mixed type: string (date format)|int (unix timestamp)|\DateTime',
          'Expires' => 'mixed type: string (date format)|int (unix timestamp)|\DateTime',
          'GrantFullControl' => 'string',
          'GrantRead' => 'string',
          'GrantReadACP' => 'string',
          'GrantWriteACP' => 'string',
          // Key is required
          'Key' => 'string',
          'Metadata' => array(
              // Associative array of custom 'string' key names
              'string' => 'string',
              // ... repeated
          ),
          'MetadataDirective' => 'string',
          'ServerSideEncryption' => 'string',
          'StorageClass' => 'string',
          'WebsiteRedirectLocation' => 'string',
          'SSECustomerAlgorithm' => 'string',
          'SSECustomerKey' => 'string',
          'SSECustomerKeyMD5' => 'string',
          'SSEKMSKeyId' => 'string',
          'CopySourceSSECustomerAlgorithm' => 'string',
          'CopySourceSSECustomerKey' => 'string',
          'CopySourceSSECustomerKeyMD5' => 'string',
          'RequestPayer' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - ACL => (string: private | public-read | public-read-write | authenticated-read | bucket-owner-read | bucket-owner-full-control )
    The canned ACL to apply to the object.
  - Bucket => (string)
  - CacheControl => (string)
    Specifies caching behavior along the request/reply chain.
  - ContentDisposition => (string)
    Specifies presentational information for the object.
  - 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.
  - ContentLanguage => (string)
    The language the content is in.
  - ContentType => (string)
    A standard MIME type describing the format of the object data.
  - CopySource => (string)
    The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.
  - CopySourceIfMatch => (string)
    Copies the object if its entity tag (ETag) matches the specified tag.
  - CopySourceIfModifiedSince => (string [date format]|int [unix timestamp]|\DateTime)
    Copies the object if it has been modified since the specified time.
  - CopySourceIfNoneMatch => (string)
    Copies the object if its entity tag (ETag) is different than the specified ETag.
  - CopySourceIfUnmodifiedSince => (string [date format]|int [unix timestamp]|\DateTime)
    Copies the object if it hasn't been modified since the specified time.
  - Expires => (string [date format]|int [unix timestamp]|\DateTime)
    The date and time at which the object is no longer cacheable.
  - GrantFullControl => (string)
    Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
  - GrantRead => (string)
    Allows grantee to read the object data and its metadata.
  - GrantReadACP => (string)
    Allows grantee to read the object ACL.
  - GrantWriteACP => (string)
    Allows grantee to write the ACL for the applicable object.
  - Key => (string)
  - Metadata => (associative-array<string>)

    Associative array of <string> keys mapping to (string) values. Each array key should be changed to an appropriate <string>.

    A map of metadata to store with the object in S3.
    - <string> => (string)
      The metadata key. This will be prefixed with x-amz-meta- before sending to S3 as a header. The x-amz-meta- header will be stripped from the key when retrieving headers.
  - MetadataDirective => (string: COPY | REPLACE )
    Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
  - ServerSideEncryption => (string: AES256 | aws:kms )
    The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
  - StorageClass => (string: STANDARD | REDUCED_REDUNDANCY | STANDARD_IA )
    The type of storage to use for the object. Defaults to 'STANDARD'.
  - WebsiteRedirectLocation => (string)
    If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
  - SSECustomerAlgorithm => (string)
    Specifies the algorithm to use to when encrypting the object (e.g., AES256).
  - SSECustomerKey => (string)
    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.
  - SSECustomerKeyMD5 => (string)
    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
  - SSEKMSKeyId => (string)
    Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
  - CopySourceSSECustomerAlgorithm => (string)
    Specifies the algorithm to use when decrypting the source object (e.g., AES256).
  - CopySourceSSECustomerKey => (string)
    Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.
  - CopySourceSSECustomerKeyMD5 => (string)
    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
  - RequestPayer => (string: requester )
    Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- ETag => (string)
- LastModified => (string)
- Expiration => (string)
  If the object expiration is configured, the response includes this header.
- CopySourceVersionId => (string)
- VersionId => (string)
  Version ID of the newly created copy.
- ServerSideEncryption => (string)
  The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
- SSECustomerAlgorithm => (string)
  If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
- SSECustomerKeyMD5 => (string)
  If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.
- SSEKMSKeyId => (string)
  If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.
- RequestCharged => (string)
  If present, indicates that the requester was successfully charged for the request.
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`createBucket( array $args = array() )`

Executes the CreateBucket operation.

Creates a new bucket.

#### Examples

- Basic formatting example

      $result = $client->createBucket(array(
          'ACL' => 'string',
          // Bucket is required
          'Bucket' => 'string',
          'LocationConstraint' => 'string',
          'GrantFullControl' => 'string',
          'GrantRead' => 'string',
          'GrantReadACP' => 'string',
          'GrantWrite' => 'string',
          'GrantWriteACP' => 'string',
      ));

- Create an Amazon S3 bucket

      $client->createBucket(array('Bucket' => 'mybucket'));

- Create a bucket in a specific region

      // Create a valid bucket and use a LocationConstraint
      $result = $client->createBucket(array(
          'Bucket'             => $bucket,
          'LocationConstraint' => 'us-west-2',
      ));

      // Get the Location header of the response
      echo $result['Location'] . "\n";

      // Get the request ID
      echo $result['RequestId'] . "\n";

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - ACL => (string: private | public-read | public-read-write | authenticated-read )
    The canned ACL to apply to the bucket.
  - Bucket => (string)
  - LocationConstraint => (string: EU | eu-west-1 | us-west-1 | us-west-2 | ap-southeast-1 | ap-southeast-2 | ap-northeast-1 | sa-east-1 | cn-north-1 | eu-central-1 )
    Specifies the region where the bucket will be created. If you don't specify a region, the bucket will be created in US Standard.
  - GrantFullControl => (string)
    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
  - GrantRead => (string)
    Allows grantee to list the objects in the bucket.
  - GrantReadACP => (string)
    Allows grantee to read the bucket ACL.
  - GrantWrite => (string)
    Allows grantee to create, overwrite, and delete any object in the bucket.
  - GrantWriteACP => (string)
    Allows grantee to write the ACL for the applicable bucket.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Location => (string)
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`createMultipartUpload( array $args = array() )`

Executes the CreateMultipartUpload operation.

Initiates a multipart upload and returns an upload ID.

Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

#### Examples

- Basic formatting example

      $result = $client->createMultipartUpload(array(
          'ACL' => 'string',
          // Bucket is required
          'Bucket' => 'string',
          'CacheControl' => 'string',
          'ContentDisposition' => 'string',
          'ContentEncoding' => 'string',
          'ContentLanguage' => 'string',
          'ContentType' => 'string',
          'Expires' => 'mixed type: string (date format)|int (unix timestamp)|\DateTime',
          'GrantFullControl' => 'string',
          'GrantRead' => 'string',
          'GrantReadACP' => 'string',
          'GrantWriteACP' => 'string',
          // Key is required
          'Key' => 'string',
          'Metadata' => array(
              // Associative array of custom 'string' key names
              'string' => 'string',
              // ... repeated
          ),
          'ServerSideEncryption' => 'string',
          'StorageClass' => 'string',
          'WebsiteRedirectLocation' => 'string',
          'SSECustomerAlgorithm' => 'string',
          'SSECustomerKey' => 'string',
          'SSECustomerKeyMD5' => 'string',
          'SSEKMSKeyId' => 'string',
          'RequestPayer' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - ACL => (string: private | public-read | public-read-write | authenticated-read | bucket-owner-read | bucket-owner-full-control )
    The canned ACL to apply to the object.
  - Bucket => (string)
  - CacheControl => (string)
    Specifies caching behavior along the request/reply chain.
  - ContentDisposition => (string)
    Specifies presentational information for the object.
  - 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.
  - ContentLanguage => (string)
    The language the content is in.
  - ContentType => (string)
    A standard MIME type describing the format of the object data.
  - Expires => (string [date format]|int [unix timestamp]|\DateTime)
    The date and time at which the object is no longer cacheable.
  - GrantFullControl => (string)
    Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
  - GrantRead => (string)
    Allows grantee to read the object data and its metadata.
  - GrantReadACP => (string)
    Allows grantee to read the object ACL.
  - GrantWriteACP => (string)
    Allows grantee to write the ACL for the applicable object.
  - Key => (string)
  - Metadata => (associative-array<string>)

    Associative array of <string> keys mapping to (string) values. Each array key should be changed to an appropriate <string>.

    A map of metadata to store with the object in S3.
    - <string> => (string)
      The metadata key. This will be prefixed with x-amz-meta- before sending to S3 as a header. The x-amz-meta- header will be stripped from the key when retrieving headers.
  - ServerSideEncryption => (string: AES256 | aws:kms )
    The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
  - StorageClass => (string: STANDARD | REDUCED_REDUNDANCY | STANDARD_IA )
    The type of storage to use for the object. Defaults to 'STANDARD'.
  - WebsiteRedirectLocation => (string)
    If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
  - SSECustomerAlgorithm => (string)
    Specifies the algorithm to use to when encrypting the object (e.g., AES256).
  - SSECustomerKey => (string)
    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.
  - SSECustomerKeyMD5 => (string)
    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
  - SSEKMSKeyId => (string)
    Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
  - RequestPayer => (string: requester )
    Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Bucket => (string)
  Name of the bucket to which the multipart upload was initiated.
- Key => (string)
  Object key for which the multipart upload was initiated.
- UploadId => (string)
  ID for the initiated multipart upload.
- ServerSideEncryption => (string)
  The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
- SSECustomerAlgorithm => (string)
  If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
- SSECustomerKeyMD5 => (string)
  If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.
- SSEKMSKeyId => (string)
  If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.
- RequestCharged => (string)
  If present, indicates that the requester was successfully charged for the request.
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`deleteBucket( array $args = array() )`

Executes the DeleteBucket operation.

Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket itself can be deleted.

#### Examples

- Basic formatting example

      $result = $client->deleteBucket(array(
          // Bucket is required
          'Bucket' => 'string',
      ));

- Clear the contents and delete a bucket

      // Delete the objects in the bucket before attempting to delete
      // the bucket
      $clear = new ClearBucket($client, $bucket);
      $clear->clear();

      // Delete the bucket
      $client->deleteBucket(array('Bucket' => $bucket));

      // Wait until the bucket is not accessible
      $client->waitUntil('BucketNotExists', array('Bucket' => $bucket));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`deleteBucketCors( array $args = array() )`

Executes the DeleteBucketCors operation.

Deletes the cors configuration information set for the bucket.

#### Examples

- Basic formatting example

      $result = $client->deleteBucketCors(array(
          // Bucket is required
          'Bucket' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`deleteBucketLifecycle( array $args = array() )`

Executes the DeleteBucketLifecycle operation.

Deletes the lifecycle configuration from the bucket.

#### Examples

- Basic formatting example

      $result = $client->deleteBucketLifecycle(array(
          // Bucket is required
          'Bucket' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`deleteBucketPolicy( array $args = array() )`

Executes the DeleteBucketPolicy operation.

Deletes the policy from the bucket.

#### Examples

- Basic formatting example

      $result = $client->deleteBucketPolicy(array(
          // Bucket is required
          'Bucket' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`deleteBucketReplication( array $args = array() )`

Executes the DeleteBucketReplication operation.

#### Examples

- Basic formatting example

      $result = $client->deleteBucketReplication(array(
          // Bucket is required
          'Bucket' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- RequestId => ()
  Request ID of the operation

# `public `Guzzle\Service\Resource\Model``
`deleteBucketTagging( array $args = array() )`

Executes the DeleteBucketTagging operation.

Deletes the tags from the bucket.

#### Examples

- Basic formatting example

      $result = $client->deleteBucketTagging(array(
          // Bucket is required
          'Bucket' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`deleteBucketWebsite( array $args = array() )`

Executes the DeleteBucketWebsite operation.

This operation removes the website configuration from the bucket.

#### Examples

- Basic formatting example

      $result = $client->deleteBucketWebsite(array(
          // Bucket is required
          'Bucket' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`deleteObject( array $args = array() )`

Executes the DeleteObject operation.

Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects.

#### Examples

- Basic formatting example

      $result = $client->deleteObject(array(
          // Bucket is required
          'Bucket' => 'string',
          // Key is required
          'Key' => 'string',
          'MFA' => 'string',
          'VersionId' => 'string',
          'RequestPayer' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
  - Key => (string)
  - MFA => (string)
    The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.
  - VersionId => (string)
    VersionId used to reference a specific version of the object.
  - RequestPayer => (string: requester )
    Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DeleteMarker => (bool)
  Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker.
- VersionId => (string)
  Returns the version ID of the delete marker created as a result of the DELETE operation.
- RequestCharged => (string)
  If present, indicates that the requester was successfully charged for the request.
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`deleteObjects( array $args = array() )`

Executes the DeleteObjects operation.

This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys.

#### Examples

- Basic formatting example

      $result = $client->deleteObjects(array(
          // Bucket is required
          'Bucket' => 'string',
          // Objects is required
          'Objects' => array(
              array(
                  // Key is required
                  'Key' => 'string',
                  'VersionId' => 'string',
              ),
              // ... repeated
          ),
          'Quiet' => true || false,
          'MFA' => 'string',
          'RequestPayer' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
  - Objects => (array<associative-array>)
    - (associative-array)
      - Key => (string)
        Key name of the object to delete.
      - VersionId => (string)
        VersionId for the specific version of the object to delete.
  - Quiet => (bool)
    Element to enable quiet mode for the request. When you add this element, you must set its value to true.
  - MFA => (string)
    The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.
  - RequestPayer => (string: requester )
    Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Deleted => (array<associative-array>)
  - (associative-array)
    - Key => (string)
    - VersionId => (string)
    - DeleteMarker => (bool)
    - DeleteMarkerVersionId => (string)
- RequestCharged => (string)
  If present, indicates that the requester was successfully charged for the request.
- Errors => (array<associative-array>)
  - (associative-array)
    - Key => (string)
    - VersionId => (string)
    - Code => (string)
    - Message => (string)
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`getBucketAcl( array $args = array() )`

Executes the GetBucketAcl operation.

Gets the access control policy for the bucket.

#### Examples

- Basic formatting example

      $result = $client->getBucketAcl(array(
          // Bucket is required
          'Bucket' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Owner => (associative-array)
  - DisplayName => (string)
  - ID => (string)
- Grants => (array<associative-array>)
  A list of grants.
  - (associative-array)
    - Grantee => (associative-array)
      - DisplayName => (string)
        Screen name of the grantee.
      - EmailAddress => (string)
        Email address of the grantee.
      - ID => (string)
        The canonical user ID of the grantee.
      - Type => (string)
        Type of grantee
      - URI => (string)
        URI of the grantee group.
    - Permission => (string)
      Specifies the permission given to the grantee.
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`getBucketCors( array $args = array() )`

Executes the GetBucketCors operation.

Returns the cors configuration for the bucket.

#### Examples

- Basic formatting example

      $result = $client->getBucketCors(array(
          // Bucket is required
          'Bucket' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- CORSRules => (array<associative-array>)
  - (associative-array)
    - AllowedHeaders => (array<string>)
      Specifies which headers are allowed in a pre-flight OPTIONS request.
    - AllowedMethods => (array<string>)
      Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute.
    - AllowedOrigins => (array<string>)
      One or more origins you want customers to be able to access the bucket from.
    - ExposeHeaders => (array<string>)
      One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).
    - MaxAgeSeconds => (int)
      The time in seconds that your browser is to cache the preflight response for the specified resource.
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`getBucketLifecycle( array $args = array() )`

Executes the GetBucketLifecycle operation.

Deprecated, see the GetBucketLifecycleConfiguration operation.

#### Examples

- Basic formatting example

      $result = $client->getBucketLifecycle(array(
          // Bucket is required
          'Bucket' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Rules => (array<associative-array>)
  - (associative-array)
    - Expiration => (associative-array)
      - Date => (string)
        Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.
      - Days => (int)
        Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.
    - ID => (string)
      Unique identifier for the rule. The value cannot be longer than 255 characters.
    - Prefix => (string)
      Prefix identifying one or more objects to which the rule applies.
    - Status => (string)
      If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.
    - Transition => (associative-array)
      - Date => (string)
        Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.
      - Days => (int)
        Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.
      - StorageClass => (string)
        The class of storage used to store the object.
    - NoncurrentVersionTransition => (associative-array)
      Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA or GLACIER storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA or GLACIER storage class at a specific period in the object's lifetime.
      - NoncurrentDays => (int)
        Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide.
      - StorageClass => (string)
        The class of storage used to store the object.
    - NoncurrentVersionExpiration => (associative-array)
      Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.
      - NoncurrentDays => (int)
        Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide.
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`getBucketLifecycleConfiguration( array $args = array() )`

Executes the GetBucketLifecycleConfiguration operation.

Returns the lifecycle configuration information set on the bucket.

#### Examples

- Basic formatting example

      $result = $client->getBucketLifecycleConfiguration(array(
          // Bucket is required
          'Bucket' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Rules => (array<associative-array>)
  - (associative-array)
    - Expiration => (associative-array)
      - Date => (string)
        Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.
      - Days => (int)
        Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.
    - ID => (string)
      Unique identifier for the rule. The value cannot be longer than 255 characters.
    - Prefix => (string)
      Prefix identifying one or more objects to which the rule applies.
    - Status => (string)
      If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.
    - Transitions => (array<associative-array>)
      - (associative-array)
        - Date => (string)
          Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.
        - Days => (int)
          Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.
        - StorageClass => (string)
          The class of storage used to store the object.
    - NoncurrentVersionTransitions => (array<associative-array>)
      - (associative-array)
        Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA or GLACIER storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA or GLACIER storage class at a specific period in the object's lifetime.
        - NoncurrentDays => (int)
          Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide.
        - StorageClass => (string)
          The class of storage used to store the object.
    - NoncurrentVersionExpiration => (associative-array)
      Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.
      - NoncurrentDays => (int)
        Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide.
- RequestId => ()
  Request ID of the operation

# `public `Guzzle\Service\Resource\Model``
`getBucketLocation( array $args = array() )`

Executes the GetBucketLocation operation.

Returns the region the bucket resides in.

#### Examples

- Basic formatting example

      $result = $client->getBucketLocation(array(
          // Bucket is required
          'Bucket' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Location => (string)

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`getBucketLogging( array $args = array() )`

Executes the GetBucketLogging operation.

Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner.

#### Examples

- Basic formatting example

      $result = $client->getBucketLogging(array(
          // Bucket is required
          'Bucket' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- LoggingEnabled => (associative-array)
  - TargetBucket => (string)
    Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key.
  - TargetGrants => (array<associative-array>)
    - (associative-array)
      - Grantee => (associative-array)
        - DisplayName => (string)
          Screen name of the grantee.
        - EmailAddress => (string)
          Email address of the grantee.
        - ID => (string)
          The canonical user ID of the grantee.
        - Type => (string)
          Type of grantee
        - URI => (string)
          URI of the grantee group.
      - Permission => (string)
        Logging permissions assigned to the Grantee for the bucket.
  - TargetPrefix => (string)
    This element lets you specify a prefix for the keys that the log files will be stored under.
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`getBucketNotification( array $args = array() )`

Executes the GetBucketNotification operation.

Deprecated, see the GetBucketNotificationConfiguration operation.

#### Examples

- Basic formatting example

      $result = $client->getBucketNotification(array(
          // Bucket is required
          'Bucket' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
    Name of the buket to get the notification configuration for.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- TopicConfiguration => (associative-array)
  - Id => (string)
    Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.
  - Events => (array<string>)(string)
    Bucket event for which to send notifications.
  - Event => (string)
    Bucket event for which to send notifications.
  - Topic => (string)
    Amazon SNS topic to which Amazon S3 will publish a message to report the specified events for the bucket.
- QueueConfiguration => (associative-array)
  - Id => (string)
    Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.
  - Event => (string)
    Bucket event for which to send notifications.
  - Events => (array<string>)(string)
    Bucket event for which to send notifications.
  - Queue => (string)
- CloudFunctionConfiguration => (associative-array)
  - Id => (string)
    Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.
  - Event => (string)
    Bucket event for which to send notifications.
  - Events => (array<string>)(string)
    Bucket event for which to send notifications.
  - CloudFunction => (string)
  - InvocationRole => (string)
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`getBucketNotificationConfiguration( array $args = array() )`

Executes the GetBucketNotificationConfiguration operation.

Returns the notification configuration of a bucket.

#### Examples

- Basic formatting example

      $result = $client->getBucketNotificationConfiguration(array(
          // Bucket is required
          'Bucket' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
    Name of the buket to get the notification configuration for.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- TopicConfigurations => (array<associative-array>)
  - (associative-array)
    Container for specifying the configuration when you want Amazon S3 to publish events to an Amazon Simple Notification Service (Amazon SNS) topic.
    - Id => (string)
      Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.
    - TopicArn => (string)
      Amazon SNS topic ARN to which Amazon S3 will publish a message when it detects events of specified type.
    - Events => (array<string>)(string)
      Bucket event for which to send notifications.
    - Filter => (associative-array)
      Container for object key name filtering rules. For information about key name filtering, go to Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide.
      - Key => (associative-array)
        Container for object key name prefix and suffix filtering rules.
        - FilterRules => (array<associative-array>)
          A list of containers for key value pair that defines the criteria for the filter rule.
          - (associative-array)
            Container for key value pair that defines the criteria for the filter rule.
            - Name => (string)
              Object key name prefix or suffix identifying one or more objects to which the filtering rule applies. Maximum prefix length can be up to 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, go to Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide.
            - Value => (string)
- QueueConfigurations => (array<associative-array>)
  - (associative-array)
    Container for specifying an configuration when you want Amazon S3 to publish events to an Amazon Simple Queue Service (Amazon SQS) queue.
    - Id => (string)
      Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.
    - QueueArn => (string)
      Amazon SQS queue ARN to which Amazon S3 will publish a message when it detects events of specified type.
    - Events => (array<string>)(string)
      Bucket event for which to send notifications.
    - Filter => (associative-array)
      Container for object key name filtering rules. For information about key name filtering, go to Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide.
      - Key => (associative-array)
        Container for object key name prefix and suffix filtering rules.
        - FilterRules => (array<associative-array>)
          A list of containers for key value pair that defines the criteria for the filter rule.
          - (associative-array)
            Container for key value pair that defines the criteria for the filter rule.
            - Name => (string)
              Object key name prefix or suffix identifying one or more objects to which the filtering rule applies. Maximum prefix length can be up to 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, go to Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide.
            - Value => (string)
- LambdaFunctionConfigurations => (array<associative-array>)
  - (associative-array)
    Container for specifying the AWS Lambda notification configuration.
    - Id => (string)
      Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.
    - LambdaFunctionArn => (string)
      Lambda cloud function ARN that Amazon S3 can invoke when it detects events of the specified type.
    - Events => (array<string>)(string)
      Bucket event for which to send notifications.
    - Filter => (associative-array)
      Container for object key name filtering rules. For information about key name filtering, go to Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide.
      - Key => (associative-array)
        Container for object key name prefix and suffix filtering rules.
        - FilterRules => (array<associative-array>)
          A list of containers for key value pair that defines the criteria for the filter rule.
          - (associative-array)
            Container for key value pair that defines the criteria for the filter rule.
            - Name => (string)
              Object key name prefix or suffix identifying one or more objects to which the filtering rule applies. Maximum prefix length can be up to 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, go to Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide.
            - Value => (string)
- RequestId => ()
  Request ID of the operation

# `public `Guzzle\Service\Resource\Model``
`getBucketPolicy( array $args = array() )`

Executes the GetBucketPolicy operation.

Returns the policy of a specified bucket.

#### Examples

- Basic formatting example

      $result = $client->getBucketPolicy(array(
          // Bucket is required
          'Bucket' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Policy => (string | Guzzle\Http\EntityBody)
  The bucket policy as a JSON document.
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`getBucketReplication( array $args = array() )`

Executes the GetBucketReplication operation.

#### Examples

- Basic formatting example

      $result = $client->getBucketReplication(array(
          // Bucket is required
          'Bucket' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Role => (string)
  Amazon Resource Name (ARN) of an IAM role for Amazon S3 to assume when replicating the objects.
- Rules => (array<associative-array>)
  Container for information about a particular replication rule. Replication configuration must have at least one rule and can contain up to 1,000 rules.
  - (associative-array)
    - ID => (string)
      Unique identifier for the rule. The value cannot be longer than 255 characters.
    - Prefix => (string)
      Object keyname prefix identifying one or more objects to which the rule applies. Maximum prefix length can be up to 1,024 characters. Overlapping prefixes are not supported.
    - Status => (string)
      The rule is ignored if status is not Enabled.
    - Destination => (associative-array)
      - Bucket => (string)
        Amazon resource name (ARN) of the bucket where you want Amazon S3 to store replicas of the object identified by the rule.
      - StorageClass => (string)
        The class of storage used to store the object.
- RequestId => ()
  Request ID of the operation

# `public `Guzzle\Service\Resource\Model``
`getBucketRequestPayment( array $args = array() )`

Executes the GetBucketRequestPayment operation.

Returns the request payment configuration of a bucket.

#### Examples

- Basic formatting example

      $result = $client->getBucketRequestPayment(array(
          // Bucket is required
          'Bucket' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Payer => (string)
  Specifies who pays for the download and request fees.
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`getBucketTagging( array $args = array() )`

Executes the GetBucketTagging operation.

Returns the tag set associated with the bucket.

#### Examples

- Basic formatting example

      $result = $client->getBucketTagging(array(
          // Bucket is required
          'Bucket' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- TagSet => (array<associative-array>)
  - (associative-array)
    - Key => (string)
      Name of the tag.
    - Value => (string)
      Value of the tag.
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`getBucketVersioning( array $args = array() )`

Executes the GetBucketVersioning operation.

Returns the versioning state of a bucket.

#### Examples

- Basic formatting example

      $result = $client->getBucketVersioning(array(
          // Bucket is required
          'Bucket' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Status => (string)
  The versioning state of the bucket.
- MFADelete => (string)
  Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`getBucketWebsite( array $args = array() )`

Executes the GetBucketWebsite operation.

Returns the website configuration for a bucket.

#### Examples

- Basic formatting example

      $result = $client->getBucketWebsite(array(
          // Bucket is required
          'Bucket' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- RedirectAllRequestsTo => (associative-array)
  - HostName => (string)
    Name of the host where requests will be redirected.
  - Protocol => (string)
    Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request.
- IndexDocument => (associative-array)
  - Suffix => (string)
    A suffix that is appended to a request that is for a directory on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character.
- ErrorDocument => (associative-array)
  - Key => (string)
    The object key name to use when a 4XX class error occurs.
- RoutingRules => (array<associative-array>)
  - (associative-array)
    - Condition => (associative-array)
      A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.
      - HttpErrorCodeReturnedEquals => (string)
        The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied.
      - KeyPrefixEquals => (string)
        The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied.
    - Redirect => (associative-array)
      Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can can specify a different error code to return.
      - HostName => (string)
        The host name to use in the redirect request.
      - HttpRedirectCode => (string)
        The HTTP redirect code to use on the response. Not required if one of the siblings is present.
      - Protocol => (string)
        Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request.
      - ReplaceKeyPrefixWith => (string)
        The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided.
      - ReplaceKeyWith => (string)
        The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is present. Can be present only if ReplaceKeyPrefixWith is not provided.
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`getObject( array $args = array() )`

Executes the GetObject operation.

Retrieves objects from Amazon S3.

#### Examples

- Basic formatting example

      $result = $client->getObject(array(
          // Bucket is required
          'Bucket' => 'string',
          'IfMatch' => 'string',
          'IfModifiedSince' => 'mixed type: string (date format)|int (unix timestamp)|\DateTime',
          'IfNoneMatch' => 'string',
          'IfUnmodifiedSince' => 'mixed type: string (date format)|int (unix timestamp)|\DateTime',
          // Key is required
          'Key' => 'string',
          'Range' => 'string',
          'ResponseCacheControl' => 'string',
          'ResponseContentDisposition' => 'string',
          'ResponseContentEncoding' => 'string',
          'ResponseContentLanguage' => 'string',
          'ResponseContentType' => 'string',
          'ResponseExpires' => 'mixed type: string (date format)|int (unix timestamp)|\DateTime',
          'VersionId' => 'string',
          'SSECustomerAlgorithm' => 'string',
          'SSECustomerKey' => 'string',
          'SSECustomerKeyMD5' => 'string',
          'RequestPayer' => 'string',
          'SaveAs' => '',
      ));

- Get an object from a bucket

      // Get an object using the getObject operation
      $result = $client->getObject(array(
          'Bucket' => $bucket,
          'Key'    => 'data.txt'
      ));

      // The 'Body' value of the result is an EntityBody object
      echo get_class($result['Body']) . "\n";
      // > Guzzle\Http\EntityBody

      // The 'Body' value can be cast to a string
      echo $result['Body'] . "\n";
      // > Hello!

- Get an object from a bucket and interact with the body of the object

      // Seek to the beginning of the stream
      $result['Body']->rewind();

      // Read the body off of the underlying stream in chunks
      while ($data = $result['Body']->read(1024)) {
          echo $data;
      }

      // Cast the body to a primitive string
      // Warning: This loads the entire contents into memory!
      $bodyAsString = (string) $result['Body'];

- Get an object from a bucket and save the object directly to a file

      $result = $client->getObject(array(
          'Bucket' => $bucket,
          'Key'    => 'data.txt',
          'SaveAs' => '/tmp/data.txt'
      ));

      // Contains an EntityBody that wraps a file resource of /tmp/data.txt
      echo $result['Body']->getUri() . "\n";
      // > /tmp/data.txt

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
  - IfMatch => (string)
    Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).
  - IfModifiedSince => (string [date format]|int [unix timestamp]|\DateTime)
    Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).
  - IfNoneMatch => (string)
    Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).
  - IfUnmodifiedSince => (string [date format]|int [unix timestamp]|\DateTime)
    Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).
  - Key => (string)
  - Range => (string)
    Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
  - ResponseCacheControl => (string)
    Sets the Cache-Control header of the response.
  - ResponseContentDisposition => (string)
    Sets the Content-Disposition header of the response
  - ResponseContentEncoding => (string)
    Sets the Content-Encoding header of the response.
  - ResponseContentLanguage => (string)
    Sets the Content-Language header of the response.
  - ResponseContentType => (string)
    Sets the Content-Type header of the response.
  - ResponseExpires => (string [date format]|int [unix timestamp]|\DateTime)
    Sets the Expires header of the response.
  - VersionId => (string)
    VersionId used to reference a specific version of the object.
  - SSECustomerAlgorithm => (string)
    Specifies the algorithm to use to when encrypting the object (e.g., AES256).
  - SSECustomerKey => (string)
    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.
  - SSECustomerKeyMD5 => (string)
    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
  - RequestPayer => (string: requester )
    Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
  - SaveAs => ()
    Specify where the contents of the object should be downloaded. Can be the path to a file, a resource returned by fopen, or a Guzzle\Http\EntityBodyInterface object.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Body => (string | Guzzle\Http\EntityBody)
  Object data.
- DeleteMarker => (bool)
  Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.
- AcceptRanges => (string)
- Expiration => (string)
  If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key value pairs providing object expiration information. The value of the rule-id is URL encoded.
- Restore => (string)
  Provides information about object restoration operation and expiration time of the restored object copy.
- LastModified => (string)
  Last modified date of the object
- ContentLength => (int)
  Size of the body in bytes.
- ETag => (string)
  An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL
- MissingMeta => (int)
  This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.
- VersionId => (string)
  Version of the object.
- CacheControl => (string)
  Specifies caching behavior along the request/reply chain.
- ContentDisposition => (string)
  Specifies presentational information for the object.
- 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.
- ContentLanguage => (string)
  The language the content is in.
- ContentRange => (string)
  The portion of the object returned in the response.
- ContentType => (string)
  A standard MIME type describing the format of the object data.
- Expires => (string)
  The date and time at which the object is no longer cacheable.
- WebsiteRedirectLocation => (string)
  If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
- ServerSideEncryption => (string)
  The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
- Metadata => (associative-array<string>)

  Associative array of <string> keys mapping to (string) values. Each array key should be changed to an appropriate <string>.

  A map of metadata to store with the object in S3.
  - <string> => (string)
    The metadata value.
- SSECustomerAlgorithm => (string)
  If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
- SSECustomerKeyMD5 => (string)
  If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.
- SSEKMSKeyId => (string)
  If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.
- StorageClass => (string)
- RequestCharged => (string)
  If present, indicates that the requester was successfully charged for the request.
- ReplicationStatus => (string)
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`getObjectAcl( array $args = array() )`

Executes the GetObjectAcl operation.

Returns the access control list (ACL) of an object.

#### Examples

- Basic formatting example

      $result = $client->getObjectAcl(array(
          // Bucket is required
          'Bucket' => 'string',
          // Key is required
          'Key' => 'string',
          'VersionId' => 'string',
          'RequestPayer' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
  - Key => (string)
  - VersionId => (string)
    VersionId used to reference a specific version of the object.
  - RequestPayer => (string: requester )
    Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Owner => (associative-array)
  - DisplayName => (string)
  - ID => (string)
- Grants => (array<associative-array>)
  A list of grants.
  - (associative-array)
    - Grantee => (associative-array)
      - DisplayName => (string)
        Screen name of the grantee.
      - EmailAddress => (string)
        Email address of the grantee.
      - ID => (string)
        The canonical user ID of the grantee.
      - Type => (string)
        Type of grantee
      - URI => (string)
        URI of the grantee group.
    - Permission => (string)
      Specifies the permission given to the grantee.
- RequestCharged => (string)
  If present, indicates that the requester was successfully charged for the request.
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`getObjectTorrent( array $args = array() )`

Executes the GetObjectTorrent operation.

Return torrent files from a bucket.

#### Examples

- Basic formatting example

      $result = $client->getObjectTorrent(array(
          // Bucket is required
          'Bucket' => 'string',
          // Key is required
          'Key' => 'string',
          'RequestPayer' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
  - Key => (string)
  - RequestPayer => (string: requester )
    Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Body => (string | Guzzle\Http\EntityBody)
- RequestCharged => (string)
  If present, indicates that the requester was successfully charged for the request.
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`headBucket( array $args = array() )`

Executes the HeadBucket operation.

This operation is useful to determine if a bucket exists and you have permission to access it.

#### Examples

- Basic formatting example

      $result = $client->headBucket(array(
          // Bucket is required
          'Bucket' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`headObject( array $args = array() )`

Executes the HeadObject operation.

The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.

#### Examples

- Basic formatting example

      $result = $client->headObject(array(
          // Bucket is required
          'Bucket' => 'string',
          'IfMatch' => 'string',
          'IfModifiedSince' => 'mixed type: string (date format)|int (unix timestamp)|\DateTime',
          'IfNoneMatch' => 'string',
          'IfUnmodifiedSince' => 'mixed type: string (date format)|int (unix timestamp)|\DateTime',
          // Key is required
          'Key' => 'string',
          'Range' => 'string',
          'VersionId' => 'string',
          'SSECustomerAlgorithm' => 'string',
          'SSECustomerKey' => 'string',
          'SSECustomerKeyMD5' => 'string',
          'RequestPayer' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
  - IfMatch => (string)
    Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).
  - IfModifiedSince => (string [date format]|int [unix timestamp]|\DateTime)
    Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).
  - IfNoneMatch => (string)
    Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).
  - IfUnmodifiedSince => (string [date format]|int [unix timestamp]|\DateTime)
    Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).
  - Key => (string)
  - Range => (string)
    Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
  - VersionId => (string)
    VersionId used to reference a specific version of the object.
  - SSECustomerAlgorithm => (string)
    Specifies the algorithm to use to when encrypting the object (e.g., AES256).
  - SSECustomerKey => (string)
    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.
  - SSECustomerKeyMD5 => (string)
    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
  - RequestPayer => (string: requester )
    Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DeleteMarker => (bool)
  Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.
- AcceptRanges => (string)
- Expiration => (string)
  If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key value pairs providing object expiration information. The value of the rule-id is URL encoded.
- Restore => (string)
  Provides information about object restoration operation and expiration time of the restored object copy.
- LastModified => (string)
  Last modified date of the object
- ContentLength => (int)
  Size of the body in bytes.
- ETag => (string)
  An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL
- MissingMeta => (int)
  This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.
- VersionId => (string)
  Version of the object.
- CacheControl => (string)
  Specifies caching behavior along the request/reply chain.
- ContentDisposition => (string)
  Specifies presentational information for the object.
- 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.
- ContentLanguage => (string)
  The language the content is in.
- ContentType => (string)
  A standard MIME type describing the format of the object data.
- Expires => (string)
  The date and time at which the object is no longer cacheable.
- WebsiteRedirectLocation => (string)
  If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
- ServerSideEncryption => (string)
  The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
- Metadata => (associative-array<string>)

  Associative array of <string> keys mapping to (string) values. Each array key should be changed to an appropriate <string>.

  A map of metadata to store with the object in S3.
  - <string> => (string)
    The metadata value.
- SSECustomerAlgorithm => (string)
  If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
- SSECustomerKeyMD5 => (string)
  If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.
- SSEKMSKeyId => (string)
  If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.
- StorageClass => (string)
- RequestCharged => (string)
  If present, indicates that the requester was successfully charged for the request.
- ReplicationStatus => (string)
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`listBuckets( array $args = array() )`

Executes the ListBuckets operation.

Returns a list of all buckets owned by the authenticated sender of the request.

#### Examples

- Basic formatting example

      $result = $client->listBuckets(array(
      ));

- Send a ListBuckets request

      $result = $client->listBuckets();

      foreach ($result['Buckets'] as $bucket) {
          // Each Bucket value will contain a Name and CreationDate
          echo "{$bucket['Name']} - {$bucket['CreationDate']}\n";
      }

- Send a ListBuckets request and use the getPath() method to grab nested data from the response model

      // Grab the nested Owner/ID value from the result model using getPath()
      $result = $client->listBuckets();
      echo $result->getPath('Owner/ID') . "\n";

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Buckets => (array<associative-array>)
  - (associative-array)
    - Name => (string)
      The name of the bucket.
    - CreationDate => (string)
      Date the bucket was created.
- Owner => (associative-array)
  - DisplayName => (string)
  - ID => (string)
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`listMultipartUploads( array $args = array() )`

Executes the ListMultipartUploads operation.

This operation lists in-progress multipart uploads.

#### Examples

- Basic formatting example

      $result = $client->listMultipartUploads(array(
          // Bucket is required
          'Bucket' => 'string',
          'Delimiter' => 'string',
          'EncodingType' => 'string',
          'KeyMarker' => 'string',
          'MaxUploads' => integer,
          'Prefix' => 'string',
          'UploadIdMarker' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
  - Delimiter => (string)
    Character you use to group keys.
  - EncodingType => (string: url )
    Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.
  - KeyMarker => (string)
    Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.
  - MaxUploads => (int)
    Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.
  - Prefix => (string)
    Lists in-progress uploads only for those keys that begin with the specified prefix.
  - UploadIdMarker => (string)
    Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Bucket => (string)
  Name of the bucket to which the multipart upload was initiated.
- KeyMarker => (string)
  The key at or after which the listing began.
- UploadIdMarker => (string)
  Upload ID after which listing began.
- NextKeyMarker => (string)
  When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.
- Prefix => (string)
  When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.
- Delimiter => (string)
- NextUploadIdMarker => (string)
  When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request.
- MaxUploads => (int)
  Maximum number of multipart uploads that could have been included in the response.
- IsTruncated => (bool)
  Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.
- Uploads => (array<associative-array>)
  - (associative-array)
    - UploadId => (string)
      Upload ID that identifies the multipart upload.
    - Key => (string)
      Key of the object for which the multipart upload was initiated.
    - Initiated => (string)
      Date and time at which the multipart upload was initiated.
    - StorageClass => (string)
      The class of storage used to store the object.
    - Owner => (associative-array)
      - DisplayName => (string)
      - ID => (string)
    - Initiator => (associative-array)
      Identifies who initiated the multipart upload.
      - ID => (string)
        If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value.
      - DisplayName => (string)
        Name of the Principal.
- CommonPrefixes => (array<associative-array>)
  - (associative-array)
    - Prefix => (string)
- EncodingType => (string)
  Encoding type used by Amazon S3 to encode object keys in the response.
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`listObjectVersions( array $args = array() )`

Executes the ListObjectVersions operation.

Returns metadata about all of the versions of objects in a bucket.

#### Examples

- Basic formatting example

      $result = $client->listObjectVersions(array(
          // Bucket is required
          'Bucket' => 'string',
          'Delimiter' => 'string',
          'EncodingType' => 'string',
          'KeyMarker' => 'string',
          'MaxKeys' => integer,
          'Prefix' => 'string',
          'VersionIdMarker' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
  - Delimiter => (string)
    A delimiter is a character you use to group keys.
  - EncodingType => (string: url )
    Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.
  - KeyMarker => (string)
    Specifies the key to start with when listing objects in a bucket.
  - MaxKeys => (int)
    Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.
  - Prefix => (string)
    Limits the response to keys that begin with the specified prefix.
  - VersionIdMarker => (string)
    Specifies the object version you want to start listing from.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- IsTruncated => (bool)
  A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.
- KeyMarker => (string)
  Marks the last Key returned in a truncated response.
- VersionIdMarker => (string)
- NextKeyMarker => (string)
  Use this value for the key marker request parameter in a subsequent request.
- NextVersionIdMarker => (string)
  Use this value for the next version id marker parameter in a subsequent request.
- Versions => (array<associative-array>)
  - (associative-array)
    - ETag => (string)
    - Size => (int)
      Size in bytes of the object.
    - StorageClass => (string)
      The class of storage used to store the object.
    - Key => (string)
      The object key.
    - VersionId => (string)
      Version ID of an object.
    - IsLatest => (bool)
      Specifies whether the object is (true) or is not (false) the latest version of an object.
    - LastModified => (string)
      Date and time the object was last modified.
    - Owner => (associative-array)
      - DisplayName => (string)
      - ID => (string)
- DeleteMarkers => (array<associative-array>)
  - (associative-array)
    - Owner => (associative-array)
      - DisplayName => (string)
      - ID => (string)
    - Key => (string)
      The object key.
    - VersionId => (string)
      Version ID of an object.
    - IsLatest => (bool)
      Specifies whether the object is (true) or is not (false) the latest version of an object.
    - LastModified => (string)
      Date and time the object was last modified.
- Name => (string)
- Prefix => (string)
- Delimiter => (string)
- MaxKeys => (int)
- CommonPrefixes => (array<associative-array>)
  - (associative-array)
    - Prefix => (string)
- EncodingType => (string)
  Encoding type used by Amazon S3 to encode object keys in the response.
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`listObjects( array $args = array() )`

Executes the ListObjects operation.

Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket.

#### Examples

- Basic formatting example

      $result = $client->listObjects(array(
          // Bucket is required
          'Bucket' => 'string',
          'Delimiter' => 'string',
          'EncodingType' => 'string',
          'Marker' => 'string',
          'MaxKeys' => integer,
          'Prefix' => 'string',
      ));

- List all objects in a bucket using a ListObjects iterator

      $iterator = $client->getIterator('ListObjects', array(
          'Bucket' => $bucket
      ));

      foreach ($iterator as $object) {
          echo $object['Key'] . "\n";
      }

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
  - Delimiter => (string)
    A delimiter is a character you use to group keys.
  - EncodingType => (string: url )
    Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.
  - Marker => (string)
    Specifies the key to start with when listing objects in a bucket.
  - MaxKeys => (int)
    Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.
  - Prefix => (string)
    Limits the response to keys that begin with the specified prefix.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- IsTruncated => (bool)
  A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.
- Marker => (string)
- NextMarker => (string)
  When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMaker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys.
- Contents => (array<associative-array>)
  - (associative-array)
    - Key => (string)
    - LastModified => (string)
    - ETag => (string)
    - Size => (int)
    - StorageClass => (string)
      The class of storage used to store the object.
    - Owner => (associative-array)
      - DisplayName => (string)
      - ID => (string)
- Name => (string)
- Prefix => (string)
- Delimiter => (string)
- MaxKeys => (int)
- CommonPrefixes => (array<associative-array>)
  - (associative-array)
    - Prefix => (string)
- EncodingType => (string)
  Encoding type used by Amazon S3 to encode object keys in the response.
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`listParts( array $args = array() )`

Executes the ListParts operation.

Lists the parts that have been uploaded for a specific multipart upload.

#### Examples

- Basic formatting example

      $result = $client->listParts(array(
          // Bucket is required
          'Bucket' => 'string',
          // Key is required
          'Key' => 'string',
          'MaxParts' => integer,
          'PartNumberMarker' => integer,
          // UploadId is required
          'UploadId' => 'string',
          'RequestPayer' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
  - Key => (string)
  - MaxParts => (int)
    Sets the maximum number of parts to return.
  - PartNumberMarker => (int)
    Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.
  - UploadId => (string)
    Upload ID identifying the multipart upload whose parts are being listed.
  - RequestPayer => (string: requester )
    Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Bucket => (string)
  Name of the bucket to which the multipart upload was initiated.
- Key => (string)
  Object key for which the multipart upload was initiated.
- UploadId => (string)
  Upload ID identifying the multipart upload whose parts are being listed.
- PartNumberMarker => (int)
  Part number after which listing begins.
- NextPartNumberMarker => (int)
  When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.
- MaxParts => (int)
  Maximum number of parts that were allowed in the response.
- IsTruncated => (bool)
  Indicates whether the returned list of parts is truncated.
- Parts => (array<associative-array>)
  - (associative-array)
    - PartNumber => (int)
      Part number identifying the part. This is a positive integer between 1 and 10,000.
    - LastModified => (string)
      Date and time at which the part was uploaded.
    - ETag => (string)
      Entity tag returned when the part was uploaded.
    - Size => (int)
      Size of the uploaded part data.
- Initiator => (associative-array)
  Identifies who initiated the multipart upload.
  - ID => (string)
    If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value.
  - DisplayName => (string)
    Name of the Principal.
- Owner => (associative-array)
  - DisplayName => (string)
  - ID => (string)
- StorageClass => (string)
  The class of storage used to store the object.
- RequestCharged => (string)
  If present, indicates that the requester was successfully charged for the request.
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`putBucketAcl( array $args = array() )`

Executes the PutBucketAcl operation.

Sets the permissions on a bucket using access control lists (ACL).

#### Examples

- Basic formatting example

      $result = $client->putBucketAcl(array(
          'ACL' => 'string',
          'Grants' => array(
              array(
                  'Grantee' => array(
                      'DisplayName' => 'string',
                      'EmailAddress' => 'string',
                      'ID' => 'string',
                      // Type is required
                      'Type' => 'string',
                      'URI' => 'string',
                  ),
                  'Permission' => 'string',
              ),
              // ... repeated
          ),
          'Owner' => array(
              'DisplayName' => 'string',
              'ID' => 'string',
          ),
          // Bucket is required
          'Bucket' => 'string',
          'GrantFullControl' => 'string',
          'GrantRead' => 'string',
          'GrantReadACP' => 'string',
          'GrantWrite' => 'string',
          'GrantWriteACP' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - ACL => (string: private | public-read | public-read-write | authenticated-read )
    The canned ACL to apply to the bucket.
  - Grants => (array<associative-array>)
    A list of grants.
    - (associative-array)
      - Grantee => (associative-array)
        - DisplayName => (string)
          Screen name of the grantee.
        - EmailAddress => (string)
          Email address of the grantee.
        - ID => (string)
          The canonical user ID of the grantee.
        - Type => (string: CanonicalUser | AmazonCustomerByEmail | Group )
          Type of grantee
        - URI => (string)
          URI of the grantee group.
      - Permission => (string: FULL_CONTROL | WRITE | WRITE_ACP | READ | READ_ACP )
        Specifies the permission given to the grantee.
  - Owner => (associative-array)
    - DisplayName => (string)
    - ID => (string)
  - Bucket => (string)
  - GrantFullControl => (string)
    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
  - GrantRead => (string)
    Allows grantee to list the objects in the bucket.
  - GrantReadACP => (string)
    Allows grantee to read the bucket ACL.
  - GrantWrite => (string)
    Allows grantee to create, overwrite, and delete any object in the bucket.
  - GrantWriteACP => (string)
    Allows grantee to write the ACL for the applicable bucket.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`putBucketCors( array $args = array() )`

Executes the PutBucketCors operation.

Sets the cors configuration for a bucket.

#### Examples

- Basic formatting example

      $result = $client->putBucketCors(array(
          // Bucket is required
          'Bucket' => 'string',
          // CORSRules is required
          'CORSRules' => array(
              array(
                  'AllowedHeaders' => array('string', ... ),
                  // AllowedMethods is required
                  'AllowedMethods' => array('string', ... ),
                  // AllowedOrigins is required
                  'AllowedOrigins' => array('string', ... ),
                  'ExposeHeaders' => array('string', ... ),
                  'MaxAgeSeconds' => integer,
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
  - CORSRules => (array<associative-array>)
    - (associative-array)
      - AllowedHeaders => (array<string>)
        Specifies which headers are allowed in a pre-flight OPTIONS request.
      - AllowedMethods => (array<string>)
        Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute.
      - AllowedOrigins => (array<string>)
        One or more origins you want customers to be able to access the bucket from.
      - ExposeHeaders => (array<string>)
        One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).
      - MaxAgeSeconds => (int)
        The time in seconds that your browser is to cache the preflight response for the specified resource.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`putBucketLifecycle( array $args = array() )`

Executes the PutBucketLifecycle operation.

Deprecated, see the PutBucketLifecycleConfiguration operation.

#### Examples

- Basic formatting example

      $result = $client->putBucketLifecycle(array(
          // Bucket is required
          'Bucket' => 'string',
          // Rules is required
          'Rules' => array(
              array(
                  'Expiration' => array(
                      'Date' => 'mixed type: string (date format)|int (unix timestamp)|\DateTime',
                      'Days' => integer,
                  ),
                  'ID' => 'string',
                  // Prefix is required
                  'Prefix' => 'string',
                  // Status is required
                  'Status' => 'string',
                  'Transition' => array(
                      'Date' => 'mixed type: string (date format)|int (unix timestamp)|\DateTime',
                      'Days' => integer,
                      'StorageClass' => 'string',
                  ),
                  'NoncurrentVersionTransition' => array(
                      'NoncurrentDays' => integer,
                      'StorageClass' => 'string',
                  ),
                  'NoncurrentVersionExpiration' => array(
                      'NoncurrentDays' => integer,
                  ),
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
  - Rules => (array<associative-array>)
    - (associative-array)
      - Expiration => (associative-array)
        - Date => (string [date format]|int [unix timestamp]|\DateTime)
          Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.
        - Days => (int)
          Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.
      - ID => (string)
        Unique identifier for the rule. The value cannot be longer than 255 characters.
      - Prefix => (string)
        Prefix identifying one or more objects to which the rule applies.
      - Status => (string: Enabled | Disabled )
        If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.
      - Transition => (associative-array)
        - Date => (string [date format]|int [unix timestamp]|\DateTime)
          Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.
        - Days => (int)
          Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.
        - StorageClass => (string: GLACIER | STANDARD_IA )
          The class of storage used to store the object.
      - NoncurrentVersionTransition => (associative-array)
        Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA or GLACIER storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA or GLACIER storage class at a specific period in the object's lifetime.
        - NoncurrentDays => (int)
          Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide.
        - StorageClass => (string: GLACIER | STANDARD_IA )
          The class of storage used to store the object.
      - NoncurrentVersionExpiration => (associative-array)
        Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.
        - NoncurrentDays => (int)
          Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`putBucketLifecycleConfiguration( array $args = array() )`

Executes the PutBucketLifecycleConfiguration operation.

Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it.

#### Examples

- Basic formatting example

      $result = $client->putBucketLifecycleConfiguration(array(
          // Bucket is required
          'Bucket' => 'string',
          // Rules is required
          'Rules' => array(
              array(
                  'Expiration' => array(
                      'Date' => 'mixed type: string (date format)|int (unix timestamp)|\DateTime',
                      'Days' => integer,
                  ),
                  'ID' => 'string',
                  // Prefix is required
                  'Prefix' => 'string',
                  // Status is required
                  'Status' => 'string',
                  'Transitions' => array(
                      array(
                          'Date' => 'mixed type: string (date format)|int (unix timestamp)|\DateTime',
                          'Days' => integer,
                          'StorageClass' => 'string',
                      ),
                      // ... repeated
                  ),
                  'NoncurrentVersionTransitions' => array(
                      array(
                          'NoncurrentDays' => integer,
                          'StorageClass' => 'string',
                      ),
                      // ... repeated
                  ),
                  'NoncurrentVersionExpiration' => array(
                      'NoncurrentDays' => integer,
                  ),
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
  - Rules => (array<associative-array>)
    - (associative-array)
      - Expiration => (associative-array)
        - Date => (string [date format]|int [unix timestamp]|\DateTime)
          Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.
        - Days => (int)
          Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.
      - ID => (string)
        Unique identifier for the rule. The value cannot be longer than 255 characters.
      - Prefix => (string)
        Prefix identifying one or more objects to which the rule applies.
      - Status => (string: Enabled | Disabled )
        If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.
      - Transitions => (array<associative-array>)
        - (associative-array)
          - Date => (string [date format]|int [unix timestamp]|\DateTime)
            Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.
          - Days => (int)
            Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.
          - StorageClass => (string: GLACIER | STANDARD_IA )
            The class of storage used to store the object.
      - NoncurrentVersionTransitions => (array<associative-array>)
        - (associative-array)
          Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA or GLACIER storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA or GLACIER storage class at a specific period in the object's lifetime.
          - NoncurrentDays => (int)
            Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide.
          - StorageClass => (string: GLACIER | STANDARD_IA )
            The class of storage used to store the object.
      - NoncurrentVersionExpiration => (associative-array)
        Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.
        - NoncurrentDays => (int)
          Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- RequestId => ()
  Request ID of the operation

# `public `Guzzle\Service\Resource\Model``
`putBucketLogging( array $args = array() )`

Executes the PutBucketLogging operation.

Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the logging status of a bucket, you must be the bucket owner.

#### Examples

- Basic formatting example

      $result = $client->putBucketLogging(array(
          // Bucket is required
          'Bucket' => 'string',
          'LoggingEnabled' => array(
              'TargetBucket' => 'string',
              'TargetGrants' => array(
                  array(
                      'Grantee' => array(
                          'DisplayName' => 'string',
                          'EmailAddress' => 'string',
                          'ID' => 'string',
                          // Type is required
                          'Type' => 'string',
                          'URI' => 'string',
                      ),
                      'Permission' => 'string',
                  ),
                  // ... repeated
              ),
              'TargetPrefix' => 'string',
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
  - LoggingEnabled => (associative-array)
    - TargetBucket => (string)
      Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key.
    - TargetGrants => (array<associative-array>)
      - (associative-array)
        - Grantee => (associative-array)
          - DisplayName => (string)
            Screen name of the grantee.
          - EmailAddress => (string)
            Email address of the grantee.
          - ID => (string)
            The canonical user ID of the grantee.
          - Type => (string: CanonicalUser | AmazonCustomerByEmail | Group )
            Type of grantee
          - URI => (string)
            URI of the grantee group.
        - Permission => (string: FULL_CONTROL | READ | WRITE )
          Logging permissions assigned to the Grantee for the bucket.
    - TargetPrefix => (string)
      This element lets you specify a prefix for the keys that the log files will be stored under.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`putBucketNotification( array $args = array() )`

Executes the PutBucketNotification operation.

Deprecated, see the PutBucketNotificationConfiguraiton operation.

#### Examples

- Basic formatting example

      $result = $client->putBucketNotification(array(
          // Bucket is required
          'Bucket' => 'string',
          'TopicConfiguration' => array(
              'Id' => 'string',
              'Events' => array('string', ... ),
              'Event' => 'string',
              'Topic' => 'string',
          ),
          'QueueConfiguration' => array(
              'Id' => 'string',
              'Event' => 'string',
              'Events' => array('string', ... ),
              'Queue' => 'string',
          ),
          'CloudFunctionConfiguration' => array(
              'Id' => 'string',
              'Event' => 'string',
              'Events' => array('string', ... ),
              'CloudFunction' => 'string',
              'InvocationRole' => 'string',
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
  - TopicConfiguration => (associative-array)
    - Id => (string)
      Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.
    - Events => (array<string: s3:ReducedRedundancyLostObject | s3:ObjectCreated: | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved: | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated >)(string: s3:ReducedRedundancyLostObject | s3:ObjectCreated: | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved: | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated )
      Bucket event for which to send notifications.
    - Event => (string: s3:ReducedRedundancyLostObject | s3:ObjectCreated: | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved: | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated )
      Bucket event for which to send notifications.
    - Topic => (string)
      Amazon SNS topic to which Amazon S3 will publish a message to report the specified events for the bucket.
  - QueueConfiguration => (associative-array)
    - Id => (string)
      Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.
    - Event => (string: s3:ReducedRedundancyLostObject | s3:ObjectCreated: | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved: | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated )
      Bucket event for which to send notifications.
    - Events => (array<string: s3:ReducedRedundancyLostObject | s3:ObjectCreated: | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved: | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated >)(string: s3:ReducedRedundancyLostObject | s3:ObjectCreated: | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved: | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated )
      Bucket event for which to send notifications.
    - Queue => (string)
  - CloudFunctionConfiguration => (associative-array)
    - Id => (string)
      Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.
    - Event => (string: s3:ReducedRedundancyLostObject | s3:ObjectCreated: | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved: | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated )
      Bucket event for which to send notifications.
    - Events => (array<string: s3:ReducedRedundancyLostObject | s3:ObjectCreated: | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved: | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated >)(string: s3:ReducedRedundancyLostObject | s3:ObjectCreated: | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved: | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated )
      Bucket event for which to send notifications.
    - CloudFunction => (string)
    - InvocationRole => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`putBucketNotificationConfiguration( array $args = array() )`

Executes the PutBucketNotificationConfiguration operation.

Enables notifications of specified events for a bucket.

#### Examples

- Basic formatting example

      $result = $client->putBucketNotificationConfiguration(array(
          // Bucket is required
          'Bucket' => 'string',
          'TopicConfigurations' => array(
              array(
                  'Id' => 'string',
                  // TopicArn is required
                  'TopicArn' => 'string',
                  // Events is required
                  'Events' => array('string', ... ),
                  'Filter' => array(
                      'Key' => array(
                          'FilterRules' => array(
                              array(
                                  'Name' => 'string',
                                  'Value' => 'string',
                              ),
                              // ... repeated
                          ),
                      ),
                  ),
              ),
              // ... repeated
          ),
          'QueueConfigurations' => array(
              array(
                  'Id' => 'string',
                  // QueueArn is required
                  'QueueArn' => 'string',
                  // Events is required
                  'Events' => array('string', ... ),
                  'Filter' => array(
                      'Key' => array(
                          'FilterRules' => array(
                              array(
                                  'Name' => 'string',
                                  'Value' => 'string',
                              ),
                              // ... repeated
                          ),
                      ),
                  ),
              ),
              // ... repeated
          ),
          'LambdaFunctionConfigurations' => array(
              array(
                  'Id' => 'string',
                  // LambdaFunctionArn is required
                  'LambdaFunctionArn' => 'string',
                  // Events is required
                  'Events' => array('string', ... ),
                  'Filter' => array(
                      'Key' => array(
                          'FilterRules' => array(
                              array(
                                  'Name' => 'string',
                                  'Value' => 'string',
                              ),
                              // ... repeated
                          ),
                      ),
                  ),
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
  - TopicConfigurations => (array<associative-array>)
    - (associative-array)
      Container for specifying the configuration when you want Amazon S3 to publish events to an Amazon Simple Notification Service (Amazon SNS) topic.
      - Id => (string)
        Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.
      - TopicArn => (string)
        Amazon SNS topic ARN to which Amazon S3 will publish a message when it detects events of specified type.
      - Events => (array<string: s3:ReducedRedundancyLostObject | s3:ObjectCreated: | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved: | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated >)(string: s3:ReducedRedundancyLostObject | s3:ObjectCreated: | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved: | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated )
        Bucket event for which to send notifications.
      - Filter => (associative-array)
        Container for object key name filtering rules. For information about key name filtering, go to Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide.
        - Key => (associative-array)
          Container for object key name prefix and suffix filtering rules.
          - FilterRules => (array<associative-array>)
            A list of containers for key value pair that defines the criteria for the filter rule.
            - (associative-array)
              Container for key value pair that defines the criteria for the filter rule.
              - Name => (string: prefix | suffix )
                Object key name prefix or suffix identifying one or more objects to which the filtering rule applies. Maximum prefix length can be up to 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, go to Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide.
              - Value => (string)
  - QueueConfigurations => (array<associative-array>)
    - (associative-array)
      Container for specifying an configuration when you want Amazon S3 to publish events to an Amazon Simple Queue Service (Amazon SQS) queue.
      - Id => (string)
        Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.
      - QueueArn => (string)
        Amazon SQS queue ARN to which Amazon S3 will publish a message when it detects events of specified type.
      - Events => (array<string: s3:ReducedRedundancyLostObject | s3:ObjectCreated: | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved: | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated >)(string: s3:ReducedRedundancyLostObject | s3:ObjectCreated: | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved: | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated )
        Bucket event for which to send notifications.
      - Filter => (associative-array)
        Container for object key name filtering rules. For information about key name filtering, go to Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide.
        - Key => (associative-array)
          Container for object key name prefix and suffix filtering rules.
          - FilterRules => (array<associative-array>)
            A list of containers for key value pair that defines the criteria for the filter rule.
            - (associative-array)
              Container for key value pair that defines the criteria for the filter rule.
              - Name => (string: prefix | suffix )
                Object key name prefix or suffix identifying one or more objects to which the filtering rule applies. Maximum prefix length can be up to 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, go to Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide.
              - Value => (string)
  - LambdaFunctionConfigurations => (array<associative-array>)
    - (associative-array)
      Container for specifying the AWS Lambda notification configuration.
      - Id => (string)
        Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.
      - LambdaFunctionArn => (string)
        Lambda cloud function ARN that Amazon S3 can invoke when it detects events of the specified type.
      - Events => (array<string: s3:ReducedRedundancyLostObject | s3:ObjectCreated: | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved: | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated >)(string: s3:ReducedRedundancyLostObject | s3:ObjectCreated: | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved: | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated )
        Bucket event for which to send notifications.
      - Filter => (associative-array)
        Container for object key name filtering rules. For information about key name filtering, go to Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide.
        - Key => (associative-array)
          Container for object key name prefix and suffix filtering rules.
          - FilterRules => (array<associative-array>)
            A list of containers for key value pair that defines the criteria for the filter rule.
            - (associative-array)
              Container for key value pair that defines the criteria for the filter rule.
              - Name => (string: prefix | suffix )
                Object key name prefix or suffix identifying one or more objects to which the filtering rule applies. Maximum prefix length can be up to 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, go to Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide.
              - Value => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- RequestId => ()
  Request ID of the operation

# `public `Guzzle\Service\Resource\Model``
`putBucketPolicy( array $args = array() )`

Executes the PutBucketPolicy operation.

Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it.

#### Examples

- Basic formatting example

      $result = $client->putBucketPolicy(array(
          // Bucket is required
          'Bucket' => 'string',
          // Policy is required
          'Policy' => 'mixed type: string|resource|\Guzzle\Http\EntityBodyInterface',
      ));

- Execute the CreateTrail operation

      // Create a bucket in S3 to store the logs and configure the policy
      $s3->createBucket(array('Bucket' => $bucket));
      $s3->waitUntil('BucketExists]', array('Bucket' => $bucket));
      $s3->putBucketPolicy(array(
          'Bucket' => $bucket,
          'Policy' => json_encode(array(
              'Statement' => array(
                  array(
                      'Sid' => 'cloudtrail-to-s3',
                      'Action' => array(
                          's3:GetBucketAcl',
                          's3:PutObject'
                      ),
                      'Effect' => 'Allow',
                      'Resource' => array(
                          "arn:aws:s3:::{$bucket}",
                          "arn:aws:s3:::{$bucket}/AWSLogs/*"
                      ),
                      'Principal' => array(
                          'AWS' => array(
                              // Documented CloudTrail Principal ARNs
                              'arn:aws:iam::086441151436:root',
                              'arn:aws:iam::113285607260:root'
                          )
                      )
                  )
              )
          ))
      ));

      // Create a CloudTrail trail and set the bucket to use
      $client->createTrail(array(
          'Name'         => 'test-trail',
          'S3BucketName' => $bucket,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
  - Policy => (string|resource|\Guzzle\Http\EntityBodyInterface)
    The bucket policy as a JSON document.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`putBucketReplication( array $args = array() )`

Executes the PutBucketReplication operation.

Creates a new replication configuration (or replaces an existing one, if present).

#### Examples

- Basic formatting example

      $result = $client->putBucketReplication(array(
          // Bucket is required
          'Bucket' => 'string',
          // Role is required
          'Role' => 'string',
          // Rules is required
          'Rules' => array(
              array(
                  'ID' => 'string',
                  // Prefix is required
                  'Prefix' => 'string',
                  // Status is required
                  'Status' => 'string',
                  // Destination is required
                  'Destination' => array(
                      // Bucket is required
                      'Bucket' => 'string',
                      'StorageClass' => 'string',
                  ),
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
  - Role => (string)
    Amazon Resource Name (ARN) of an IAM role for Amazon S3 to assume when replicating the objects.
  - Rules => (array<associative-array>)
    Container for information about a particular replication rule. Replication configuration must have at least one rule and can contain up to 1,000 rules.
    - (associative-array)
      - ID => (string)
        Unique identifier for the rule. The value cannot be longer than 255 characters.
      - Prefix => (string)
        Object keyname prefix identifying one or more objects to which the rule applies. Maximum prefix length can be up to 1,024 characters. Overlapping prefixes are not supported.
      - Status => (string: Enabled | Disabled )
        The rule is ignored if status is not Enabled.
      - Destination => (associative-array)
        - Bucket => (string)
          Amazon resource name (ARN) of the bucket where you want Amazon S3 to store replicas of the object identified by the rule.
        - StorageClass => (string: STANDARD | REDUCED_REDUNDANCY | STANDARD_IA )
          The class of storage used to store the object.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- RequestId => ()
  Request ID of the operation

# `public `Guzzle\Service\Resource\Model``
`putBucketRequestPayment( array $args = array() )`

Executes the PutBucketRequestPayment operation.

Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. Documentation on requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html

#### Examples

- Basic formatting example

      $result = $client->putBucketRequestPayment(array(
          // Bucket is required
          'Bucket' => 'string',
          // Payer is required
          'Payer' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
  - Payer => (string: Requester | BucketOwner )
    Specifies who pays for the download and request fees.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`putBucketTagging( array $args = array() )`

Executes the PutBucketTagging operation.

Sets the tags for a bucket.

#### Examples

- Basic formatting example

      $result = $client->putBucketTagging(array(
          // Bucket is required
          'Bucket' => 'string',
          // TagSet is required
          'TagSet' => array(
              array(
                  // Key is required
                  'Key' => 'string',
                  // Value is required
                  'Value' => 'string',
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
  - TagSet => (array<associative-array>)
    - (associative-array)
      - Key => (string)
        Name of the tag.
      - Value => (string)
        Value of the tag.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`putBucketVersioning( array $args = array() )`

Executes the PutBucketVersioning operation.

Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.

#### Examples

- Basic formatting example

      $result = $client->putBucketVersioning(array(
          // Bucket is required
          'Bucket' => 'string',
          'MFA' => 'string',
          'MFADelete' => 'string',
          'Status' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
  - MFA => (string)
    The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.
  - MFADelete => (string: Enabled | Disabled )
    Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.
  - Status => (string: Enabled | Suspended )
    The versioning state of the bucket.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`putBucketWebsite( array $args = array() )`

Executes the PutBucketWebsite operation.

Set the website configuration for a bucket.

#### Examples

- Basic formatting example

      $result = $client->putBucketWebsite(array(
          // Bucket is required
          'Bucket' => 'string',
          'ErrorDocument' => array(
              // Key is required
              'Key' => 'string',
          ),
          'IndexDocument' => array(
              // Suffix is required
              'Suffix' => 'string',
          ),
          'RedirectAllRequestsTo' => array(
              // HostName is required
              'HostName' => 'string',
              'Protocol' => 'string',
          ),
          'RoutingRules' => array(
              array(
                  'Condition' => array(
                      'HttpErrorCodeReturnedEquals' => 'string',
                      'KeyPrefixEquals' => 'string',
                  ),
                  // Redirect is required
                  'Redirect' => array(
                      'HostName' => 'string',
                      'HttpRedirectCode' => 'string',
                      'Protocol' => 'string',
                      'ReplaceKeyPrefixWith' => 'string',
                      'ReplaceKeyWith' => 'string',
                  ),
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
  - ErrorDocument => (associative-array)
    - Key => (string)
      The object key name to use when a 4XX class error occurs.
  - IndexDocument => (associative-array)
    - Suffix => (string)
      A suffix that is appended to a request that is for a directory on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character.
  - RedirectAllRequestsTo => (associative-array)
    - HostName => (string)
      Name of the host where requests will be redirected.
    - Protocol => (string: http | https )
      Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request.
  - RoutingRules => (array<associative-array>)
    - (associative-array)
      - Condition => (associative-array)
        A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.
        - HttpErrorCodeReturnedEquals => (string)
          The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied.
        - KeyPrefixEquals => (string)
          The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied.
      - Redirect => (associative-array)
        Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can can specify a different error code to return.
        - HostName => (string)
          The host name to use in the redirect request.
        - HttpRedirectCode => (string)
          The HTTP redirect code to use on the response. Not required if one of the siblings is present.
        - Protocol => (string: http | https )
          Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request.
        - ReplaceKeyPrefixWith => (string)
          The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided.
        - ReplaceKeyWith => (string)
          The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is present. Can be present only if ReplaceKeyPrefixWith is not provided.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`putObject( array $args = array() )`

Executes the PutObject operation.

Adds an object to a bucket.

#### Examples

- Basic formatting example

      $result = $client->putObject(array(
          'ACL' => 'string',
          'Body' => 'mixed type: string|resource|\Guzzle\Http\EntityBodyInterface',
          // Bucket is required
          'Bucket' => 'string',
          'CacheControl' => 'string',
          'ContentDisposition' => 'string',
          'ContentEncoding' => 'string',
          'ContentLanguage' => 'string',
          'ContentLength' => integer,
          'ContentType' => 'string',
          'Expires' => 'mixed type: string (date format)|int (unix timestamp)|\DateTime',
          'GrantFullControl' => 'string',
          'GrantRead' => 'string',
          'GrantReadACP' => 'string',
          'GrantWriteACP' => 'string',
          // Key is required
          'Key' => 'string',
          'Metadata' => array(
              // Associative array of custom 'string' key names
              'string' => 'string',
              // ... repeated
          ),
          'ServerSideEncryption' => 'string',
          'StorageClass' => 'string',
          'WebsiteRedirectLocation' => 'string',
          'SSECustomerAlgorithm' => 'string',
          'SSECustomerKey' => 'string',
          'SSECustomerKeyMD5' => 'string',
          'SSEKMSKeyId' => 'string',
          'RequestPayer' => 'string',
      ));

- Upload an object to a bucket using a string for the object body

      // Upload an object to Amazon S3
      $result = $client->putObject(array(
          'Bucket' => $bucket,
          'Key'    => 'data.txt',
          'Body'   => 'Hello!'
      ));

      // Access parts of the result object
      echo $result['Expiration'] . "\n";
      echo $result['ServerSideEncryption'] . "\n";
      echo $result['ETag'] . "\n";
      echo $result['VersionId'] . "\n";
      echo $result['RequestId'] . "\n";

      // Get the URL the object can be downloaded from
      echo $result['ObjectURL'] . "\n";

- Upload an object by streaming the contents of a file

      // Upload an object by streaming the contents of a file
      // $pathToFile should be absolute path to a file on disk
      $result = $client->putObject(array(
          'Bucket'     => $bucket,
          'Key'        => 'data_from_file.txt',
          'SourceFile' => $pathToFile,
          'Metadata'   => array(
              'Foo' => 'abc',
              'Baz' => '123'
          )
      ));

      // We can poll the object until it is accessible
      $client->waitUntil('ObjectExists', array(
          'Bucket' => $this->bucket,
          'Key'    => 'data_from_file.txt'
      ));

- Upload an object by streaming the contents of a PHP stream

      // Upload an object by streaming the contents of a PHP stream.
      // Note: You must supply a "ContentLength" parameter to an
      // operation if the steam does not respond to fstat() or if the
      // fstat() of stream does not provide a valid the 'size' attribute.
      // For example, the "http" stream wrapper will require a ContentLength
      // parameter because it does not respond to fstat().
      $client->putObject(array(
          'Bucket' => $bucket,
          'Key'    => 'data_from_stream.txt',
          'Body'   => fopen($pathToFile, 'r+')
      ));

- Upload an object by streaming the contents of a Guzzle\Http\EntityBodyInterface object

      // Be sure to add a use statement at the beginning of you script:
      // use Guzzle\Http\EntityBody;

      // Upload an object by streaming the contents of an EntityBody object
      $client->putObject(array(
          'Bucket' => $bucket,
          'Key'    => 'data_from_entity_body.txt',
          'Body'   => EntityBody::factory(fopen($pathToFile, 'r+'))
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - ACL => (string: private | public-read | public-read-write | authenticated-read | bucket-owner-read | bucket-owner-full-control )
    The canned ACL to apply to the object.
  - Body => (string|resource|\Guzzle\Http\EntityBodyInterface)
    Pass a string containing the body, a handle returned by fopen, or a Guzzle\Http\EntityBodyInterface object
  - Bucket => (string)
  - CacheControl => (string)
    Specifies caching behavior along the request/reply chain.
  - ContentDisposition => (string)
    Specifies presentational information for the object.
  - 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.
  - ContentLanguage => (string)
    The language the content is in.
  - ContentLength => (int)
    Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.
  - ContentType => (string)
    A standard MIME type describing the format of the object data.
  - Expires => (string [date format]|int [unix timestamp]|\DateTime)
    The date and time at which the object is no longer cacheable.
  - GrantFullControl => (string)
    Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
  - GrantRead => (string)
    Allows grantee to read the object data and its metadata.
  - GrantReadACP => (string)
    Allows grantee to read the object ACL.
  - GrantWriteACP => (string)
    Allows grantee to write the ACL for the applicable object.
  - Key => (string)
  - Metadata => (associative-array<string>)

    Associative array of <string> keys mapping to (string) values. Each array key should be changed to an appropriate <string>.

    A map of metadata to store with the object in S3.
    - <string> => (string)
      The metadata key. This will be prefixed with x-amz-meta- before sending to S3 as a header. The x-amz-meta- header will be stripped from the key when retrieving headers.
  - ServerSideEncryption => (string: AES256 | aws:kms )
    The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
  - StorageClass => (string: STANDARD | REDUCED_REDUNDANCY | STANDARD_IA )
    The type of storage to use for the object. Defaults to 'STANDARD'.
  - WebsiteRedirectLocation => (string)
    If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
  - SSECustomerAlgorithm => (string)
    Specifies the algorithm to use to when encrypting the object (e.g., AES256).
  - SSECustomerKey => (string)
    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.
  - SSECustomerKeyMD5 => (string)
    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
  - SSEKMSKeyId => (string)
    Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
  - RequestPayer => (string: requester )
    Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Expiration => (string)
  If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.
- ETag => (string)
  Entity tag for the uploaded object.
- ServerSideEncryption => (string)
  The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
- VersionId => (string)
  Version of the object.
- SSECustomerAlgorithm => (string)
  If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
- SSECustomerKeyMD5 => (string)
  If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.
- SSEKMSKeyId => (string)
  If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.
- RequestCharged => (string)
  If present, indicates that the requester was successfully charged for the request.
- RequestId => ()
  Request ID of the operation
- ObjectURL => ()
  URL of the uploaded object

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`putObjectAcl( array $args = array() )`

Executes the PutObjectAcl operation.

uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket

#### Examples

- Basic formatting example

      $result = $client->putObjectAcl(array(
          'ACL' => 'string',
          'Grants' => array(
              array(
                  'Grantee' => array(
                      'DisplayName' => 'string',
                      'EmailAddress' => 'string',
                      'ID' => 'string',
                      // Type is required
                      'Type' => 'string',
                      'URI' => 'string',
                  ),
                  'Permission' => 'string',
              ),
              // ... repeated
          ),
          'Owner' => array(
              'DisplayName' => 'string',
              'ID' => 'string',
          ),
          // Bucket is required
          'Bucket' => 'string',
          'GrantFullControl' => 'string',
          'GrantRead' => 'string',
          'GrantReadACP' => 'string',
          'GrantWrite' => 'string',
          'GrantWriteACP' => 'string',
          // Key is required
          'Key' => 'string',
          'RequestPayer' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - ACL => (string: private | public-read | public-read-write | authenticated-read | bucket-owner-read | bucket-owner-full-control )
    The canned ACL to apply to the object.
  - Grants => (array<associative-array>)
    A list of grants.
    - (associative-array)
      - Grantee => (associative-array)
        - DisplayName => (string)
          Screen name of the grantee.
        - EmailAddress => (string)
          Email address of the grantee.
        - ID => (string)
          The canonical user ID of the grantee.
        - Type => (string: CanonicalUser | AmazonCustomerByEmail | Group )
          Type of grantee
        - URI => (string)
          URI of the grantee group.
      - Permission => (string: FULL_CONTROL | WRITE | WRITE_ACP | READ | READ_ACP )
        Specifies the permission given to the grantee.
  - Owner => (associative-array)
    - DisplayName => (string)
    - ID => (string)
  - Bucket => (string)
  - GrantFullControl => (string)
    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
  - GrantRead => (string)
    Allows grantee to list the objects in the bucket.
  - GrantReadACP => (string)
    Allows grantee to read the bucket ACL.
  - GrantWrite => (string)
    Allows grantee to create, overwrite, and delete any object in the bucket.
  - GrantWriteACP => (string)
    Allows grantee to write the ACL for the applicable bucket.
  - Key => (string)
  - RequestPayer => (string: requester )
    Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- RequestCharged => (string)
  If present, indicates that the requester was successfully charged for the request.
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`restoreObject( array $args = array() )`

Executes the RestoreObject operation.

Restores an archived copy of an object back into Amazon S3

#### Examples

- Basic formatting example

      $result = $client->restoreObject(array(
          // Bucket is required
          'Bucket' => 'string',
          // Key is required
          'Key' => 'string',
          'VersionId' => 'string',
          // Days is required
          'Days' => integer,
          'RequestPayer' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
  - Key => (string)
  - VersionId => (string)
  - Days => (int)
    Lifetime of the active copy in days
  - RequestPayer => (string: requester )
    Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- RequestCharged => (string)
  If present, indicates that the requester was successfully charged for the request.
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`uploadPart( array $args = array() )`

Executes the UploadPart operation.

Uploads a part in a multipart upload.

Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

#### Examples

- Basic formatting example

      $result = $client->uploadPart(array(
          'Body' => 'mixed type: string|resource|\Guzzle\Http\EntityBodyInterface',
          // Bucket is required
          'Bucket' => 'string',
          'ContentLength' => integer,
          // Key is required
          'Key' => 'string',
          // PartNumber is required
          'PartNumber' => integer,
          // UploadId is required
          'UploadId' => 'string',
          'ServerSideEncryption' => 'string',
          'SSECustomerAlgorithm' => 'string',
          'SSECustomerKey' => 'string',
          'SSECustomerKeyMD5' => 'string',
          'RequestPayer' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Body => (string|resource|\Guzzle\Http\EntityBodyInterface)
    Pass a string containing the body, a handle returned by fopen, or a Guzzle\Http\EntityBodyInterface object
  - Bucket => (string)
  - ContentLength => (int)
    Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.
  - Key => (string)
  - PartNumber => (int)
    Part number of part being uploaded. This is a positive integer between 1 and 10,000.
  - UploadId => (string)
    Upload ID identifying the multipart upload whose part is being uploaded.
  - ServerSideEncryption => (string: AES256 )
    The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256).
  - SSECustomerAlgorithm => (string)
    Specifies the algorithm to use to when encrypting the object (e.g., AES256).
  - SSECustomerKey => (string)
    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.
  - SSECustomerKeyMD5 => (string)
    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
  - RequestPayer => (string: requester )
    Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- ServerSideEncryption => (string)
  The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
- ETag => (string)
  Entity tag for the uploaded object.
- SSECustomerAlgorithm => (string)
  If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
- SSECustomerKeyMD5 => (string)
  If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.
- SSEKMSKeyId => (string)
  If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.
- RequestCharged => (string)
  If present, indicates that the requester was successfully charged for the request.
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public `Guzzle\Service\Resource\Model``
`uploadPartCopy( array $args = array() )`

Executes the UploadPartCopy operation.

Uploads a part by copying data from an existing object as data source.

#### Examples

- Basic formatting example

      $result = $client->uploadPartCopy(array(
          // Bucket is required
          'Bucket' => 'string',
          // CopySource is required
          'CopySource' => 'string',
          'CopySourceIfMatch' => 'string',
          'CopySourceIfModifiedSince' => 'mixed type: string (date format)|int (unix timestamp)|\DateTime',
          'CopySourceIfNoneMatch' => 'string',
          'CopySourceIfUnmodifiedSince' => 'mixed type: string (date format)|int (unix timestamp)|\DateTime',
          'CopySourceRange' => 'string',
          // Key is required
          'Key' => 'string',
          // PartNumber is required
          'PartNumber' => integer,
          // UploadId is required
          'UploadId' => 'string',
          'SSECustomerAlgorithm' => 'string',
          'SSECustomerKey' => 'string',
          'SSECustomerKeyMD5' => 'string',
          'CopySourceSSECustomerAlgorithm' => 'string',
          'CopySourceSSECustomerKey' => 'string',
          'CopySourceSSECustomerKeyMD5' => 'string',
          'RequestPayer' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Bucket => (string)
  - CopySource => (string)
    The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.
  - CopySourceIfMatch => (string)
    Copies the object if its entity tag (ETag) matches the specified tag.
  - CopySourceIfModifiedSince => (string [date format]|int [unix timestamp]|\DateTime)
    Copies the object if it has been modified since the specified time.
  - CopySourceIfNoneMatch => (string)
    Copies the object if its entity tag (ETag) is different than the specified ETag.
  - CopySourceIfUnmodifiedSince => (string [date format]|int [unix timestamp]|\DateTime)
    Copies the object if it hasn't been modified since the specified time.
  - CopySourceRange => (string)
    The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first ten bytes of the source. You can copy a range only if the source object is greater than 5 GB.
  - Key => (string)
  - PartNumber => (int)
    Part number of part being copied. This is a positive integer between 1 and 10,000.
  - UploadId => (string)
    Upload ID identifying the multipart upload whose part is being copied.
  - SSECustomerAlgorithm => (string)
    Specifies the algorithm to use to when encrypting the object (e.g., AES256).
  - SSECustomerKey => (string)
    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.
  - SSECustomerKeyMD5 => (string)
    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
  - CopySourceSSECustomerAlgorithm => (string)
    Specifies the algorithm to use when decrypting the source object (e.g., AES256).
  - CopySourceSSECustomerKey => (string)
    Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.
  - CopySourceSSECustomerKeyMD5 => (string)
    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
  - RequestPayer => (string: requester )
    Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- CopySourceVersionId => (string)
  The version of the source object that was copied, if you have enabled versioning on the source bucket.
- ETag => (string)
  Entity tag of the object.
- LastModified => (string)
  Date and time at which the object was uploaded.
- ServerSideEncryption => (string)
  The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
- SSECustomerAlgorithm => (string)
  If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
- SSECustomerKeyMD5 => (string)
  If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.
- SSEKMSKeyId => (string)
  If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.
- RequestCharged => (string)
  If present, indicates that the requester was successfully charged for the request.
- RequestId => ()
  Request ID of the operation

#### Link

online documentation
# `public`
`waitUntilBucketExists( array $input )`

Wait until a bucket exists. The input array uses the parameters of the HeadBucket operation and waiter specific settings

#### Examples

- Execute the CreateTrail operation

      // Create a bucket in S3 to store the logs and configure the policy
      $s3->createBucket(array('Bucket' => $bucket));
      $s3->waitUntil('BucketExists]', array('Bucket' => $bucket));
      $s3->putBucketPolicy(array(
          'Bucket' => $bucket,
          'Policy' => json_encode(array(
              'Statement' => array(
                  array(
                      'Sid' => 'cloudtrail-to-s3',
                      'Action' => array(
                          's3:GetBucketAcl',
                          's3:PutObject'
                      ),
                      'Effect' => 'Allow',
                      'Resource' => array(
                          "arn:aws:s3:::{$bucket}",
                          "arn:aws:s3:::{$bucket}/AWSLogs/*"
                      ),
                      'Principal' => array(
                          'AWS' => array(
                              // Documented CloudTrail Principal ARNs
                              'arn:aws:iam::086441151436:root',
                              'arn:aws:iam::113285607260:root'
                          )
                      )
                  )
              )
          ))
      ));

      // Create a CloudTrail trail and set the bucket to use
      $client->createTrail(array(
          'Name'         => 'test-trail',
          'S3BucketName' => $bucket,
      ));

- Poll a bucket until it exists

      // Poll the bucket until it is accessible
      $client->waitUntil('BucketExists', array('Bucket' => $bucket));

#### Parameters

$input
  `array`
  $input

# `public`
`waitUntilBucketNotExists( array $input )`

Wait until a bucket does not exist. The input array uses the parameters of the HeadBucket operation and waiter specific settings

#### Examples

- Clear the contents and delete a bucket

      // Delete the objects in the bucket before attempting to delete
      // the bucket
      $clear = new ClearBucket($client, $bucket);
      $clear->clear();

      // Delete the bucket
      $client->deleteBucket(array('Bucket' => $bucket));

      // Wait until the bucket is not accessible
      $client->waitUntil('BucketNotExists', array('Bucket' => $bucket));

#### Parameters

$input
  `array`
  $input

# `public`
`waitUntilObjectExists( array $input )`

Wait until an object exists. The input array uses the parameters of the HeadObject operation and waiter specific settings

#### Parameters

$input
  `array`
  $input

# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getListBucketsIterator( array $args = array() )`

The input array uses the parameters of the ListBuckets operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``
# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getListMultipartUploadsIterator( array $args = array() )`

The input array uses the parameters of the ListMultipartUploads operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``
# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getListObjectVersionsIterator( array $args = array() )`

The input array uses the parameters of the ListObjectVersions operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``
# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getListObjectsIterator( array $args = array() )`

The input array uses the parameters of the ListObjects operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``
# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getListPartsIterator( array $args = array() )`

The input array uses the parameters of the ListParts operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``

### Methods inherited from Aws\Common\Client\AbstractClient

`__call()`, `__construct()`, `createRequest()`, `getAllEvents()`, `getApiVersion()`, `getCredentials()`, `getRegion()`, `getRegions()`, `getWaiter()`, `getWaiterFactory()`, `send()`, `setCredentials()`, `setRegion()`, `setWaiterFactory()`, `waitUntil()`

### Methods inherited from Guzzle\Service\Client

`execute()`, `executeMultiple()`, `getCommand()`, `getCommandFactory()`, `getDescription()`, `getInflector()`, `getIterator()`, `getResourceIteratorFactory()`, `prepareCommand()`, `setCommandFactory()`, `setDescription()`, `setInflector()`, `setResourceIteratorFactory()`

### Methods inherited from Guzzle\Http\Client

`delete()`, `expandTemplate()`, `extractPharCacert()`, `get()`, `getBaseUrl()`, `getConfig()`, `getCurlMulti()`, `getDefaultOption()`, `getDefaultUserAgent()`, `getUriTemplate()`, `head()`, `initSsl()`, `options()`, `patch()`, `post()`, `prepareRequest()`, `put()`, `sendMultiple()`, `setBaseUrl()`, `setConfig()`, `setCurlMulti()`, `setDefaultOption()`, `setRequestFactory()`, `setSslVerification()`, `setUriTemplate()`, `setUserAgent()`

### Methods inherited from Guzzle\Common\AbstractHasDispatcher

`addSubscriber()`, `dispatch()`, `getEventDispatcher()`, `setEventDispatcher()`

### Magic methods summary

## Constants summary

`string` | `LATEST_API_VERSION` | `'2006-03-01'` | #

### Constants inherited from Guzzle\Service\Client

`COMMAND_PARAMS`

### Constants inherited from Guzzle\Http\Client

`CURL_OPTIONS`, `DEFAULT_SELECT_TIMEOUT`, `DISABLE_REDIRECTS`, `MAX_HANDLES`, `REQUEST_OPTIONS`, `SSL_CERT_AUTHORITY`

### Constants inherited from Guzzle\Http\ClientInterface

`CREATE_REQUEST`, `HTTP_DATE`

## Properties summary

`protected static array` | $commandAliases | # Aliases for S3 operations
`protected string` | $directory | #

### Properties inherited from Aws\Common\Client\AbstractClient

`$aggregator`, `$credentials`, `$signature`, `$waiterFactory`

### Properties inherited from Guzzle\Service\Client

`$commandFactory`, `$inflector`, `$resourceIteratorFactory`, `$serviceDescription`

### Properties inherited from Guzzle\Http\Client

`$defaultHeaders`, `$requestFactory`, `$userAgent`

### Properties inherited from Guzzle\Common\AbstractHasDispatcher

`$eventDispatcher`