AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inheritance Hierarchy

System.Object
  Amazon.S3.Model.InventoryConfiguration

Namespace: Amazon.S3.Model
Assembly: AWSSDK.S3.dll
Version: 3.x.y.z

Syntax

C#
public class InventoryConfiguration

The InventoryConfiguration type exposes the following members

Constructors

NameDescription
Public Method InventoryConfiguration()

Properties

NameTypeDescription
Public Property Destination Amazon.S3.Model.InventoryDestination

Gets and sets the property Destination.

Contains information about where to publish the inventory results.

Public Property IncludedObjectVersions Amazon.S3.InventoryIncludedObjectVersions

Gets and sets the property 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.

Public Property InventoryFilter Amazon.S3.Model.InventoryFilter

Gets and sets the property InventoryFilter.

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

Public Property InventoryId System.String

Gets and sets the property InventoryId.

The ID used to identify the inventory configuration.

Public Property InventoryOptionalFields System.Collections.Generic.List<Amazon.S3.InventoryOptionalField>

Gets and sets the property InventoryOptionalFields.

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

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property IsEnabled System.Nullable<System.Boolean>

Gets and sets the property 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.

Public Property Schedule Amazon.S3.Model.InventorySchedule

Gets and sets the property Schedule.

Specifies the schedule for generating inventory results.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer