Amazon Simple Storage Service – 2006-03-01

MissingMeta

Type: 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.

ObjectLockLegalHoldStatus

Type: string

Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an object’s legal hold status.

ObjectLockMode

Type: string

The Object Lock mode currently in place for this object.

ObjectLockRetainUntilDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when this object’s Object Lock will expire.

PartsCount

Type: int

The count of parts this object has.

ReplicationStatus

Type: string

Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.

RequestCharged

Type: string

If present, indicates that the requester was successfully charged for the request.

Restore

Type: string

Provides information about object restoration action and expiration time of the restored object copy.

SSECustomerAlgorithm

Type: 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

Type: 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

Type: string

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.

ServerSideEncryption

Type: string

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

StorageClass

Type: string

Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

TagCount

Type: int

The number of tags, if any, on the object.

VersionId

Type: string

Version of the object.

WebsiteRedirectLocation

Type: 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.

Errors

NoSuchKey: The specified key does not exist.
InvalidObjectState: Object is archived and inaccessible until restored.

Examples

Example 1: To retrieve an object

The following example retrieves an object for an S3 bucket.

$result = $client->getObject([
    'Bucket' => 'examplebucket',
    'Key' => 'HappyFace.jpg',
]);

Result syntax:

[
    'AcceptRanges' => 'bytes',
    'ContentLength' => 3191,
    'ContentType' => 'image/jpeg',
    'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"',
    'LastModified' => ,
    'Metadata' => [
    ],
    'TagCount' => 2,
    'VersionId' => 'null',
]

Example 2: To retrieve a byte range of an object

The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range.

$result = $client->getObject([
    'Bucket' => 'examplebucket',
    'Key' => 'SampleFile.txt',
    'Range' => 'bytes=0-9',
]);

Result syntax:

[
    'AcceptRanges' => 'bytes',
    'ContentLength' => 10,
    'ContentRange' => 'bytes 0-9/43',
    'ContentType' => 'text/plain',
    'ETag' => '"0d94420ffd0bc68cd3d152506b97a9cc"',
    'LastModified' => ,
    'Metadata' => [
    ],
    'VersionId' => 'null',
]

Example 3: To get an object via an S3 access point ARN

The following example retrieves an object by referencing the bucket via an S3 accesss point ARN. Result output is simplified for the example.

$result = $client->getObject([
    'Bucket' => 'arn:aws:s3:us-east-1:123456789012:accesspoint:myaccesspoint',
    'Key' => 'my-key',
]);

Result syntax:

[
    'Body' => <BLOB>,
    'ContentLength' => 11,
    'ContentType' => 'application/octet-stream',
]

GetObjectAcl

$result = $client->getObjectAcl([/* ... */]); $promise = $client->getObjectAclAsync([/* ... */]);

Returns the access control list (ACL) of an object. To use this operation, you must have READ_ACP access to the object.

This action is not supported by Amazon S3 on Outposts.

Versioning

By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource.

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the bucket-owner-full-control ACL with the owner being the account that created the bucket. For more information, see Controlling object ownership and disabling ACLs in the Amazon S3 User Guide.

The following operations are related to GetObjectAcl:

Parameter Syntax

$result = $client->getObjectAcl([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Key' => '<string>', // REQUIRED
    'RequestPayer' => 'requester',
    'VersionId' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name that contains the object for which to get the ACL information.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName–AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Key

Required: Yes
Type: string

The key of the object for which to get the ACL information.

RequestPayer

Type: string

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

VersionId

Type: string

VersionId used to reference a specific version of the object.

Result Syntax

[
    'Grants' => [
        [
            'Grantee' => [
                'DisplayName' => '<string>',
                'EmailAddress' => '<string>',
                'ID' => '<string>',
                'Type' => 'CanonicalUser|AmazonCustomerByEmail|Group',
                'URI' => '<string>',
            ],
            'Permission' => 'FULL_CONTROL|WRITE|WRITE_ACP|READ|READ_ACP',
        ],
        // ...
    ],
    'Owner' => [
        'DisplayName' => '<string>',
        'ID' => '<string>',
    ],
    'RequestCharged' => 'requester',
]

Result Details

Members

Grants

Type: Array of Grant structures

A list of grants.

Owner

Type: Owner structure

Container for the bucket owner’s display name and ID.

RequestCharged

Type: string

If present, indicates that the requester was successfully charged for the request.

Errors

NoSuchKey: The specified key does not exist.

Examples

Example 1: To retrieve object ACL

The following example retrieves access control list (ACL) of an object.

$result = $client->getObjectAcl([
    'Bucket' => 'examplebucket',
    'Key' => 'HappyFace.jpg',
]);

Result syntax:

[
    'Grants' => [
        [
            'Grantee' => [
                'DisplayName' => 'owner-display-name',
                'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
                'Type' => 'CanonicalUser',
            ],
            'Permission' => 'WRITE',
        ],
        [
            'Grantee' => [
                'DisplayName' => 'owner-display-name',
                'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
                'Type' => 'CanonicalUser',
            ],
            'Permission' => 'WRITE_ACP',
        ],
        [
            'Grantee' => [
                'DisplayName' => 'owner-display-name',
                'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
                'Type' => 'CanonicalUser',
            ],
            'Permission' => 'READ',
        ],
        [
            'Grantee' => [
                'DisplayName' => 'owner-display-name',
                'ID' => '852b113eexamplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
                'Type' => 'CanonicalUser',
            ],
            'Permission' => 'READ_ACP',
        ],
    ],
    'Owner' => [
        'DisplayName' => 'owner-display-name',
        'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
    ],
]

GetObjectLegalHold

$result = $client->getObjectLegalHold([/* ... */]); $promise = $client->getObjectLegalHoldAsync([/* ... */]);

Gets an object’s current Legal Hold status. For more information, see Locking Objects.

This action is not supported by Amazon S3 on Outposts.

Parameter Syntax

$result = $client->getObjectLegalHold([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Key' => '<string>', // REQUIRED
    'RequestPayer' => 'requester',
    'VersionId' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name containing the object whose Legal Hold status you want to retrieve.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Key

Required: Yes
Type: string

The key name for the object whose Legal Hold status you want to retrieve.

RequestPayer

Type: string

VersionId

Type: string

The version ID of the object whose Legal Hold status you want to retrieve.

Result Syntax

[
    'LegalHold' => [
        'Status' => 'ON|OFF',
    ],
]

Result Details

Members

LegalHold

Type: ObjectLockLegalHold structure

The current Legal Hold status for the specified object.

Errors

There are no errors described for this operation.

GetObjectLockConfiguration

$result = $client->getObjectLockConfiguration([/* ... */]); $promise = $client->getObjectLockConfigurationAsync([/* ... */]);

Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.

Parameter Syntax

$result = $client->getObjectLockConfiguration([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket whose Object Lock configuration you want to retrieve.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Result Syntax

[
    'ObjectLockConfiguration' => [
        'ObjectLockEnabled' => 'Enabled',
        'Rule' => [
            'DefaultRetention' => [
                'Days' => <integer>,
                'Mode' => 'GOVERNANCE|COMPLIANCE',
                'Years' => <integer>,
            ],
        ],
    ],
]

Result Details

Members

ObjectLockConfiguration

Type: ObjectLockConfiguration structure

The specified bucket’s Object Lock configuration.

Errors

There are no errors described for this operation.

GetObjectRetention

$result = $client->getObjectRetention([/* ... */]); $promise = $client->getObjectRetentionAsync([/* ... */]);

Retrieves an object’s retention settings. For more information, see Locking Objects.

This action is not supported by Amazon S3 on Outposts.

Parameter Syntax

$result = $client->getObjectRetention([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Key' => '<string>', // REQUIRED
    'RequestPayer' => 'requester',
    'VersionId' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name containing the object whose retention settings you want to retrieve.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Key

Required: Yes
Type: string

The key name for the object whose retention settings you want to retrieve.

RequestPayer

Type: string

VersionId

Type: string

The version ID for the object whose retention settings you want to retrieve.

Result Syntax

[
    'Retention' => [
        'Mode' => 'GOVERNANCE|COMPLIANCE',
        'RetainUntilDate' => <DateTime>,
    ],
]

Result Details

Members

Retention

Type: ObjectLockRetention structure

The container element for an object’s retention settings.

Errors

There are no errors described for this operation.

GetObjectTagging

$result = $client->getObjectTagging([/* ... */]); $promise = $client->getObjectTaggingAsync([/* ... */]);

Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.

To use this operation, you must have permission to perform the s3:GetObjectTagging action. By default, the GET action returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the s3:GetObjectVersionTagging action.

By default, the bucket owner has this permission and can grant this permission to others.

For information about the Amazon S3 object tagging feature, see Object Tagging.

The following action is related to GetObjectTagging:

Parameter Syntax

$result = $client->getObjectTagging([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Key' => '<string>', // REQUIRED
    'RequestPayer' => 'requester',
    'VersionId' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name containing the object for which to get the tagging information.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName–AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Key

Required: Yes
Type: string

Object key for which to get the tagging information.

RequestPayer

Type: string

VersionId

Type: string

The versionId of the object for which to get the tagging information.

Result Syntax

[
    'TagSet' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'VersionId' => '<string>',
]

Result Details

Members

TagSet

Required: Yes
Type: Array of Tag structures

Contains the tag set.

VersionId

Type: string

The versionId of the object for which you got the tagging information.

Errors

There are no errors described for this operation.

Examples

Example 1: To retrieve tag set of a specific object version

The following example retrieves tag set of an object. The request specifies object version.

$result = $client->getObjectTagging([
    'Bucket' => 'examplebucket',
    'Key' => 'exampleobject',
    'VersionId' => 'ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI',
]);

Result syntax:

[
    'TagSet' => [
        [
            'Key' => 'Key1',
            'Value' => 'Value1',
        ],
    ],
    'VersionId' => 'ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI',
]

Example 2: To retrieve tag set of an object

The following example retrieves tag set of an object.

$result = $client->getObjectTagging([
    'Bucket' => 'examplebucket',
    'Key' => 'HappyFace.jpg',
]);

Result syntax:

[
    'TagSet' => [
        [
            'Key' => 'Key4',
            'Value' => 'Value4',
        ],
        [
            'Key' => 'Key3',
            'Value' => 'Value3',
        ],
    ],
    'VersionId' => 'null',
]

GetObjectTorrent

$result = $client->getObjectTorrent([/* ... */]); $promise = $client->getObjectTorrentAsync([/* ... */]);

Returns torrent files from a bucket. BitTorrent can save you bandwidth when you’re distributing large files. For more information about BitTorrent, see Using BitTorrent with Amazon S3.

You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using server-side encryption with a customer-provided encryption key.

To use GET, you must have READ access to the object.

This action is not supported by Amazon S3 on Outposts.

The following action is related to GetObjectTorrent:

GetObject

Parameter Syntax

$result = $client->getObjectTorrent([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Key' => '<string>', // REQUIRED
    'RequestPayer' => 'requester',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket containing the object for which to get the torrent files.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Key

Required: Yes
Type: string

The object key for which to get the information.

RequestPayer

Type: string

Result Syntax

[
    'Body' => <string || resource || Psr\Http\Message\StreamInterface>,
    'RequestCharged' => 'requester',
]

Result Details

Members

Body

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

A Bencoded dictionary as defined by the BitTorrent specification

RequestCharged

Type: string

If present, indicates that the requester was successfully charged for the request.

Errors

There are no errors described for this operation.

Examples

Example 1: To retrieve torrent files for an object

The following example retrieves torrent files of an object.

$result = $client->getObjectTorrent([
    'Bucket' => 'examplebucket',
    'Key' => 'HappyFace.jpg',
]);

Result syntax:

[
]

GetPublicAccessBlock

$result = $client->getPublicAccessBlock([/* ... */]); $promise = $client->getPublicAccessBlockAsync([/* ... */]);

Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner’s account. If the PublicAccessBlock settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of “Public”.

The following operations are related to GetPublicAccessBlock:

Parameter Syntax

$result = $client->getPublicAccessBlock([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to retrieve.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Result Syntax

[
    'PublicAccessBlockConfiguration' => [
        'BlockPublicAcls' => true || false,
        'BlockPublicPolicy' => true || false,
        'IgnorePublicAcls' => true || false,
        'RestrictPublicBuckets' => true || false,
    ],
]

Result Details

Members

PublicAccessBlockConfiguration

Type: PublicAccessBlockConfiguration structure

The PublicAccessBlock configuration currently in effect for this Amazon S3 bucket.

Errors

There are no errors described for this operation.

HeadBucket

$result = $client->headBucket([/* ... */]); $promise = $client->headBucketAsync([/* ... */]);

This action is useful to determine if a bucket exists and you have permission to access it. The action returns a 200 OK if the bucket exists and you have permission to access it.

If the bucket does not exist or you do not have permission to access it, the HEAD request returns a generic 404 Not Found or 403 Forbidden code. A message body is not included, so you cannot determine the exception beyond these error codes.

To use this operation, you must have permissions to perform the s3:ListBucket action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

To use this API against an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using the Amazon Web Services SDKs, you provide the ARN in place of the bucket name. For more information see, Using access points.

Parameter Syntax

$result = $client->headBucket([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NoSuchBucket: The specified bucket does not exist.

Examples

Example 1: To determine if bucket exists

This operation checks to see if a bucket exists.

$result = $client->headBucket([
    'Bucket' => 'acl1',
]);

HeadObject

$result = $client->headObject([/* ... */]); $promise = $client->headObjectAsync([/* ... */]);

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

A HEAD request has the same options as a GET action on an object. The response is identical to the GET response except that there is no response body. Because of this, if the HEAD request generates an error, it returns a generic 404 Not Found or 403 Forbidden code. It is not possible to retrieve the exact exception beyond these error codes.

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:

x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).

Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.
The last modified property in this case is the creation date of the object.

Request headers are limited to 8 KB in size. For more information, see Common Request Headers.

Consider the following when using request headers:

Consideration 1 – If both of the If-Match and If-Unmodified-Since headers are present in the request as follows:
- If-Match condition evaluates to true, and;
- If-Unmodified-Since condition evaluates to false;
Then Amazon S3 returns 200 OK and the data requested.
Consideration 2 – If both of the If-None-Match and If-Modified-Since headers are present in the request as follows:
- If-None-Match condition evaluates to false, and;
- If-Modified-Since condition evaluates to true;
Then Amazon S3 returns the 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

Permissions

You need the relevant read object (or version) permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 (“no such key”) error.
If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 (“access denied”) error.

The following action is related to HeadObject:

GetObject

Parameter Syntax

$result = $client->headObject([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'IfMatch' => '<string>',
    'IfModifiedSince' => <integer || string || DateTime>,
    'IfNoneMatch' => '<string>',
    'IfUnmodifiedSince' => <integer || string || DateTime>,
    'Key' => '<string>', // REQUIRED
    'PartNumber' => <integer>,
    'Range' => '<string>',
    'RequestPayer' => 'requester',
    'SSECustomerAlgorithm' => '<string>',
    'SSECustomerKey' => '<string>',
    'SSECustomerKeyMD5' => '<string>',
    'VersionId' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket containing the object.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

IfMatch

Type: string

Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).

IfModifiedSince

Type: timestamp (string|DateTime or anything parsable by strtotime)

Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

IfNoneMatch

Type: string

Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).

IfUnmodifiedSince

Type: timestamp (string|DateTime or anything parsable by strtotime)

Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).

Key

Required: Yes
Type: string

The object key.

PartNumber

Type: int

Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a ‘ranged’ HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.

Range

Type: string

Downloads the specified range bytes of an object. For more information about the HTTP Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

Amazon S3 doesn’t support retrieving multiple ranges of data per GET request.

RequestPayer

Type: string

SSECustomerAlgorithm

Type: string

Specifies the algorithm to use to when encrypting the object (for example, AES256).

SSECustomerKey

Type: 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 S3 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 value will be base64 encoded on your behalf.

SSECustomerKeyMD5

Type: 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 that the encryption key was transmitted without error.

VersionId

Type: string

VersionId used to reference a specific version of the object.

Result Syntax

[
    'AcceptRanges' => '<string>',
    'ArchiveStatus' => 'ARCHIVE_ACCESS|DEEP_ARCHIVE_ACCESS',
    'BucketKeyEnabled' => true || false,
    'CacheControl' => '<string>',
    'ContentDisposition' => '<string>',
    'ContentEncoding' => '<string>',
    'ContentLanguage' => '<string>',
    'ContentLength' => <integer>,
    'ContentType' => '<string>',
    'DeleteMarker' => true || false,
    'ETag' => '<string>',
    'Expiration' => '<string>',
    'Expires' => <DateTime>,
    'LastModified' => <DateTime>,
    'Metadata' => ['<string>', ...],
    'MissingMeta' => <integer>,
    'ObjectLockLegalHoldStatus' => 'ON|OFF',
    'ObjectLockMode' => 'GOVERNANCE|COMPLIANCE',
    'ObjectLockRetainUntilDate' => <DateTime>,
    'PartsCount' => <integer>,
    'ReplicationStatus' => 'COMPLETE|PENDING|FAILED|REPLICA',
    'RequestCharged' => 'requester',
    'Restore' => '<string>',
    'SSECustomerAlgorithm' => '<string>',
    'SSECustomerKeyMD5' => '<string>',
    'SSEKMSKeyId' => '<string>',
    'ServerSideEncryption' => 'AES256|aws:kms',
    'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR',
    'VersionId' => '<string>',
    'WebsiteRedirectLocation' => '<string>',
]

Result Details

Members

AcceptRanges

Type: string

Indicates that a range of bytes was specified.

ArchiveStatus

Type: string

The archive state of the head object.

BucketKeyEnabled

Type: boolean

Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

CacheControl

Type: string

Specifies caching behavior along the request/reply chain.

ContentDisposition

Type: string

Specifies presentational information for the object.

ContentEncoding

Type: 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

Type: string

The language the content is in.

ContentLength

Type: long (int|float)

Size of the body in bytes.

ContentType

Type: string

A standard MIME type describing the format of the object data.

DeleteMarker

Type: boolean

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.

ETag

Type: string

An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

Expiration

Type: 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.

Expires

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time at which the object is no longer cacheable.

LastModified

Type: timestamp (string|DateTime or anything parsable by strtotime)

Creation date of the object.

Metadata

Type: Associative array of custom strings keys (MetadataKey) to strings

A map of metadata to store with the object in S3.

MissingMeta

Type: int

ObjectLockLegalHoldStatus

Type: string

Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.

ObjectLockMode

Type: string

The Object Lock mode, if any, that’s in effect for this object. This header is only returned if the requester has the s3:GetObjectRetention permission. For more information about S3 Object Lock, see Object Lock.

ObjectLockRetainUntilDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the Object Lock retention period expires. This header is only returned if the requester has the s3:GetObjectRetention permission.

PartsCount

Type: int

The count of parts this object has.

ReplicationStatus

Type: string

Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.

In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (GetObject) or object metadata (HeadObject) from these buckets, Amazon S3 will return the x-amz-replication-status header in the response as follows:

If requesting an object from the source bucket — Amazon S3 will return the x-amz-replication-status header if the object in your request is eligible for replication.For example, suppose that in your replication configuration, you specify object prefix TaxDocs requesting Amazon S3 to replicate objects with key prefix TaxDocs. Any objects you upload with this key name prefix, for example TaxDocs/document1.pdf, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the x-amz-replication-status header with value PENDING, COMPLETED or FAILED indicating object replication status.
If requesting an object from a destination bucket — Amazon S3 will return the x-amz-replication-status header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress.
When replicating objects to multiple destination buckets the x-amz-replication-status header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.

For more information, see Replication.

RequestCharged

Type: string

If present, indicates that the requester was successfully charged for the request.

Restore

Type: string

If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.

If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:

x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"

If the object restoration is in progress, the header returns the value ongoing-request="true".

For more information about archiving objects, see Transitioning Objects: General Considerations.

SSECustomerAlgorithm

Type: 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

Type: string

SSEKMSKeyId

Type: string

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.

ServerSideEncryption

Type: string

If the object is stored using server-side encryption either with an Amazon Web Services KMS key or an Amazon S3-managed encryption key, the response includes this header with the value of the server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

StorageClass

Type: string

Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

For more information, see Storage Classes.

VersionId

Type: string

Version of the object.

WebsiteRedirectLocation

Type: string

Errors

NoSuchKey: The specified key does not exist.

Examples

Example 1: To retrieve metadata of an object without returning the object itself

The following example retrieves an object metadata.

$result = $client->headObject([
    'Bucket' => 'examplebucket',
    'Key' => 'HappyFace.jpg',
]);

Result syntax:

[
    'AcceptRanges' => 'bytes',
    'ContentLength' => 3191,
    'ContentType' => 'image/jpeg',
    'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"',
    'LastModified' => ,
    'Metadata' => [
    ],
    'VersionId' => 'null',
]

ListBucketAnalyticsConfigurations

$result = $client->listBucketAnalyticsConfigurations([/* ... */]); $promise = $client->listBucketAnalyticsConfigurationsAsync([/* ... */]);

Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. You should always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there will be a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.

The following operations are related to ListBucketAnalyticsConfigurations:

Parameter Syntax

$result = $client->listBucketAnalyticsConfigurations([
    'Bucket' => '<string>', // REQUIRED
    'ContinuationToken' => '<string>',
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket from which analytics configurations are retrieved.

ContinuationToken

Type: string

The ContinuationToken that represents a placeholder from where this request should begin.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Result Syntax

[
    'AnalyticsConfigurationList' => [
        [
            'Filter' => [
                'And' => [
                    'Prefix' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'Prefix' => '<string>',
                'Tag' => [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
            ],
            'Id' => '<string>',
            'StorageClassAnalysis' => [
                'DataExport' => [
                    'Destination' => [
                        'S3BucketDestination' => [
                            'Bucket' => '<string>',
                            'BucketAccountId' => '<string>',
                            'Format' => 'CSV',
                            'Prefix' => '<string>',
                        ],
                    ],
                    'OutputSchemaVersion' => 'V_1',
                ],
            ],
        ],
        // ...
    ],
    'ContinuationToken' => '<string>',
    'IsTruncated' => true || false,
    'NextContinuationToken' => '<string>',
]

Result Details

Members

AnalyticsConfigurationList

Type: Array of AnalyticsConfiguration structures

The list of analytics configurations for a bucket.

ContinuationToken

Type: string

The marker that is used as a starting point for this analytics configuration list response. This value is present if it was sent in the request.

IsTruncated

Type: boolean

Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.

NextContinuationToken

Type: string

NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value.

Errors

There are no errors described for this operation.

ListBucketIntelligentTieringConfigurations

$result = $client->listBucketIntelligentTieringConfigurations([/* ... */]); $promise = $client->listBucketIntelligentTieringConfigurationsAsync([/* ... */]);

Lists the S3 Intelligent-Tiering configuration from the specified bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to ListBucketIntelligentTieringConfigurations include:

Parameter Syntax

$result = $client->listBucketIntelligentTieringConfigurations([
    'Bucket' => '<string>', // REQUIRED
    'ContinuationToken' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

ContinuationToken

Type: string

The ContinuationToken that represents a placeholder from where this request should begin.

Result Syntax

[
    'ContinuationToken' => '<string>',
    'IntelligentTieringConfigurationList' => [
        [
            'Filter' => [
                'And' => [
                    'Prefix' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'Prefix' => '<string>',
                'Tag' => [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
            ],
            'Id' => '<string>',
            'Status' => 'Enabled|Disabled',
            'Tierings' => [
                [
                    'AccessTier' => 'ARCHIVE_ACCESS|DEEP_ARCHIVE_ACCESS',
                    'Days' => <integer>,
                ],
                // ...
            ],
        ],
        // ...
    ],
    'IsTruncated' => true || false,
    'NextContinuationToken' => '<string>',
]

Result Details

Members

ContinuationToken

Type: string

The ContinuationToken that represents a placeholder from where this request should begin.

IntelligentTieringConfigurationList

Type: Array of IntelligentTieringConfiguration structures

The list of S3 Intelligent-Tiering configurations for a bucket.

IsTruncated

Type: boolean

NextContinuationToken

Type: string

The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands.

Errors

There are no errors described for this operation.

ListBucketInventoryConfigurations

$result = $client->listBucketInventoryConfigurations([/* ... */]); $promise = $client->listBucketInventoryConfigurationsAsync([/* ... */]);

Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory

The following operations are related to ListBucketInventoryConfigurations:

Parameter Syntax

$result = $client->listBucketInventoryConfigurations([
    'Bucket' => '<string>', // REQUIRED
    'ContinuationToken' => '<string>',
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket containing the inventory configurations to retrieve.

ContinuationToken

Type: string

The marker used to continue an inventory configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Result Syntax

[
    'ContinuationToken' => '<string>',
    'InventoryConfigurationList' => [
        [
            'Destination' => [
                'S3BucketDestination' => [
                    'AccountId' => '<string>',
                    'Bucket' => '<string>',
                    'Encryption' => [
                        'SSEKMS' => [
                            'KeyId' => '<string>',
                        ],
                        'SSES3' => [
                        ],
                    ],
                    'Format' => 'CSV|ORC|Parquet',
                    'Prefix' => '<string>',
                ],
            ],
            'Filter' => [
                'Prefix' => '<string>',
            ],
            'Id' => '<string>',
            'IncludedObjectVersions' => 'All|Current',
            'IsEnabled' => true || false,
            'OptionalFields' => ['<string>', ...],
            'Schedule' => [
                'Frequency' => 'Daily|Weekly',
            ],
        ],
        // ...
    ],
    'IsTruncated' => true || false,
    'NextContinuationToken' => '<string>',
]

Result Details

Members

ContinuationToken

Type: string

If sent in the request, the marker that is used as a starting point for this inventory configuration list response.

InventoryConfigurationList

Type: Array of InventoryConfiguration structures

The list of inventory configurations for a bucket.

IsTruncated

Type: boolean

Tells whether the returned list of inventory configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken is provided for a subsequent request.

NextContinuationToken

Type: string

Errors

There are no errors described for this operation.

ListBucketMetricsConfigurations

$result = $client->listBucketMetricsConfigurations([/* ... */]); $promise = $client->listBucketMetricsConfigurationsAsync([/* ... */]);

Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to ListBucketMetricsConfigurations:

Parameter Syntax

$result = $client->listBucketMetricsConfigurations([
    'Bucket' => '<string>', // REQUIRED
    'ContinuationToken' => '<string>',
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket containing the metrics configurations to retrieve.

ContinuationToken

Type: string

The marker that is used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Result Syntax

[
    'ContinuationToken' => '<string>',
    'IsTruncated' => true || false,
    'MetricsConfigurationList' => [
        [
            'Filter' => [
                'AccessPointArn' => '<string>',
                'And' => [
                    'AccessPointArn' => '<string>',
                    'Prefix' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'Prefix' => '<string>',
                'Tag' => [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
            ],
            'Id' => '<string>',
        ],
        // ...
    ],
    'NextContinuationToken' => '<string>',
]

Result Details

Members

ContinuationToken

Type: string

The marker that is used as a starting point for this metrics configuration list response. This value is present if it was sent in the request.

IsTruncated

Type: boolean

Indicates whether the returned list of metrics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.

MetricsConfigurationList

Type: Array of MetricsConfiguration structures

The list of metrics configurations for a bucket.

NextContinuationToken

Type: string

The marker used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

Errors

There are no errors described for this operation.

ListBuckets

$result = $client->listBuckets([/* ... */]); $promise = $client->listBucketsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listBuckets([
]);

Parameter Details

Members

Result Syntax

[
    'Buckets' => [
        [
            'CreationDate' => <DateTime>,
            'Name' => '<string>',
        ],
        // ...
    ],
    'Owner' => [
        'DisplayName' => '<string>',
        'ID' => '<string>',
    ],
]

Result Details

Members

Buckets

Type: Array of Bucket structures

The list of buckets owned by the requestor.

Owner

Type: Owner structure

The owner of the buckets listed.

Errors

There are no errors described for this operation.

Examples

Example 1: To list object versions

The following example return versions of an object with specific key name prefix. The request limits the number of items returned to two. If there are are more than two object version, S3 returns NextToken in the response. You can specify this token value in your next request to fetch next set of object versions.

$result = $client->listBuckets([
]);

Result syntax:

[
    'Buckets' => [
        [
            'CreationDate' => ,
            'Name' => 'examplebucket',
        ],
        [
            'CreationDate' => ,
            'Name' => 'examplebucket2',
        ],
        [
            'CreationDate' => ,
            'Name' => 'examplebucket3',
        ],
    ],
    'Owner' => [
        'DisplayName' => 'own-display-name',
        'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31',
    ],
]

ListMultipartUploads

$result = $client->listMultipartUploads([/* ... */]); $promise = $client->listMultipartUploadsAsync([/* ... */]);

This action lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.

This action returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum number of uploads a response can include, which is also the default value. You can further limit the number of uploads in a response by specifying the max-uploads parameter in the response. If additional multipart uploads satisfy the list criteria, the response will contain an IsTruncated element with the value true. To list the additional multipart uploads, use the key-marker and upload-id-marker request parameters.

In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time.

For more information on multipart uploads, see Uploading Objects Using Multipart Upload.

For information on permissions required to use the multipart upload API, see Multipart Upload and Permissions.

The following operations are related to ListMultipartUploads:

Parameter Syntax

$result = $client->listMultipartUploads([
    'Bucket' => '<string>', // REQUIRED
    'Delimiter' => '<string>',
    'EncodingType' => 'url',
    'ExpectedBucketOwner' => '<string>',
    'KeyMarker' => '<string>',
    'MaxUploads' => <integer>,
    'Prefix' => '<string>',
    'UploadIdMarker' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket to which the multipart upload was initiated.

Delimiter

Type: string

Character you use to group keys.

All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don’t specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.

EncodingType

Type: string

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.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

KeyMarker

Type: string

Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.

If upload-id-marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

If upload-id-marker is specified, any multipart uploads for a key equal to the key-marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker.

MaxUploads

Type: 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

Type: string

Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you’d use a folder in a file system.)

UploadIdMarker

Type: 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. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.

Result Syntax

[
    'Bucket' => '<string>',
    'CommonPrefixes' => [
        [
            'Prefix' => '<string>',
        ],
        // ...
    ],
    'Delimiter' => '<string>',
    'EncodingType' => 'url',
    'IsTruncated' => true || false,
    'KeyMarker' => '<string>',
    'MaxUploads' => <integer>,
    'NextKeyMarker' => '<string>',
    'NextUploadIdMarker' => '<string>',
    'Prefix' => '<string>',
    'UploadIdMarker' => '<string>',
    'Uploads' => [
        [
            'Initiated' => <DateTime>,
            'Initiator' => [
                'DisplayName' => '<string>',
                'ID' => '<string>',
            ],
            'Key' => '<string>',
            'Owner' => [
                'DisplayName' => '<string>',
                'ID' => '<string>',
            ],
            'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR',
            'UploadId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

Bucket

Type: string

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

CommonPrefixes

Type: Array of CommonPrefix structures

If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element. The distinct key prefixes are returned in the Prefix child element.

Delimiter

Type: string

Contains the delimiter you specified in the request. If you don’t specify a delimiter in your request, this element is absent from the response.

EncodingType

Type: string

Encoding type used by Amazon S3 to encode object keys in the response.

If you specify encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

Delimiter, KeyMarker, Prefix, NextKeyMarker, Key.

IsTruncated

Type: boolean

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.

KeyMarker

Type: string

The key at or after which the listing began.

MaxUploads

Type: int

Maximum number of multipart uploads that could have been included in the response.

NextKeyMarker

Type: 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.

NextUploadIdMarker

Type: 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.

Prefix

Type: 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.

UploadIdMarker

Type: string

Upload ID after which listing began.

Uploads

Type: Array of MultipartUpload structures

Container for elements related to a particular multipart upload. A response can contain zero or more Upload elements.

Errors

There are no errors described for this operation.

Examples

Example 1: To list in-progress multipart uploads on a bucket

The following example lists in-progress multipart uploads on a specific bucket.

$result = $client->listMultipartUploads([
    'Bucket' => 'examplebucket',
]);

Result syntax:

[
    'Uploads' => [
        [
            'Initiated' => ,
            'Initiator' => [
                'DisplayName' => 'display-name',
                'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
            ],
            'Key' => 'JavaFile',
            'Owner' => [
                'DisplayName' => 'display-name',
                'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
            ],
            'StorageClass' => 'STANDARD',
            'UploadId' => 'examplelUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--',
        ],
        [
            'Initiated' => ,
            'Initiator' => [
                'DisplayName' => 'display-name',
                'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
            ],
            'Key' => 'JavaFile',
            'Owner' => [
                'DisplayName' => 'display-name',
                'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
            ],
            'StorageClass' => 'STANDARD',
            'UploadId' => 'examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--',
        ],
    ],
]

Example 2: List next set of multipart uploads when previous result is truncated

The following example specifies the upload-id-marker and key-marker from previous truncated response to retrieve next setup of multipart uploads.

$result = $client->listMultipartUploads([
    'Bucket' => 'examplebucket',
    'KeyMarker' => 'nextkeyfrompreviousresponse',
    'MaxUploads' => 2,
    'UploadIdMarker' => 'valuefrompreviousresponse',
]);

Result syntax:

[
    'Bucket' => 'acl1',
    'IsTruncated' => 1,
    'KeyMarker' => '',
    'MaxUploads' => 2,
    'NextKeyMarker' => 'someobjectkey',
    'NextUploadIdMarker' => 'examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--',
    'UploadIdMarker' => '',
    'Uploads' => [
        [
            'Initiated' => ,
            'Initiator' => [
                'DisplayName' => 'ownder-display-name',
                'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
            ],
            'Key' => 'JavaFile',
            'Owner' => [
                'DisplayName' => 'mohanataws',
                'ID' => '852b113e7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
            ],
            'StorageClass' => 'STANDARD',
            'UploadId' => 'gZ30jIqlUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--',
        ],
        [
            'Initiated' => ,
            'Initiator' => [
                'DisplayName' => 'ownder-display-name',
                'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
            ],
            'Key' => 'JavaFile',
            'Owner' => [
                'DisplayName' => 'ownder-display-name',
                'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
            ],
            'StorageClass' => 'STANDARD',
            'UploadId' => 'b7tZSqIlo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--',
        ],
    ],
]

ListObjectVersions

$result = $client->listObjectVersions([/* ... */]); $promise = $client->listObjectVersionsAsync([/* ... */]);

Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions.

To use this operation, you must have permissions to perform the s3:ListBucketVersions action. Be aware of the name difference.

A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately.

To use this operation, you must have READ access to the bucket.

This action is not supported by Amazon S3 on Outposts.

The following operations are related to ListObjectVersions:

Parameter Syntax

$result = $client->listObjectVersions([
    'Bucket' => '<string>', // REQUIRED
    'Delimiter' => '<string>',
    'EncodingType' => 'url',
    'ExpectedBucketOwner' => '<string>',
    'KeyMarker' => '<string>',
    'MaxKeys' => <integer>,
    'Prefix' => '<string>',
    'VersionIdMarker' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name that contains the objects.

Delimiter

Type: string

A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

EncodingType

Type: string

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

KeyMarker

Type: string

Specifies the key to start with when listing objects in a bucket.

MaxKeys

Type: int

Sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains <isTruncated>true</isTruncated>. To return the additional keys, see key-marker and version-id-marker.

Prefix

Type: string

Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you’d use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.

VersionIdMarker

Type: string

Specifies the object version you want to start listing from.

Result Syntax

[
    'CommonPrefixes' => [
        [
            'Prefix' => '<string>',
        ],
        // ...
    ],
    'DeleteMarkers' => [
        [
            'IsLatest' => true || false,
            'Key' => '<string>',
            'LastModified' => <DateTime>,
            'Owner' => [
                'DisplayName' => '<string>',
                'ID' => '<string>',
            ],
            'VersionId' => '<string>',
        ],
        // ...
    ],
    'Delimiter' => '<string>',
    'EncodingType' => 'url',
    'IsTruncated' => true || false,
    'KeyMarker' => '<string>',
    'MaxKeys' => <integer>,
    'Name' => '<string>',
    'NextKeyMarker' => '<string>',
    'NextVersionIdMarker' => '<string>',
    'Prefix' => '<string>',
    'VersionIdMarker' => '<string>',
    'Versions' => [
        [
            'ETag' => '<string>',
            'IsLatest' => true || false,
            'Key' => '<string>',
            'LastModified' => <DateTime>,
            'Owner' => [
                'DisplayName' => '<string>',
                'ID' => '<string>',
            ],
            'Size' => <integer>,
            'StorageClass' => 'STANDARD',
            'VersionId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

CommonPrefixes

Type: Array of CommonPrefix structures

All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.

DeleteMarkers

Type: Array of DeleteMarkerEntry structures

Container for an object that is a delete marker.

Delimiter

Type: string

The delimiter grouping the included keys. A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

EncodingType

Type: string

Encoding type used by Amazon S3 to encode object key names in the XML response.

If you specify encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

IsTruncated

Type: boolean

A flag that indicates whether 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

Type: string

Marks the last key returned in a truncated response.

MaxKeys

Type: int

Specifies the maximum number of objects to return.

Name

Type: string

The bucket name.

NextKeyMarker

Type: string

When the number of responses exceeds the value of MaxKeys, NextKeyMarker specifies the first key not returned that satisfies the search criteria. Use this value for the key-marker request parameter in a subsequent request.

NextVersionIdMarker

Type: string

When the number of responses exceeds the value of MaxKeys, NextVersionIdMarker specifies the first object version not returned that satisfies the search criteria. Use this value for the version-id-marker request parameter in a subsequent request.

Prefix

Type: string

Selects objects that start with the value supplied by this parameter.

VersionIdMarker

Type: string

Marks the last version of the key returned in a truncated response.

Versions

Type: Array of ObjectVersion structures

Container for version information.

Errors

There are no errors described for this operation.

Examples

Example 1: To list object versions

$result = $client->listObjectVersions([
    'Bucket' => 'examplebucket',
    'Prefix' => 'HappyFace.jpg',
]);

Result syntax:

[
    'Versions' => [
        [
            'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"',
            'IsLatest' => 1,
            'Key' => 'HappyFace.jpg',
            'LastModified' => ,
            'Owner' => [
                'DisplayName' => 'owner-display-name',
                'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
            ],
            'Size' => 3191,
            'StorageClass' => 'STANDARD',
            'VersionId' => 'null',
        ],
        [
            'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"',
            'IsLatest' => ,
            'Key' => 'HappyFace.jpg',
            'LastModified' => ,
            'Owner' => [
                'DisplayName' => 'owner-display-name',
                'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
            ],
            'Size' => 3191,
            'StorageClass' => 'STANDARD',
            'VersionId' => 'PHtexPGjH2y.zBgT8LmB7wwLI2mpbz.k',
        ],
    ],
]

ListObjects

$result = $client->listObjects([/* ... */]); $promise = $client->listObjectsAsync([/* ... */]);

Returns some or all (up to 1,000) 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. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately.

This action has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, Amazon S3 continues to support ListObjects.

The following operations are related to ListObjects:

Parameter Syntax

$result = $client->listObjects([
    'Bucket' => '<string>', // REQUIRED
    'Delimiter' => '<string>',
    'EncodingType' => 'url',
    'ExpectedBucketOwner' => '<string>',
    'Marker' => '<string>',
    'MaxKeys' => <integer>,
    'Prefix' => '<string>',
    'RequestPayer' => 'requester',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket containing the objects.

Delimiter

Type: string

A delimiter is a character you use to group keys.

EncodingType

Type: string

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Marker

Type: string

Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.

MaxKeys

Type: int

Sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

Prefix

Type: string

Limits the response to keys that begin with the specified prefix.

RequestPayer

Type: string

Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.

Result Syntax

[
    'CommonPrefixes' => [
        [
            'Prefix' => '<string>',
        ],
        // ...
    ],
    'Contents' => [
        [
            'ETag' => '<string>',
            'Key' => '<string>',
            'LastModified' => <DateTime>,
            'Owner' => [
                'DisplayName' => '<string>',
                'ID' => '<string>',
            ],
            'Size' => <integer>,
            'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR',
        ],
        // ...
    ],
    'Delimiter' => '<string>',
    'EncodingType' => 'url',
    'IsTruncated' => true || false,
    'Marker' => '<string>',
    'MaxKeys' => <integer>,
    'Name' => '<string>',
    'NextMarker' => '<string>',
    'Prefix' => '<string>',
]

Result Details

Members

CommonPrefixes

Type: Array of CommonPrefix structures

All of the keys (up to 1,000) rolled up in a common prefix count as a single return when calculating the number of returns.

A response can contain CommonPrefixes only if you specify a delimiter.

CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by the delimiter.

CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.

For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

Contents

Type: Array of Object structures

Metadata about each object returned.

Delimiter

Type: string

Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.

EncodingType

Type: string

Encoding type used by Amazon S3 to encode object keys in the response.

IsTruncated

Type: boolean

A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.

Marker

Type: string

Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.

MaxKeys

Type: int

The maximum number of keys returned in the response body.

Name

Type: string

The bucket name.

NextMarker

Type: 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 NextMarker 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.

Prefix

Type: string

Keys that begin with the indicated prefix.

Errors

NoSuchBucket: The specified bucket does not exist.

Examples

Example 1: To list objects in a bucket

The following example list two objects in a bucket.

$result = $client->listObjects([
    'Bucket' => 'examplebucket',
    'MaxKeys' => 2,
]);

Result syntax:

[
    'Contents' => [
        [
            'ETag' => '"70ee1738b6b21e2c8a43f3a5ab0eee71"',
            'Key' => 'example1.jpg',
            'LastModified' => ,
            'Owner' => [
                'DisplayName' => 'myname',
                'ID' => '12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
            ],
            'Size' => 11,
            'StorageClass' => 'STANDARD',
        ],
        [
            'ETag' => '"9c8af9a76df052144598c115ef33e511"',
            'Key' => 'example2.jpg',
            'LastModified' => ,
            'Owner' => [
                'DisplayName' => 'myname',
                'ID' => '12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
            ],
            'Size' => 713193,
            'StorageClass' => 'STANDARD',
        ],
    ],
    'NextMarker' => 'eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==',
]

ListObjectsV2

$result = $client->listObjectsV2([/* ... */]); $promise = $client->listObjectsV2Async([/* ... */]);

Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately. Objects are returned sorted in an ascending order of the respective key names in the list. For more information about listing objects, see Listing object keys programmatically

To use this operation, you must have READ access to the bucket.

To use this action in an Identity and Access Management (IAM) policy, you must have permissions to perform the s3:ListBucket action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

This section describes the latest revision of this action. We recommend that you use this revised API for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API, ListObjects.

To get a list of your buckets, see ListBuckets.

The following operations are related to ListObjectsV2:

Parameter Syntax

$result = $client->listObjectsV2([
    'Bucket' => '<string>', // REQUIRED
    'ContinuationToken' => '<string>',
    'Delimiter' => '<string>',
    'EncodingType' => 'url',
    'ExpectedBucketOwner' => '<string>',
    'FetchOwner' => true || false,
    'MaxKeys' => <integer>,
    'Prefix' => '<string>',
    'RequestPayer' => 'requester',
    'StartAfter' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

Bucket name to list.

ContinuationToken

Type: string

ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key.

Delimiter

Type: string

A delimiter is a character you use to group keys.

EncodingType

Type: string

Encoding type used by Amazon S3 to encode object keys in the response.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

FetchOwner

Type: boolean

The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true.

MaxKeys

Type: int

Sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

Prefix

Type: string

Limits the response to keys that begin with the specified prefix.

RequestPayer

Type: string

Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.

StartAfter

Type: string

StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.

Result Syntax

[
    'CommonPrefixes' => [
        [
            'Prefix' => '<string>',
        ],
        // ...
    ],
    'Contents' => [
        [
            'ETag' => '<string>',
            'Key' => '<string>',
            'LastModified' => <DateTime>,
            'Owner' => [
                'DisplayName' => '<string>',
                'ID' => '<string>',
            ],
            'Size' => <integer>,
            'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR',
        ],
        // ...
    ],
    'ContinuationToken' => '<string>',
    'Delimiter' => '<string>',
    'EncodingType' => 'url',
    'IsTruncated' => true || false,
    'KeyCount' => <integer>,
    'MaxKeys' => <integer>,
    'Name' => '<string>',
    'NextContinuationToken' => '<string>',
    'Prefix' => '<string>',
    'StartAfter' => '<string>',
]

Result Details

Members

CommonPrefixes

Type: Array of CommonPrefix structures

All of the keys (up to 1,000) rolled up into a common prefix count as a single return when calculating the number of returns.

A response can contain CommonPrefixes only if you specify a delimiter.

CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter.

CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.

For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

Contents

Type: Array of Object structures

Metadata about each object returned.

ContinuationToken

Type: string

If ContinuationToken was sent with the request, it is included in the response.

Delimiter

Type: string

Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.

EncodingType

Type: string

Encoding type used by Amazon S3 to encode object key names in the XML response.

If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

Delimiter, Prefix, Key, and StartAfter.

IsTruncated

Type: boolean

Set to false if all of the results were returned. Set to true if more keys are available to return. If the number of results exceeds that specified by MaxKeys, all of the results might not be returned.

KeyCount

Type: int

KeyCount is the number of keys returned with this request. KeyCount will always be less than or equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys

MaxKeys

Type: int

Sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

Name

Type: string

The bucket name.

NextContinuationToken

Type: string

NextContinuationToken is sent when isTruncated is true, which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key

Prefix

Type: string

Keys that begin with the indicated prefix.

StartAfter

Type: string

If StartAfter was sent with the request, it is included in the response.

Errors

NoSuchBucket: The specified bucket does not exist.

Examples

Example 1: To get object list

The following example retrieves object list. The request specifies max keys to limit response to include only 2 object keys.

$result = $client->listObjectsV2([
    'Bucket' => 'examplebucket',
    'MaxKeys' => 2,
]);

Result syntax:

[
    'Contents' => [
        [
            'ETag' => '"70ee1738b6b21e2c8a43f3a5ab0eee71"',
            'Key' => 'happyface.jpg',
            'LastModified' => ,
            'Size' => 11,
            'StorageClass' => 'STANDARD',
        ],
        [
            'ETag' => '"becf17f89c30367a9a44495d62ed521a-1"',
            'Key' => 'test.jpg',
            'LastModified' => ,
            'Size' => 4192256,
            'StorageClass' => 'STANDARD',
        ],
    ],
    'IsTruncated' => 1,
    'KeyCount' => 2,
    'MaxKeys' => 2,
    'Name' => 'examplebucket',
    'NextContinuationToken' => '1w41l63U0xa8q7smH50vCxyTQqdxo69O3EmK28Bi5PcROI4wI/EyIJg==',
    'Prefix' => '',
]

ListParts

$result = $client->listParts([/* ... */]); $promise = $client->listPartsAsync([/* ... */]);

Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the max-parts request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an IsTruncated field with the value of true, and a NextPartNumberMarker element. In subsequent ListParts requests you can include the part-number-marker query string parameter and set its value to the NextPartNumberMarker field value from the previous response.

For more information on multipart uploads, see Uploading Objects Using Multipart Upload.

For information on permissions required to use the multipart upload API, see Multipart Upload and Permissions.

The following operations are related to ListParts:

Parameter Syntax

$result = $client->listParts([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Key' => '<string>', // REQUIRED
    'MaxParts' => <integer>,
    'PartNumberMarker' => <integer>,
    'RequestPayer' => 'requester',
    'UploadId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket to which the parts are being uploaded.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Key

Required: Yes
Type: string

Object key for which the multipart upload was initiated.

MaxParts

Type: int

Sets the maximum number of parts to return.

PartNumberMarker

Type: int

Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

RequestPayer

Type: string

UploadId

Required: Yes
Type: string

Upload ID identifying the multipart upload whose parts are being listed.

Result Syntax

[
    'AbortDate' => <DateTime>,
    'AbortRuleId' => '<string>',
    'Bucket' => '<string>',
    'Initiator' => [
        'DisplayName' => '<string>',
        'ID' => '<string>',
    ],
    'IsTruncated' => true || false,
    'Key' => '<string>',
    'MaxParts' => <integer>,
    'NextPartNumberMarker' => <integer>,
    'Owner' => [
        'DisplayName' => '<string>',
        'ID' => '<string>',
    ],
    'PartNumberMarker' => <integer>,
    'Parts' => [
        [
            'ETag' => '<string>',
            'LastModified' => <DateTime>,
            'PartNumber' => <integer>,
            'Size' => <integer>,
        ],
        // ...
    ],
    'RequestCharged' => 'requester',
    'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR',
    'UploadId' => '<string>',
]

Result Details

Members

AbortDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, then the response includes this header indicating when the initiated multipart upload will become eligible for abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

The response will also include the x-amz-abort-rule-id header that will provide the ID of the lifecycle configuration rule that defines this action.

AbortRuleId

Type: string

This header is returned along with the x-amz-abort-date header. It identifies applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.

Bucket

Type: string

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

Initiator

Type: Initiator structure

Container element that identifies who initiated the multipart upload. If the initiator is an Amazon Web Services account, this element provides the same information as the Owner element. If the initiator is an IAM User, this element provides the user ARN and display name.

IsTruncated

Type: boolean

Indicates whether the returned list of parts is truncated. A true value indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts element.

Key

Type: string

Object key for which the multipart upload was initiated.

MaxParts

Type: int

Maximum number of parts that were allowed in the response.

NextPartNumberMarker

Type: 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.

Owner

Type: Owner structure

Container element that identifies the object owner, after the object is created. If multipart upload is initiated by an IAM user, this element provides the parent account ID and display name.

PartNumberMarker

Type: 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.

Parts

Type: Array of Part structures

Container for elements related to a particular part. A response can contain zero or more Part elements.

RequestCharged

Type: string

If present, indicates that the requester was successfully charged for the request.

StorageClass

Type: string

Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded object.

UploadId

Type: string

Upload ID identifying the multipart upload whose parts are being listed.

Errors

There are no errors described for this operation.

Examples

Example 1: To list parts of a multipart upload.

The following example lists parts uploaded for a specific multipart upload.

$result = $client->listParts([
    'Bucket' => 'examplebucket',
    'Key' => 'bigobject',
    'UploadId' => 'example7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--',
]);

Result syntax:

[
    'Initiator' => [
        'DisplayName' => 'owner-display-name',
        'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
    ],
    'Owner' => [
        'DisplayName' => 'owner-display-name',
        'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
    ],
    'Parts' => [
        [
            'ETag' => '"d8c2eafd90c266e19ab9dcacc479f8af"',
            'LastModified' => ,
            'PartNumber' => 1,
            'Size' => 26246026,
        ],
        [
            'ETag' => '"d8c2eafd90c266e19ab9dcacc479f8af"',
            'LastModified' => ,
            'PartNumber' => 2,
            'Size' => 26246026,
        ],
    ],
    'StorageClass' => 'STANDARD',
]

PutBucketAccelerateConfiguration

$result = $client->putBucketAccelerateConfiguration([/* ... */]); $promise = $client->putBucketAccelerateConfigurationAsync([/* ... */]);

Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to Amazon S3.

To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

The Transfer Acceleration state of a bucket can be set to one of the following two values:

Enabled – Enables accelerated data transfers to the bucket.
Suspended – Disables accelerated data transfers to the bucket.

The GetBucketAccelerateConfiguration action returns the transfer acceleration state of a bucket.

After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase.

The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods (“.”).

For more information about transfer acceleration, see Transfer Acceleration.

The following operations are related to PutBucketAccelerateConfiguration:

Parameter Syntax

$result = $client->putBucketAccelerateConfiguration([
    'AccelerateConfiguration' => [ // REQUIRED
        'Status' => 'Enabled|Suspended',
    ],
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

AccelerateConfiguration

Required: Yes
Type: AccelerateConfiguration structure

Container for setting the transfer acceleration state.

Bucket

Required: Yes
Type: string

The name of the bucket for which the accelerate configuration is set.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

PutBucketAcl

$result = $client->putBucketAcl([/* ... */]); $promise = $client->putBucketAclAsync([/* ... */]);

Sets the permissions on an existing bucket using access control lists (ACL). For more information, see Using ACLs. To set the ACL of a bucket, you must have WRITE_ACP permission.

You can use one of the following two ways to set a bucket’s permissions:

Specify the ACL in the request body
Specify permissions using request headers

You cannot specify access permission using both the body and the request headers.

Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return the AccessControlListNotSupported error code. Requests to read ACLs are still supported. For more information, see Controlling object ownership in the Amazon S3 User Guide.

Access Permissions

You can set access permissions using one of the following methods:

Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of x-amz-acl. If you use this header, you cannot use other access control-specific headers in your request. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. When using these headers, you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use the x-amz-acl header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.You specify each grantee as a type=value pair, where the type is one of the following:
- id – if the value specified is the canonical user ID of an Amazon Web Services account
- uri – if you are granting permissions to a predefined group
- emailAddress – if the value specified is the email address of an Amazon Web Services accountUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
  - US East (N. Virginia)
  - US West (N. California)
  - US West (Oregon)
  - Asia Pacific (Singapore)
  - Asia Pacific (Sydney)
  - Asia Pacific (Tokyo)
  - Europe (Ireland)
  - South America (São Paulo)
  For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
For example, the following x-amz-grant-write header grants create, overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and two Amazon Web Services accounts identified by their email addresses.

x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333", id="555566667777"

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

Grantee Values

You can specify the person (grantee) to whom you’re assigning access rights (using request elements) in the following ways:

By the person’s ID:<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>DisplayName is optional and ignored in the request
By URI:<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
By Email address:<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee>The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
- US East (N. Virginia)
- US West (N. California)
- US West (Oregon)
- Asia Pacific (Singapore)
- Asia Pacific (Sydney)
- Asia Pacific (Tokyo)
- Europe (Ireland)
- South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

Related Resources

Parameter Syntax

$result = $client->putBucketAcl([
    'ACL' => 'private|public-read|public-read-write|authenticated-read',
    'AccessControlPolicy' => [
        'Grants' => [
            [
                'Grantee' => [
                    'DisplayName' => '<string>',
                    'EmailAddress' => '<string>',
                    'ID' => '<string>',
                    'Type' => 'CanonicalUser|AmazonCustomerByEmail|Group', // REQUIRED
                    'URI' => '<string>',
                ],
                'Permission' => 'FULL_CONTROL|WRITE|WRITE_ACP|READ|READ_ACP',
            ],
            // ...
        ],
        'Owner' => [
            'DisplayName' => '<string>',
            'ID' => '<string>',
        ],
    ],
    'Bucket' => '<string>', // REQUIRED
    'ContentMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'GrantFullControl' => '<string>',
    'GrantRead' => '<string>',
    'GrantReadACP' => '<string>',
    'GrantWrite' => '<string>',
    'GrantWriteACP' => '<string>',
]);

Parameter Details

Members

ACL

Type: string

The canned ACL to apply to the bucket.

AccessControlPolicy

Type: AccessControlPolicy structure

Contains the elements that set the ACL permissions for an object per grantee.

Bucket

Required: Yes
Type: string

The bucket to which to apply the ACL.

ContentMD5

Type: string

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

The value will be computed on your behalf.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

GrantFullControl

Type: string

Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

GrantRead

Type: string

Allows grantee to list the objects in the bucket.

GrantReadACP

Type: string

Allows grantee to read the bucket ACL.

GrantWrite

Type: string

Allows grantee to create new objects in the bucket.

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

GrantWriteACP

Type: string

Allows grantee to write the ACL for the applicable bucket.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: Put bucket acl

The following example replaces existing ACL on a bucket. The ACL grants the bucket owner (specified using the owner ID) and write permission to the LogDelivery group. Because this is a replace operation, you must specify all the grants in your request. To incrementally add or remove ACL grants, you might use the console.

$result = $client->putBucketAcl([
    'Bucket' => 'examplebucket',
    'GrantFullControl' => 'id=examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484',
    'GrantWrite' => 'uri=http://acs.amazonaws.com/groups/s3/LogDelivery',
]);

PutBucketAnalyticsConfiguration

$result = $client->putBucketAnalyticsConfiguration([/* ... */]); $promise = $client->putBucketAnalyticsConfigurationAsync([/* ... */]);

Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket.

You can choose to have storage class analysis export analysis reports sent to a comma-separated values (CSV) flat file. See the DataExport request element. Reports are updated daily and are based on the object filters that you configure. When selecting data export, you specify a destination bucket and an optional destination prefix where the file is written. You can export the data to a destination bucket in a different account. However, the destination bucket must be in the same Region as the bucket that you are making the PUT analytics configuration to. For more information, see Amazon S3 Analytics – Storage Class Analysis.

You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

Special Errors

- HTTP Error: HTTP 400 Bad Request
- Code: InvalidArgument
- Cause: Invalid argument.
- HTTP Error: HTTP 400 Bad Request
- Code: TooManyConfigurations
- Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
- HTTP Error: HTTP 403 Forbidden
- Code: AccessDenied
- Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket.

Related Resources

Parameter Syntax

$result = $client->putBucketAnalyticsConfiguration([
    'AnalyticsConfiguration' => [ // REQUIRED
        'Filter' => [
            'And' => [
                'Prefix' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            'Prefix' => '<string>',
            'Tag' => [
                'Key' => '<string>', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
        ],
        'Id' => '<string>', // REQUIRED
        'StorageClassAnalysis' => [ // REQUIRED
            'DataExport' => [
                'Destination' => [ // REQUIRED
                    'S3BucketDestination' => [ // REQUIRED
                        'Bucket' => '<string>', // REQUIRED
                        'BucketAccountId' => '<string>',
                        'Format' => 'CSV', // REQUIRED
                        'Prefix' => '<string>',
                    ],
                ],
                'OutputSchemaVersion' => 'V_1', // REQUIRED
            ],
        ],
    ],
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Members

AnalyticsConfiguration

Required: Yes
Type: AnalyticsConfiguration structure

The configuration and any analyses for the analytics filter.

Bucket

Required: Yes
Type: string

The name of the bucket to which an analytics configuration is stored.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Id

Required: Yes
Type: string

The ID that identifies the analytics configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

PutBucketCors

$result = $client->putBucketCors([/* ... */]); $promise = $client->putBucketCorsAsync([/* ... */]);

Sets the cors configuration for your bucket. If the configuration exists, Amazon S3 replaces it.

To use this operation, you must be allowed to perform the s3:PutBucketCORS action. By default, the bucket owner has this permission and can grant it to others.

You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your Amazon S3 bucket at my.example.bucket.com by using the browser’s XMLHttpRequest capability.

To enable cross-origin resource sharing (CORS) on a bucket, you add the cors subresource to the bucket. The cors subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size.

When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the cors configuration on the bucket and uses the first CORSRule rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met:

The request’s Origin header must match AllowedOrigin elements.
The request method (for example, GET, PUT, HEAD, and so on) or the Access-Control-Request-Method header in case of a pre-flight OPTIONS request must be one of the AllowedMethod elements.
Every header specified in the Access-Control-Request-Headers request header of a pre-flight request must match an AllowedHeader element.

For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

Related Resources

Parameter Syntax

$result = $client->putBucketCors([
    'Bucket' => '<string>', // REQUIRED
    'CORSConfiguration' => [ // REQUIRED
        'CORSRules' => [ // REQUIRED
            [
                'AllowedHeaders' => ['<string>', ...],
                'AllowedMethods' => ['<string>', ...], // REQUIRED
                'AllowedOrigins' => ['<string>', ...], // REQUIRED
                'ExposeHeaders' => ['<string>', ...],
                'ID' => '<string>',
                'MaxAgeSeconds' => <integer>,
            ],
            // ...
        ],
    ],
    'ContentMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

Specifies the bucket impacted by the corsconfiguration.

CORSConfiguration

Required: Yes
Type: CORSConfiguration structure

Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

ContentMD5

Type: string

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

The value will be computed on your behalf.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: To set cors configuration on a bucket.

The following example enables PUT, POST, and DELETE requests from www.example.com, and enables GET requests from any domain.

$result = $client->putBucketCors([
    'Bucket' => '',
    'CORSConfiguration' => [
        'CORSRules' => [
            [
                'AllowedHeaders' => [
                    '*',
                ],
                'AllowedMethods' => [
                    'PUT',
                    'POST',
                    'DELETE',
                ],
                'AllowedOrigins' => [
                    'http://www.example.com',
                ],
                'ExposeHeaders' => [
                    'x-amz-server-side-encryption',
                ],
                'MaxAgeSeconds' => 3000,
            ],
            [
                'AllowedHeaders' => [
                    'Authorization',
                ],
                'AllowedMethods' => [
                    'GET',
                ],
                'AllowedOrigins' => [
                    '*',
                ],
                'MaxAgeSeconds' => 3000,
            ],
        ],
    ],
    'ContentMD5' => '',
]);

PutBucketEncryption

$result = $client->putBucketEncryption([/* ... */]); $promise = $client->putBucketEncryptionAsync([/* ... */]);

This action uses the encryption subresource to configure default encryption and Amazon S3 Bucket Key for an existing bucket.

Default encryption for a bucket can use server-side encryption with Amazon S3-managed keys (SSE-S3) or customer managed keys (SSE-KMS). If you specify default encryption using SSE-KMS, you can also configure Amazon S3 Bucket Key. For information about default encryption, see Amazon S3 default bucket encryption in the Amazon S3 User Guide. For more information about S3 Bucket Keys, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

This action requires Amazon Web Services Signature Version 4. For more information, see Authenticating Requests (Amazon Web Services Signature Version 4).

To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.

Related Resources

Parameter Syntax

$result = $client->putBucketEncryption([
    'Bucket' => '<string>', // REQUIRED
    'ContentMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'ServerSideEncryptionConfiguration' => [ // REQUIRED
        'Rules' => [ // REQUIRED
            [
                'ApplyServerSideEncryptionByDefault' => [
                    'KMSMasterKeyID' => '<string>',
                    'SSEAlgorithm' => 'AES256|aws:kms', // REQUIRED
                ],
                'BucketKeyEnabled' => true || false,
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3) or customer managed keys (SSE-KMS). For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the Amazon S3 User Guide.

ContentMD5

Type: string

The base64-encoded 128-bit MD5 digest of the server-side encryption configuration.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

The value will be computed on your behalf.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

ServerSideEncryptionConfiguration

Required: Yes
Type: ServerSideEncryptionConfiguration structure

Specifies the default server-side-encryption configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

PutBucketIntelligentTieringConfiguration

$result = $client->putBucketIntelligentTieringConfiguration([/* ... */]); $promise = $client->putBucketIntelligentTieringConfigurationAsync([/* ... */]);

Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to 1,000 S3 Intelligent-Tiering configurations per bucket.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to PutBucketIntelligentTieringConfiguration include:

You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically move objects stored in the S3 Intelligent-Tiering storage class to the Archive Access or Deep Archive Access tier.

Special Errors

HTTP 400 Bad Request Error
- Code: InvalidArgument
- Cause: Invalid Argument
HTTP 400 Bad Request Error
- Code: TooManyConfigurations
- Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
HTTP 403 Forbidden Error
- Code: AccessDenied
- Cause: You are not the owner of the specified bucket, or you do not have the s3:PutIntelligentTieringConfiguration bucket permission to set the configuration on the bucket.

Parameter Syntax

$result = $client->putBucketIntelligentTieringConfiguration([
    'Bucket' => '<string>', // REQUIRED
    'Id' => '<string>', // REQUIRED
    'IntelligentTieringConfiguration' => [ // REQUIRED
        'Filter' => [
            'And' => [
                'Prefix' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            'Prefix' => '<string>',
            'Tag' => [
                'Key' => '<string>', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
        ],
        'Id' => '<string>', // REQUIRED
        'Status' => 'Enabled|Disabled', // REQUIRED
        'Tierings' => [ // REQUIRED
            [
                'AccessTier' => 'ARCHIVE_ACCESS|DEEP_ARCHIVE_ACCESS', // REQUIRED
                'Days' => <integer>, // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

Id

Required: Yes
Type: string

The ID used to identify the S3 Intelligent-Tiering configuration.

IntelligentTieringConfiguration

Required: Yes
Type: IntelligentTieringConfiguration structure

Container for S3 Intelligent-Tiering configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

PutBucketInventoryConfiguration

$result = $client->putBucketInventoryConfiguration([/* ... */]); $promise = $client->putBucketInventoryConfigurationAsync([/* ... */]);

This implementation of the PUT action adds an inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket.

Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the inventory flat file is stored is called the destination bucket. The destination bucket must be in the same Amazon Web Services Region as the source bucket.

When you configure an inventory for a source bucket, you specify the destination bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see Amazon S3 Inventory in the Amazon S3 User Guide.

You must create a bucket policy on the destination bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.

Special Errors

HTTP 400 Bad Request Error
- Code: InvalidArgument
- Cause: Invalid Argument
HTTP 400 Bad Request Error
- Code: TooManyConfigurations
- Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
HTTP 403 Forbidden Error
- Code: AccessDenied
- Cause: You are not the owner of the specified bucket, or you do not have the s3:PutInventoryConfiguration bucket permission to set the configuration on the bucket.

Related Resources

Parameter Syntax

$result = $client->putBucketInventoryConfiguration([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Id' => '<string>', // REQUIRED
    'InventoryConfiguration' => [ // REQUIRED
        'Destination' => [ // REQUIRED
            'S3BucketDestination' => [ // REQUIRED
                'AccountId' => '<string>',
                'Bucket' => '<string>', // REQUIRED
                'Encryption' => [
                    'SSEKMS' => [
                        'KeyId' => '<string>', // REQUIRED
                    ],
                    'SSES3' => [
                    ],
                ],
                'Format' => 'CSV|ORC|Parquet', // REQUIRED
                'Prefix' => '<string>',
            ],
        ],
        'Filter' => [
            'Prefix' => '<string>', // REQUIRED
        ],
        'Id' => '<string>', // REQUIRED
        'IncludedObjectVersions' => 'All|Current', // REQUIRED
        'IsEnabled' => true || false, // REQUIRED
        'OptionalFields' => ['<string>', ...],
        'Schedule' => [ // REQUIRED
            'Frequency' => 'Daily|Weekly', // REQUIRED
        ],
    ],
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket where the inventory configuration will be stored.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Id

Required: Yes
Type: string

The ID used to identify the inventory configuration.

InventoryConfiguration

Required: Yes
Type: InventoryConfiguration structure

Specifies the inventory configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

PutBucketLifecycle

$result = $client->putBucketLifecycle([/* ... */]); $promise = $client->putBucketLifecycleAsync([/* ... */]);

For an updated version of this API, see PutBucketLifecycleConfiguration. This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API.

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Object Lifecycle Management in the Amazon S3 User Guide.

By default, all Amazon S3 resources, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration) are private. Only the resource owner, the Amazon Web Services account that created the resource, can access it. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, users must get the s3:PutLifecycleConfiguration permission.

You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:

s3:DeleteObject
s3:DeleteObjectVersion
s3:PutLifecycleConfiguration

For more information about permissions, see Managing Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide.

For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see Examples of Lifecycle Configuration.

Related Resources

GetBucketLifecycle(Deprecated)
GetBucketLifecycleConfiguration
RestoreObject
By default, a resource owner—in this case, a bucket owner, which is the Amazon Web Services account that created the bucket—can perform any of the operations. A resource owner can also grant others permission to perform the operation. For more information, see the following topics in the Amazon S3 User Guide:
- Specifying Permissions in a Policy
- Managing Access Permissions to your Amazon S3 Resources

Parameter Syntax

$result = $client->putBucketLifecycle([
    'Bucket' => '<string>', // REQUIRED
    'ContentMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'LifecycleConfiguration' => [
        'Rules' => [ // REQUIRED
            [
                'AbortIncompleteMultipartUpload' => [
                    'DaysAfterInitiation' => <integer>,
                ],
                'Expiration' => [
                    'Date' => <integer || string || DateTime>,
                    'Days' => <integer>,
                    'ExpiredObjectDeleteMarker' => true || false,
                ],
                'ID' => '<string>',
                'NoncurrentVersionExpiration' => [
                    'NewerNoncurrentVersions' => <integer>,
                    'NoncurrentDays' => <integer>,
                ],
                'NoncurrentVersionTransition' => [
                    'NewerNoncurrentVersions' => <integer>,
                    'NoncurrentDays' => <integer>,
                    'StorageClass' => 'GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|GLACIER_IR',
                ],
                'Prefix' => '<string>', // REQUIRED
                'Status' => 'Enabled|Disabled', // REQUIRED
                'Transition' => [
                    'Date' => <integer || string || DateTime>,
                    'Days' => <integer>,
                    'StorageClass' => 'GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|GLACIER_IR',
                ],
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

ContentMD5

Type: string

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

The value will be computed on your behalf.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

LifecycleConfiguration

Type: LifecycleConfiguration structure

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

PutBucketLifecycleConfiguration

$result = $client->putBucketLifecycleConfiguration([/* ... */]); $promise = $client->putBucketLifecycleConfigurationAsync([/* ... */]);

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Managing your storage lifecycle.

Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle.

Rules

You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. Each rule consists of the following:

Filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both.
Status whether the rule is in effect.
One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions.

For more information, see Object Lifecycle Management and Lifecycle Configuration Elements.

Permissions

By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission.

You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:

s3:DeleteObject
s3:DeleteObjectVersion
s3:PutLifecycleConfiguration

For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources.

The following are related to PutBucketLifecycleConfiguration:

Parameter Syntax

$result = $client->putBucketLifecycleConfiguration([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'LifecycleConfiguration' => [
        'Rules' => [ // REQUIRED
            [
                'AbortIncompleteMultipartUpload' => [
                    'DaysAfterInitiation' => <integer>,
                ],
                'Expiration' => [
                    'Date' => <integer || string || DateTime>,
                    'Days' => <integer>,
                    'ExpiredObjectDeleteMarker' => true || false,
                ],
                'Filter' => [
                    'And' => [
                        'ObjectSizeGreaterThan' => <integer>,
                        'ObjectSizeLessThan' => <integer>,
                        'Prefix' => '<string>',
                        'Tags' => [
                            [
                                'Key' => '<string>', // REQUIRED
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                    'ObjectSizeGreaterThan' => <integer>,
                    'ObjectSizeLessThan' => <integer>,
                    'Prefix' => '<string>',
                    'Tag' => [
                        'Key' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                ],
                'ID' => '<string>',
                'NoncurrentVersionExpiration' => [
                    'NewerNoncurrentVersions' => <integer>,
                    'NoncurrentDays' => <integer>,
                ],
                'NoncurrentVersionTransitions' => [
                    [
                        'NewerNoncurrentVersions' => <integer>,
                        'NoncurrentDays' => <integer>,
                        'StorageClass' => 'GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|GLACIER_IR',
                    ],
                    // ...
                ],
                'Prefix' => '<string>',
                'Status' => 'Enabled|Disabled', // REQUIRED
                'Transitions' => [
                    [
                        'Date' => <integer || string || DateTime>,
                        'Days' => <integer>,
                        'StorageClass' => 'GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|GLACIER_IR',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket for which to set the configuration.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

LifecycleConfiguration

Type: BucketLifecycleConfiguration structure

Container for lifecycle rules. You can add as many as 1,000 rules.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: Put bucket lifecycle

The following example replaces existing lifecycle configuration, if any, on the specified bucket.

$result = $client->putBucketLifecycleConfiguration([
    'Bucket' => 'examplebucket',
    'LifecycleConfiguration' => [
        'Rules' => [
            [
                'Expiration' => [
                    'Days' => 3650,
                ],
                'Filter' => [
                    'Prefix' => 'documents/',
                ],
                'ID' => 'TestOnly',
                'Status' => 'Enabled',
                'Transitions' => [
                    [
                        'Days' => 365,
                        'StorageClass' => 'GLACIER',
                    ],
                ],
            ],
        ],
    ],
]);

PutBucketLogging

$result = $client->putBucketLogging([/* ... */]); $promise = $client->putBucketLoggingAsync([/* ... */]);

Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner.

The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee request element to grant access to other people. The Permissions request element specifies the kind of access the grantee has to the logs.

If the target bucket for log delivery uses the bucket owner enforced setting for S3 Object Ownership, you can’t use the Grantee request element to grant access to others. Permissions can only be granted using policies. For more information, see Permissions for server access log delivery in the Amazon S3 User Guide.

Grantee Values

You can specify the person (grantee) to whom you’re assigning access rights (using request elements) in the following ways:

By the person’s ID:<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>DisplayName is optional and ignored in the request.
By Email address:<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee>The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
By URI:<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>

To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you use an empty BucketLoggingStatus request element:

<BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" />

For more information about server access logging, see Server Access Logging in the Amazon S3 User Guide.

For more information about creating a bucket, see CreateBucket. For more information about returning the logging status of a bucket, see GetBucketLogging.

The following operations are related to PutBucketLogging:

Parameter Syntax

$result = $client->putBucketLogging([
    'Bucket' => '<string>', // REQUIRED
    'BucketLoggingStatus' => [ // REQUIRED
        'LoggingEnabled' => [
            'TargetBucket' => '<string>', // REQUIRED
            'TargetGrants' => [
                [
                    'Grantee' => [
                        'DisplayName' => '<string>',
                        'EmailAddress' => '<string>',
                        'ID' => '<string>',
                        'Type' => 'CanonicalUser|AmazonCustomerByEmail|Group', // REQUIRED
                        'URI' => '<string>',
                    ],
                    'Permission' => 'FULL_CONTROL|READ|WRITE',
                ],
                // ...
            ],
            'TargetPrefix' => '<string>', // REQUIRED
        ],
    ],
    'ContentMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket for which to set the logging parameters.

BucketLoggingStatus

Required: Yes
Type: BucketLoggingStatus structure

Container for logging status information.

ContentMD5

Type: string

The MD5 hash of the PutBucketLogging request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

The value will be computed on your behalf.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: Set logging configuration for a bucket

The following example sets logging policy on a bucket. For the Log Delivery group to deliver logs to the destination bucket, it needs permission for the READ_ACP action which the policy grants.

$result = $client->putBucketLogging([
    'Bucket' => 'sourcebucket',
    'BucketLoggingStatus' => [
        'LoggingEnabled' => [
            'TargetBucket' => 'targetbucket',
            'TargetGrants' => [
                [
                    'Grantee' => [
                        'Type' => 'Group',
                        'URI' => 'http://acs.amazonaws.com/groups/global/AllUsers',
                    ],
                    'Permission' => 'READ',
                ],
            ],
            'TargetPrefix' => 'MyBucketLogs/',
        ],
    ],
]);

PutBucketMetricsConfiguration

$result = $client->putBucketMetricsConfiguration([/* ... */]); $promise = $client->putBucketMetricsConfigurationAsync([/* ... */]);

Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per bucket. If you’re updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don’t include the elements you want to keep, they are erased.

To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to PutBucketMetricsConfiguration:

GetBucketLifecycle has the following special error:

Error code: TooManyConfigurations
- Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
- HTTP Status Code: HTTP 400 Bad Request

Parameter Syntax

$result = $client->putBucketMetricsConfiguration([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Id' => '<string>', // REQUIRED
    'MetricsConfiguration' => [ // REQUIRED
        'Filter' => [
            'AccessPointArn' => '<string>',
            'And' => [
                'AccessPointArn' => '<string>',
                'Prefix' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            'Prefix' => '<string>',
            'Tag' => [
                'Key' => '<string>', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
        ],
        'Id' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket for which the metrics configuration is set.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Id

Required: Yes
Type: string

The ID used to identify the metrics configuration.

MetricsConfiguration

Required: Yes
Type: MetricsConfiguration structure

Specifies the metrics configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

PutBucketNotification

$result = $client->putBucketNotification([/* ... */]); $promise = $client->putBucketNotificationAsync([/* ... */]);

No longer used, see the PutBucketNotificationConfiguration operation.

Parameter Syntax

$result = $client->putBucketNotification([
    'Bucket' => '<string>', // REQUIRED
    'ContentMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'NotificationConfiguration' => [ // REQUIRED
        'CloudFunctionConfiguration' => [
            'CloudFunction' => '<string>',
            'Event' => 's3:ReducedRedundancyLostObject|s3:ObjectCreated:*|s3:ObjectCreated:Put|s3:ObjectCreated:Post|s3:ObjectCreated:Copy|s3:ObjectCreated:CompleteMultipartUpload|s3:ObjectRemoved:*|s3:ObjectRemoved:Delete|s3:ObjectRemoved:DeleteMarkerCreated|s3:ObjectRestore:*|s3:ObjectRestore:Post|s3:ObjectRestore:Completed|s3:Replication:*|s3:Replication:OperationFailedReplication|s3:Replication:OperationNotTracked|s3:Replication:OperationMissedThreshold|s3:Replication:OperationReplicatedAfterThreshold|s3:ObjectRestore:Delete|s3:LifecycleTransition|s3:IntelligentTiering|s3:ObjectAcl:Put|s3:LifecycleExpiration:*|s3:LifecycleExpiration:Delete|s3:LifecycleExpiration:DeleteMarkerCreated|s3:ObjectTagging:*|s3:ObjectTagging:Put|s3:ObjectTagging:Delete',
            'Events' => ['<string>', ...],
            'Id' => '<string>',
            'InvocationRole' => '<string>',
        ],
        'QueueConfiguration' => [
            'Event' => 's3:ReducedRedundancyLostObject|s3:ObjectCreated:*|s3:ObjectCreated:Put|s3:ObjectCreated:Post|s3:ObjectCreated:Copy|s3:ObjectCreated:CompleteMultipartUpload|s3:ObjectRemoved:*|s3:ObjectRemoved:Delete|s3:ObjectRemoved:DeleteMarkerCreated|s3:ObjectRestore:*|s3:ObjectRestore:Post|s3:ObjectRestore:Completed|s3:Replication:*|s3:Replication:OperationFailedReplication|s3:Replication:OperationNotTracked|s3:Replication:OperationMissedThreshold|s3:Replication:OperationReplicatedAfterThreshold|s3:ObjectRestore:Delete|s3:LifecycleTransition|s3:IntelligentTiering|s3:ObjectAcl:Put|s3:LifecycleExpiration:*|s3:LifecycleExpiration:Delete|s3:LifecycleExpiration:DeleteMarkerCreated|s3:ObjectTagging:*|s3:ObjectTagging:Put|s3:ObjectTagging:Delete',
            'Events' => ['<string>', ...],
            'Id' => '<string>',
            'Queue' => '<string>',
        ],
        'TopicConfiguration' => [
            'Event' => 's3:ReducedRedundancyLostObject|s3:ObjectCreated:*|s3:ObjectCreated:Put|s3:ObjectCreated:Post|s3:ObjectCreated:Copy|s3:ObjectCreated:CompleteMultipartUpload|s3:ObjectRemoved:*|s3:ObjectRemoved:Delete|s3:ObjectRemoved:DeleteMarkerCreated|s3:ObjectRestore:*|s3:ObjectRestore:Post|s3:ObjectRestore:Completed|s3:Replication:*|s3:Replication:OperationFailedReplication|s3:Replication:OperationNotTracked|s3:Replication:OperationMissedThreshold|s3:Replication:OperationReplicatedAfterThreshold|s3:ObjectRestore:Delete|s3:LifecycleTransition|s3:IntelligentTiering|s3:ObjectAcl:Put|s3:LifecycleExpiration:*|s3:LifecycleExpiration:Delete|s3:LifecycleExpiration:DeleteMarkerCreated|s3:ObjectTagging:*|s3:ObjectTagging:Put|s3:ObjectTagging:Delete',
            'Events' => ['<string>', ...],
            'Id' => '<string>',
            'Topic' => '<string>',
        ],
    ],
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket.

ContentMD5

Type: string

The MD5 hash of the PutPublicAccessBlock request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

The value will be computed on your behalf.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

NotificationConfiguration

Required: Yes
Type: NotificationConfigurationDeprecated structure

The container for the configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

PutBucketNotificationConfiguration

$result = $client->putBucketNotificationConfiguration([/* ... */]); $promise = $client->putBucketNotificationConfigurationAsync([/* ... */]);

Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications.

Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type.

By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty NotificationConfiguration.

<NotificationConfiguration>

</NotificationConfiguration>

This action replaces the existing notification configuration with the configuration you include in the request body.

After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events.

You can disable notifications by adding the empty NotificationConfiguration element.

By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with s3:PutBucketNotification permission.

The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the configuration to your bucket.

Responses

If the configuration in the request body includes only one TopicConfiguration specifying only the s3:ReducedRedundancyLostObject event type, the response will also include the x-amz-sns-test-message-id header containing the message ID of the test notification sent to the topic.

The following action is related to PutBucketNotificationConfiguration:

GetBucketNotificationConfiguration

Parameter Syntax

$result = $client->putBucketNotificationConfiguration([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'NotificationConfiguration' => [ // REQUIRED
        'EventBridgeConfiguration' => [
        ],
        'LambdaFunctionConfigurations' => [
            [
                'Events' => ['<string>', ...], // REQUIRED
                'Filter' => [
                    'Key' => [
                        'FilterRules' => [
                            [
                                'Name' => 'prefix|suffix',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                'Id' => '<string>',
                'LambdaFunctionArn' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'QueueConfigurations' => [
            [
                'Events' => ['<string>', ...], // REQUIRED
                'Filter' => [
                    'Key' => [
                        'FilterRules' => [
                            [
                                'Name' => 'prefix|suffix',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                'Id' => '<string>',
                'QueueArn' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'TopicConfigurations' => [
            [
                'Events' => ['<string>', ...], // REQUIRED
                'Filter' => [
                    'Key' => [
                        'FilterRules' => [
                            [
                                'Name' => 'prefix|suffix',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                'Id' => '<string>',
                'TopicArn' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'SkipDestinationValidation' => true || false,
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

NotificationConfiguration

Required: Yes
Type: NotificationConfiguration structure

A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket.

SkipDestinationValidation

Type: boolean

Skips validation of Amazon SQS, Amazon SNS, and Lambda destinations. True or false value.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: Set notification configuration for a bucket

The following example sets notification configuration on a bucket to publish the object created events to an SNS topic.

$result = $client->putBucketNotificationConfiguration([
    'Bucket' => 'examplebucket',
    'NotificationConfiguration' => [
        'TopicConfigurations' => [
            [
                'Events' => [
                    's3:ObjectCreated:*',
                ],
                'TopicArn' => 'arn:aws:sns:us-west-2:123456789012:s3-notification-topic',
            ],
        ],
    ],
]);

PutBucketOwnershipControls

$result = $client->putBucketOwnershipControls([/* ... */]); $promise = $client->putBucketOwnershipControlsAsync([/* ... */]);

Creates or modifies OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying permissions in a policy.

For information about Amazon S3 Object Ownership, see Using object ownership.

The following operations are related to PutBucketOwnershipControls:

GetBucketOwnershipControls
DeleteBucketOwnershipControls

Parameter Syntax

$result = $client->putBucketOwnershipControls([
    'Bucket' => '<string>', // REQUIRED
    'ContentMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'OwnershipControls' => [ // REQUIRED
        'Rules' => [ // REQUIRED
            [
                'ObjectOwnership' => 'BucketOwnerPreferred|ObjectWriter|BucketOwnerEnforced', // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the Amazon S3 bucket whose OwnershipControls you want to set.

ContentMD5

Type: string

The MD5 hash of the OwnershipControls request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

The value will be computed on your behalf.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

OwnershipControls

Required: Yes
Type: OwnershipControls structure

The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) that you want to apply to this Amazon S3 bucket.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

PutBucketPolicy

$result = $client->putBucketPolicy([/* ... */]); $promise = $client->putBucketPolicyAsync([/* ... */]);

Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the PutBucketPolicy permissions on the specified bucket and belong to the bucket owner’s account in order to use this operation.

If you don’t have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you’re not using an identity that belongs to the bucket owner’s account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

For more information, see Bucket policy examples.

The following operations are related to PutBucketPolicy:

Parameter Syntax

$result = $client->putBucketPolicy([
    'Bucket' => '<string>', // REQUIRED
    'ConfirmRemoveSelfBucketAccess' => true || false,
    'ContentMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'Policy' => '<string>', // REQUIRED
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket.

ConfirmRemoveSelfBucketAccess

Type: boolean

Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

ContentMD5

Type: string

The MD5 hash of the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

The value will be computed on your behalf.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Policy

Required: Yes
Type: string

The bucket policy as a JSON document.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: Set bucket policy

The following example sets a permission policy on a bucket.

$result = $client->putBucketPolicy([
    'Bucket' => 'examplebucket',
    'Policy' => '{"Version": "2012-10-17", "Statement": [{ "Sid": "id-1","Effect": "Allow","Principal": {"AWS": "arn:aws:iam::123456789012:root"}, "Action": [ "s3:PutObject","s3:PutObjectAcl"], "Resource": ["arn:aws:s3:::acl3/*" ] } ]}',
]);

PutBucketReplication

$result = $client->putBucketReplication([/* ... */]); $promise = $client->putBucketReplicationAsync([/* ... */]);

Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 User Guide.

Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket or buckets where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information.

A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset.

To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, Status, and Priority.

If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see Backward Compatibility.

For information about enabling versioning on a bucket, see Using Versioning.

Handling Replication of Encrypted Objects

By default, Amazon S3 doesn’t replicate objects that are stored at rest using server-side encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the following: SourceSelectionCriteria, SseKmsEncryptedObjects, Status, EncryptionConfiguration, and ReplicaKmsKeyID. For information about replication configuration, see Replicating Objects Created with SSE Using KMS keys.

For information on PutBucketReplication errors, see List of replication-related error codes

Permissions

To create a PutBucketReplication request, you must have s3:PutReplicationConfiguration permissions for the bucket.

By default, a resource owner, in this case the Amazon Web Services account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see Specifying Permissions in a Policy and Managing Access Permissions to Your Amazon S3 Resources.

To perform this operation, the user or role performing the action must have the iam:PassRole permission.

The following operations are related to PutBucketReplication:

Parameter Syntax

$result = $client->putBucketReplication([
    'Bucket' => '<string>', // REQUIRED
    'ContentMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'ReplicationConfiguration' => [ // REQUIRED
        'Role' => '<string>', // REQUIRED
        'Rules' => [ // REQUIRED
            [
                'DeleteMarkerReplication' => [
                    'Status' => 'Enabled|Disabled',
                ],
                'Destination' => [ // REQUIRED
                    'AccessControlTranslation' => [
                        'Owner' => 'Destination', // REQUIRED
                    ],
                    'Account' => '<string>',
                    'Bucket' => '<string>', // REQUIRED
                    'EncryptionConfiguration' => [
                        'ReplicaKmsKeyID' => '<string>',
                    ],
                    'Metrics' => [
                        'EventThreshold' => [
                            'Minutes' => <integer>,
                        ],
                        'Status' => 'Enabled|Disabled', // REQUIRED
                    ],
                    'ReplicationTime' => [
                        'Status' => 'Enabled|Disabled', // REQUIRED
                        'Time' => [ // REQUIRED
                            'Minutes' => <integer>,
                        ],
                    ],
                    'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR',
                ],
                'ExistingObjectReplication' => [
                    'Status' => 'Enabled|Disabled', // REQUIRED
                ],
                'Filter' => [
                    'And' => [
                        'Prefix' => '<string>',
                        'Tags' => [
                            [
                                'Key' => '<string>', // REQUIRED
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                    'Prefix' => '<string>',
                    'Tag' => [
                        'Key' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                ],
                'ID' => '<string>',
                'Prefix' => '<string>',
                'Priority' => <integer>,
                'SourceSelectionCriteria' => [
                    'ReplicaModifications' => [
                        'Status' => 'Enabled|Disabled', // REQUIRED
                    ],
                    'SseKmsEncryptedObjects' => [
                        'Status' => 'Enabled|Disabled', // REQUIRED
                    ],
                ],
                'Status' => 'Enabled|Disabled', // REQUIRED
            ],
            // ...
        ],
    ],
    'Token' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket

ContentMD5

Type: string

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

The value will be computed on your behalf.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

ReplicationConfiguration

Required: Yes
Type: ReplicationConfiguration structure

A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.

Token

Type: string

A token to allow Object Lock to be enabled for an existing bucket.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: Set replication configuration on a bucket

The following example sets replication configuration on a bucket.

$result = $client->putBucketReplication([
    'Bucket' => 'examplebucket',
    'ReplicationConfiguration' => [
        'Role' => 'arn:aws:iam::123456789012:role/examplerole',
        'Rules' => [
            [
                'Destination' => [
                    'Bucket' => 'arn:aws:s3:::destinationbucket',
                    'StorageClass' => 'STANDARD',
                ],
                'Prefix' => '',
                'Status' => 'Enabled',
            ],
        ],
    ],
]);

PutBucketRequestPayment

$result = $client->putBucketRequestPayment([/* ... */]); $promise = $client->putBucketRequestPaymentAsync([/* ... */]);

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. For more information, see Requester Pays Buckets.

The following operations are related to PutBucketRequestPayment:

Parameter Syntax

$result = $client->putBucketRequestPayment([
    'Bucket' => '<string>', // REQUIRED
    'ContentMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'RequestPaymentConfiguration' => [ // REQUIRED
        'Payer' => 'Requester|BucketOwner', // REQUIRED
    ],
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name.

ContentMD5

Type: string

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

The value will be computed on your behalf.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

RequestPaymentConfiguration

Required: Yes
Type: RequestPaymentConfiguration structure

Container for Payer.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: Set request payment configuration on a bucket.

The following example sets request payment configuration on a bucket so that person requesting the download is charged.

$result = $client->putBucketRequestPayment([
    'Bucket' => 'examplebucket',
    'RequestPaymentConfiguration' => [
        'Payer' => 'Requester',
    ],
]);

PutBucketTagging

$result = $client->putBucketTagging([/* ... */]); $promise = $client->putBucketTaggingAsync([/* ... */]);

Sets the tags for a bucket.

Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost Allocation and Tagging and Using Cost Allocation in Amazon S3 Bucket Tags.

When this operation sets the tags for a bucket, it will overwrite any current tags the bucket already has. You cannot use this operation to add tags to an existing list of tags.

To use this operation, you must have permissions to perform the s3:PutBucketTagging action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

PutBucketTagging has the following special errors:

Error code: InvalidTagError
- Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see User-Defined Tag Restrictions and Amazon Web Services-Generated Cost Allocation Tag Restrictions.
Error code: MalformedXMLError
- Description: The XML provided does not match the schema.
Error code: OperationAbortedError
- Description: A conflicting conditional action is currently in progress against this resource. Please try again.
Error code: InternalError
- Description: The service was unable to apply the provided tag to the bucket.

The following operations are related to PutBucketTagging:

Parameter Syntax

$result = $client->putBucketTagging([
    'Bucket' => '<string>', // REQUIRED
    'ContentMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'Tagging' => [ // REQUIRED
        'TagSet' => [ // REQUIRED
            [
                'Key' => '<string>', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name.

ContentMD5

Type: string

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

The value will be computed on your behalf.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Tagging

Required: Yes
Type: Tagging structure

Container for the TagSet and Tag elements.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: Set tags on a bucket

The following example sets tags on a bucket. Any existing tags are replaced.

$result = $client->putBucketTagging([
    'Bucket' => 'examplebucket',
    'Tagging' => [
        'TagSet' => [
            [
                'Key' => 'Key1',
                'Value' => 'Value1',
            ],
            [
                'Key' => 'Key2',
                'Value' => 'Value2',
            ],
        ],
    ],
]);

PutBucketVersioning

$result = $client->putBucketVersioning([/* ... */]); $promise = $client->putBucketVersioningAsync([/* ... */]);

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

You can set the versioning state with one of the following values:

Enabled—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.

Suspended—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.

If the versioning state has never been set on a bucket, it has no versioning state; a GetBucketVersioning request does not return a versioning state value.

If the bucket owner enables MFA Delete in the bucket versioning configuration, the bucket owner must include the x-amz-mfa request header and the Status and the MfaDelete request elements in a request to set the versioning state of the bucket.

If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning.

Related Resources

Parameter Syntax

$result = $client->putBucketVersioning([
    'Bucket' => '<string>', // REQUIRED
    'ContentMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'MFA' => '<string>',
    'VersioningConfiguration' => [ // REQUIRED
        'MFADelete' => 'Enabled|Disabled',
        'Status' => 'Enabled|Suspended',
    ],
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name.

ContentMD5

Type: string

>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

The value will be computed on your behalf.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

MFA

Type: string

The concatenation of the authentication device’s serial number, a space, and the value that is displayed on your authentication device.

VersioningConfiguration

Required: Yes
Type: VersioningConfiguration structure

Container for setting the versioning state.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: Set versioning configuration on a bucket

The following example sets versioning configuration on bucket. The configuration enables versioning on the bucket.

$result = $client->putBucketVersioning([
    'Bucket' => 'examplebucket',
    'VersioningConfiguration' => [
        'MFADelete' => 'Disabled',
        'Status' => 'Enabled',
    ],
]);

PutBucketWebsite

$result = $client->putBucketWebsite([/* ... */]); $promise = $client->putBucketWebsiteAsync([/* ... */]);

Sets the configuration of the website that is specified in the website subresource. To configure a bucket as a website, you can add this subresource on the bucket with website configuration information such as the file name of the index document and any redirect rules. For more information, see Hosting Websites on Amazon S3.

This PUT action requires the S3:PutBucketWebsite permission. By default, only the bucket owner can configure the website attached to a bucket; however, bucket owners can allow other users to set the website configuration by writing a bucket policy that grants them the S3:PutBucketWebsite permission.

To redirect all website requests sent to the bucket’s website endpoint, you add a website configuration with the following elements. Because all requests are sent to another website, you don’t need to provide index document name for the bucket.

WebsiteConfiguration
RedirectAllRequestsTo
HostName
Protocol

If you want granular control over redirects, you can use the following elements to add routing rules that describe conditions for redirecting requests and information about the redirect destination. In this case, the website configuration must provide an index document for the bucket, because some requests might not be redirected.

WebsiteConfiguration
IndexDocument
Suffix
ErrorDocument
Key
RoutingRules
RoutingRule
Condition
HttpErrorCodeReturnedEquals
KeyPrefixEquals
Redirect
Protocol
HostName
ReplaceKeyPrefixWith
ReplaceKeyWith
HttpRedirectCode

Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more than 50 routing rules, you can use object redirect. For more information, see Configuring an Object Redirect in the Amazon S3 User Guide.

Parameter Syntax

$result = $client->putBucketWebsite([
    'Bucket' => '<string>', // REQUIRED
    'ContentMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'WebsiteConfiguration' => [ // REQUIRED
        'ErrorDocument' => [
            'Key' => '<string>', // REQUIRED
        ],
        'IndexDocument' => [
            'Suffix' => '<string>', // REQUIRED
        ],
        'RedirectAllRequestsTo' => [
            'HostName' => '<string>', // REQUIRED
            'Protocol' => 'http|https',
        ],
        'RoutingRules' => [
            [
                'Condition' => [
                    'HttpErrorCodeReturnedEquals' => '<string>',
                    'KeyPrefixEquals' => '<string>',
                ],
                'Redirect' => [ // REQUIRED
                    'HostName' => '<string>',
                    'HttpRedirectCode' => '<string>',
                    'Protocol' => 'http|https',
                    'ReplaceKeyPrefixWith' => '<string>',
                    'ReplaceKeyWith' => '<string>',
                ],
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name.

ContentMD5

Type: string

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

The value will be computed on your behalf.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

WebsiteConfiguration

Required: Yes
Type: WebsiteConfiguration structure

Container for the request.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: Set website configuration on a bucket

The following example adds website configuration to a bucket.

$result = $client->putBucketWebsite([
    'Bucket' => 'examplebucket',
    'ContentMD5' => '',
    'WebsiteConfiguration' => [
        'ErrorDocument' => [
            'Key' => 'error.html',
        ],
        'IndexDocument' => [
            'Suffix' => 'index.html',
        ],
    ],
]);

PutObject

$result = $client->putObject([/* ... */]); $promise = $client->putObjectAsync([/* ... */]);

Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.

Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket.

Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead.

To ensure that data is not corrupted traversing the network, use the Content-MD5 header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.

To successfully complete the PutObject request, you must have the s3:PutObject in your IAM permissions.
To successfully change the objects acl of your PutObject request, you must have the s3:PutObjectAcl in your IAM permissions.
The Content-MD5 header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see Amazon S3 Object Lock Overview in the Amazon S3 User Guide.

Server-side Encryption

You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. You have the option to provide your own encryption key or use Amazon Web Services managed encryption keys (SSE-S3 or SSE-KMS). For more information, see Using Server-Side Encryption.

If you request server-side encryption using Amazon Web Services Key Management Service (SSE-KMS), you can enable an S3 Bucket Key at the object-level. For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

Access Control List (ACL)-Specific Request Headers

You can use headers to grant ACL- based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API.

If the bucket that you’re uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don’t specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a 400 error with the error code AccessControlListNotSupported.

For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.

If your bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by any account will be owned by the bucket owner.

Storage Class Options

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

Versioning

If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects.

For more information about versioning, see Adding Objects to Versioning Enabled Buckets. For information about returning the versioning state of a bucket, see GetBucketVersioning.

Related Resources

Additional info on behavior of the stream parameters: Psr7 takes ownership of streams and will automatically close streams when this method is called with a stream as the Body parameter. To prevent this, set the Body using GuzzleHttp\Psr7\stream_for method with a is an instance of Psr\Http\Message\StreamInterface, and it will be returned unmodified. This will allow you to keep the stream in scope.

Parameter Syntax

$result = $client->putObject([
    'ACL' => 'private|public-read|public-read-write|authenticated-read|aws-exec-read|bucket-owner-read|bucket-owner-full-control',
    'Body' => <string || resource || Psr\Http\Message\StreamInterface>,
    'Bucket' => '<string>', // REQUIRED
    'BucketKeyEnabled' => true || false,
    'CacheControl' => '<string>',
    'ContentDisposition' => '<string>',
    'ContentEncoding' => '<string>',
    'ContentLanguage' => '<string>',
    'ContentLength' => <integer>,
    'ContentSHA256' => '<string>',
    'ContentType' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'Expires' => <integer || string || DateTime>,
    'GrantFullControl' => '<string>',
    'GrantRead' => '<string>',
    'GrantReadACP' => '<string>',
    'GrantWriteACP' => '<string>',
    'Key' => '<string>', // REQUIRED
    'Metadata' => ['<string>', ...],
    'ObjectLockLegalHoldStatus' => 'ON|OFF',
    'ObjectLockMode' => 'GOVERNANCE|COMPLIANCE',
    'ObjectLockRetainUntilDate' => <integer || string || DateTime>,
    'RequestPayer' => 'requester',
    'SSECustomerAlgorithm' => '<string>',
    'SSECustomerKey' => '<string>',
    'SSECustomerKeyMD5' => '<string>',
    'SSEKMSEncryptionContext' => '<string>',
    'SSEKMSKeyId' => '<string>',
    'ServerSideEncryption' => 'AES256|aws:kms',
    'SourceFile' => '<string>',
    'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR',
    'Tagging' => '<string>',
    'WebsiteRedirectLocation' => '<string>',
]);

Parameter Details

Members

ACL

Type: string

The canned ACL to apply to the object. For more information, see Canned ACL.

This action is not supported by Amazon S3 on Outposts.

Body

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

Object data.

Bucket

Required: Yes
Type: string

The bucket name to which the PUT action was initiated.

BucketKeyEnabled

Type: boolean

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with a PUT action doesn’t affect bucket-level settings for S3 Bucket Key.

CacheControl

Type: string

Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

ContentDisposition

Type: string

Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.

ContentEncoding

Type: 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. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.

ContentLanguage

Type: string

The language the content is in.

ContentLength

Type: long (int|float)

Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.

ContentSHA256

Type: string

A SHA256 hash of the body content of the request.

This value will be computed for you it is not supplied.

ContentType

Type: string

A standard MIME type describing the format of the contents. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Expires

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.

GrantFullControl

Type: string

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

This action is not supported by Amazon S3 on Outposts.

GrantRead

Type: string

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

GrantReadACP

Type: string

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

GrantWriteACP

Type: string

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

Key

Required: Yes
Type: string

Object key for which the PUT action was initiated.

Metadata

Type: Associative array of custom strings keys (MetadataKey) to strings

A map of metadata to store with the object in S3.

ObjectLockLegalHoldStatus

Type: string

Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.

ObjectLockMode

Type: string

The Object Lock mode that you want to apply to this object.

ObjectLockRetainUntilDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when you want this object’s Object Lock to expire. Must be formatted as a timestamp parameter.

RequestPayer

Type: string

SSECustomerAlgorithm

Type: string

Specifies the algorithm to use to when encrypting the object (for example, AES256).

SSECustomerKey

Type: string

This value will be base64 encoded on your behalf.

SSECustomerKeyMD5

Type: 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 that the encryption key was transmitted without error.

SSEKMSEncryptionContext

Type: string

Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

SSEKMSKeyId

Type: string

If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetrical customer managed key that was used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key to protect the data. If the KMS key does not exist in the same account issuing the command, you must use the full ARN and not just the ID.

ServerSideEncryption

Type: string

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

SourceFile

Type: string

The path to a file on disk to use instead of the Body parameter.

StorageClass

Type: string

Tagging

Type: string

The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, “Key1=Value1”)

WebsiteRedirectLocation

Type: string

In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:

x-amz-website-redirect-location: /anotherPage.html

In the following example, the request header sets the object redirect to another website:

x-amz-website-redirect-location: http://www.example.com/

For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.

Result Syntax

[
    'BucketKeyEnabled' => true || false,
    'ETag' => '<string>',
    'Expiration' => '<string>',
    'ObjectURL' => '<string>',
    'RequestCharged' => 'requester',
    'SSECustomerAlgorithm' => '<string>',
    'SSECustomerKeyMD5' => '<string>',
    'SSEKMSEncryptionContext' => '<string>',
    'SSEKMSKeyId' => '<string>',
    'ServerSideEncryption' => 'AES256|aws:kms',
    'VersionId' => '<string>',
]

Result Details

Members

BucketKeyEnabled

Type: boolean

Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

ETag

Type: string

Entity tag for the uploaded object.

Expiration

Type: string

If the expiration is configured for the object (see PutBucketLifecycleConfiguration), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL encoded.

ObjectURL

Type: string

The URI of the created object.

RequestCharged

Type: string

If present, indicates that the requester was successfully charged for the request.

SSECustomerAlgorithm

Type: string

If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.