Amazonka.S3.Types.InventoryConfiguration

Documentation

data InventoryConfiguration

Specifies the inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory in the Amazon S3 API Reference.

See: newInventoryConfiguration smart constructor.

Constructors

InventoryConfiguration'

Fields

• filter' :: Maybe InventoryFilter

  Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.

• optionalFields :: Maybe [InventoryOptionalField]

  Contains the optional fields that are included in the inventory results.

• destination :: InventoryDestination

  Contains information about where to publish the inventory results.

• isEnabled :: Bool

  Specifies whether the inventory is enabled or disabled. If set to True, an inventory list is generated. If set to False, no inventory list is generated.

• id :: Text

  The ID used to identify the inventory configuration.

• includedObjectVersions :: InventoryIncludedObjectVersions

  Object versions to include in the inventory list. If set to All, the list includes all the object versions, which adds the version-related fields VersionId, IsLatest, and DeleteMarker to the list. If set to Current, the list does not contain these version-related fields.

• schedule :: InventorySchedule

  Specifies the schedule for generating inventory results.

Instances

FromXML InventoryConfiguration

Defined in Amazonka.S3.Types.InventoryConfiguration

Methods

parseXML :: [Node] -> Either String InventoryConfiguration

ToXML InventoryConfiguration

Defined in Amazonka.S3.Types.InventoryConfiguration

Methods

toXML :: InventoryConfiguration -> XML

Generic InventoryConfiguration

Defined in Amazonka.S3.Types.InventoryConfiguration

Associated Types

type Rep InventoryConfiguration :: Type -> Type

Methods

from :: InventoryConfiguration -> Rep InventoryConfiguration x

to :: Rep InventoryConfiguration x -> InventoryConfiguration

Show InventoryConfiguration

Defined in Amazonka.S3.Types.InventoryConfiguration

Methods

showsPrec :: Int -> InventoryConfiguration -> ShowS

show :: InventoryConfiguration -> String

showList :: [InventoryConfiguration] -> ShowS

NFData InventoryConfiguration

Defined in Amazonka.S3.Types.InventoryConfiguration

Methods

rnf :: InventoryConfiguration -> ()

Eq InventoryConfiguration

Defined in Amazonka.S3.Types.InventoryConfiguration

Methods

(==) :: InventoryConfiguration -> InventoryConfiguration -> Bool

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

Hashable InventoryConfiguration

Defined in Amazonka.S3.Types.InventoryConfiguration

Methods

hashWithSalt :: Int -> InventoryConfiguration -> Int

hash :: InventoryConfiguration -> Int

type Rep InventoryConfiguration

Defined in Amazonka.S3.Types.InventoryConfiguration

type Rep InventoryConfiguration = D1 ('MetaData "InventoryConfiguration" "Amazonka.S3.Types.InventoryConfiguration" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "InventoryConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InventoryFilter)) :*: (S1 ('MetaSel ('Just "optionalFields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InventoryOptionalField])) :*: S1 ('MetaSel ('Just "destination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InventoryDestination))) :*: ((S1 ('MetaSel ('Just "isEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "includedObjectVersions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InventoryIncludedObjectVersions) :*: S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InventorySchedule)))))

newInventoryConfiguration

Arguments

:: InventoryDestination

$sel:destination:InventoryConfiguration'

-> Bool

$sel:isEnabled:InventoryConfiguration'

-> Text

$sel:id:InventoryConfiguration'

-> InventoryIncludedObjectVersions

$sel:includedObjectVersions:InventoryConfiguration'

-> InventorySchedule

$sel:schedule:InventoryConfiguration'

-> InventoryConfiguration

Create a value of InventoryConfiguration 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:filter':InventoryConfiguration', inventoryConfiguration_filter - Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.

$sel:optionalFields:InventoryConfiguration', inventoryConfiguration_optionalFields - Contains the optional fields that are included in the inventory results.

$sel:destination:InventoryConfiguration', inventoryConfiguration_destination - Contains information about where to publish the inventory results.

$sel:isEnabled:InventoryConfiguration', inventoryConfiguration_isEnabled - Specifies whether the inventory is enabled or disabled. If set to True, an inventory list is generated. If set to False, no inventory list is generated.

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

$sel:includedObjectVersions:InventoryConfiguration', inventoryConfiguration_includedObjectVersions - Object versions to include in the inventory list. If set to All, the list includes all the object versions, which adds the version-related fields VersionId, IsLatest, and DeleteMarker to the list. If set to Current, the list does not contain these version-related fields.

$sel:schedule:InventoryConfiguration', inventoryConfiguration_schedule - Specifies the schedule for generating inventory results.

inventoryConfiguration_filter :: Lens' InventoryConfiguration (Maybe InventoryFilter)

Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.

inventoryConfiguration_optionalFields :: Lens' InventoryConfiguration (Maybe [InventoryOptionalField])

Contains the optional fields that are included in the inventory results.

inventoryConfiguration_destination :: Lens' InventoryConfiguration InventoryDestination

Contains information about where to publish the inventory results.

inventoryConfiguration_isEnabled :: Lens' InventoryConfiguration Bool

Specifies whether the inventory is enabled or disabled. If set to True, an inventory list is generated. If set to False, no inventory list is generated.

inventoryConfiguration_id :: Lens' InventoryConfiguration Text

The ID used to identify the inventory configuration.

inventoryConfiguration_includedObjectVersions :: Lens' InventoryConfiguration InventoryIncludedObjectVersions

Object versions to include in the inventory list. If set to All, the list includes all the object versions, which adds the version-related fields VersionId, IsLatest, and DeleteMarker to the list. If set to Current, the list does not contain these version-related fields.

inventoryConfiguration_schedule :: Lens' InventoryConfiguration InventorySchedule

Specifies the schedule for generating inventory results.