libZSservicesZSamazonka-s3ZSamazonka-s3
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.S3.GetBucketEncryption

Description

Returns the default encryption configuration for an Amazon S3 bucket. If the bucket does not have a default encryption configuration, GetBucketEncryption returns ServerSideEncryptionConfigurationNotFoundError.

For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption.

To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration 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 following operations are related to GetBucketEncryption:

Synopsis

Creating a Request

data GetBucketEncryption Source #

See: newGetBucketEncryption smart constructor.

Constructors

GetBucketEncryption' 

Fields

  • expectedBucketOwner :: Maybe Text

    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.

  • bucket :: BucketName

    The name of the bucket from which the server-side encryption configuration is retrieved.

Instances

Instances details
Eq GetBucketEncryption Source # 
Instance details

Defined in Amazonka.S3.GetBucketEncryption

Read GetBucketEncryption Source # 
Instance details

Defined in Amazonka.S3.GetBucketEncryption

Show GetBucketEncryption Source # 
Instance details

Defined in Amazonka.S3.GetBucketEncryption

Generic GetBucketEncryption Source # 
Instance details

Defined in Amazonka.S3.GetBucketEncryption

Associated Types

type Rep GetBucketEncryption :: Type -> Type #

NFData GetBucketEncryption Source # 
Instance details

Defined in Amazonka.S3.GetBucketEncryption

Methods

rnf :: GetBucketEncryption -> () #

Hashable GetBucketEncryption Source # 
Instance details

Defined in Amazonka.S3.GetBucketEncryption

AWSRequest GetBucketEncryption Source # 
Instance details

Defined in Amazonka.S3.GetBucketEncryption

Associated Types

type AWSResponse GetBucketEncryption #

ToHeaders GetBucketEncryption Source # 
Instance details

Defined in Amazonka.S3.GetBucketEncryption

ToPath GetBucketEncryption Source # 
Instance details

Defined in Amazonka.S3.GetBucketEncryption

ToQuery GetBucketEncryption Source # 
Instance details

Defined in Amazonka.S3.GetBucketEncryption

type Rep GetBucketEncryption Source # 
Instance details

Defined in Amazonka.S3.GetBucketEncryption

type Rep GetBucketEncryption = D1 ('MetaData "GetBucketEncryption" "Amazonka.S3.GetBucketEncryption" "libZSservicesZSamazonka-s3ZSamazonka-s3" 'False) (C1 ('MetaCons "GetBucketEncryption'" 'PrefixI 'True) (S1 ('MetaSel ('Just "expectedBucketOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BucketName)))
type AWSResponse GetBucketEncryption Source # 
Instance details

Defined in Amazonka.S3.GetBucketEncryption

newGetBucketEncryption Source #

Create a value of GetBucketEncryption 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:

$sel:expectedBucketOwner:GetBucketEncryption', getBucketEncryption_expectedBucketOwner - 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.

$sel:bucket:GetBucketEncryption', getBucketEncryption_bucket - The name of the bucket from which the server-side encryption configuration is retrieved.

Request Lenses

getBucketEncryption_expectedBucketOwner :: Lens' GetBucketEncryption (Maybe Text) Source #

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.

getBucketEncryption_bucket :: Lens' GetBucketEncryption BucketName Source #

The name of the bucket from which the server-side encryption configuration is retrieved.

Destructuring the Response

data GetBucketEncryptionResponse Source #

See: newGetBucketEncryptionResponse smart constructor.

Instances

Instances details
Eq GetBucketEncryptionResponse Source # 
Instance details

Defined in Amazonka.S3.GetBucketEncryption

Show GetBucketEncryptionResponse Source # 
Instance details

Defined in Amazonka.S3.GetBucketEncryption

Generic GetBucketEncryptionResponse Source # 
Instance details

Defined in Amazonka.S3.GetBucketEncryption

Associated Types

type Rep GetBucketEncryptionResponse :: Type -> Type #

NFData GetBucketEncryptionResponse Source # 
Instance details

Defined in Amazonka.S3.GetBucketEncryption

type Rep GetBucketEncryptionResponse Source # 
Instance details

Defined in Amazonka.S3.GetBucketEncryption

type Rep GetBucketEncryptionResponse = D1 ('MetaData "GetBucketEncryptionResponse" "Amazonka.S3.GetBucketEncryption" "libZSservicesZSamazonka-s3ZSamazonka-s3" 'False) (C1 ('MetaCons "GetBucketEncryptionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverSideEncryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServerSideEncryptionConfiguration)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetBucketEncryptionResponse Source #

Create a value of GetBucketEncryptionResponse 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:

$sel:serverSideEncryptionConfiguration:GetBucketEncryptionResponse', getBucketEncryptionResponse_serverSideEncryptionConfiguration - Undocumented member.

$sel:httpStatus:GetBucketEncryptionResponse', getBucketEncryptionResponse_httpStatus - The response's http status code.

Response Lenses