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

Description

Returns the tag set associated with the bucket.

To use this operation, you must have permission to perform the s3:GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

GetBucketTagging has the following special error:

  • Error code: NoSuchTagSetError

    • Description: There is no tag set associated with the bucket.

The following operations are related to GetBucketTagging:

Synopsis

Creating a Request

data GetBucketTagging Source #

See: newGetBucketTagging smart constructor.

Constructors

GetBucketTagging' 

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 tagging information.

Instances

Instances details
Eq GetBucketTagging Source # 
Instance details

Defined in Amazonka.S3.GetBucketTagging

Methods

(==) :: GetBucketTagging -> GetBucketTagging -> Bool #

(/=) :: GetBucketTagging -> GetBucketTagging -> Bool #

Read GetBucketTagging Source # 
Instance details

Defined in Amazonka.S3.GetBucketTagging

Methods

readsPrec :: Int -> ReadS GetBucketTagging #

readList :: ReadS [GetBucketTagging] #

readPrec :: ReadPrec GetBucketTagging #

readListPrec :: ReadPrec [GetBucketTagging] #

Show GetBucketTagging Source # 
Instance details

Defined in Amazonka.S3.GetBucketTagging

Methods

showsPrec :: Int -> GetBucketTagging -> ShowS #

show :: GetBucketTagging -> String #

showList :: [GetBucketTagging] -> ShowS #

Generic GetBucketTagging Source # 
Instance details

Defined in Amazonka.S3.GetBucketTagging

Associated Types

type Rep GetBucketTagging :: Type -> Type #

Methods

from :: GetBucketTagging -> Rep GetBucketTagging x #

to :: Rep GetBucketTagging x -> GetBucketTagging #

NFData GetBucketTagging Source # 
Instance details

Defined in Amazonka.S3.GetBucketTagging

Methods

rnf :: GetBucketTagging -> () #

Hashable GetBucketTagging Source # 
Instance details

Defined in Amazonka.S3.GetBucketTagging

Methods

hashWithSalt :: Int -> GetBucketTagging -> Int #

hash :: GetBucketTagging -> Int #

AWSRequest GetBucketTagging Source # 
Instance details

Defined in Amazonka.S3.GetBucketTagging

Associated Types

type AWSResponse GetBucketTagging #

Methods

request :: GetBucketTagging -> Request GetBucketTagging #

response :: MonadResource m => Logger -> Service -> Proxy GetBucketTagging -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetBucketTagging))) #

ToHeaders GetBucketTagging Source # 
Instance details

Defined in Amazonka.S3.GetBucketTagging

Methods

toHeaders :: GetBucketTagging -> [Header] #

ToPath GetBucketTagging Source # 
Instance details

Defined in Amazonka.S3.GetBucketTagging

Methods

toPath :: GetBucketTagging -> ByteString #

ToQuery GetBucketTagging Source # 
Instance details

Defined in Amazonka.S3.GetBucketTagging

Methods

toQuery :: GetBucketTagging -> QueryString #

type Rep GetBucketTagging Source # 
Instance details

Defined in Amazonka.S3.GetBucketTagging

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

Defined in Amazonka.S3.GetBucketTagging

type AWSResponse GetBucketTagging = GetBucketTaggingResponse

newGetBucketTagging Source #

Arguments

:: BucketName

$sel:bucket:GetBucketTagging'

-> GetBucketTagging 

Create a value of GetBucketTagging 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:GetBucketTagging', getBucketTagging_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:GetBucketTagging', getBucketTagging_bucket - The name of the bucket for which to get the tagging information.

Request Lenses

getBucketTagging_expectedBucketOwner :: Lens' GetBucketTagging (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.

getBucketTagging_bucket :: Lens' GetBucketTagging BucketName Source #

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

Destructuring the Response

data GetBucketTaggingResponse Source #

See: newGetBucketTaggingResponse smart constructor.

Constructors

GetBucketTaggingResponse' 

Fields

Instances

Instances details
Eq GetBucketTaggingResponse Source # 
Instance details

Defined in Amazonka.S3.GetBucketTagging

Methods

(==) :: GetBucketTaggingResponse -> GetBucketTaggingResponse -> Bool #

(/=) :: GetBucketTaggingResponse -> GetBucketTaggingResponse -> Bool #

Read GetBucketTaggingResponse Source # 
Instance details

Defined in Amazonka.S3.GetBucketTagging

Methods

readsPrec :: Int -> ReadS GetBucketTaggingResponse #

readList :: ReadS [GetBucketTaggingResponse] #

readPrec :: ReadPrec GetBucketTaggingResponse #

readListPrec :: ReadPrec [GetBucketTaggingResponse] #

Show GetBucketTaggingResponse Source # 
Instance details

Defined in Amazonka.S3.GetBucketTagging

Methods

showsPrec :: Int -> GetBucketTaggingResponse -> ShowS #

show :: GetBucketTaggingResponse -> String #

showList :: [GetBucketTaggingResponse] -> ShowS #

Generic GetBucketTaggingResponse Source # 
Instance details

Defined in Amazonka.S3.GetBucketTagging

Associated Types

type Rep GetBucketTaggingResponse :: Type -> Type #

Methods

from :: GetBucketTaggingResponse -> Rep GetBucketTaggingResponse x #

to :: Rep GetBucketTaggingResponse x -> GetBucketTaggingResponse #

NFData GetBucketTaggingResponse Source # 
Instance details

Defined in Amazonka.S3.GetBucketTagging

Methods

rnf :: GetBucketTaggingResponse -> () #

type Rep GetBucketTaggingResponse Source # 
Instance details

Defined in Amazonka.S3.GetBucketTagging

type Rep GetBucketTaggingResponse = D1 ('MetaData "GetBucketTaggingResponse" "Amazonka.S3.GetBucketTagging" "libZSservicesZSamazonka-s3ZSamazonka-s3" 'False) (C1 ('MetaCons "GetBucketTaggingResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "tagSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Tag])))

newGetBucketTaggingResponse Source #

Arguments

:: Int

$sel:httpStatus:GetBucketTaggingResponse'

-> GetBucketTaggingResponse 

Create a value of GetBucketTaggingResponse 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:httpStatus:GetBucketTaggingResponse', getBucketTaggingResponse_httpStatus - The response's http status code.

$sel:tagSet:GetBucketTaggingResponse', getBucketTaggingResponse_tagSet - Contains the tag set.

Response Lenses

getBucketTaggingResponse_httpStatus :: Lens' GetBucketTaggingResponse Int Source #

The response's http status code.

getBucketTaggingResponse_tagSet :: Lens' GetBucketTaggingResponse [Tag] Source #

Contains the tag set.