Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.S3.GetBucketVersioning

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the versioning state of a bucket.

To retrieve the versioning state of a bucket, you must be the bucket owner.

This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is enabled, the bucket owner must use an authentication device to change the versioning state of the bucket.

The following operations are related to GetBucketVersioning:

Creating a Request

data GetBucketVersioning Source #

See: newGetBucketVersioning smart constructor.

Constructors

GetBucketVersioning'
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 for which to get the versioning information.

Instances

Instances details

Eq GetBucketVersioning Source #
Instance details Defined in Amazonka.S3.GetBucketVersioning Methods (==) :: GetBucketVersioning -> GetBucketVersioning -> Bool # (/=) :: GetBucketVersioning -> GetBucketVersioning -> Bool #
Read GetBucketVersioning Source #
Instance details Defined in Amazonka.S3.GetBucketVersioning Methods readsPrec :: Int -> ReadS GetBucketVersioning # readList :: ReadS [GetBucketVersioning] # readPrec :: ReadPrec GetBucketVersioning # readListPrec :: ReadPrec [GetBucketVersioning] #
Show GetBucketVersioning Source #
Instance details Defined in Amazonka.S3.GetBucketVersioning Methods showsPrec :: Int -> GetBucketVersioning -> ShowS # show :: GetBucketVersioning -> String # showList :: [GetBucketVersioning] -> ShowS #
Generic GetBucketVersioning Source #
Instance details Defined in Amazonka.S3.GetBucketVersioning Associated Types type Rep GetBucketVersioning :: Type -> Type # Methods from :: GetBucketVersioning -> Rep GetBucketVersioning x # to :: Rep GetBucketVersioning x -> GetBucketVersioning #
NFData GetBucketVersioning Source #
Instance details Defined in Amazonka.S3.GetBucketVersioning Methods rnf :: GetBucketVersioning -> () #
Hashable GetBucketVersioning Source #
Instance details Defined in Amazonka.S3.GetBucketVersioning Methods hashWithSalt :: Int -> GetBucketVersioning -> Int # hash :: GetBucketVersioning -> Int #
AWSRequest GetBucketVersioning Source #
Instance details Defined in Amazonka.S3.GetBucketVersioning Associated Types type AWSResponse GetBucketVersioning # Methods request :: GetBucketVersioning -> Request GetBucketVersioning # response :: MonadResource m => Logger -> Service -> Proxy GetBucketVersioning -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetBucketVersioning))) #
ToHeaders GetBucketVersioning Source #
Instance details Defined in Amazonka.S3.GetBucketVersioning Methods toHeaders :: GetBucketVersioning -> [Header] #
ToPath GetBucketVersioning Source #
Instance details Defined in Amazonka.S3.GetBucketVersioning Methods toPath :: GetBucketVersioning -> ByteString #
ToQuery GetBucketVersioning Source #
Instance details Defined in Amazonka.S3.GetBucketVersioning Methods toQuery :: GetBucketVersioning -> QueryString #
type Rep GetBucketVersioning Source #
Instance details Defined in Amazonka.S3.GetBucketVersioning type Rep GetBucketVersioning = D1 ('MetaData "GetBucketVersioning" "Amazonka.S3.GetBucketVersioning" "libZSservicesZSamazonka-s3ZSamazonka-s3" 'False) (C1 ('MetaCons "GetBucketVersioning'" 'PrefixI 'True) (S1 ('MetaSel ('Just "expectedBucketOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BucketName)))
type AWSResponse GetBucketVersioning Source #
Instance details Defined in Amazonka.S3.GetBucketVersioning type AWSResponse GetBucketVersioning = GetBucketVersioningResponse

newGetBucketVersioning Source #

Arguments

:: BucketName	`$sel:bucket:GetBucketVersioning'`
-> GetBucketVersioning

Create a value of GetBucketVersioning 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:GetBucketVersioning', getBucketVersioning_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:GetBucketVersioning', getBucketVersioning_bucket - The name of the bucket for which to get the versioning information.

Request Lenses

getBucketVersioning_expectedBucketOwner :: Lens' GetBucketVersioning (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.

getBucketVersioning_bucket :: Lens' GetBucketVersioning BucketName Source #

The name of the bucket for which to get the versioning information.

Destructuring the Response

data GetBucketVersioningResponse Source #

See: newGetBucketVersioningResponse smart constructor.

Constructors

GetBucketVersioningResponse'

Fields

status :: Maybe BucketVersioningStatus
The versioning state of the bucket.
mfaDelete :: Maybe MFADeleteStatus
Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq GetBucketVersioningResponse Source #
Instance details Defined in Amazonka.S3.GetBucketVersioning Methods (==) :: GetBucketVersioningResponse -> GetBucketVersioningResponse -> Bool # (/=) :: GetBucketVersioningResponse -> GetBucketVersioningResponse -> Bool #
Read GetBucketVersioningResponse Source #
Instance details Defined in Amazonka.S3.GetBucketVersioning Methods readsPrec :: Int -> ReadS GetBucketVersioningResponse # readList :: ReadS [GetBucketVersioningResponse] # readPrec :: ReadPrec GetBucketVersioningResponse # readListPrec :: ReadPrec [GetBucketVersioningResponse] #
Show GetBucketVersioningResponse Source #
Instance details Defined in Amazonka.S3.GetBucketVersioning Methods showsPrec :: Int -> GetBucketVersioningResponse -> ShowS # show :: GetBucketVersioningResponse -> String # showList :: [GetBucketVersioningResponse] -> ShowS #
Generic GetBucketVersioningResponse Source #
Instance details Defined in Amazonka.S3.GetBucketVersioning Associated Types type Rep GetBucketVersioningResponse :: Type -> Type # Methods from :: GetBucketVersioningResponse -> Rep GetBucketVersioningResponse x # to :: Rep GetBucketVersioningResponse x -> GetBucketVersioningResponse #
NFData GetBucketVersioningResponse Source #
Instance details Defined in Amazonka.S3.GetBucketVersioning Methods rnf :: GetBucketVersioningResponse -> () #
type Rep GetBucketVersioningResponse Source #
Instance details Defined in Amazonka.S3.GetBucketVersioning type Rep GetBucketVersioningResponse = D1 ('MetaData "GetBucketVersioningResponse" "Amazonka.S3.GetBucketVersioning" "libZSservicesZSamazonka-s3ZSamazonka-s3" 'False) (C1 ('MetaCons "GetBucketVersioningResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BucketVersioningStatus)) :: (S1 ('MetaSel ('Just "mfaDelete") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MFADeleteStatus)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetBucketVersioningResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetBucketVersioningResponse'`
-> GetBucketVersioningResponse

Create a value of GetBucketVersioningResponse 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:status:GetBucketVersioningResponse', getBucketVersioningResponse_status - The versioning state of the bucket.

$sel:mfaDelete:GetBucketVersioningResponse', getBucketVersioningResponse_mfaDelete - Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.

$sel:httpStatus:GetBucketVersioningResponse', getBucketVersioningResponse_httpStatus - The response's http status code.

Response Lenses

getBucketVersioningResponse_status :: Lens' GetBucketVersioningResponse (Maybe BucketVersioningStatus) Source #

The versioning state of the bucket.

getBucketVersioningResponse_mfaDelete :: Lens' GetBucketVersioningResponse (Maybe MFADeleteStatus) Source #

Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.

getBucketVersioningResponse_httpStatus :: Lens' GetBucketVersioningResponse Int Source #

The response's http status code.