Amazonka.S3.PutPublicAccessBlock

Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock 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 configurations 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".

Related Resources

• GetPublicAccessBlock
• DeletePublicAccessBlock
• GetBucketPolicyStatus
• Using Amazon S3 Block Public Access

Creating a Request

data PutPublicAccessBlock

See: newPutPublicAccessBlock smart constructor.

Constructors

PutPublicAccessBlock'

Fields

• checksumAlgorithm :: Maybe ChecksumAlgorithm

  Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

  If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

• contentMD5 :: Maybe Text

  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.

• expectedBucketOwner :: Maybe Text

  The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• bucket :: BucketName

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

• publicAccessBlockConfiguration :: PublicAccessBlockConfiguration

  The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon S3 User Guide.

Instances

ToHeaders PutPublicAccessBlock

Defined in Amazonka.S3.PutPublicAccessBlock

Methods

toHeaders :: PutPublicAccessBlock -> [Header]

ToPath PutPublicAccessBlock

Defined in Amazonka.S3.PutPublicAccessBlock

Methods

toPath :: PutPublicAccessBlock -> ByteString

ToQuery PutPublicAccessBlock

Defined in Amazonka.S3.PutPublicAccessBlock

Methods

toQuery :: PutPublicAccessBlock -> QueryString

ToElement PutPublicAccessBlock

Defined in Amazonka.S3.PutPublicAccessBlock

Methods

toElement :: PutPublicAccessBlock -> Element

AWSRequest PutPublicAccessBlock

Defined in Amazonka.S3.PutPublicAccessBlock

Associated Types

type AWSResponse PutPublicAccessBlock

Methods

request :: (Service -> Service) -> PutPublicAccessBlock -> Request PutPublicAccessBlock

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutPublicAccessBlock -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutPublicAccessBlock)))

Generic PutPublicAccessBlock

Defined in Amazonka.S3.PutPublicAccessBlock

Associated Types

type Rep PutPublicAccessBlock :: Type -> Type

Methods

from :: PutPublicAccessBlock -> Rep PutPublicAccessBlock x

to :: Rep PutPublicAccessBlock x -> PutPublicAccessBlock

Read PutPublicAccessBlock

Defined in Amazonka.S3.PutPublicAccessBlock

Methods

readsPrec :: Int -> ReadS PutPublicAccessBlock

readList :: ReadS [PutPublicAccessBlock]

readPrec :: ReadPrec PutPublicAccessBlock

readListPrec :: ReadPrec [PutPublicAccessBlock]

Show PutPublicAccessBlock

Defined in Amazonka.S3.PutPublicAccessBlock

Methods

showsPrec :: Int -> PutPublicAccessBlock -> ShowS

show :: PutPublicAccessBlock -> String

showList :: [PutPublicAccessBlock] -> ShowS

NFData PutPublicAccessBlock

Defined in Amazonka.S3.PutPublicAccessBlock

Methods

rnf :: PutPublicAccessBlock -> ()

Eq PutPublicAccessBlock

Defined in Amazonka.S3.PutPublicAccessBlock

Methods

(==) :: PutPublicAccessBlock -> PutPublicAccessBlock -> Bool

(/=) :: PutPublicAccessBlock -> PutPublicAccessBlock -> Bool

Hashable PutPublicAccessBlock

Defined in Amazonka.S3.PutPublicAccessBlock

Methods

hashWithSalt :: Int -> PutPublicAccessBlock -> Int

hash :: PutPublicAccessBlock -> Int

type AWSResponse PutPublicAccessBlock

Defined in Amazonka.S3.PutPublicAccessBlock

type AWSResponse PutPublicAccessBlock = PutPublicAccessBlockResponse

type Rep PutPublicAccessBlock

Defined in Amazonka.S3.PutPublicAccessBlock

type Rep PutPublicAccessBlock = D1 ('MetaData "PutPublicAccessBlock" "Amazonka.S3.PutPublicAccessBlock" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "PutPublicAccessBlock'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "checksumAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChecksumAlgorithm)) :*: S1 ('MetaSel ('Just "contentMD5") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "expectedBucketOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BucketName) :*: S1 ('MetaSel ('Just "publicAccessBlockConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PublicAccessBlockConfiguration)))))

newPutPublicAccessBlock

Arguments

:: BucketName

PutPublicAccessBlock

-> PublicAccessBlockConfiguration

$sel:publicAccessBlockConfiguration:PutPublicAccessBlock'

-> PutPublicAccessBlock

Create a value of PutPublicAccessBlock with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

PutPublicAccessBlock, putPublicAccessBlock_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

$sel:contentMD5:PutPublicAccessBlock', putPublicAccessBlock_contentMD5 - 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.

$sel:expectedBucketOwner:PutPublicAccessBlock', putPublicAccessBlock_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

PutPublicAccessBlock, putPublicAccessBlock_bucket - The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to set.

$sel:publicAccessBlockConfiguration:PutPublicAccessBlock', putPublicAccessBlock_publicAccessBlockConfiguration - The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon S3 User Guide.

Request Lenses

putPublicAccessBlock_checksumAlgorithm :: Lens' PutPublicAccessBlock (Maybe ChecksumAlgorithm)

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

putPublicAccessBlock_contentMD5 :: Lens' PutPublicAccessBlock (Maybe Text)

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.

putPublicAccessBlock_expectedBucketOwner :: Lens' PutPublicAccessBlock (Maybe Text)

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putPublicAccessBlock_bucket :: Lens' PutPublicAccessBlock BucketName

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

putPublicAccessBlock_publicAccessBlockConfiguration :: Lens' PutPublicAccessBlock PublicAccessBlockConfiguration

The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon S3 User Guide.

Destructuring the Response

data PutPublicAccessBlockResponse

See: newPutPublicAccessBlockResponse smart constructor.

Constructors

PutPublicAccessBlockResponse'

Instances

Generic PutPublicAccessBlockResponse

Defined in Amazonka.S3.PutPublicAccessBlock

Associated Types

type Rep PutPublicAccessBlockResponse :: Type -> Type

Methods

from :: PutPublicAccessBlockResponse -> Rep PutPublicAccessBlockResponse x

to :: Rep PutPublicAccessBlockResponse x -> PutPublicAccessBlockResponse

Read PutPublicAccessBlockResponse

Defined in Amazonka.S3.PutPublicAccessBlock

Methods

readsPrec :: Int -> ReadS PutPublicAccessBlockResponse

readList :: ReadS [PutPublicAccessBlockResponse]

readPrec :: ReadPrec PutPublicAccessBlockResponse

readListPrec :: ReadPrec [PutPublicAccessBlockResponse]

Show PutPublicAccessBlockResponse

Defined in Amazonka.S3.PutPublicAccessBlock

Methods

showsPrec :: Int -> PutPublicAccessBlockResponse -> ShowS

show :: PutPublicAccessBlockResponse -> String

showList :: [PutPublicAccessBlockResponse] -> ShowS

NFData PutPublicAccessBlockResponse

Defined in Amazonka.S3.PutPublicAccessBlock

Methods

rnf :: PutPublicAccessBlockResponse -> ()

Eq PutPublicAccessBlockResponse

Defined in Amazonka.S3.PutPublicAccessBlock

Methods

(==) :: PutPublicAccessBlockResponse -> PutPublicAccessBlockResponse -> Bool

(/=) :: PutPublicAccessBlockResponse -> PutPublicAccessBlockResponse -> Bool

type Rep PutPublicAccessBlockResponse

Defined in Amazonka.S3.PutPublicAccessBlock

type Rep PutPublicAccessBlockResponse = D1 ('MetaData "PutPublicAccessBlockResponse" "Amazonka.S3.PutPublicAccessBlock" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "PutPublicAccessBlockResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newPutPublicAccessBlockResponse :: PutPublicAccessBlockResponse

Create a value of PutPublicAccessBlockResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.