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

Description

Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.

To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default and 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.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

The following operations are related to GetBucketInventoryConfiguration:

Synopsis

Creating a Request

data GetBucketInventoryConfiguration Source #

See: newGetBucketInventoryConfiguration smart constructor.

Constructors

GetBucketInventoryConfiguration' 

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 containing the inventory configuration to retrieve.

  • id :: Text

    The ID used to identify the inventory configuration.

Instances

Instances details
Eq GetBucketInventoryConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetBucketInventoryConfiguration

Methods

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

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

Read GetBucketInventoryConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetBucketInventoryConfiguration

Methods

readsPrec :: Int -> ReadS GetBucketInventoryConfiguration #

readList :: ReadS [GetBucketInventoryConfiguration] #

readPrec :: ReadPrec GetBucketInventoryConfiguration #

readListPrec :: ReadPrec [GetBucketInventoryConfiguration] #

Show GetBucketInventoryConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetBucketInventoryConfiguration

Methods

showsPrec :: Int -> GetBucketInventoryConfiguration -> ShowS #

show :: GetBucketInventoryConfiguration -> String #

showList :: [GetBucketInventoryConfiguration] -> ShowS #

Generic GetBucketInventoryConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetBucketInventoryConfiguration

Associated Types

type Rep GetBucketInventoryConfiguration :: Type -> Type #

Methods

from :: GetBucketInventoryConfiguration -> Rep GetBucketInventoryConfiguration x #

to :: Rep GetBucketInventoryConfiguration x -> GetBucketInventoryConfiguration #

NFData GetBucketInventoryConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetBucketInventoryConfiguration

Methods

rnf :: GetBucketInventoryConfiguration -> () #

Hashable GetBucketInventoryConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetBucketInventoryConfiguration

Methods

hashWithSalt :: Int -> GetBucketInventoryConfiguration -> Int #

hash :: GetBucketInventoryConfiguration -> Int #

AWSRequest GetBucketInventoryConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetBucketInventoryConfiguration

Associated Types

type AWSResponse GetBucketInventoryConfiguration #

Methods

request :: GetBucketInventoryConfiguration -> Request GetBucketInventoryConfiguration #

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

ToHeaders GetBucketInventoryConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetBucketInventoryConfiguration

Methods

toHeaders :: GetBucketInventoryConfiguration -> [Header] #

ToPath GetBucketInventoryConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetBucketInventoryConfiguration

Methods

toPath :: GetBucketInventoryConfiguration -> ByteString #

ToQuery GetBucketInventoryConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetBucketInventoryConfiguration

Methods

toQuery :: GetBucketInventoryConfiguration -> QueryString #

type Rep GetBucketInventoryConfiguration Source # 
Instance details

Defined in Amazonka.S3.GetBucketInventoryConfiguration

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

Defined in Amazonka.S3.GetBucketInventoryConfiguration

type AWSResponse GetBucketInventoryConfiguration = GetBucketInventoryConfigurationResponse

newGetBucketInventoryConfiguration Source #

Arguments

:: BucketName

$sel:bucket:GetBucketInventoryConfiguration'

-> Text

$sel:id:GetBucketInventoryConfiguration'

-> GetBucketInventoryConfiguration 

Create a value of GetBucketInventoryConfiguration 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:GetBucketInventoryConfiguration', getBucketInventoryConfiguration_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:GetBucketInventoryConfiguration', getBucketInventoryConfiguration_bucket - The name of the bucket containing the inventory configuration to retrieve.

$sel:id:GetBucketInventoryConfiguration', getBucketInventoryConfiguration_id - The ID used to identify the inventory configuration.

Request Lenses

getBucketInventoryConfiguration_expectedBucketOwner :: Lens' GetBucketInventoryConfiguration (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.

getBucketInventoryConfiguration_bucket :: Lens' GetBucketInventoryConfiguration BucketName Source #

The name of the bucket containing the inventory configuration to retrieve.

getBucketInventoryConfiguration_id :: Lens' GetBucketInventoryConfiguration Text Source #

The ID used to identify the inventory configuration.

Destructuring the Response

data GetBucketInventoryConfigurationResponse Source #

See: newGetBucketInventoryConfigurationResponse smart constructor.

Constructors

GetBucketInventoryConfigurationResponse' 

Fields

Instances

Instances details
Eq GetBucketInventoryConfigurationResponse Source # 
Instance details

Defined in Amazonka.S3.GetBucketInventoryConfiguration

Methods

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

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

Show GetBucketInventoryConfigurationResponse Source # 
Instance details

Defined in Amazonka.S3.GetBucketInventoryConfiguration

Methods

showsPrec :: Int -> GetBucketInventoryConfigurationResponse -> ShowS #

show :: GetBucketInventoryConfigurationResponse -> String #

showList :: [GetBucketInventoryConfigurationResponse] -> ShowS #

Generic GetBucketInventoryConfigurationResponse Source # 
Instance details

Defined in Amazonka.S3.GetBucketInventoryConfiguration

Associated Types

type Rep GetBucketInventoryConfigurationResponse :: Type -> Type #

Methods

from :: GetBucketInventoryConfigurationResponse -> Rep GetBucketInventoryConfigurationResponse x #

to :: Rep GetBucketInventoryConfigurationResponse x -> GetBucketInventoryConfigurationResponse #

NFData GetBucketInventoryConfigurationResponse Source # 
Instance details

Defined in Amazonka.S3.GetBucketInventoryConfiguration

Methods

rnf :: GetBucketInventoryConfigurationResponse -> () #

type Rep GetBucketInventoryConfigurationResponse Source # 
Instance details

Defined in Amazonka.S3.GetBucketInventoryConfiguration

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

newGetBucketInventoryConfigurationResponse Source #

Arguments

:: Int

$sel:httpStatus:GetBucketInventoryConfigurationResponse'

-> GetBucketInventoryConfigurationResponse 

Create a value of GetBucketInventoryConfigurationResponse 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:inventoryConfiguration:GetBucketInventoryConfigurationResponse', getBucketInventoryConfigurationResponse_inventoryConfiguration - Specifies the inventory configuration.

$sel:httpStatus:GetBucketInventoryConfigurationResponse', getBucketInventoryConfigurationResponse_httpStatus - The response's http status code.

Response Lenses

getBucketInventoryConfigurationResponse_inventoryConfiguration :: Lens' GetBucketInventoryConfigurationResponse (Maybe InventoryConfiguration) Source #

Specifies the inventory configuration.

getBucketInventoryConfigurationResponse_httpStatus :: Lens' GetBucketInventoryConfigurationResponse Int Source #

The response's http status code.