com.amazonaws.services.s3.model

Class GetBucketPolicyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.s3.model.GetBucketPolicyRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, ExpectedBucketOwnerRequest, Serializable, Cloneable

public class GetBucketPolicyRequest
extends AmazonWebServiceRequest
implements Serializable, ExpectedBucketOwnerRequest

Gets the policy for the specified bucket. Only the owner of the bucket can retrieve the policy. If no policy has been set for the bucket, then an empty result object with a null policy text field will be returned.

Bucket policies provide access control management at the bucket level for both the bucket resource and contained object resources. Only one policy can be specified per-bucket.

See the Amazon S3 User Guide for more information on forming bucket polices.

See Also:

AmazonS3.getBucketPolicy(GetBucketPolicyRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetBucketPolicyRequest(String bucketName) Creates a new request object, ready to be executed to retrieve the bucket policy of an Amazon S3 bucket.

Method Summary

Modifier and Type	Method and Description
String	getBucketName() Returns the name of the Amazon S3 bucket whose policy is being retrieved.
String	getExpectedBucketOwner() Returns he account id of the expected bucket owner.
void	setBucketName(String bucketName) Sets the name of the Amazon S3 bucket whose policy is being retrieved.
void	setExpectedBucketOwner(String expectedBucketOwner) Set the account id of the expected bucket owner.
GetBucketPolicyRequest	withBucketName(String bucketName) Sets the name of the Amazon S3 bucket whose policy is being retrieved, and returns the updated request object so that additional method calls can be chained together.
GetBucketPolicyRequest	withExpectedBucketOwner(String expectedBucketOwner) Set the account id of the expected bucket owner.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GetBucketPolicyRequest

public GetBucketPolicyRequest(String bucketName)

Creates a new request object, ready to be executed to retrieve the bucket policy of an Amazon S3 bucket.

Parameters:

bucketName - The name of the Amazon S3 bucket whose policy is being retrieved.

Method Detail

getExpectedBucketOwner

public String getExpectedBucketOwner()

Description copied from interface: ExpectedBucketOwnerRequest

Returns he 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.

Specified by:

getExpectedBucketOwner in interface ExpectedBucketOwnerRequest

withExpectedBucketOwner

public GetBucketPolicyRequest withExpectedBucketOwner(String expectedBucketOwner)

Description copied from interface: ExpectedBucketOwnerRequest

Set 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.

Specified by:

withExpectedBucketOwner in interface ExpectedBucketOwnerRequest

setExpectedBucketOwner

public void setExpectedBucketOwner(String expectedBucketOwner)

Description copied from interface: ExpectedBucketOwnerRequest

Set 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.

Specified by:

setExpectedBucketOwner in interface ExpectedBucketOwnerRequest

getBucketName

public String getBucketName()

Returns the name of the Amazon S3 bucket whose policy is being retrieved.

Returns:

The name of the Amazon S3 bucket whose policy is being retrieved.

setBucketName

public void setBucketName(String bucketName)

Sets the name of the Amazon S3 bucket whose policy is being retrieved.

Parameters:

bucketName - The name of the Amazon S3 bucket whose policy is being retrieved.

withBucketName

public GetBucketPolicyRequest withBucketName(String bucketName)

Sets the name of the Amazon S3 bucket whose policy is being retrieved, and returns the updated request object so that additional method calls can be chained together.

Parameters:

bucketName - The name of the Amazon S3 bucket whose policy is being retrieved.

Returns:

The updated request object so that additional method calls can be chained together.