get_bucket_policy ( $bucket, $opt )

Gets the policy of the specified Amazon S3 bucket.

To use this operation, the caller must have GetPolicy permissions for the specified bucket and must be the bucket owner. If the caller does not have GetPolicy permissions, this method will generate a 403 Access Denied error. If the caller has the correct permissions but is not the bucket owner, this method will generate a 405 Method Not Allowed error. If the bucket does not have a policy defined for it, this method will generate a 404 Policy Not Found error.

Access

public

Parameters

Parameter

Type

Required

Description

$bucket

string

Required

The name of the bucket to use.

$opt

array

Optional

An associative array of parameters that can have the following keys:

  • curlopts - array - Optional - A set of values to pass directly into curl_setopt(), where the key is a pre-defined CURLOPT_* constant.
  • returnCurlHandle - boolean - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.

Returns

Type

Description

CFResponse

A CFResponse object containing a parsed HTTP response.

Examples

Get the bucket policy for a given bucket.

// Instantiate the class
$s3 = new AmazonS3();
$bucket = 'my-bucket' . strtolower($s3->key);

// Get the bucket policy
$response = $s3->get_bucket_policy($bucket);

// Success?
var_dump($response->isOK());
Result:
bool(true)

Related Methods

Source

Method defined in services/s3.class.php | Toggle source view (9 lines) | View on GitHub

public function get_bucket_policy($bucket, $opt = null)
{
    if (!$opt) $opt = array();
    $opt['verb'] = 'GET';
    $opt['sub_resource'] = 'policy';

    // Authenticate to S3
    return $this->authenticate($bucket, $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback