Amazonka.S3.GetBucketOwnershipControls

Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying permissions in a policy.

For information about Amazon S3 Object Ownership, see Using Object Ownership.

The following operations are related to GetBucketOwnershipControls:

• PutBucketOwnershipControls
• DeleteBucketOwnershipControls

Creating a Request

data GetBucketOwnershipControls

See: newGetBucketOwnershipControls smart constructor.

Constructors

GetBucketOwnershipControls'

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 Amazon S3 bucket whose OwnershipControls you want to retrieve.

Instances

ToHeaders GetBucketOwnershipControls

Defined in Amazonka.S3.GetBucketOwnershipControls

Methods

toHeaders :: GetBucketOwnershipControls -> [Header]

ToPath GetBucketOwnershipControls

Defined in Amazonka.S3.GetBucketOwnershipControls

Methods

toPath :: GetBucketOwnershipControls -> ByteString

ToQuery GetBucketOwnershipControls

Defined in Amazonka.S3.GetBucketOwnershipControls

Methods

toQuery :: GetBucketOwnershipControls -> QueryString

AWSRequest GetBucketOwnershipControls

Defined in Amazonka.S3.GetBucketOwnershipControls

Associated Types

type AWSResponse GetBucketOwnershipControls

Methods

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

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

Generic GetBucketOwnershipControls

Defined in Amazonka.S3.GetBucketOwnershipControls

Associated Types

type Rep GetBucketOwnershipControls :: Type -> Type

Methods

from :: GetBucketOwnershipControls -> Rep GetBucketOwnershipControls x

to :: Rep GetBucketOwnershipControls x -> GetBucketOwnershipControls

Read GetBucketOwnershipControls

Defined in Amazonka.S3.GetBucketOwnershipControls

Methods

readsPrec :: Int -> ReadS GetBucketOwnershipControls

readList :: ReadS [GetBucketOwnershipControls]

readPrec :: ReadPrec GetBucketOwnershipControls

readListPrec :: ReadPrec [GetBucketOwnershipControls]

Show GetBucketOwnershipControls

Defined in Amazonka.S3.GetBucketOwnershipControls

Methods

showsPrec :: Int -> GetBucketOwnershipControls -> ShowS

show :: GetBucketOwnershipControls -> String

showList :: [GetBucketOwnershipControls] -> ShowS

NFData GetBucketOwnershipControls

Defined in Amazonka.S3.GetBucketOwnershipControls

Methods

rnf :: GetBucketOwnershipControls -> ()

Eq GetBucketOwnershipControls

Defined in Amazonka.S3.GetBucketOwnershipControls

Methods

(==) :: GetBucketOwnershipControls -> GetBucketOwnershipControls -> Bool

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

Hashable GetBucketOwnershipControls

Defined in Amazonka.S3.GetBucketOwnershipControls

Methods

hashWithSalt :: Int -> GetBucketOwnershipControls -> Int

hash :: GetBucketOwnershipControls -> Int

type AWSResponse GetBucketOwnershipControls

Defined in Amazonka.S3.GetBucketOwnershipControls

type AWSResponse GetBucketOwnershipControls = GetBucketOwnershipControlsResponse

type Rep GetBucketOwnershipControls

Defined in Amazonka.S3.GetBucketOwnershipControls

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

newGetBucketOwnershipControls

Arguments

:: BucketName

GetBucketOwnershipControls

-> GetBucketOwnershipControls

Create a value of GetBucketOwnershipControls 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:GetBucketOwnershipControls', getBucketOwnershipControls_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).

GetBucketOwnershipControls, getBucketOwnershipControls_bucket - The name of the Amazon S3 bucket whose OwnershipControls you want to retrieve.

Request Lenses

getBucketOwnershipControls_expectedBucketOwner :: Lens' GetBucketOwnershipControls (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).

getBucketOwnershipControls_bucket :: Lens' GetBucketOwnershipControls BucketName

The name of the Amazon S3 bucket whose OwnershipControls you want to retrieve.

Destructuring the Response

data GetBucketOwnershipControlsResponse

See: newGetBucketOwnershipControlsResponse smart constructor.

Constructors

GetBucketOwnershipControlsResponse'

Fields

• ownershipControls :: Maybe OwnershipControls

  The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) currently in effect for this Amazon S3 bucket.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetBucketOwnershipControlsResponse

Defined in Amazonka.S3.GetBucketOwnershipControls

Associated Types

type Rep GetBucketOwnershipControlsResponse :: Type -> Type

Methods

from :: GetBucketOwnershipControlsResponse -> Rep GetBucketOwnershipControlsResponse x

to :: Rep GetBucketOwnershipControlsResponse x -> GetBucketOwnershipControlsResponse

Read GetBucketOwnershipControlsResponse

Defined in Amazonka.S3.GetBucketOwnershipControls

Methods

readsPrec :: Int -> ReadS GetBucketOwnershipControlsResponse

readList :: ReadS [GetBucketOwnershipControlsResponse]

readPrec :: ReadPrec GetBucketOwnershipControlsResponse

readListPrec :: ReadPrec [GetBucketOwnershipControlsResponse]

Show GetBucketOwnershipControlsResponse

Defined in Amazonka.S3.GetBucketOwnershipControls

Methods

showsPrec :: Int -> GetBucketOwnershipControlsResponse -> ShowS

show :: GetBucketOwnershipControlsResponse -> String

showList :: [GetBucketOwnershipControlsResponse] -> ShowS

NFData GetBucketOwnershipControlsResponse

Defined in Amazonka.S3.GetBucketOwnershipControls

Methods

rnf :: GetBucketOwnershipControlsResponse -> ()

Eq GetBucketOwnershipControlsResponse

Defined in Amazonka.S3.GetBucketOwnershipControls

Methods

(==) :: GetBucketOwnershipControlsResponse -> GetBucketOwnershipControlsResponse -> Bool

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

type Rep GetBucketOwnershipControlsResponse

Defined in Amazonka.S3.GetBucketOwnershipControls

type Rep GetBucketOwnershipControlsResponse = D1 ('MetaData "GetBucketOwnershipControlsResponse" "Amazonka.S3.GetBucketOwnershipControls" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "GetBucketOwnershipControlsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ownershipControls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OwnershipControls)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetBucketOwnershipControlsResponse

Arguments

:: Int

$sel:httpStatus:GetBucketOwnershipControlsResponse'

-> GetBucketOwnershipControlsResponse

Create a value of GetBucketOwnershipControlsResponse 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:ownershipControls:GetBucketOwnershipControlsResponse', getBucketOwnershipControlsResponse_ownershipControls - The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) currently in effect for this Amazon S3 bucket.

$sel:httpStatus:GetBucketOwnershipControlsResponse', getBucketOwnershipControlsResponse_httpStatus - The response's http status code.

Response Lenses

getBucketOwnershipControlsResponse_ownershipControls :: Lens' GetBucketOwnershipControlsResponse (Maybe OwnershipControls)

The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) currently in effect for this Amazon S3 bucket.

getBucketOwnershipControlsResponse_httpStatus :: Lens' GetBucketOwnershipControlsResponse Int

The response's http status code.