Amazonka.S3.GetBucketVersioning

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:

• GetObject
• PutObject
• DeleteObject

Creating a Request

data GetBucketVersioning

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 fails with the HTTP status code 403 Forbidden (access denied).

• bucket :: BucketName

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

Instances

ToHeaders GetBucketVersioning

Defined in Amazonka.S3.GetBucketVersioning

Methods

toHeaders :: GetBucketVersioning -> [Header]

ToPath GetBucketVersioning

Defined in Amazonka.S3.GetBucketVersioning

Methods

toPath :: GetBucketVersioning -> ByteString

ToQuery GetBucketVersioning

Defined in Amazonka.S3.GetBucketVersioning

Methods

toQuery :: GetBucketVersioning -> QueryString

AWSRequest GetBucketVersioning

Defined in Amazonka.S3.GetBucketVersioning

Associated Types

type AWSResponse GetBucketVersioning

Methods

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

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

Generic GetBucketVersioning

Defined in Amazonka.S3.GetBucketVersioning

Associated Types

type Rep GetBucketVersioning :: Type -> Type

Methods

from :: GetBucketVersioning -> Rep GetBucketVersioning x

to :: Rep GetBucketVersioning x -> GetBucketVersioning

Read GetBucketVersioning

Defined in Amazonka.S3.GetBucketVersioning

Methods

readsPrec :: Int -> ReadS GetBucketVersioning

readList :: ReadS [GetBucketVersioning]

readPrec :: ReadPrec GetBucketVersioning

readListPrec :: ReadPrec [GetBucketVersioning]

Show GetBucketVersioning

Defined in Amazonka.S3.GetBucketVersioning

Methods

showsPrec :: Int -> GetBucketVersioning -> ShowS

show :: GetBucketVersioning -> String

showList :: [GetBucketVersioning] -> ShowS

NFData GetBucketVersioning

Defined in Amazonka.S3.GetBucketVersioning

Methods

rnf :: GetBucketVersioning -> ()

Eq GetBucketVersioning

Defined in Amazonka.S3.GetBucketVersioning

Methods

(==) :: GetBucketVersioning -> GetBucketVersioning -> Bool

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

Hashable GetBucketVersioning

Defined in Amazonka.S3.GetBucketVersioning

Methods

hashWithSalt :: Int -> GetBucketVersioning -> Int

hash :: GetBucketVersioning -> Int

type AWSResponse GetBucketVersioning

Defined in Amazonka.S3.GetBucketVersioning

type AWSResponse GetBucketVersioning = GetBucketVersioningResponse

type Rep GetBucketVersioning

Defined in Amazonka.S3.GetBucketVersioning

type Rep GetBucketVersioning = D1 ('MetaData "GetBucketVersioning" "Amazonka.S3.GetBucketVersioning" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" '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)))

newGetBucketVersioning

Arguments

:: BucketName

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 fails with the HTTP status code 403 Forbidden (access denied).

GetBucketVersioning, getBucketVersioning_bucket - The name of the bucket for which to get the versioning information.

Request Lenses

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

getBucketVersioning_bucket :: Lens' GetBucketVersioning BucketName

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

Destructuring the Response

data GetBucketVersioningResponse

See: newGetBucketVersioningResponse smart constructor.

Constructors

GetBucketVersioningResponse'

Fields

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

• status :: Maybe BucketVersioningStatus

  The versioning state of the bucket.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetBucketVersioningResponse

Defined in Amazonka.S3.GetBucketVersioning

Associated Types

type Rep GetBucketVersioningResponse :: Type -> Type

Methods

from :: GetBucketVersioningResponse -> Rep GetBucketVersioningResponse x

to :: Rep GetBucketVersioningResponse x -> GetBucketVersioningResponse

Read GetBucketVersioningResponse

Defined in Amazonka.S3.GetBucketVersioning

Methods

readsPrec :: Int -> ReadS GetBucketVersioningResponse

readList :: ReadS [GetBucketVersioningResponse]

readPrec :: ReadPrec GetBucketVersioningResponse

readListPrec :: ReadPrec [GetBucketVersioningResponse]

Show GetBucketVersioningResponse

Defined in Amazonka.S3.GetBucketVersioning

Methods

showsPrec :: Int -> GetBucketVersioningResponse -> ShowS

show :: GetBucketVersioningResponse -> String

showList :: [GetBucketVersioningResponse] -> ShowS

NFData GetBucketVersioningResponse

Defined in Amazonka.S3.GetBucketVersioning

Methods

rnf :: GetBucketVersioningResponse -> ()

Eq GetBucketVersioningResponse

Defined in Amazonka.S3.GetBucketVersioning

Methods

(==) :: GetBucketVersioningResponse -> GetBucketVersioningResponse -> Bool

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

type Rep GetBucketVersioningResponse

Defined in Amazonka.S3.GetBucketVersioning

type Rep GetBucketVersioningResponse = D1 ('MetaData "GetBucketVersioningResponse" "Amazonka.S3.GetBucketVersioning" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "GetBucketVersioningResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "mfaDelete") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MFADeleteStatus)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BucketVersioningStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetBucketVersioningResponse

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:

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.

GetBucketVersioningResponse, getBucketVersioningResponse_status - The versioning state of the bucket.

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

Response Lenses

getBucketVersioningResponse_mfaDelete :: Lens' GetBucketVersioningResponse (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.

getBucketVersioningResponse_status :: Lens' GetBucketVersioningResponse (Maybe BucketVersioningStatus)

The versioning state of the bucket.

getBucketVersioningResponse_httpStatus :: Lens' GetBucketVersioningResponse Int

The response's http status code.