# Data Types
<a name="API_Types"></a>

The following data types are supported by Amazon S3:
+  [AbacStatus](API_AbacStatus.md) 
+  [AbortIncompleteMultipartUpload](API_AbortIncompleteMultipartUpload.md) 
+  [AccelerateConfiguration](API_AccelerateConfiguration.md) 
+  [AccessControlPolicy](API_AccessControlPolicy.md) 
+  [AccessControlTranslation](API_AccessControlTranslation.md) 
+  [AnalyticsAndOperator](API_AnalyticsAndOperator.md) 
+  [AnalyticsConfiguration](API_AnalyticsConfiguration.md) 
+  [AnalyticsExportDestination](API_AnalyticsExportDestination.md) 
+  [AnalyticsFilter](API_AnalyticsFilter.md) 
+  [AnalyticsS3BucketDestination](API_AnalyticsS3BucketDestination.md) 
+  [BlockedEncryptionTypes](API_BlockedEncryptionTypes.md) 
+  [Bucket](API_Bucket.md) 
+  [BucketInfo](API_BucketInfo.md) 
+  [BucketLifecycleConfiguration](API_BucketLifecycleConfiguration.md) 
+  [BucketLoggingStatus](API_BucketLoggingStatus.md) 
+  [Checksum](API_Checksum.md) 
+  [CloudFunctionConfiguration](API_CloudFunctionConfiguration.md) 
+  [CommonPrefix](API_CommonPrefix.md) 
+  [CompletedMultipartUpload](API_CompletedMultipartUpload.md) 
+  [CompletedPart](API_CompletedPart.md) 
+  [Condition](API_Condition.md) 
+  [ContinuationEvent](API_ContinuationEvent.md) 
+  [CopyObjectResult](API_CopyObjectResult.md) 
+  [CopyPartResult](API_CopyPartResult.md) 
+  [CORSConfiguration](API_CORSConfiguration.md) 
+  [CORSRule](API_CORSRule.md) 
+  [CreateBucketConfiguration](API_CreateBucketConfiguration.md) 
+  [CSVInput](API_CSVInput.md) 
+  [CSVOutput](API_CSVOutput.md) 
+  [DefaultRetention](API_DefaultRetention.md) 
+  [Delete](API_Delete.md) 
+  [DeletedObject](API_DeletedObject.md) 
+  [DeleteMarkerEntry](API_DeleteMarkerEntry.md) 
+  [DeleteMarkerReplication](API_DeleteMarkerReplication.md) 
+  [Destination](API_Destination.md) 
+  [DestinationResult](API_DestinationResult.md) 
+  [Encryption](API_Encryption.md) 
+  [EncryptionConfiguration](API_EncryptionConfiguration.md) 
+  [EndEvent](API_EndEvent.md) 
+  [Error](API_Error.md) 
+  [ErrorDetails](API_ErrorDetails.md) 
+  [ErrorDocument](API_ErrorDocument.md) 
+  [EventBridgeConfiguration](API_EventBridgeConfiguration.md) 
+  [ExistingObjectReplication](API_ExistingObjectReplication.md) 
+  [FilterRule](API_FilterRule.md) 
+  [GetBucketMetadataConfigurationResult](API_GetBucketMetadataConfigurationResult.md) 
+  [GetBucketMetadataTableConfigurationResult](API_GetBucketMetadataTableConfigurationResult.md) 
+  [GetObjectAttributesParts](API_GetObjectAttributesParts.md) 
+  [GlacierJobParameters](API_GlacierJobParameters.md) 
+  [Grant](API_Grant.md) 
+  [Grantee](API_Grantee.md) 
+  [IndexDocument](API_IndexDocument.md) 
+  [Initiator](API_Initiator.md) 
+  [InputSerialization](API_InputSerialization.md) 
+  [IntelligentTieringAndOperator](API_IntelligentTieringAndOperator.md) 
+  [IntelligentTieringConfiguration](API_IntelligentTieringConfiguration.md) 
+  [IntelligentTieringFilter](API_IntelligentTieringFilter.md) 
+  [InventoryConfiguration](API_InventoryConfiguration.md) 
+  [InventoryDestination](API_InventoryDestination.md) 
+  [InventoryEncryption](API_InventoryEncryption.md) 
+  [InventoryFilter](API_InventoryFilter.md) 
+  [InventoryS3BucketDestination](API_InventoryS3BucketDestination.md) 
+  [InventorySchedule](API_InventorySchedule.md) 
+  [InventoryTableConfiguration](API_InventoryTableConfiguration.md) 
+  [InventoryTableConfigurationResult](API_InventoryTableConfigurationResult.md) 
+  [InventoryTableConfigurationUpdates](API_InventoryTableConfigurationUpdates.md) 
+  [JournalTableConfiguration](API_JournalTableConfiguration.md) 
+  [JournalTableConfigurationResult](API_JournalTableConfigurationResult.md) 
+  [JournalTableConfigurationUpdates](API_JournalTableConfigurationUpdates.md) 
+  [JSONInput](API_JSONInput.md) 
+  [JSONOutput](API_JSONOutput.md) 
+  [LambdaFunctionConfiguration](API_LambdaFunctionConfiguration.md) 
+  [LifecycleConfiguration](API_LifecycleConfiguration.md) 
+  [LifecycleExpiration](API_LifecycleExpiration.md) 
+  [LifecycleRule](API_LifecycleRule.md) 
+  [LifecycleRuleAndOperator](API_LifecycleRuleAndOperator.md) 
+  [LifecycleRuleFilter](API_LifecycleRuleFilter.md) 
+  [LocationInfo](API_LocationInfo.md) 
+  [LoggingEnabled](API_LoggingEnabled.md) 
+  [MetadataConfiguration](API_MetadataConfiguration.md) 
+  [MetadataConfigurationResult](API_MetadataConfigurationResult.md) 
+  [MetadataEntry](API_MetadataEntry.md) 
+  [MetadataTableConfiguration](API_MetadataTableConfiguration.md) 
+  [MetadataTableConfigurationResult](API_MetadataTableConfigurationResult.md) 
+  [MetadataTableEncryptionConfiguration](API_MetadataTableEncryptionConfiguration.md) 
+  [Metrics](API_Metrics.md) 
+  [MetricsAndOperator](API_MetricsAndOperator.md) 
+  [MetricsConfiguration](API_MetricsConfiguration.md) 
+  [MetricsFilter](API_MetricsFilter.md) 
+  [MultipartUpload](API_MultipartUpload.md) 
+  [NoncurrentVersionExpiration](API_NoncurrentVersionExpiration.md) 
+  [NoncurrentVersionTransition](API_NoncurrentVersionTransition.md) 
+  [NotificationConfiguration](API_NotificationConfiguration.md) 
+  [NotificationConfigurationDeprecated](API_NotificationConfigurationDeprecated.md) 
+  [NotificationConfigurationFilter](API_NotificationConfigurationFilter.md) 
+  [Object](API_Object.md) 
+  [ObjectEncryption](API_ObjectEncryption.md) 
+  [ObjectIdentifier](API_ObjectIdentifier.md) 
+  [ObjectLockConfiguration](API_ObjectLockConfiguration.md) 
+  [ObjectLockLegalHold](API_ObjectLockLegalHold.md) 
+  [ObjectLockRetention](API_ObjectLockRetention.md) 
+  [ObjectLockRule](API_ObjectLockRule.md) 
+  [ObjectPart](API_ObjectPart.md) 
+  [ObjectVersion](API_ObjectVersion.md) 
+  [OutputLocation](API_OutputLocation.md) 
+  [OutputSerialization](API_OutputSerialization.md) 
+  [Owner](API_Owner.md) 
+  [OwnershipControls](API_OwnershipControls.md) 
+  [OwnershipControlsRule](API_OwnershipControlsRule.md) 
+  [ParquetInput](API_ParquetInput.md) 
+  [Part](API_Part.md) 
+  [PartitionedPrefix](API_PartitionedPrefix.md) 
+  [PolicyStatus](API_PolicyStatus.md) 
+  [Progress](API_Progress.md) 
+  [ProgressEvent](API_ProgressEvent.md) 
+  [PublicAccessBlockConfiguration](API_PublicAccessBlockConfiguration.md) 
+  [QueueConfiguration](API_QueueConfiguration.md) 
+  [QueueConfigurationDeprecated](API_QueueConfigurationDeprecated.md) 
+  [RecordExpiration](API_RecordExpiration.md) 
+  [RecordsEvent](API_RecordsEvent.md) 
+  [Redirect](API_Redirect.md) 
+  [RedirectAllRequestsTo](API_RedirectAllRequestsTo.md) 
+  [ReplicaModifications](API_ReplicaModifications.md) 
+  [ReplicationConfiguration](API_ReplicationConfiguration.md) 
+  [ReplicationRule](API_ReplicationRule.md) 
+  [ReplicationRuleAndOperator](API_ReplicationRuleAndOperator.md) 
+  [ReplicationRuleFilter](API_ReplicationRuleFilter.md) 
+  [ReplicationTime](API_ReplicationTime.md) 
+  [ReplicationTimeValue](API_ReplicationTimeValue.md) 
+  [RequestPaymentConfiguration](API_RequestPaymentConfiguration.md) 
+  [RequestProgress](API_RequestProgress.md) 
+  [RestoreRequest](API_RestoreRequest.md) 
+  [RestoreStatus](API_RestoreStatus.md) 
+  [RoutingRule](API_RoutingRule.md) 
+  [Rule](API_Rule.md) 
+  [S3KeyFilter](API_S3KeyFilter.md) 
+  [S3Location](API_S3Location.md) 
+  [S3TablesDestination](API_S3TablesDestination.md) 
+  [S3TablesDestinationResult](API_S3TablesDestinationResult.md) 
+  [ScanRange](API_ScanRange.md) 
+  [SelectObjectContentEventStream](API_SelectObjectContentEventStream.md) 
+  [SelectParameters](API_SelectParameters.md) 
+  [ServerSideEncryptionByDefault](API_ServerSideEncryptionByDefault.md) 
+  [ServerSideEncryptionConfiguration](API_ServerSideEncryptionConfiguration.md) 
+  [ServerSideEncryptionRule](API_ServerSideEncryptionRule.md) 
+  [SessionCredentials](API_SessionCredentials.md) 
+  [SimplePrefix](API_SimplePrefix.md) 
+  [SourceSelectionCriteria](API_SourceSelectionCriteria.md) 
+  [SSEKMS](API_SSEKMS.md) 
+  [SseKmsEncryptedObjects](API_SseKmsEncryptedObjects.md) 
+  [SSEKMSEncryption](API_SSEKMSEncryption.md) 
+  [SSES3](API_SSES3.md) 
+  [Stats](API_Stats.md) 
+  [StatsEvent](API_StatsEvent.md) 
+  [StorageClassAnalysis](API_StorageClassAnalysis.md) 
+  [StorageClassAnalysisDataExport](API_StorageClassAnalysisDataExport.md) 
+  [Tag](API_Tag.md) 
+  [Tagging](API_Tagging.md) 
+  [TargetGrant](API_TargetGrant.md) 
+  [TargetObjectKeyFormat](API_TargetObjectKeyFormat.md) 
+  [Tiering](API_Tiering.md) 
+  [TopicConfiguration](API_TopicConfiguration.md) 
+  [TopicConfigurationDeprecated](API_TopicConfigurationDeprecated.md) 
+  [Transition](API_Transition.md) 
+  [VersioningConfiguration](API_VersioningConfiguration.md) 
+  [WebsiteConfiguration](API_WebsiteConfiguration.md) 

The following data types are supported by Amazon S3 Control:
+  [AbortIncompleteMultipartUpload](API_control_AbortIncompleteMultipartUpload.md) 
+  [AccessControlTranslation](API_control_AccessControlTranslation.md) 
+  [AccessGrantsLocationConfiguration](API_control_AccessGrantsLocationConfiguration.md) 
+  [AccessPoint](API_control_AccessPoint.md) 
+  [AccountLevel](API_control_AccountLevel.md) 
+  [ActivityMetrics](API_control_ActivityMetrics.md) 
+  [AdvancedCostOptimizationMetrics](API_control_AdvancedCostOptimizationMetrics.md) 
+  [AdvancedDataProtectionMetrics](API_control_AdvancedDataProtectionMetrics.md) 
+  [AdvancedPerformanceMetrics](API_control_AdvancedPerformanceMetrics.md) 
+  [AsyncErrorDetails](API_control_AsyncErrorDetails.md) 
+  [AsyncOperation](API_control_AsyncOperation.md) 
+  [AsyncRequestParameters](API_control_AsyncRequestParameters.md) 
+  [AsyncResponseDetails](API_control_AsyncResponseDetails.md) 
+  [AwsLambdaTransformation](API_control_AwsLambdaTransformation.md) 
+  [BucketLevel](API_control_BucketLevel.md) 
+  [CloudWatchMetrics](API_control_CloudWatchMetrics.md) 
+  [CreateBucketConfiguration](API_control_CreateBucketConfiguration.md) 
+  [CreateMultiRegionAccessPointInput](API_control_CreateMultiRegionAccessPointInput.md) 
+  [Credentials](API_control_Credentials.md) 
+  [DeleteMarkerReplication](API_control_DeleteMarkerReplication.md) 
+  [DeleteMultiRegionAccessPointInput](API_control_DeleteMultiRegionAccessPointInput.md) 
+  [Destination](API_control_Destination.md) 
+  [DetailedStatusCodesMetrics](API_control_DetailedStatusCodesMetrics.md) 
+  [DSSEKMSFilter](API_control_DSSEKMSFilter.md) 
+  [EncryptionConfiguration](API_control_EncryptionConfiguration.md) 
+  [EstablishedMultiRegionAccessPointPolicy](API_control_EstablishedMultiRegionAccessPointPolicy.md) 
+  [Exclude](API_control_Exclude.md) 
+  [ExistingObjectReplication](API_control_ExistingObjectReplication.md) 
+  [GeneratedManifestEncryption](API_control_GeneratedManifestEncryption.md) 
+  [Grantee](API_control_Grantee.md) 
+  [Include](API_control_Include.md) 
+  [JobDescriptor](API_control_JobDescriptor.md) 
+  [JobFailure](API_control_JobFailure.md) 
+  [JobListDescriptor](API_control_JobListDescriptor.md) 
+  [JobManifest](API_control_JobManifest.md) 
+  [JobManifestGenerator](API_control_JobManifestGenerator.md) 
+  [JobManifestGeneratorFilter](API_control_JobManifestGeneratorFilter.md) 
+  [JobManifestLocation](API_control_JobManifestLocation.md) 
+  [JobManifestSpec](API_control_JobManifestSpec.md) 
+  [JobOperation](API_control_JobOperation.md) 
+  [JobProgressSummary](API_control_JobProgressSummary.md) 
+  [JobReport](API_control_JobReport.md) 
+  [JobTimers](API_control_JobTimers.md) 
+  [KeyNameConstraint](API_control_KeyNameConstraint.md) 
+  [LambdaInvokeOperation](API_control_LambdaInvokeOperation.md) 
+  [LifecycleConfiguration](API_control_LifecycleConfiguration.md) 
+  [LifecycleExpiration](API_control_LifecycleExpiration.md) 
+  [LifecycleRule](API_control_LifecycleRule.md) 
+  [LifecycleRuleAndOperator](API_control_LifecycleRuleAndOperator.md) 
+  [LifecycleRuleFilter](API_control_LifecycleRuleFilter.md) 
+  [ListAccessGrantEntry](API_control_ListAccessGrantEntry.md) 
+  [ListAccessGrantsInstanceEntry](API_control_ListAccessGrantsInstanceEntry.md) 
+  [ListAccessGrantsLocationsEntry](API_control_ListAccessGrantsLocationsEntry.md) 
+  [ListCallerAccessGrantsEntry](API_control_ListCallerAccessGrantsEntry.md) 
+  [ListStorageLensConfigurationEntry](API_control_ListStorageLensConfigurationEntry.md) 
+  [ListStorageLensGroupEntry](API_control_ListStorageLensGroupEntry.md) 
+  [MatchObjectAge](API_control_MatchObjectAge.md) 
+  [MatchObjectSize](API_control_MatchObjectSize.md) 
+  [Metrics](API_control_Metrics.md) 
+  [MultiRegionAccessPointPolicyDocument](API_control_MultiRegionAccessPointPolicyDocument.md) 
+  [MultiRegionAccessPointRegionalResponse](API_control_MultiRegionAccessPointRegionalResponse.md) 
+  [MultiRegionAccessPointReport](API_control_MultiRegionAccessPointReport.md) 
+  [MultiRegionAccessPointRoute](API_control_MultiRegionAccessPointRoute.md) 
+  [MultiRegionAccessPointsAsyncResponse](API_control_MultiRegionAccessPointsAsyncResponse.md) 
+  [NoncurrentVersionExpiration](API_control_NoncurrentVersionExpiration.md) 
+  [NoncurrentVersionTransition](API_control_NoncurrentVersionTransition.md) 
+  [NotSSEFilter](API_control_NotSSEFilter.md) 
+  [ObjectEncryption](API_control_ObjectEncryption.md) 
+  [ObjectEncryptionFilter](API_control_ObjectEncryptionFilter.md) 
+  [ObjectLambdaAccessPoint](API_control_ObjectLambdaAccessPoint.md) 
+  [ObjectLambdaAccessPointAlias](API_control_ObjectLambdaAccessPointAlias.md) 
+  [ObjectLambdaConfiguration](API_control_ObjectLambdaConfiguration.md) 
+  [ObjectLambdaContentTransformation](API_control_ObjectLambdaContentTransformation.md) 
+  [ObjectLambdaTransformationConfiguration](API_control_ObjectLambdaTransformationConfiguration.md) 
+  [PolicyStatus](API_control_PolicyStatus.md) 
+  [PrefixLevel](API_control_PrefixLevel.md) 
+  [PrefixLevelStorageMetrics](API_control_PrefixLevelStorageMetrics.md) 
+  [ProposedMultiRegionAccessPointPolicy](API_control_ProposedMultiRegionAccessPointPolicy.md) 
+  [PublicAccessBlockConfiguration](API_control_PublicAccessBlockConfiguration.md) 
+  [PutMultiRegionAccessPointPolicyInput](API_control_PutMultiRegionAccessPointPolicyInput.md) 
+  [Region](API_control_Region.md) 
+  [RegionalBucket](API_control_RegionalBucket.md) 
+  [RegionReport](API_control_RegionReport.md) 
+  [ReplicaModifications](API_control_ReplicaModifications.md) 
+  [ReplicationConfiguration](API_control_ReplicationConfiguration.md) 
+  [ReplicationRule](API_control_ReplicationRule.md) 
+  [ReplicationRuleAndOperator](API_control_ReplicationRuleAndOperator.md) 
+  [ReplicationRuleFilter](API_control_ReplicationRuleFilter.md) 
+  [ReplicationTime](API_control_ReplicationTime.md) 
+  [ReplicationTimeValue](API_control_ReplicationTimeValue.md) 
+  [S3AccessControlList](API_control_S3AccessControlList.md) 
+  [S3AccessControlPolicy](API_control_S3AccessControlPolicy.md) 
+  [S3BucketDestination](API_control_S3BucketDestination.md) 
+  [S3ComputeObjectChecksumOperation](API_control_S3ComputeObjectChecksumOperation.md) 
+  [S3CopyObjectOperation](API_control_S3CopyObjectOperation.md) 
+  [S3DeleteObjectTaggingOperation](API_control_S3DeleteObjectTaggingOperation.md) 
+  [S3GeneratedManifestDescriptor](API_control_S3GeneratedManifestDescriptor.md) 
+  [S3Grant](API_control_S3Grant.md) 
+  [S3Grantee](API_control_S3Grantee.md) 
+  [S3InitiateRestoreObjectOperation](API_control_S3InitiateRestoreObjectOperation.md) 
+  [S3JobManifestGenerator](API_control_S3JobManifestGenerator.md) 
+  [S3ManifestOutputLocation](API_control_S3ManifestOutputLocation.md) 
+  [S3ObjectLockLegalHold](API_control_S3ObjectLockLegalHold.md) 
+  [S3ObjectMetadata](API_control_S3ObjectMetadata.md) 
+  [S3ObjectOwner](API_control_S3ObjectOwner.md) 
+  [S3ReplicateObjectOperation](API_control_S3ReplicateObjectOperation.md) 
+  [S3Retention](API_control_S3Retention.md) 
+  [S3SetObjectAclOperation](API_control_S3SetObjectAclOperation.md) 
+  [S3SetObjectLegalHoldOperation](API_control_S3SetObjectLegalHoldOperation.md) 
+  [S3SetObjectRetentionOperation](API_control_S3SetObjectRetentionOperation.md) 
+  [S3SetObjectTaggingOperation](API_control_S3SetObjectTaggingOperation.md) 
+  [S3Tag](API_control_S3Tag.md) 
+  [S3UpdateObjectEncryptionOperation](API_control_S3UpdateObjectEncryptionOperation.md) 
+  [S3UpdateObjectEncryptionSSEKMS](API_control_S3UpdateObjectEncryptionSSEKMS.md) 
+  [Scope](API_control_Scope.md) 
+  [SelectionCriteria](API_control_SelectionCriteria.md) 
+  [SourceSelectionCriteria](API_control_SourceSelectionCriteria.md) 
+  [SSECFilter](API_control_SSECFilter.md) 
+  [SSEKMS](API_control_SSEKMS.md) 
+  [SseKmsEncryptedObjects](API_control_SseKmsEncryptedObjects.md) 
+  [SSEKMSEncryption](API_control_SSEKMSEncryption.md) 
+  [SSEKMSFilter](API_control_SSEKMSFilter.md) 
+  [SSES3](API_control_SSES3.md) 
+  [SSES3Encryption](API_control_SSES3Encryption.md) 
+  [SSES3Filter](API_control_SSES3Filter.md) 
+  [StorageLensAwsOrg](API_control_StorageLensAwsOrg.md) 
+  [StorageLensConfiguration](API_control_StorageLensConfiguration.md) 
+  [StorageLensDataExport](API_control_StorageLensDataExport.md) 
+  [StorageLensDataExportEncryption](API_control_StorageLensDataExportEncryption.md) 
+  [StorageLensExpandedPrefixesDataExport](API_control_StorageLensExpandedPrefixesDataExport.md) 
+  [StorageLensGroup](API_control_StorageLensGroup.md) 
+  [StorageLensGroupAndOperator](API_control_StorageLensGroupAndOperator.md) 
+  [StorageLensGroupFilter](API_control_StorageLensGroupFilter.md) 
+  [StorageLensGroupLevel](API_control_StorageLensGroupLevel.md) 
+  [StorageLensGroupLevelSelectionCriteria](API_control_StorageLensGroupLevelSelectionCriteria.md) 
+  [StorageLensGroupOrOperator](API_control_StorageLensGroupOrOperator.md) 
+  [StorageLensTableDestination](API_control_StorageLensTableDestination.md) 
+  [StorageLensTag](API_control_StorageLensTag.md) 
+  [Tag](API_control_Tag.md) 
+  [Tagging](API_control_Tagging.md) 
+  [Transition](API_control_Transition.md) 
+  [VersioningConfiguration](API_control_VersioningConfiguration.md) 
+  [VpcConfiguration](API_control_VpcConfiguration.md) 

The following data types are supported by Amazon S3 Files:
+  [CreationPermissions](API_S3Files_CreationPermissions.md) 
+  [ExpirationDataRule](API_S3Files_ExpirationDataRule.md) 
+  [ImportDataRule](API_S3Files_ImportDataRule.md) 
+  [ListAccessPointsDescription](API_S3Files_ListAccessPointsDescription.md) 
+  [ListFileSystemsDescription](API_S3Files_ListFileSystemsDescription.md) 
+  [ListMountTargetsDescription](API_S3Files_ListMountTargetsDescription.md) 
+  [PosixUser](API_S3Files_PosixUser.md) 
+  [RootDirectory](API_S3Files_RootDirectory.md) 
+  [Tag](API_S3Files_Tag.md) 

The following data types are supported by Amazon S3 on Outposts:
+  [Endpoint](API_s3outposts_Endpoint.md) 
+  [FailedReason](API_s3outposts_FailedReason.md) 
+  [NetworkInterface](API_s3outposts_NetworkInterface.md) 
+  [Outpost](API_s3outposts_Outpost.md) 

The following data types are supported by Amazon S3 Tables:
+  [EncryptionConfiguration](API_s3Buckets_EncryptionConfiguration.md) 
+  [IcebergCompactionSettings](API_s3Buckets_IcebergCompactionSettings.md) 
+  [IcebergMetadata](API_s3Buckets_IcebergMetadata.md) 
+  [IcebergPartitionField](API_s3Buckets_IcebergPartitionField.md) 
+  [IcebergPartitionSpec](API_s3Buckets_IcebergPartitionSpec.md) 
+  [IcebergSchema](API_s3Buckets_IcebergSchema.md) 
+  [IcebergSchemaV2](API_s3Buckets_IcebergSchemaV2.md) 
+  [IcebergSnapshotManagementSettings](API_s3Buckets_IcebergSnapshotManagementSettings.md) 
+  [IcebergSortField](API_s3Buckets_IcebergSortField.md) 
+  [IcebergSortOrder](API_s3Buckets_IcebergSortOrder.md) 
+  [IcebergUnreferencedFileRemovalSettings](API_s3Buckets_IcebergUnreferencedFileRemovalSettings.md) 
+  [LastSuccessfulReplicatedUpdate](API_s3Buckets_LastSuccessfulReplicatedUpdate.md) 
+  [ManagedTableInformation](API_s3Buckets_ManagedTableInformation.md) 
+  [NamespaceSummary](API_s3Buckets_NamespaceSummary.md) 
+  [ReplicationDestination](API_s3Buckets_ReplicationDestination.md) 
+  [ReplicationDestinationStatusModel](API_s3Buckets_ReplicationDestinationStatusModel.md) 
+  [ReplicationInformation](API_s3Buckets_ReplicationInformation.md) 
+  [SchemaField](API_s3Buckets_SchemaField.md) 
+  [SchemaV2Field](API_s3Buckets_SchemaV2Field.md) 
+  [StorageClassConfiguration](API_s3Buckets_StorageClassConfiguration.md) 
+  [TableBucketMaintenanceConfigurationValue](API_s3Buckets_TableBucketMaintenanceConfigurationValue.md) 
+  [TableBucketMaintenanceSettings](API_s3Buckets_TableBucketMaintenanceSettings.md) 
+  [TableBucketReplicationConfiguration](API_s3Buckets_TableBucketReplicationConfiguration.md) 
+  [TableBucketReplicationRule](API_s3Buckets_TableBucketReplicationRule.md) 
+  [TableBucketSummary](API_s3Buckets_TableBucketSummary.md) 
+  [TableMaintenanceConfigurationValue](API_s3Buckets_TableMaintenanceConfigurationValue.md) 
+  [TableMaintenanceJobStatusValue](API_s3Buckets_TableMaintenanceJobStatusValue.md) 
+  [TableMaintenanceSettings](API_s3Buckets_TableMaintenanceSettings.md) 
+  [TableMetadata](API_s3Buckets_TableMetadata.md) 
+  [TableRecordExpirationConfigurationValue](API_s3Buckets_TableRecordExpirationConfigurationValue.md) 
+  [TableRecordExpirationJobMetrics](API_s3Buckets_TableRecordExpirationJobMetrics.md) 
+  [TableRecordExpirationSettings](API_s3Buckets_TableRecordExpirationSettings.md) 
+  [TableReplicationConfiguration](API_s3Buckets_TableReplicationConfiguration.md) 
+  [TableReplicationRule](API_s3Buckets_TableReplicationRule.md) 
+  [TableSummary](API_s3Buckets_TableSummary.md) 

The following data types are supported by Amazon S3 Vectors:
+  [EncryptionConfiguration](API_S3VectorBuckets_EncryptionConfiguration.md) 
+  [GetOutputVector](API_S3VectorBuckets_GetOutputVector.md) 
+  [Index](API_S3VectorBuckets_Index.md) 
+  [IndexSummary](API_S3VectorBuckets_IndexSummary.md) 
+  [ListOutputVector](API_S3VectorBuckets_ListOutputVector.md) 
+  [MetadataConfiguration](API_S3VectorBuckets_MetadataConfiguration.md) 
+  [PutInputVector](API_S3VectorBuckets_PutInputVector.md) 
+  [QueryOutputVector](API_S3VectorBuckets_QueryOutputVector.md) 
+  [ValidationExceptionField](API_S3VectorBuckets_ValidationExceptionField.md) 
+  [VectorBucket](API_S3VectorBuckets_VectorBucket.md) 
+  [VectorBucketSummary](API_S3VectorBuckets_VectorBucketSummary.md) 
+  [VectorData](API_S3VectorBuckets_VectorData.md) 

# Amazon S3
<a name="API_Types_Amazon_Simple_Storage_Service"></a>

The following data types are supported by Amazon S3:
+  [AbacStatus](API_AbacStatus.md) 
+  [AbortIncompleteMultipartUpload](API_AbortIncompleteMultipartUpload.md) 
+  [AccelerateConfiguration](API_AccelerateConfiguration.md) 
+  [AccessControlPolicy](API_AccessControlPolicy.md) 
+  [AccessControlTranslation](API_AccessControlTranslation.md) 
+  [AnalyticsAndOperator](API_AnalyticsAndOperator.md) 
+  [AnalyticsConfiguration](API_AnalyticsConfiguration.md) 
+  [AnalyticsExportDestination](API_AnalyticsExportDestination.md) 
+  [AnalyticsFilter](API_AnalyticsFilter.md) 
+  [AnalyticsS3BucketDestination](API_AnalyticsS3BucketDestination.md) 
+  [BlockedEncryptionTypes](API_BlockedEncryptionTypes.md) 
+  [Bucket](API_Bucket.md) 
+  [BucketInfo](API_BucketInfo.md) 
+  [BucketLifecycleConfiguration](API_BucketLifecycleConfiguration.md) 
+  [BucketLoggingStatus](API_BucketLoggingStatus.md) 
+  [Checksum](API_Checksum.md) 
+  [CloudFunctionConfiguration](API_CloudFunctionConfiguration.md) 
+  [CommonPrefix](API_CommonPrefix.md) 
+  [CompletedMultipartUpload](API_CompletedMultipartUpload.md) 
+  [CompletedPart](API_CompletedPart.md) 
+  [Condition](API_Condition.md) 
+  [ContinuationEvent](API_ContinuationEvent.md) 
+  [CopyObjectResult](API_CopyObjectResult.md) 
+  [CopyPartResult](API_CopyPartResult.md) 
+  [CORSConfiguration](API_CORSConfiguration.md) 
+  [CORSRule](API_CORSRule.md) 
+  [CreateBucketConfiguration](API_CreateBucketConfiguration.md) 
+  [CSVInput](API_CSVInput.md) 
+  [CSVOutput](API_CSVOutput.md) 
+  [DefaultRetention](API_DefaultRetention.md) 
+  [Delete](API_Delete.md) 
+  [DeletedObject](API_DeletedObject.md) 
+  [DeleteMarkerEntry](API_DeleteMarkerEntry.md) 
+  [DeleteMarkerReplication](API_DeleteMarkerReplication.md) 
+  [Destination](API_Destination.md) 
+  [DestinationResult](API_DestinationResult.md) 
+  [Encryption](API_Encryption.md) 
+  [EncryptionConfiguration](API_EncryptionConfiguration.md) 
+  [EndEvent](API_EndEvent.md) 
+  [Error](API_Error.md) 
+  [ErrorDetails](API_ErrorDetails.md) 
+  [ErrorDocument](API_ErrorDocument.md) 
+  [EventBridgeConfiguration](API_EventBridgeConfiguration.md) 
+  [ExistingObjectReplication](API_ExistingObjectReplication.md) 
+  [FilterRule](API_FilterRule.md) 
+  [GetBucketMetadataConfigurationResult](API_GetBucketMetadataConfigurationResult.md) 
+  [GetBucketMetadataTableConfigurationResult](API_GetBucketMetadataTableConfigurationResult.md) 
+  [GetObjectAttributesParts](API_GetObjectAttributesParts.md) 
+  [GlacierJobParameters](API_GlacierJobParameters.md) 
+  [Grant](API_Grant.md) 
+  [Grantee](API_Grantee.md) 
+  [IndexDocument](API_IndexDocument.md) 
+  [Initiator](API_Initiator.md) 
+  [InputSerialization](API_InputSerialization.md) 
+  [IntelligentTieringAndOperator](API_IntelligentTieringAndOperator.md) 
+  [IntelligentTieringConfiguration](API_IntelligentTieringConfiguration.md) 
+  [IntelligentTieringFilter](API_IntelligentTieringFilter.md) 
+  [InventoryConfiguration](API_InventoryConfiguration.md) 
+  [InventoryDestination](API_InventoryDestination.md) 
+  [InventoryEncryption](API_InventoryEncryption.md) 
+  [InventoryFilter](API_InventoryFilter.md) 
+  [InventoryS3BucketDestination](API_InventoryS3BucketDestination.md) 
+  [InventorySchedule](API_InventorySchedule.md) 
+  [InventoryTableConfiguration](API_InventoryTableConfiguration.md) 
+  [InventoryTableConfigurationResult](API_InventoryTableConfigurationResult.md) 
+  [InventoryTableConfigurationUpdates](API_InventoryTableConfigurationUpdates.md) 
+  [JournalTableConfiguration](API_JournalTableConfiguration.md) 
+  [JournalTableConfigurationResult](API_JournalTableConfigurationResult.md) 
+  [JournalTableConfigurationUpdates](API_JournalTableConfigurationUpdates.md) 
+  [JSONInput](API_JSONInput.md) 
+  [JSONOutput](API_JSONOutput.md) 
+  [LambdaFunctionConfiguration](API_LambdaFunctionConfiguration.md) 
+  [LifecycleConfiguration](API_LifecycleConfiguration.md) 
+  [LifecycleExpiration](API_LifecycleExpiration.md) 
+  [LifecycleRule](API_LifecycleRule.md) 
+  [LifecycleRuleAndOperator](API_LifecycleRuleAndOperator.md) 
+  [LifecycleRuleFilter](API_LifecycleRuleFilter.md) 
+  [LocationInfo](API_LocationInfo.md) 
+  [LoggingEnabled](API_LoggingEnabled.md) 
+  [MetadataConfiguration](API_MetadataConfiguration.md) 
+  [MetadataConfigurationResult](API_MetadataConfigurationResult.md) 
+  [MetadataEntry](API_MetadataEntry.md) 
+  [MetadataTableConfiguration](API_MetadataTableConfiguration.md) 
+  [MetadataTableConfigurationResult](API_MetadataTableConfigurationResult.md) 
+  [MetadataTableEncryptionConfiguration](API_MetadataTableEncryptionConfiguration.md) 
+  [Metrics](API_Metrics.md) 
+  [MetricsAndOperator](API_MetricsAndOperator.md) 
+  [MetricsConfiguration](API_MetricsConfiguration.md) 
+  [MetricsFilter](API_MetricsFilter.md) 
+  [MultipartUpload](API_MultipartUpload.md) 
+  [NoncurrentVersionExpiration](API_NoncurrentVersionExpiration.md) 
+  [NoncurrentVersionTransition](API_NoncurrentVersionTransition.md) 
+  [NotificationConfiguration](API_NotificationConfiguration.md) 
+  [NotificationConfigurationDeprecated](API_NotificationConfigurationDeprecated.md) 
+  [NotificationConfigurationFilter](API_NotificationConfigurationFilter.md) 
+  [Object](API_Object.md) 
+  [ObjectEncryption](API_ObjectEncryption.md) 
+  [ObjectIdentifier](API_ObjectIdentifier.md) 
+  [ObjectLockConfiguration](API_ObjectLockConfiguration.md) 
+  [ObjectLockLegalHold](API_ObjectLockLegalHold.md) 
+  [ObjectLockRetention](API_ObjectLockRetention.md) 
+  [ObjectLockRule](API_ObjectLockRule.md) 
+  [ObjectPart](API_ObjectPart.md) 
+  [ObjectVersion](API_ObjectVersion.md) 
+  [OutputLocation](API_OutputLocation.md) 
+  [OutputSerialization](API_OutputSerialization.md) 
+  [Owner](API_Owner.md) 
+  [OwnershipControls](API_OwnershipControls.md) 
+  [OwnershipControlsRule](API_OwnershipControlsRule.md) 
+  [ParquetInput](API_ParquetInput.md) 
+  [Part](API_Part.md) 
+  [PartitionedPrefix](API_PartitionedPrefix.md) 
+  [PolicyStatus](API_PolicyStatus.md) 
+  [Progress](API_Progress.md) 
+  [ProgressEvent](API_ProgressEvent.md) 
+  [PublicAccessBlockConfiguration](API_PublicAccessBlockConfiguration.md) 
+  [QueueConfiguration](API_QueueConfiguration.md) 
+  [QueueConfigurationDeprecated](API_QueueConfigurationDeprecated.md) 
+  [RecordExpiration](API_RecordExpiration.md) 
+  [RecordsEvent](API_RecordsEvent.md) 
+  [Redirect](API_Redirect.md) 
+  [RedirectAllRequestsTo](API_RedirectAllRequestsTo.md) 
+  [ReplicaModifications](API_ReplicaModifications.md) 
+  [ReplicationConfiguration](API_ReplicationConfiguration.md) 
+  [ReplicationRule](API_ReplicationRule.md) 
+  [ReplicationRuleAndOperator](API_ReplicationRuleAndOperator.md) 
+  [ReplicationRuleFilter](API_ReplicationRuleFilter.md) 
+  [ReplicationTime](API_ReplicationTime.md) 
+  [ReplicationTimeValue](API_ReplicationTimeValue.md) 
+  [RequestPaymentConfiguration](API_RequestPaymentConfiguration.md) 
+  [RequestProgress](API_RequestProgress.md) 
+  [RestoreRequest](API_RestoreRequest.md) 
+  [RestoreStatus](API_RestoreStatus.md) 
+  [RoutingRule](API_RoutingRule.md) 
+  [Rule](API_Rule.md) 
+  [S3KeyFilter](API_S3KeyFilter.md) 
+  [S3Location](API_S3Location.md) 
+  [S3TablesDestination](API_S3TablesDestination.md) 
+  [S3TablesDestinationResult](API_S3TablesDestinationResult.md) 
+  [ScanRange](API_ScanRange.md) 
+  [SelectObjectContentEventStream](API_SelectObjectContentEventStream.md) 
+  [SelectParameters](API_SelectParameters.md) 
+  [ServerSideEncryptionByDefault](API_ServerSideEncryptionByDefault.md) 
+  [ServerSideEncryptionConfiguration](API_ServerSideEncryptionConfiguration.md) 
+  [ServerSideEncryptionRule](API_ServerSideEncryptionRule.md) 
+  [SessionCredentials](API_SessionCredentials.md) 
+  [SimplePrefix](API_SimplePrefix.md) 
+  [SourceSelectionCriteria](API_SourceSelectionCriteria.md) 
+  [SSEKMS](API_SSEKMS.md) 
+  [SseKmsEncryptedObjects](API_SseKmsEncryptedObjects.md) 
+  [SSEKMSEncryption](API_SSEKMSEncryption.md) 
+  [SSES3](API_SSES3.md) 
+  [Stats](API_Stats.md) 
+  [StatsEvent](API_StatsEvent.md) 
+  [StorageClassAnalysis](API_StorageClassAnalysis.md) 
+  [StorageClassAnalysisDataExport](API_StorageClassAnalysisDataExport.md) 
+  [Tag](API_Tag.md) 
+  [Tagging](API_Tagging.md) 
+  [TargetGrant](API_TargetGrant.md) 
+  [TargetObjectKeyFormat](API_TargetObjectKeyFormat.md) 
+  [Tiering](API_Tiering.md) 
+  [TopicConfiguration](API_TopicConfiguration.md) 
+  [TopicConfigurationDeprecated](API_TopicConfigurationDeprecated.md) 
+  [Transition](API_Transition.md) 
+  [VersioningConfiguration](API_VersioningConfiguration.md) 
+  [WebsiteConfiguration](API_WebsiteConfiguration.md) 

# AbacStatus
<a name="API_AbacStatus"></a>

The ABAC status of the general purpose bucket. When ABAC is enabled for the general purpose bucket, you can use tags to manage access to the general purpose buckets as well as for cost tracking purposes. When ABAC is disabled for the general purpose buckets, you can only use tags for cost tracking purposes. For more information, see [Using tags with S3 general purpose buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging.html). 

## Contents
<a name="API_AbacStatus_Contents"></a>

 ** Status **   <a name="AmazonS3-Type-AbacStatus-Status"></a>
The ABAC status of the general purpose bucket.   
Type: String  
Valid Values: `Enabled | Disabled`   
Required: No

## See Also
<a name="API_AbacStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/AbacStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/AbacStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/AbacStatus) 

# AbortIncompleteMultipartUpload
<a name="API_AbortIncompleteMultipartUpload"></a>

Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see [ Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) in the *Amazon S3 User Guide*.

## Contents
<a name="API_AbortIncompleteMultipartUpload_Contents"></a>

 ** DaysAfterInitiation **   <a name="AmazonS3-Type-AbortIncompleteMultipartUpload-DaysAfterInitiation"></a>
Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload.  
Type: Integer  
Required: No

## See Also
<a name="API_AbortIncompleteMultipartUpload_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/AbortIncompleteMultipartUpload) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/AbortIncompleteMultipartUpload) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/AbortIncompleteMultipartUpload) 

# AccelerateConfiguration
<a name="API_AccelerateConfiguration"></a>

Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*.

## Contents
<a name="API_AccelerateConfiguration_Contents"></a>

 ** Status **   <a name="AmazonS3-Type-AccelerateConfiguration-Status"></a>
Specifies the transfer acceleration status of the bucket.  
Type: String  
Valid Values: `Enabled | Suspended`   
Required: No

## See Also
<a name="API_AccelerateConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/AccelerateConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/AccelerateConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/AccelerateConfiguration) 

# AccessControlPolicy
<a name="API_AccessControlPolicy"></a>

Contains the elements that set the ACL permissions for an object per grantee.

## Contents
<a name="API_AccessControlPolicy_Contents"></a>

 ** Grants **   <a name="AmazonS3-Type-AccessControlPolicy-Grants"></a>
A list of grants.  
Type: Array of [Grant](API_Grant.md) data types  
Required: No

 ** Owner **   <a name="AmazonS3-Type-AccessControlPolicy-Owner"></a>
Container for the bucket owner's display name and ID.  
Type: [Owner](API_Owner.md) data type  
Required: No

## See Also
<a name="API_AccessControlPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/AccessControlPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/AccessControlPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/AccessControlPolicy) 

# AccessControlTranslation
<a name="API_AccessControlTranslation"></a>

A container for information about access control for replicas.

## Contents
<a name="API_AccessControlTranslation_Contents"></a>

 ** Owner **   <a name="AmazonS3-Type-AccessControlTranslation-Owner"></a>
Specifies the replica ownership. For default and valid values, see [PUT bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) in the *Amazon S3 API Reference*.  
Type: String  
Valid Values: `Destination`   
Required: Yes

## See Also
<a name="API_AccessControlTranslation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/AccessControlTranslation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/AccessControlTranslation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/AccessControlTranslation) 

# AnalyticsAndOperator
<a name="API_AnalyticsAndOperator"></a>

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates in any combination, and an object must match all of the predicates for the filter to apply.

## Contents
<a name="API_AnalyticsAndOperator_Contents"></a>

 ** Prefix **   <a name="AmazonS3-Type-AnalyticsAndOperator-Prefix"></a>
The prefix to use when evaluating an AND predicate: The prefix that an object must have to be included in the metrics results.  
Type: String  
Required: No

 ** Tags **   <a name="AmazonS3-Type-AnalyticsAndOperator-Tags"></a>
The list of tags to use when evaluating an AND predicate.  
Type: Array of [Tag](API_Tag.md) data types  
Required: No

## See Also
<a name="API_AnalyticsAndOperator_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/AnalyticsAndOperator) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/AnalyticsAndOperator) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/AnalyticsAndOperator) 

# AnalyticsConfiguration
<a name="API_AnalyticsConfiguration"></a>

Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.

## Contents
<a name="API_AnalyticsConfiguration_Contents"></a>

 ** Id **   <a name="AmazonS3-Type-AnalyticsConfiguration-Id"></a>
The ID that identifies the analytics configuration.  
Type: String  
Required: Yes

 ** StorageClassAnalysis **   <a name="AmazonS3-Type-AnalyticsConfiguration-StorageClassAnalysis"></a>
 Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes.   
Type: [StorageClassAnalysis](API_StorageClassAnalysis.md) data type  
Required: Yes

 ** Filter **   <a name="AmazonS3-Type-AnalyticsConfiguration-Filter"></a>
The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.  
Type: [AnalyticsFilter](API_AnalyticsFilter.md) data type  
Required: No

## See Also
<a name="API_AnalyticsConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/AnalyticsConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/AnalyticsConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/AnalyticsConfiguration) 

# AnalyticsExportDestination
<a name="API_AnalyticsExportDestination"></a>

Where to publish the analytics results.

## Contents
<a name="API_AnalyticsExportDestination_Contents"></a>

 ** S3BucketDestination **   <a name="AmazonS3-Type-AnalyticsExportDestination-S3BucketDestination"></a>
A destination signifying output to an S3 bucket.  
Type: [AnalyticsS3BucketDestination](API_AnalyticsS3BucketDestination.md) data type  
Required: Yes

## See Also
<a name="API_AnalyticsExportDestination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/AnalyticsExportDestination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/AnalyticsExportDestination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/AnalyticsExportDestination) 

# AnalyticsFilter
<a name="API_AnalyticsFilter"></a>

The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.

## Contents
<a name="API_AnalyticsFilter_Contents"></a>

 ** And **   <a name="AmazonS3-Type-AnalyticsFilter-And"></a>
A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates.  
Type: [AnalyticsAndOperator](API_AnalyticsAndOperator.md) data type  
Required: No

 ** Prefix **   <a name="AmazonS3-Type-AnalyticsFilter-Prefix"></a>
The prefix to use when evaluating an analytics filter.  
Type: String  
Required: No

 ** Tag **   <a name="AmazonS3-Type-AnalyticsFilter-Tag"></a>
The tag to use when evaluating an analytics filter.  
Type: [Tag](API_Tag.md) data type  
Required: No

## See Also
<a name="API_AnalyticsFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/AnalyticsFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/AnalyticsFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/AnalyticsFilter) 

# AnalyticsS3BucketDestination
<a name="API_AnalyticsS3BucketDestination"></a>

Contains information about where to publish the analytics results.

## Contents
<a name="API_AnalyticsS3BucketDestination_Contents"></a>

 ** Bucket **   <a name="AmazonS3-Type-AnalyticsS3BucketDestination-Bucket"></a>
The Amazon Resource Name (ARN) of the bucket to which data is exported.  
Type: String  
Required: Yes

 ** Format **   <a name="AmazonS3-Type-AnalyticsS3BucketDestination-Format"></a>
Specifies the file format used when exporting data to Amazon S3.  
Type: String  
Valid Values: `CSV`   
Required: Yes

 ** BucketAccountId **   <a name="AmazonS3-Type-AnalyticsS3BucketDestination-BucketAccountId"></a>
The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.  
 Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes. 
Type: String  
Required: No

 ** Prefix **   <a name="AmazonS3-Type-AnalyticsS3BucketDestination-Prefix"></a>
The prefix to use when exporting data. The prefix is prepended to all results.  
Type: String  
Required: No

## See Also
<a name="API_AnalyticsS3BucketDestination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/AnalyticsS3BucketDestination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/AnalyticsS3BucketDestination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/AnalyticsS3BucketDestination) 

# BlockedEncryptionTypes
<a name="API_BlockedEncryptionTypes"></a>

A bucket-level setting for Amazon S3 general purpose buckets used to prevent the upload of new objects encrypted with the specified server-side encryption type. For example, blocking an encryption type will block `PutObject`, `CopyObject`, `PostObject`, multipart upload, and replication requests to the bucket for objects with the specified encryption type. However, you can continue to read and list any pre-existing objects already encrypted with the specified encryption type. For more information, see [Blocking or unblocking SSE-C for a general purpose bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/blocking-unblocking-s3-c-encryption-gpb.html).

This data type is used with the following actions:
+  [PutBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html) 
+  [GetBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html) 
+  [DeleteBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html) 

Permissions  
You must have the `s3:PutEncryptionConfiguration` permission to block or unblock an encryption type for a bucket.   
You must have the `s3:GetEncryptionConfiguration` permission to view a bucket's encryption type. 

## Contents
<a name="API_BlockedEncryptionTypes_Contents"></a>

 ** EncryptionType **   <a name="AmazonS3-Type-BlockedEncryptionTypes-EncryptionType"></a>
The object encryption type that you want to block or unblock for an Amazon S3 general purpose bucket.  
Currently, this parameter only supports blocking or unblocking server side encryption with customer-provided keys (SSE-C). For more information about SSE-C, see [Using server-side encryption with customer-provided keys (SSE-C)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html).
Type: Array of strings  
Valid Values: `NONE | SSE-C`   
Required: No

## See Also
<a name="API_BlockedEncryptionTypes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/BlockedEncryptionTypes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/BlockedEncryptionTypes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/BlockedEncryptionTypes) 

# Bucket
<a name="API_Bucket"></a>

 In terms of implementation, a Bucket is a resource. 

## Contents
<a name="API_Bucket_Contents"></a>

 ** BucketArn **   <a name="AmazonS3-Type-Bucket-BucketArn"></a>
The Amazon Resource Name (ARN) of the S3 bucket. ARNs uniquely identify AWS resources across all of AWS.  
This parameter is only supported for S3 directory buckets. For more information, see [Using tags with directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-tagging.html).
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `arn:[^:]+:(s3|s3express):.*`   
Required: No

 ** BucketRegion **   <a name="AmazonS3-Type-Bucket-BucketRegion"></a>
 `BucketRegion` indicates the AWS region where the bucket is located. If the request contains at least one valid parameter, it is included in the response.  
Type: String  
Required: No

 ** CreationDate **   <a name="AmazonS3-Type-Bucket-CreationDate"></a>
Date the bucket was created. This date can change when making changes to your bucket, such as editing its bucket policy.  
Type: Timestamp  
Required: No

 ** Name **   <a name="AmazonS3-Type-Bucket-Name"></a>
The name of the bucket.  
Type: String  
Required: No

## See Also
<a name="API_Bucket_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/Bucket) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/Bucket) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/Bucket) 

# BucketInfo
<a name="API_BucketInfo"></a>

Specifies the information about the bucket that will be created. For more information about directory buckets, see [Directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html) in the *Amazon S3 User Guide*.

**Note**  
This functionality is only supported by directory buckets.

## Contents
<a name="API_BucketInfo_Contents"></a>

 ** DataRedundancy **   <a name="AmazonS3-Type-BucketInfo-DataRedundancy"></a>
The number of Zone (Availability Zone or Local Zone) that's used for redundancy for the bucket.  
Type: String  
Valid Values: `SingleAvailabilityZone | SingleLocalZone`   
Required: No

 ** Type **   <a name="AmazonS3-Type-BucketInfo-Type"></a>
The type of bucket.  
Type: String  
Valid Values: `Directory`   
Required: No

## See Also
<a name="API_BucketInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/BucketInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/BucketInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/BucketInfo) 

# BucketLifecycleConfiguration
<a name="API_BucketLifecycleConfiguration"></a>

Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*.

## Contents
<a name="API_BucketLifecycleConfiguration_Contents"></a>

 ** Rules **   <a name="AmazonS3-Type-BucketLifecycleConfiguration-Rules"></a>
A lifecycle rule for individual objects in an Amazon S3 bucket.  
Type: Array of [LifecycleRule](API_LifecycleRule.md) data types  
Required: Yes

## See Also
<a name="API_BucketLifecycleConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/BucketLifecycleConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/BucketLifecycleConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/BucketLifecycleConfiguration) 

# BucketLoggingStatus
<a name="API_BucketLoggingStatus"></a>

Container for logging status information.

## Contents
<a name="API_BucketLoggingStatus_Contents"></a>

 ** LoggingEnabled **   <a name="AmazonS3-Type-BucketLoggingStatus-LoggingEnabled"></a>
Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more information, see [PUT Bucket logging](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html) in the *Amazon S3 API Reference*.  
Type: [LoggingEnabled](API_LoggingEnabled.md) data type  
Required: No

## See Also
<a name="API_BucketLoggingStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/BucketLoggingStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/BucketLoggingStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/BucketLoggingStatus) 

# Checksum
<a name="API_Checksum"></a>

Contains all the possible checksum or digest values for an object.

## Contents
<a name="API_Checksum_Contents"></a>

 ** ChecksumCRC32 **   <a name="AmazonS3-Type-Checksum-ChecksumCRC32"></a>
The Base64 encoded, 32-bit `CRC32 checksum` of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ChecksumCRC32C **   <a name="AmazonS3-Type-Checksum-ChecksumCRC32C"></a>
The Base64 encoded, 32-bit `CRC32C` checksum of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ChecksumCRC64NVME **   <a name="AmazonS3-Type-Checksum-ChecksumCRC64NVME"></a>
The Base64 encoded, 64-bit `CRC64NVME` checksum of the object. This checksum is present if the object was uploaded with the `CRC64NVME` checksum algorithm, or if the object was uploaded without a checksum (and Amazon S3 added the default checksum, `CRC64NVME`, to the uploaded object). For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ChecksumSHA1 **   <a name="AmazonS3-Type-Checksum-ChecksumSHA1"></a>
The Base64 encoded, 160-bit `SHA1` digest of the object. This checksum is only present if the checksum was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ChecksumSHA256 **   <a name="AmazonS3-Type-Checksum-ChecksumSHA256"></a>
The Base64 encoded, 256-bit `SHA256` digest of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ChecksumType **   <a name="AmazonS3-Type-Checksum-ChecksumType"></a>
The checksum type that is used to calculate the object’s checksum value. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Valid Values: `COMPOSITE | FULL_OBJECT`   
Required: No

## See Also
<a name="API_Checksum_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/Checksum) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/Checksum) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/Checksum) 

# CloudFunctionConfiguration
<a name="API_CloudFunctionConfiguration"></a>

Container for specifying the AWS Lambda notification configuration.

## Contents
<a name="API_CloudFunctionConfiguration_Contents"></a>

 ** CloudFunction **   <a name="AmazonS3-Type-CloudFunctionConfiguration-CloudFunction"></a>
Lambda cloud function ARN that Amazon S3 can invoke when it detects events of the specified type.  
Type: String  
Required: No

 ** Event **   <a name="AmazonS3-Type-CloudFunctionConfiguration-Event"></a>
 *This member has been deprecated.*   
The bucket event for which to send notifications.  
Type: String  
Valid Values: `s3:ReducedRedundancyLostObject | s3:ObjectCreated:* | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved:* | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated | s3:ObjectRestore:* | s3:ObjectRestore:Post | s3:ObjectRestore:Completed | s3:Replication:* | s3:Replication:OperationFailedReplication | s3:Replication:OperationNotTracked | s3:Replication:OperationMissedThreshold | s3:Replication:OperationReplicatedAfterThreshold | s3:ObjectRestore:Delete | s3:LifecycleTransition | s3:IntelligentTiering | s3:ObjectAcl:Put | s3:LifecycleExpiration:* | s3:LifecycleExpiration:Delete | s3:LifecycleExpiration:DeleteMarkerCreated | s3:ObjectTagging:* | s3:ObjectTagging:Put | s3:ObjectTagging:Delete`   
Required: No

 ** Events **   <a name="AmazonS3-Type-CloudFunctionConfiguration-Events"></a>
Bucket events for which to send notifications.  
Type: Array of strings  
Valid Values: `s3:ReducedRedundancyLostObject | s3:ObjectCreated:* | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved:* | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated | s3:ObjectRestore:* | s3:ObjectRestore:Post | s3:ObjectRestore:Completed | s3:Replication:* | s3:Replication:OperationFailedReplication | s3:Replication:OperationNotTracked | s3:Replication:OperationMissedThreshold | s3:Replication:OperationReplicatedAfterThreshold | s3:ObjectRestore:Delete | s3:LifecycleTransition | s3:IntelligentTiering | s3:ObjectAcl:Put | s3:LifecycleExpiration:* | s3:LifecycleExpiration:Delete | s3:LifecycleExpiration:DeleteMarkerCreated | s3:ObjectTagging:* | s3:ObjectTagging:Put | s3:ObjectTagging:Delete`   
Required: No

 ** Id **   <a name="AmazonS3-Type-CloudFunctionConfiguration-Id"></a>
An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.  
Type: String  
Required: No

 ** InvocationRole **   <a name="AmazonS3-Type-CloudFunctionConfiguration-InvocationRole"></a>
The role supporting the invocation of the Lambda function  
Type: String  
Required: No

## See Also
<a name="API_CloudFunctionConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/CloudFunctionConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/CloudFunctionConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/CloudFunctionConfiguration) 

# CommonPrefix
<a name="API_CommonPrefix"></a>

Container for all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter. CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix. For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. 

## Contents
<a name="API_CommonPrefix_Contents"></a>

 ** Prefix **   <a name="AmazonS3-Type-CommonPrefix-Prefix"></a>
Container for the specified common prefix.  
Type: String  
Required: No

## See Also
<a name="API_CommonPrefix_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/CommonPrefix) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/CommonPrefix) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/CommonPrefix) 

# CompletedMultipartUpload
<a name="API_CompletedMultipartUpload"></a>

The container for the completed multipart upload details.

## Contents
<a name="API_CompletedMultipartUpload_Contents"></a>

 ** Parts **   <a name="AmazonS3-Type-CompletedMultipartUpload-Parts"></a>
Array of CompletedPart data types.  
If you do not supply a valid `Part` with your request, the service sends back an HTTP 400 response.  
Type: Array of [CompletedPart](API_CompletedPart.md) data types  
Required: No

## See Also
<a name="API_CompletedMultipartUpload_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/CompletedMultipartUpload) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/CompletedMultipartUpload) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/CompletedMultipartUpload) 

# CompletedPart
<a name="API_CompletedPart"></a>

Details of the parts that were uploaded.

## Contents
<a name="API_CompletedPart_Contents"></a>

 ** ChecksumCRC32 **   <a name="AmazonS3-Type-CompletedPart-ChecksumCRC32"></a>
The Base64 encoded, 32-bit `CRC32` checksum of the part. This checksum is present if the multipart upload request was created with the `CRC32` checksum algorithm. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ChecksumCRC32C **   <a name="AmazonS3-Type-CompletedPart-ChecksumCRC32C"></a>
The Base64 encoded, 32-bit `CRC32C` checksum of the part. This checksum is present if the multipart upload request was created with the `CRC32C` checksum algorithm. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ChecksumCRC64NVME **   <a name="AmazonS3-Type-CompletedPart-ChecksumCRC64NVME"></a>
The Base64 encoded, 64-bit `CRC64NVME` checksum of the part. This checksum is present if the multipart upload request was created with the `CRC64NVME` checksum algorithm to the uploaded object). For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ChecksumSHA1 **   <a name="AmazonS3-Type-CompletedPart-ChecksumSHA1"></a>
The Base64 encoded, 160-bit `SHA1` checksum of the part. This checksum is present if the multipart upload request was created with the `SHA1` checksum algorithm. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ChecksumSHA256 **   <a name="AmazonS3-Type-CompletedPart-ChecksumSHA256"></a>
The Base64 encoded, 256-bit `SHA256` checksum of the part. This checksum is present if the multipart upload request was created with the `SHA256` checksum algorithm. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ETag **   <a name="AmazonS3-Type-CompletedPart-ETag"></a>
Entity tag returned when the part was uploaded.  
Type: String  
Required: No

 ** PartNumber **   <a name="AmazonS3-Type-CompletedPart-PartNumber"></a>
Part number that identifies the part. This is a positive integer between 1 and 10,000.  
+  **General purpose buckets** - In `CompleteMultipartUpload`, when a additional checksum (including `x-amz-checksum-crc32`, `x-amz-checksum-crc32c`, `x-amz-checksum-sha1`, or `x-amz-checksum-sha256`) is applied to each part, the `PartNumber` must start at 1 and the part numbers must be consecutive. Otherwise, Amazon S3 generates an HTTP `400 Bad Request` status code and an `InvalidPartOrder` error code.
+  **Directory buckets** - In `CompleteMultipartUpload`, the `PartNumber` must start at 1 and the part numbers must be consecutive.
Type: Integer  
Required: No

## See Also
<a name="API_CompletedPart_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/CompletedPart) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/CompletedPart) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/CompletedPart) 

# Condition
<a name="API_Condition"></a>

A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the `/docs` folder, redirect to the `/documents` folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.

## Contents
<a name="API_Condition_Contents"></a>

 ** HttpErrorCodeReturnedEquals **   <a name="AmazonS3-Type-Condition-HttpErrorCodeReturnedEquals"></a>
The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element `Condition` is specified and sibling `KeyPrefixEquals` is not specified. If both are specified, then both must be true for the redirect to be applied.  
Type: String  
Required: No

 ** KeyPrefixEquals **   <a name="AmazonS3-Type-Condition-KeyPrefixEquals"></a>
The object key name prefix when the redirect is applied. For example, to redirect requests for `ExamplePage.html`, the key prefix will be `ExamplePage.html`. To redirect request for all pages with the prefix `docs/`, the key prefix will be `/docs`, which identifies all objects in the `docs/` folder. Required when the parent element `Condition` is specified and sibling `HttpErrorCodeReturnedEquals` is not specified. If both conditions are specified, both must be true for the redirect to be applied.  
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).
Type: String  
Required: No

## See Also
<a name="API_Condition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/Condition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/Condition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/Condition) 

# ContinuationEvent
<a name="API_ContinuationEvent"></a>



## Contents
<a name="API_ContinuationEvent_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_ContinuationEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ContinuationEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ContinuationEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ContinuationEvent) 

# CopyObjectResult
<a name="API_CopyObjectResult"></a>

Container for all response elements.

## Contents
<a name="API_CopyObjectResult_Contents"></a>

 ** ChecksumCRC32 **   <a name="AmazonS3-Type-CopyObjectResult-ChecksumCRC32"></a>
The Base64 encoded, 32-bit `CRC32` checksum of the object. This checksum is only present if the object was uploaded with the object. For more information, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ChecksumCRC32C **   <a name="AmazonS3-Type-CopyObjectResult-ChecksumCRC32C"></a>
The Base64 encoded, 32-bit `CRC32C` checksum of the object. This checksum is only present if the checksum was uploaded with the object. For more information, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ChecksumCRC64NVME **   <a name="AmazonS3-Type-CopyObjectResult-ChecksumCRC64NVME"></a>
The Base64 encoded, 64-bit `CRC64NVME` checksum of the object. This checksum is present if the object being copied was uploaded with the `CRC64NVME` checksum algorithm, or if the object was uploaded without a checksum (and Amazon S3 added the default checksum, `CRC64NVME`, to the uploaded object). For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ChecksumSHA1 **   <a name="AmazonS3-Type-CopyObjectResult-ChecksumSHA1"></a>
The Base64 encoded, 160-bit `SHA1` digest of the object. This checksum is only present if the checksum was uploaded with the object. For more information, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ChecksumSHA256 **   <a name="AmazonS3-Type-CopyObjectResult-ChecksumSHA256"></a>
The Base64 encoded, 256-bit `SHA256` digest of the object. This checksum is only present if the checksum was uploaded with the object. For more information, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ChecksumType **   <a name="AmazonS3-Type-CopyObjectResult-ChecksumType"></a>
The checksum type that is used to calculate the object’s checksum value. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Valid Values: `COMPOSITE | FULL_OBJECT`   
Required: No

 ** ETag **   <a name="AmazonS3-Type-CopyObjectResult-ETag"></a>
Returns the ETag of the new object. The ETag reflects only changes to the contents of an object, not its metadata.  
Type: String  
Required: No

 ** LastModified **   <a name="AmazonS3-Type-CopyObjectResult-LastModified"></a>
Creation date of the object.  
Type: Timestamp  
Required: No

## See Also
<a name="API_CopyObjectResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/CopyObjectResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/CopyObjectResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/CopyObjectResult) 

# CopyPartResult
<a name="API_CopyPartResult"></a>

Container for all response elements.

## Contents
<a name="API_CopyPartResult_Contents"></a>

 ** ChecksumCRC32 **   <a name="AmazonS3-Type-CopyPartResult-ChecksumCRC32"></a>
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 32-bit `CRC32` checksum of the part. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ChecksumCRC32C **   <a name="AmazonS3-Type-CopyPartResult-ChecksumCRC32C"></a>
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 32-bit `CRC32C` checksum of the part. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ChecksumCRC64NVME **   <a name="AmazonS3-Type-CopyPartResult-ChecksumCRC64NVME"></a>
The Base64 encoded, 64-bit `CRC64NVME` checksum of the part. This checksum is present if the multipart upload request was created with the `CRC64NVME` checksum algorithm to the uploaded object). For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ChecksumSHA1 **   <a name="AmazonS3-Type-CopyPartResult-ChecksumSHA1"></a>
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 160-bit `SHA1` checksum of the part. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ChecksumSHA256 **   <a name="AmazonS3-Type-CopyPartResult-ChecksumSHA256"></a>
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 256-bit `SHA256` checksum of the part. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ETag **   <a name="AmazonS3-Type-CopyPartResult-ETag"></a>
Entity tag of the object.  
Type: String  
Required: No

 ** LastModified **   <a name="AmazonS3-Type-CopyPartResult-LastModified"></a>
Date and time at which the object was uploaded.  
Type: Timestamp  
Required: No

## See Also
<a name="API_CopyPartResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/CopyPartResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/CopyPartResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/CopyPartResult) 

# CORSConfiguration
<a name="API_CORSConfiguration"></a>

Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*.

## Contents
<a name="API_CORSConfiguration_Contents"></a>

 ** CORSRules **   <a name="AmazonS3-Type-CORSConfiguration-CORSRules"></a>
A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.  
Type: Array of [CORSRule](API_CORSRule.md) data types  
Required: Yes

## See Also
<a name="API_CORSConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/CORSConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/CORSConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/CORSConfiguration) 

# CORSRule
<a name="API_CORSRule"></a>

Specifies a cross-origin access rule for an Amazon S3 bucket.

## Contents
<a name="API_CORSRule_Contents"></a>

 ** AllowedMethods **   <a name="AmazonS3-Type-CORSRule-AllowedMethods"></a>
An HTTP method that you allow the origin to execute. Valid values are `GET`, `PUT`, `HEAD`, `POST`, and `DELETE`.  
Type: Array of strings  
Required: Yes

 ** AllowedOrigins **   <a name="AmazonS3-Type-CORSRule-AllowedOrigins"></a>
One or more origins you want customers to be able to access the bucket from.  
Type: Array of strings  
Required: Yes

 ** AllowedHeaders **   <a name="AmazonS3-Type-CORSRule-AllowedHeaders"></a>
Headers that are specified in the `Access-Control-Request-Headers` header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.  
Type: Array of strings  
Required: No

 ** ExposeHeaders **   <a name="AmazonS3-Type-CORSRule-ExposeHeaders"></a>
One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript `XMLHttpRequest` object).  
Type: Array of strings  
Required: No

 ** ID **   <a name="AmazonS3-Type-CORSRule-ID"></a>
Unique identifier for the rule. The value cannot be longer than 255 characters.  
Type: String  
Required: No

 ** MaxAgeSeconds **   <a name="AmazonS3-Type-CORSRule-MaxAgeSeconds"></a>
The time in seconds that your browser is to cache the preflight response for the specified resource.  
Type: Integer  
Required: No

## See Also
<a name="API_CORSRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/CORSRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/CORSRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/CORSRule) 

# CreateBucketConfiguration
<a name="API_CreateBucketConfiguration"></a>

The configuration information for the bucket.

## Contents
<a name="API_CreateBucketConfiguration_Contents"></a>

 ** Bucket **   <a name="AmazonS3-Type-CreateBucketConfiguration-Bucket"></a>
Specifies the information about the bucket that will be created.  
This functionality is only supported by directory buckets.
Type: [BucketInfo](API_BucketInfo.md) data type  
Required: No

 ** Location **   <a name="AmazonS3-Type-CreateBucketConfiguration-Location"></a>
Specifies the location where the bucket will be created.  
 **Directory buckets ** - The location type is Availability Zone or Local Zone. To use the Local Zone location type, your account must be enabled for Local Zones. Otherwise, you get an HTTP `403 Forbidden` error with the error code `AccessDenied`. To learn more, see [Enable accounts for Local Zones](https://docs.aws.amazon.com/AmazonS3/latest/userguide/opt-in-directory-bucket-lz.html) in the *Amazon S3 User Guide*.   
This functionality is only supported by directory buckets.
Type: [LocationInfo](API_LocationInfo.md) data type  
Required: No

 ** LocationConstraint **   <a name="AmazonS3-Type-CreateBucketConfiguration-LocationConstraint"></a>
Specifies the Region where the bucket will be created. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) Region.  
If you don't specify a Region, the bucket is created in the US East (N. Virginia) Region (us-east-1) by default. Configurations using the value `EU` will create a bucket in `eu-west-1`.  
For a list of the valid values for all of the AWS Regions, see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region).  
This functionality is not supported for directory buckets.
Type: String  
Valid Values: `af-south-1 | ap-east-1 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ap-south-1 | ap-south-2 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ap-southeast-4 | ap-southeast-5 | ca-central-1 | cn-north-1 | cn-northwest-1 | EU | eu-central-1 | eu-central-2 | eu-north-1 | eu-south-1 | eu-south-2 | eu-west-1 | eu-west-2 | eu-west-3 | il-central-1 | me-central-1 | me-south-1 | sa-east-1 | us-east-2 | us-gov-east-1 | us-gov-west-1 | us-west-1 | us-west-2`   
Required: No

 ** Tags **   <a name="AmazonS3-Type-CreateBucketConfiguration-Tags"></a>
An array of tags that you can apply to the bucket that you're creating. Tags are key-value pairs of metadata used to categorize and organize your buckets, track costs, and control access.   
You must have the `s3:TagResource` permission to create a general purpose bucket with tags or the `s3express:TagResource` permission to create a directory bucket with tags.  
When creating buckets with tags, note that tag-based conditions using `aws:ResourceTag` and `s3:BucketTag` condition keys are applicable only after ABAC is enabled on the bucket. To learn more, see [Enabling ABAC in general purpose buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging-enable-abac.html).  
Type: Array of [Tag](API_Tag.md) data types  
Required: No

## See Also
<a name="API_CreateBucketConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/CreateBucketConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/CreateBucketConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/CreateBucketConfiguration) 

# CSVInput
<a name="API_CSVInput"></a>

Describes how an uncompressed comma-separated values (CSV)-formatted input object is formatted.

## Contents
<a name="API_CSVInput_Contents"></a>

 ** AllowQuotedRecordDelimiter **   <a name="AmazonS3-Type-CSVInput-AllowQuotedRecordDelimiter"></a>
Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance.  
Type: Boolean  
Required: No

 ** Comments **   <a name="AmazonS3-Type-CSVInput-Comments"></a>
A single character used to indicate that a row should be ignored when the character is present at the start of that row. You can specify any character to indicate a comment line. The default character is `#`.  
Default: `#`   
Type: String  
Required: No

 ** FieldDelimiter **   <a name="AmazonS3-Type-CSVInput-FieldDelimiter"></a>
A single character used to separate individual fields in a record. You can specify an arbitrary delimiter.  
Type: String  
Required: No

 ** FileHeaderInfo **   <a name="AmazonS3-Type-CSVInput-FileHeaderInfo"></a>
Describes the first line of input. Valid values are:  
+  `NONE`: First line is not a header.
+  `IGNORE`: First line is a header, but you can't use the header values to indicate the column in an expression. You can use column position (such as \$11, \$12, …) to indicate the column (`SELECT s._1 FROM OBJECT s`).
+  `Use`: First line is a header, and you can use the header value to identify a column in an expression (`SELECT "name" FROM OBJECT`). 
Type: String  
Valid Values: `USE | IGNORE | NONE`   
Required: No

 ** QuoteCharacter **   <a name="AmazonS3-Type-CSVInput-QuoteCharacter"></a>
A single character used for escaping when the field delimiter is part of the value. For example, if the value is `a, b`, Amazon S3 wraps this field value in quotation marks, as follows: `" a , b "`.  
Type: String  
Default: `"`   
Ancestors: `CSV`   
Type: String  
Required: No

 ** QuoteEscapeCharacter **   <a name="AmazonS3-Type-CSVInput-QuoteEscapeCharacter"></a>
A single character used for escaping the quotation mark character inside an already escaped value. For example, the value `""" a , b """` is parsed as `" a , b "`.  
Type: String  
Required: No

 ** RecordDelimiter **   <a name="AmazonS3-Type-CSVInput-RecordDelimiter"></a>
A single character used to separate individual records in the input. Instead of the default value, you can specify an arbitrary delimiter.  
Type: String  
Required: No

## See Also
<a name="API_CSVInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/CSVInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/CSVInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/CSVInput) 

# CSVOutput
<a name="API_CSVOutput"></a>

Describes how uncompressed comma-separated values (CSV)-formatted results are formatted.

## Contents
<a name="API_CSVOutput_Contents"></a>

 ** FieldDelimiter **   <a name="AmazonS3-Type-CSVOutput-FieldDelimiter"></a>
The value used to separate individual fields in a record. You can specify an arbitrary delimiter.  
Type: String  
Required: No

 ** QuoteCharacter **   <a name="AmazonS3-Type-CSVOutput-QuoteCharacter"></a>
A single character used for escaping when the field delimiter is part of the value. For example, if the value is `a, b`, Amazon S3 wraps this field value in quotation marks, as follows: `" a , b "`.  
Type: String  
Required: No

 ** QuoteEscapeCharacter **   <a name="AmazonS3-Type-CSVOutput-QuoteEscapeCharacter"></a>
The single character used for escaping the quote character inside an already escaped value.  
Type: String  
Required: No

 ** QuoteFields **   <a name="AmazonS3-Type-CSVOutput-QuoteFields"></a>
Indicates whether to use quotation marks around output fields.   
+  `ALWAYS`: Always use quotation marks for output fields.
+  `ASNEEDED`: Use quotation marks for output fields when needed.
Type: String  
Valid Values: `ALWAYS | ASNEEDED`   
Required: No

 ** RecordDelimiter **   <a name="AmazonS3-Type-CSVOutput-RecordDelimiter"></a>
A single character used to separate individual records in the output. Instead of the default value, you can specify an arbitrary delimiter.  
Type: String  
Required: No

## See Also
<a name="API_CSVOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/CSVOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/CSVOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/CSVOutput) 

# DefaultRetention
<a name="API_DefaultRetention"></a>

The container element for optionally specifying the default Object Lock retention settings for new objects placed in the specified bucket.

**Note**  
The `DefaultRetention` settings require both a mode and a period.
The `DefaultRetention` period can be either `Days` or `Years` but you must select one. You cannot specify `Days` and `Years` at the same time.

## Contents
<a name="API_DefaultRetention_Contents"></a>

 ** Days **   <a name="AmazonS3-Type-DefaultRetention-Days"></a>
The number of days that you want to specify for the default retention period. Must be used with `Mode`.  
Type: Integer  
Required: No

 ** Mode **   <a name="AmazonS3-Type-DefaultRetention-Mode"></a>
The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. Must be used with either `Days` or `Years`.  
Type: String  
Valid Values: `GOVERNANCE | COMPLIANCE`   
Required: No

 ** Years **   <a name="AmazonS3-Type-DefaultRetention-Years"></a>
The number of years that you want to specify for the default retention period. Must be used with `Mode`.  
Type: Integer  
Required: No

## See Also
<a name="API_DefaultRetention_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/DefaultRetention) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/DefaultRetention) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/DefaultRetention) 

# Delete
<a name="API_Delete"></a>

Container for the objects to delete.

## Contents
<a name="API_Delete_Contents"></a>

 ** Objects **   <a name="AmazonS3-Type-Delete-Objects"></a>
The object to delete.  
 **Directory buckets** - For directory buckets, an object that's composed entirely of whitespace characters is not supported by the `DeleteObjects` API operation. The request will receive a `400 Bad Request` error and none of the objects in the request will be deleted.
Type: Array of [ObjectIdentifier](API_ObjectIdentifier.md) data types  
Required: Yes

 ** Quiet **   <a name="AmazonS3-Type-Delete-Quiet"></a>
Element to enable quiet mode for the request. When you add this element, you must set its value to `true`.  
Type: Boolean  
Required: No

## See Also
<a name="API_Delete_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/Delete) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/Delete) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/Delete) 

# DeletedObject
<a name="API_DeletedObject"></a>

Information about the deleted object.

## Contents
<a name="API_DeletedObject_Contents"></a>

 ** DeleteMarker **   <a name="AmazonS3-Type-DeletedObject-DeleteMarker"></a>
Indicates whether the specified object version that was permanently deleted was (true) or was not (false) a delete marker before deletion. In a simple DELETE, this header indicates whether (true) or not (false) the current version of the object is a delete marker. To learn more about delete markers, see [Working with delete markers](https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeleteMarker.html).  
This functionality is not supported for directory buckets.
Type: Boolean  
Required: No

 ** DeleteMarkerVersionId **   <a name="AmazonS3-Type-DeletedObject-DeleteMarkerVersionId"></a>
The version ID of the delete marker created as a result of the DELETE operation. If you delete a specific object version, the value returned by this header is the version ID of the object version deleted.  
This functionality is not supported for directory buckets.
Type: String  
Required: No

 ** Key **   <a name="AmazonS3-Type-DeletedObject-Key"></a>
The name of the deleted object.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** VersionId **   <a name="AmazonS3-Type-DeletedObject-VersionId"></a>
The version ID of the deleted object.  
This functionality is not supported for directory buckets.
Type: String  
Required: No

## See Also
<a name="API_DeletedObject_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/DeletedObject) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/DeletedObject) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/DeletedObject) 

# DeleteMarkerEntry
<a name="API_DeleteMarkerEntry"></a>

Information about the delete marker.

## Contents
<a name="API_DeleteMarkerEntry_Contents"></a>

 ** IsLatest **   <a name="AmazonS3-Type-DeleteMarkerEntry-IsLatest"></a>
Specifies whether the object is (true) or is not (false) the latest version of an object.   
Type: Boolean  
Required: No

 ** Key **   <a name="AmazonS3-Type-DeleteMarkerEntry-Key"></a>
The object key.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** LastModified **   <a name="AmazonS3-Type-DeleteMarkerEntry-LastModified"></a>
Date and time when the object was last modified.  
Type: Timestamp  
Required: No

 ** Owner **   <a name="AmazonS3-Type-DeleteMarkerEntry-Owner"></a>
The account that created the delete marker.   
Type: [Owner](API_Owner.md) data type  
Required: No

 ** VersionId **   <a name="AmazonS3-Type-DeleteMarkerEntry-VersionId"></a>
Version ID of an object.  
Type: String  
Required: No

## See Also
<a name="API_DeleteMarkerEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/DeleteMarkerEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/DeleteMarkerEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/DeleteMarkerEntry) 

# DeleteMarkerReplication
<a name="API_DeleteMarkerReplication"></a>

Specifies whether Amazon S3 replicates delete markers. If you specify a `Filter` in your replication configuration, you must also include a `DeleteMarkerReplication` element. If your `Filter` includes a `Tag` element, the `DeleteMarkerReplication` `Status` must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). 

For more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html). 

**Note**  
If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations).

## Contents
<a name="API_DeleteMarkerReplication_Contents"></a>

 ** Status **   <a name="AmazonS3-Type-DeleteMarkerReplication-Status"></a>
Indicates whether to replicate delete markers.  
Indicates whether to replicate delete markers.
Type: String  
Valid Values: `Enabled | Disabled`   
Required: No

## See Also
<a name="API_DeleteMarkerReplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/DeleteMarkerReplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/DeleteMarkerReplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/DeleteMarkerReplication) 

# Destination
<a name="API_Destination"></a>

Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC).

## Contents
<a name="API_Destination_Contents"></a>

 ** Bucket **   <a name="AmazonS3-Type-Destination-Bucket"></a>
 The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.  
Type: String  
Required: Yes

 ** AccessControlTranslation **   <a name="AmazonS3-Type-Destination-AccessControlTranslation"></a>
Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS account that owns the source object.  
Type: [AccessControlTranslation](API_AccessControlTranslation.md) data type  
Required: No

 ** Account **   <a name="AmazonS3-Type-Destination-Account"></a>
Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the AWS account that owns the destination bucket by specifying the `AccessControlTranslation` property, this is the account ID of the destination bucket owner. For more information, see [Replication Additional Configuration: Changing the Replica Owner](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-change-owner.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** EncryptionConfiguration **   <a name="AmazonS3-Type-Destination-EncryptionConfiguration"></a>
A container that provides information about encryption. If `SourceSelectionCriteria` is specified, you must specify this element.  
Type: [EncryptionConfiguration](API_EncryptionConfiguration.md) data type  
Required: No

 ** Metrics **   <a name="AmazonS3-Type-Destination-Metrics"></a>
 A container specifying replication metrics-related settings enabling replication metrics and events.   
Type: [Metrics](API_Metrics.md) data type  
Required: No

 ** ReplicationTime **   <a name="AmazonS3-Type-Destination-ReplicationTime"></a>
 A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a `Metrics` block.   
Type: [ReplicationTime](API_ReplicationTime.md) data type  
Required: No

 ** StorageClass **   <a name="AmazonS3-Type-Destination-StorageClass"></a>
 The storage class to use when replicating objects, such as S3 Standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica.   
For valid values, see the `StorageClass` element of the [PUT Bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) action in the *Amazon S3 API Reference*.  
 `FSX_OPENZFS` is not an accepted value when replicating objects.  
Type: String  
Valid Values: `STANDARD | REDUCED_REDUNDANCY | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_IR | SNOW | EXPRESS_ONEZONE | FSX_OPENZFS | FSX_ONTAP`   
Required: No

## See Also
<a name="API_Destination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/Destination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/Destination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/Destination) 

# DestinationResult
<a name="API_DestinationResult"></a>

 The destination information for the S3 Metadata configuration. 

## Contents
<a name="API_DestinationResult_Contents"></a>

 ** TableBucketArn **   <a name="AmazonS3-Type-DestinationResult-TableBucketArn"></a>
 The Amazon Resource Name (ARN) of the table bucket where the metadata configuration is stored.   
Type: String  
Required: No

 ** TableBucketType **   <a name="AmazonS3-Type-DestinationResult-TableBucketType"></a>
 The type of the table bucket where the metadata configuration is stored. The `aws` value indicates an AWS managed table bucket, and the `customer` value indicates a customer-managed table bucket. V2 metadata configurations are stored in AWS managed table buckets, and V1 metadata configurations are stored in customer-managed table buckets.   
Type: String  
Valid Values: `aws | customer`   
Required: No

 ** TableNamespace **   <a name="AmazonS3-Type-DestinationResult-TableNamespace"></a>
 The namespace in the table bucket where the metadata tables for a metadata configuration are stored.   
Type: String  
Required: No

## See Also
<a name="API_DestinationResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/DestinationResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/DestinationResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/DestinationResult) 

# Encryption
<a name="API_Encryption"></a>

Contains the type of server-side encryption used.

## Contents
<a name="API_Encryption_Contents"></a>

 ** EncryptionType **   <a name="AmazonS3-Type-Encryption-EncryptionType"></a>
The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, `aws:kms`).  
Type: String  
Valid Values: `AES256 | aws:fsx | aws:kms | aws:kms:dsse`   
Required: Yes

 ** KMSContext **   <a name="AmazonS3-Type-Encryption-KMSContext"></a>
If the encryption type is `aws:kms`, this optional value can be used to specify the encryption context for the restore results.  
Type: String  
Required: No

 ** KMSKeyId **   <a name="AmazonS3-Type-Encryption-KMSKeyId"></a>
If the encryption type is `aws:kms`, this optional value specifies the ID of the symmetric encryption customer managed key to use for encryption of job results. Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the * AWS Key Management Service Developer Guide*.  
Type: String  
Required: No

## See Also
<a name="API_Encryption_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/Encryption) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/Encryption) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/Encryption) 

# EncryptionConfiguration
<a name="API_EncryptionConfiguration"></a>

Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.

**Note**  
If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then AWS KMS resolves the key within the requester’s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner.

## Contents
<a name="API_EncryptionConfiguration_Contents"></a>

 ** ReplicaKmsKeyID **   <a name="AmazonS3-Type-EncryptionConfiguration-ReplicaKmsKeyID"></a>
Specifies the ID (Key ARN or Alias ARN) of the customer managed AWS KMS key stored in AWS Key Management Service (KMS) for the destination bucket. Amazon S3 uses this key to encrypt replica objects. Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the * AWS Key Management Service Developer Guide*.  
Type: String  
Required: No

## See Also
<a name="API_EncryptionConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/EncryptionConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/EncryptionConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/EncryptionConfiguration) 

# EndEvent
<a name="API_EndEvent"></a>

A message that indicates the request is complete and no more messages will be sent. You should not assume that the request is complete until the client receives an `EndEvent`.

## Contents
<a name="API_EndEvent_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_EndEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/EndEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/EndEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/EndEvent) 

# Error
<a name="API_Error"></a>

Container for all error elements.

## Contents
<a name="API_Error_Contents"></a>

 ** Code **   <a name="AmazonS3-Type-Error-Code"></a>
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type. The following is a list of Amazon S3 error codes. For more information, see [Error responses](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html).  
+ 
  +  *Code:* AccessDenied 
  +  *Description:* Access Denied
  +  *HTTP Status Code:* 403 Forbidden
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* AccountProblem
  +  *Description:* There is a problem with your AWS account that prevents the action from completing successfully. Contact AWS Support for further assistance.
  +  *HTTP Status Code:* 403 Forbidden
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* AllAccessDisabled
  +  *Description:* All access to this Amazon S3 resource has been disabled. Contact AWS Support for further assistance.
  +  *HTTP Status Code:* 403 Forbidden
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* AmbiguousGrantByEmailAddress
  +  *Description:* The email address you provided is associated with more than one account.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* AuthorizationHeaderMalformed
  +  *Description:* The authorization header you provided is invalid.
  +  *HTTP Status Code:* 400 Bad Request
  +  *HTTP Status Code:* N/A
+ 
  +  *Code:* BadDigest
  +  *Description:* The Content-MD5 you specified did not match what we received.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* BucketAlreadyExists
  +  *Description:* The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again.
  +  *HTTP Status Code:* 409 Conflict
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* BucketAlreadyOwnedByYou
  +  *Description:* The bucket you tried to create already exists, and you own it. Amazon S3 returns this error in all AWS Regions except in the North Virginia Region. For legacy compatibility, if you re-create an existing bucket that you already own in the North Virginia Region, Amazon S3 returns 200 OK and resets the bucket access control lists (ACLs).
  +  *Code:* 409 Conflict (in all Regions except the North Virginia Region) 
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* BucketNotEmpty
  +  *Description:* The bucket you tried to delete is not empty.
  +  *HTTP Status Code:* 409 Conflict
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* CredentialsNotSupported
  +  *Description:* This request does not support credentials.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* CrossLocationLoggingProhibited
  +  *Description:* Cross-location logging not allowed. Buckets in one geographic location cannot log information to a bucket in another location.
  +  *HTTP Status Code:* 403 Forbidden
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* EntityTooSmall
  +  *Description:* Your proposed upload is smaller than the minimum allowed object size.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* EntityTooLarge
  +  *Description:* Your proposed upload exceeds the maximum allowed object size.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* ExpiredToken
  +  *Description:* The provided token has expired.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* IllegalVersioningConfigurationException 
  +  *Description:* Indicates that the versioning configuration specified in the request is invalid.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* IncompleteBody
  +  *Description:* You did not provide the number of bytes specified by the Content-Length HTTP header
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* IncorrectNumberOfFilesInPostRequest
  +  *Description:* POST requires exactly one file upload per request.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* InlineDataTooLarge
  +  *Description:* Inline data exceeds the maximum allowed size.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* InternalError
  +  *Description:* We encountered an internal error. Please try again.
  +  *HTTP Status Code:* 500 Internal Server Error
  +  *SOAP Fault Code Prefix:* Server
+ 
  +  *Code:* InvalidAccessKeyId
  +  *Description:* The AWS access key ID you provided does not exist in our records.
  +  *HTTP Status Code:* 403 Forbidden
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* InvalidAddressingHeader
  +  *Description:* You must specify the Anonymous role.
  +  *HTTP Status Code:* N/A
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* InvalidArgument
  +  *Description:* Invalid Argument
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* InvalidBucketName
  +  *Description:* The specified bucket is not valid.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* InvalidBucketState
  +  *Description:* The request is not valid with the current state of the bucket.
  +  *HTTP Status Code:* 409 Conflict
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* InvalidDigest
  +  *Description:* The Content-MD5 you specified is not valid.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* InvalidEncryptionAlgorithmError
  +  *Description:* The encryption request you specified is not valid. The valid value is AES256.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* InvalidLocationConstraint
  +  *Description:* The specified location constraint is not valid. For more information about Regions, see [How to Select a Region for Your Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro). 
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* InvalidObjectState
  +  *Description:* The action is not valid for the current state of the object.
  +  *HTTP Status Code:* 403 Forbidden
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* InvalidPart
  +  *Description:* One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* InvalidPartOrder
  +  *Description:* The list of parts was not in ascending order. Parts list must be specified in order by part number.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* InvalidPayer
  +  *Description:* All access to this object has been disabled. Please contact AWS Support for further assistance.
  +  *HTTP Status Code:* 403 Forbidden
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* InvalidPolicyDocument
  +  *Description:* The content of the form does not meet the conditions specified in the policy document.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* InvalidRange
  +  *Description:* The requested range cannot be satisfied.
  +  *HTTP Status Code:* 416 Requested Range Not Satisfiable
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* InvalidRequest
  +  *Description:* Please use `AWS4-HMAC-SHA256`.
  +  *HTTP Status Code:* 400 Bad Request
  +  *Code:* N/A
+ 
  +  *Code:* InvalidRequest
  +  *Description:* SOAP requests must be made over an HTTPS connection.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* InvalidRequest
  +  *Description:* Amazon S3 Transfer Acceleration is not supported for buckets with non-DNS compliant names.
  +  *HTTP Status Code:* 400 Bad Request
  +  *Code:* N/A
+ 
  +  *Code:* InvalidRequest
  +  *Description:* Amazon S3 Transfer Acceleration is not supported for buckets with periods (.) in their names.
  +  *HTTP Status Code:* 400 Bad Request
  +  *Code:* N/A
+ 
  +  *Code:* InvalidRequest
  +  *Description:* Amazon S3 Transfer Accelerate endpoint only supports virtual style requests.
  +  *HTTP Status Code:* 400 Bad Request
  +  *Code:* N/A
+ 
  +  *Code:* InvalidRequest
  +  *Description:* Amazon S3 Transfer Accelerate is not configured on this bucket.
  +  *HTTP Status Code:* 400 Bad Request
  +  *Code:* N/A
+ 
  +  *Code:* InvalidRequest
  +  *Description:* Amazon S3 Transfer Accelerate is disabled on this bucket.
  +  *HTTP Status Code:* 400 Bad Request
  +  *Code:* N/A
+ 
  +  *Code:* InvalidRequest
  +  *Description:* Amazon S3 Transfer Acceleration is not supported on this bucket. Contact AWS Support for more information.
  +  *HTTP Status Code:* 400 Bad Request
  +  *Code:* N/A
+ 
  +  *Code:* InvalidRequest
  +  *Description:* Amazon S3 Transfer Acceleration cannot be enabled on this bucket. Contact AWS Support for more information.
  +  *HTTP Status Code:* 400 Bad Request
  +  *Code:* N/A
+ 
  +  *Code:* InvalidSecurity
  +  *Description:* The provided security credentials are not valid.
  +  *HTTP Status Code:* 403 Forbidden
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* InvalidSOAPRequest
  +  *Description:* The SOAP request body is invalid.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* InvalidStorageClass
  +  *Description:* The storage class you specified is not valid.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* InvalidTargetBucketForLogging
  +  *Description:* The target bucket for logging does not exist, is not owned by you, or does not have the appropriate grants for the log-delivery group. 
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* InvalidToken
  +  *Description:* The provided token is malformed or otherwise invalid.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* InvalidURI
  +  *Description:* Couldn't parse the specified URI.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* KeyTooLongError
  +  *Description:* Your key is too long.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* MalformedACLError
  +  *Description:* The XML you provided was not well-formed or did not validate against our published schema.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* MalformedPOSTRequest 
  +  *Description:* The body of your POST request is not well-formed multipart/form-data.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* MalformedXML
  +  *Description:* This happens when the user sends malformed XML (XML that doesn't conform to the published XSD) for the configuration. The error message is, "The XML you provided was not well-formed or did not validate against our published schema." 
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* MaxMessageLengthExceeded
  +  *Description:* Your request was too big.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* MaxPostPreDataLengthExceededError
  +  *Description:* Your POST request fields preceding the upload file were too large.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* MetadataTooLarge
  +  *Description:* Your metadata headers exceed the maximum allowed metadata size.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* MethodNotAllowed
  +  *Description:* The specified method is not allowed against this resource.
  +  *HTTP Status Code:* 405 Method Not Allowed
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* MissingAttachment
  +  *Description:* A SOAP attachment was expected, but none were found.
  +  *HTTP Status Code:* N/A
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* MissingContentLength
  +  *Description:* You must provide the Content-Length HTTP header.
  +  *HTTP Status Code:* 411 Length Required
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* MissingRequestBodyError
  +  *Description:* This happens when the user sends an empty XML document as a request. The error message is, "Request body is empty." 
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* MissingSecurityElement
  +  *Description:* The SOAP 1.1 request is missing a security element.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* MissingSecurityHeader
  +  *Description:* Your request is missing a required header.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* NoLoggingStatusForKey
  +  *Description:* There is no such thing as a logging status subresource for a key.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* NoSuchBucket
  +  *Description:* The specified bucket does not exist.
  +  *HTTP Status Code:* 404 Not Found
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* NoSuchBucketPolicy
  +  *Description:* The specified bucket does not have a bucket policy.
  +  *HTTP Status Code:* 404 Not Found
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* NoSuchKey
  +  *Description:* The specified key does not exist.
  +  *HTTP Status Code:* 404 Not Found
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* NoSuchLifecycleConfiguration
  +  *Description:* The lifecycle configuration does not exist. 
  +  *HTTP Status Code:* 404 Not Found
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* NoSuchUpload
  +  *Description:* The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.
  +  *HTTP Status Code:* 404 Not Found
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* NoSuchVersion 
  +  *Description:* Indicates that the version ID specified in the request does not match an existing version.
  +  *HTTP Status Code:* 404 Not Found
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* NotImplemented
  +  *Description:* A header you provided implies functionality that is not implemented.
  +  *HTTP Status Code:* 501 Not Implemented
  +  *SOAP Fault Code Prefix:* Server
+ 
  +  *Code:* NotSignedUp
  +  *Description:* Your account is not signed up for the Amazon S3 service. You must sign up before you can use Amazon S3. You can sign up at the following URL: [Amazon S3](http://aws.amazon.com/s3) 
  +  *HTTP Status Code:* 403 Forbidden
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* OperationAborted
  +  *Description:* A conflicting conditional action is currently in progress against this resource. Try again.
  +  *HTTP Status Code:* 409 Conflict
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* PermanentRedirect
  +  *Description:* The bucket you are attempting to access must be addressed using the specified endpoint. Send all future requests to this endpoint.
  +  *HTTP Status Code:* 301 Moved Permanently
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* PreconditionFailed
  +  *Description:* At least one of the preconditions you specified did not hold.
  +  *HTTP Status Code:* 412 Precondition Failed
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* Redirect
  +  *Description:* Temporary redirect.
  +  *HTTP Status Code:* 307 Moved Temporarily
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* RestoreAlreadyInProgress
  +  *Description:* Object restore is already in progress.
  +  *HTTP Status Code:* 409 Conflict
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* RequestIsNotMultiPartContent
  +  *Description:* Bucket POST must be of the enclosure-type multipart/form-data.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* RequestTimeout
  +  *Description:* Your socket connection to the server was not read from or written to within the timeout period.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* RequestTimeTooSkewed
  +  *Description:* The difference between the request time and the server's time is too large.
  +  *HTTP Status Code:* 403 Forbidden
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* RequestTorrentOfBucketError
  +  *Description:* Requesting the torrent file of a bucket is not permitted.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* SignatureDoesNotMatch
  +  *Description:* The request signature we calculated does not match the signature you provided. Check your AWS secret access key and signing method. For more information, see [REST Authentication](https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html) and [SOAP Authentication](https://docs.aws.amazon.com/AmazonS3/latest/dev/SOAPAuthentication.html) for details.
  +  *HTTP Status Code:* 403 Forbidden
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* ServiceUnavailable
  +  *Description:* Service is unable to handle request.
  +  *HTTP Status Code:* 503 Service Unavailable
  +  *SOAP Fault Code Prefix:* Server
+ 
  +  *Code:* SlowDown
  +  *Description:* Reduce your request rate.
  +  *HTTP Status Code:* 503 Slow Down
  +  *SOAP Fault Code Prefix:* Server
+ 
  +  *Code:* TemporaryRedirect
  +  *Description:* You are being redirected to the bucket while DNS updates.
  +  *HTTP Status Code:* 307 Moved Temporarily
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* TokenRefreshRequired
  +  *Description:* The provided token must be refreshed.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* TooManyBuckets
  +  *Description:* You have attempted to create more buckets than allowed.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* UnexpectedContent
  +  *Description:* This request does not support content.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* UnresolvableGrantByEmailAddress
  +  *Description:* The email address you provided does not match any account on record.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
+ 
  +  *Code:* UserKeyMustBeSpecified
  +  *Description:* The bucket POST must contain the specified field name. If it is specified, check the order of the fields.
  +  *HTTP Status Code:* 400 Bad Request
  +  *SOAP Fault Code Prefix:* Client
  
Type: String  
Required: No

 ** Key **   <a name="AmazonS3-Type-Error-Key"></a>
The error key.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** Message **   <a name="AmazonS3-Type-Error-Message"></a>
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.  
Type: String  
Required: No

 ** VersionId **   <a name="AmazonS3-Type-Error-VersionId"></a>
The version ID of the error.  
This functionality is not supported for directory buckets.
Type: String  
Required: No

## See Also
<a name="API_Error_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/Error) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/Error) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/Error) 

# ErrorDetails
<a name="API_ErrorDetails"></a>

 If an S3 Metadata V1 `CreateBucketMetadataTableConfiguration` or V2 `CreateBucketMetadataConfiguration` request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code and error message. 

**Note**  
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html) so that you can expire journal table records and create a live inventory table.

## Contents
<a name="API_ErrorDetails_Contents"></a>

 ** ErrorCode **   <a name="AmazonS3-Type-ErrorDetails-ErrorCode"></a>
 If the V1 `CreateBucketMetadataTableConfiguration` request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:   
+  `AccessDeniedCreatingResources` - You don't have sufficient permissions to create the required resources. Make sure that you have `s3tables:CreateNamespace`, `s3tables:CreateTable`, `s3tables:GetTable` and `s3tables:PutTablePolicy` permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. 
+  `AccessDeniedWritingToTable` - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
+  `DestinationTableNotFound` - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
+  `ServerInternalError` - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
+  `TableAlreadyExists` - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
+  `TableBucketNotFound` - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
 If the V2 `CreateBucketMetadataConfiguration` request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:   
+  `AccessDeniedCreatingResources` - You don't have sufficient permissions to create the required resources. Make sure that you have `s3tables:CreateTableBucket`, `s3tables:CreateNamespace`, `s3tables:CreateTable`, `s3tables:GetTable`, `s3tables:PutTablePolicy`, `kms:DescribeKey`, and `s3tables:PutTableEncryption` permissions. Additionally, ensure that the KMS key used to encrypt the table still exists, is active and has a resource policy granting access to the S3 service principals '`maintenance.s3tables.amazonaws.com`' and '`metadata.s3.amazonaws.com`'. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. 
+  `AccessDeniedWritingToTable` - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
+  `DestinationTableNotFound` - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
+  `ServerInternalError` - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
+  `JournalTableAlreadyExists` - A journal table already exists in the AWS managed table bucket's namespace. Delete the journal table, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
+  `InventoryTableAlreadyExists` - An inventory table already exists in the AWS managed table bucket's namespace. Delete the inventory table, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
+  `JournalTableNotAvailable` - The journal table that the inventory table relies on has a `FAILED` status. An inventory table requires a journal table with an `ACTIVE` status. To create a new journal or inventory table, you must delete the metadata configuration for this bucket, along with any journal or inventory tables, and then create a new metadata configuration.
+  `NoSuchBucket` - The specified general purpose bucket does not exist.
Type: String  
Required: No

 ** ErrorMessage **   <a name="AmazonS3-Type-ErrorDetails-ErrorMessage"></a>
 If the V1 `CreateBucketMetadataTableConfiguration` request succeeds, but S3 Metadata was unable to create the table, this structure contains the error message. The possible error codes and error messages are as follows:   
+  `AccessDeniedCreatingResources` - You don't have sufficient permissions to create the required resources. Make sure that you have `s3tables:CreateNamespace`, `s3tables:CreateTable`, `s3tables:GetTable` and `s3tables:PutTablePolicy` permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. 
+  `AccessDeniedWritingToTable` - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
+  `DestinationTableNotFound` - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
+  `ServerInternalError` - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
+  `TableAlreadyExists` - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
+  `TableBucketNotFound` - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
 If the V2 `CreateBucketMetadataConfiguration` request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:   
+  `AccessDeniedCreatingResources` - You don't have sufficient permissions to create the required resources. Make sure that you have `s3tables:CreateTableBucket`, `s3tables:CreateNamespace`, `s3tables:CreateTable`, `s3tables:GetTable`, `s3tables:PutTablePolicy`, `kms:DescribeKey`, and `s3tables:PutTableEncryption` permissions. Additionally, ensure that the KMS key used to encrypt the table still exists, is active and has a resource policy granting access to the S3 service principals '`maintenance.s3tables.amazonaws.com`' and '`metadata.s3.amazonaws.com`'. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. 
+  `AccessDeniedWritingToTable` - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
+  `DestinationTableNotFound` - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
+  `ServerInternalError` - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
+  `JournalTableAlreadyExists` - A journal table already exists in the AWS managed table bucket's namespace. Delete the journal table, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
+  `InventoryTableAlreadyExists` - An inventory table already exists in the AWS managed table bucket's namespace. Delete the inventory table, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
+  `JournalTableNotAvailable` - The journal table that the inventory table relies on has a `FAILED` status. An inventory table requires a journal table with an `ACTIVE` status. To create a new journal or inventory table, you must delete the metadata configuration for this bucket, along with any journal or inventory tables, and then create a new metadata configuration.
+  `NoSuchBucket` - The specified general purpose bucket does not exist.
Type: String  
Required: No

## See Also
<a name="API_ErrorDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ErrorDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ErrorDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ErrorDetails) 

# ErrorDocument
<a name="API_ErrorDocument"></a>

The error information.

## Contents
<a name="API_ErrorDocument_Contents"></a>

 ** Key **   <a name="AmazonS3-Type-ErrorDocument-Key"></a>
The object key name to use when a 4XX class error occurs.  
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).
Type: String  
Length Constraints: Minimum length of 1.  
Required: Yes

## See Also
<a name="API_ErrorDocument_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ErrorDocument) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ErrorDocument) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ErrorDocument) 

# EventBridgeConfiguration
<a name="API_EventBridgeConfiguration"></a>

A container for specifying the configuration for Amazon EventBridge.

## Contents
<a name="API_EventBridgeConfiguration_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_EventBridgeConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/EventBridgeConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/EventBridgeConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/EventBridgeConfiguration) 

# ExistingObjectReplication
<a name="API_ExistingObjectReplication"></a>

Optional configuration to replicate existing source bucket objects. 

**Note**  
This parameter is no longer supported. To replicate existing objects, see [Replicating existing objects with S3 Batch Replication](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-batch-replication-batch.html) in the *Amazon S3 User Guide*.

## Contents
<a name="API_ExistingObjectReplication_Contents"></a>

 ** Status **   <a name="AmazonS3-Type-ExistingObjectReplication-Status"></a>
Specifies whether Amazon S3 replicates existing source bucket objects.   
Type: String  
Valid Values: `Enabled | Disabled`   
Required: Yes

## See Also
<a name="API_ExistingObjectReplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ExistingObjectReplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ExistingObjectReplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ExistingObjectReplication) 

# FilterRule
<a name="API_FilterRule"></a>

Specifies the Amazon S3 object key name to filter on. An object key name is the name assigned to an object in your Amazon S3 bucket. You specify whether to filter on the suffix or prefix of the object key name. A prefix is a specific string of characters at the beginning of an object key name, which you can use to organize objects. For example, you can start the key names of related objects with a prefix, such as `2023-` or `engineering/`. Then, you can use `FilterRule` to find objects in a bucket with key names that have the same prefix. A suffix is similar to a prefix, but it is at the end of the object key name instead of at the beginning.

## Contents
<a name="API_FilterRule_Contents"></a>

 ** Name **   <a name="AmazonS3-Type-FilterRule-Name"></a>
The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see [Configuring Event Notifications](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*.  
Type: String  
Valid Values: `prefix | suffix`   
Required: No

 ** Value **   <a name="AmazonS3-Type-FilterRule-Value"></a>
The value that the filter searches for in object key names.  
Type: String  
Required: No

## See Also
<a name="API_FilterRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/FilterRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/FilterRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/FilterRule) 

# GetBucketMetadataConfigurationResult
<a name="API_GetBucketMetadataConfigurationResult"></a>

 The S3 Metadata configuration for a general purpose bucket. 

## Contents
<a name="API_GetBucketMetadataConfigurationResult_Contents"></a>

 ** MetadataConfigurationResult **   <a name="AmazonS3-Type-GetBucketMetadataConfigurationResult-MetadataConfigurationResult"></a>
 The metadata configuration for a general purpose bucket.   
Type: [MetadataConfigurationResult](API_MetadataConfigurationResult.md) data type  
Required: Yes

## See Also
<a name="API_GetBucketMetadataConfigurationResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/GetBucketMetadataConfigurationResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/GetBucketMetadataConfigurationResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/GetBucketMetadataConfigurationResult) 

# GetBucketMetadataTableConfigurationResult
<a name="API_GetBucketMetadataTableConfigurationResult"></a>

 The V1 S3 Metadata configuration for a general purpose bucket. 

**Note**  
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html) so that you can expire journal table records and create a live inventory table.

## Contents
<a name="API_GetBucketMetadataTableConfigurationResult_Contents"></a>

 ** MetadataTableConfigurationResult **   <a name="AmazonS3-Type-GetBucketMetadataTableConfigurationResult-MetadataTableConfigurationResult"></a>
 The V1 S3 Metadata configuration for a general purpose bucket.   
Type: [MetadataTableConfigurationResult](API_MetadataTableConfigurationResult.md) data type  
Required: Yes

 ** Status **   <a name="AmazonS3-Type-GetBucketMetadataTableConfigurationResult-Status"></a>
 The status of the metadata table. The status values are:   
+  `CREATING` - The metadata table is in the process of being created in the specified table bucket.
+  `ACTIVE` - The metadata table has been created successfully, and records are being delivered to the table. 
+  `FAILED` - Amazon S3 is unable to create the metadata table, or Amazon S3 is unable to deliver records. See `ErrorDetails` for details.
Type: String  
Required: Yes

 ** Error **   <a name="AmazonS3-Type-GetBucketMetadataTableConfigurationResult-Error"></a>
 If the `CreateBucketMetadataTableConfiguration` request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code and error message.   
Type: [ErrorDetails](API_ErrorDetails.md) data type  
Required: No

## See Also
<a name="API_GetBucketMetadataTableConfigurationResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/GetBucketMetadataTableConfigurationResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/GetBucketMetadataTableConfigurationResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/GetBucketMetadataTableConfigurationResult) 

# GetObjectAttributesParts
<a name="API_GetObjectAttributesParts"></a>

A collection of parts associated with a multipart upload.

## Contents
<a name="API_GetObjectAttributesParts_Contents"></a>

 ** IsTruncated **   <a name="AmazonS3-Type-GetObjectAttributesParts-IsTruncated"></a>
Indicates whether the returned list of parts is truncated. A value of `true` indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the `MaxParts` element.  
Type: Boolean  
Required: No

 ** MaxParts **   <a name="AmazonS3-Type-GetObjectAttributesParts-MaxParts"></a>
The maximum number of parts allowed in the response.  
Type: Integer  
Required: No

 ** NextPartNumberMarker **   <a name="AmazonS3-Type-GetObjectAttributesParts-NextPartNumberMarker"></a>
When a list is truncated, this element specifies the last part in the list, as well as the value to use for the `PartNumberMarker` request parameter in a subsequent request.  
Type: Integer  
Required: No

 ** PartNumberMarker **   <a name="AmazonS3-Type-GetObjectAttributesParts-PartNumberMarker"></a>
The marker for the current part.  
Type: Integer  
Required: No

 ** Parts **   <a name="AmazonS3-Type-GetObjectAttributesParts-Parts"></a>
A container for elements related to a particular part. A response can contain zero or more `Parts` elements.  
+  **General purpose buckets** - For `GetObjectAttributes`, if an additional checksum (including `x-amz-checksum-crc32`, `x-amz-checksum-crc32c`, `x-amz-checksum-sha1`, or `x-amz-checksum-sha256`) isn't applied to the object specified in the request, the response doesn't return the `Part` element.
+  **Directory buckets** - For `GetObjectAttributes`, regardless of whether an additional checksum is applied to the object specified in the request, the response returns the `Part` element.
Type: Array of [ObjectPart](API_ObjectPart.md) data types  
Required: No

 ** TotalPartsCount **   <a name="AmazonS3-Type-GetObjectAttributesParts-TotalPartsCount"></a>
The total number of parts.  
Type: Integer  
Required: No

## See Also
<a name="API_GetObjectAttributesParts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/GetObjectAttributesParts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/GetObjectAttributesParts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/GetObjectAttributesParts) 

# GlacierJobParameters
<a name="API_GlacierJobParameters"></a>

Container for S3 Glacier job parameters.

## Contents
<a name="API_GlacierJobParameters_Contents"></a>

 ** Tier **   <a name="AmazonS3-Type-GlacierJobParameters-Tier"></a>
Retrieval tier at which the restore will be processed.  
Type: String  
Valid Values: `Standard | Bulk | Expedited`   
Required: Yes

## See Also
<a name="API_GlacierJobParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/GlacierJobParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/GlacierJobParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/GlacierJobParameters) 

# Grant
<a name="API_Grant"></a>

Container for grant information.

## Contents
<a name="API_Grant_Contents"></a>

 ** Grantee **   <a name="AmazonS3-Type-Grant-Grantee"></a>
The person being granted permissions.  
Type: [Grantee](API_Grantee.md) data type  
Required: No

 ** Permission **   <a name="AmazonS3-Type-Grant-Permission"></a>
Specifies the permission given to the grantee.  
Type: String  
Valid Values: `FULL_CONTROL | WRITE | WRITE_ACP | READ | READ_ACP`   
Required: No

## See Also
<a name="API_Grant_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/Grant) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/Grant) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/Grant) 

# Grantee
<a name="API_Grantee"></a>

Container for the person being granted permissions.

## Contents
<a name="API_Grantee_Contents"></a>

 ** Type **   <a name="AmazonS3-Type-Grantee-Type"></a>
Type of grantee  
Type: String  
Valid Values: `CanonicalUser | AmazonCustomerByEmail | Group`   
Required: Yes

 ** DisplayName **   <a name="AmazonS3-Type-Grantee-DisplayName"></a>
  
Type: String  
Required: No

 ** EmailAddress **   <a name="AmazonS3-Type-Grantee-EmailAddress"></a>
  
Type: String  
Required: No

 ** ID **   <a name="AmazonS3-Type-Grantee-ID"></a>
The canonical user ID of the grantee.  
Type: String  
Required: No

 ** URI **   <a name="AmazonS3-Type-Grantee-URI"></a>
URI of the grantee group.  
Type: String  
Required: No

## See Also
<a name="API_Grantee_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/Grantee) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/Grantee) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/Grantee) 

# IndexDocument
<a name="API_IndexDocument"></a>

Container for the `Suffix` element.

## Contents
<a name="API_IndexDocument_Contents"></a>

 ** Suffix **   <a name="AmazonS3-Type-IndexDocument-Suffix"></a>
A suffix that is appended to a request that is for a directory on the website endpoint. (For example, if the suffix is `index.html` and you make a request to `samplebucket/images/`, the data that is returned will be for the object with the key name `images/index.html`.) The suffix must not be empty and must not include a slash character.  
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).
Type: String  
Required: Yes

## See Also
<a name="API_IndexDocument_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/IndexDocument) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/IndexDocument) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/IndexDocument) 

# Initiator
<a name="API_Initiator"></a>

Container element that identifies who initiated the multipart upload. 

## Contents
<a name="API_Initiator_Contents"></a>

 ** DisplayName **   <a name="AmazonS3-Type-Initiator-DisplayName"></a>
  
This functionality is not supported for directory buckets.
Type: String  
Required: No

 ** ID **   <a name="AmazonS3-Type-Initiator-ID"></a>
If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value.  
 **Directory buckets** - If the principal is an AWS account, it provides the AWS account ID. If the principal is an IAM User, it provides a user ARN value.
Type: String  
Required: No

## See Also
<a name="API_Initiator_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/Initiator) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/Initiator) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/Initiator) 

# InputSerialization
<a name="API_InputSerialization"></a>

Describes the serialization format of the object.

## Contents
<a name="API_InputSerialization_Contents"></a>

 ** CompressionType **   <a name="AmazonS3-Type-InputSerialization-CompressionType"></a>
Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value: NONE.  
Type: String  
Valid Values: `NONE | GZIP | BZIP2`   
Required: No

 ** CSV **   <a name="AmazonS3-Type-InputSerialization-CSV"></a>
Describes the serialization of a CSV-encoded object.  
Type: [CSVInput](API_CSVInput.md) data type  
Required: No

 ** JSON **   <a name="AmazonS3-Type-InputSerialization-JSON"></a>
Specifies JSON as object's input serialization format.  
Type: [JSONInput](API_JSONInput.md) data type  
Required: No

 ** Parquet **   <a name="AmazonS3-Type-InputSerialization-Parquet"></a>
Specifies Parquet as object's input serialization format.  
Type: [ParquetInput](API_ParquetInput.md) data type  
Required: No

## See Also
<a name="API_InputSerialization_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/InputSerialization) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/InputSerialization) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/InputSerialization) 

# IntelligentTieringAndOperator
<a name="API_IntelligentTieringAndOperator"></a>

A container for specifying S3 Intelligent-Tiering filters. The filters determine the subset of objects to which the rule applies.

## Contents
<a name="API_IntelligentTieringAndOperator_Contents"></a>

 ** Prefix **   <a name="AmazonS3-Type-IntelligentTieringAndOperator-Prefix"></a>
An object key name prefix that identifies the subset of objects to which the configuration applies.  
Type: String  
Required: No

 ** Tags **   <a name="AmazonS3-Type-IntelligentTieringAndOperator-Tags"></a>
All of these tags must exist in the object's tag set in order for the configuration to apply.  
Type: Array of [Tag](API_Tag.md) data types  
Required: No

## See Also
<a name="API_IntelligentTieringAndOperator_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/IntelligentTieringAndOperator) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/IntelligentTieringAndOperator) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/IntelligentTieringAndOperator) 

# IntelligentTieringConfiguration
<a name="API_IntelligentTieringConfiguration"></a>

Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.

For information about the S3 Intelligent-Tiering storage class, see [Storage class for automatically optimizing frequently and infrequently accessed objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access).

## Contents
<a name="API_IntelligentTieringConfiguration_Contents"></a>

 ** Id **   <a name="AmazonS3-Type-IntelligentTieringConfiguration-Id"></a>
The ID used to identify the S3 Intelligent-Tiering configuration.  
Type: String  
Required: Yes

 ** Status **   <a name="AmazonS3-Type-IntelligentTieringConfiguration-Status"></a>
Specifies the status of the configuration.  
Type: String  
Valid Values: `Enabled | Disabled`   
Required: Yes

 ** Tierings **   <a name="AmazonS3-Type-IntelligentTieringConfiguration-Tierings"></a>
Specifies the S3 Intelligent-Tiering storage class tier of the configuration.  
Type: Array of [Tiering](API_Tiering.md) data types  
Required: Yes

 ** Filter **   <a name="AmazonS3-Type-IntelligentTieringConfiguration-Filter"></a>
Specifies a bucket filter. The configuration only includes objects that meet the filter's criteria.  
Type: [IntelligentTieringFilter](API_IntelligentTieringFilter.md) data type  
Required: No

## See Also
<a name="API_IntelligentTieringConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/IntelligentTieringConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/IntelligentTieringConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/IntelligentTieringConfiguration) 

# IntelligentTieringFilter
<a name="API_IntelligentTieringFilter"></a>

The `Filter` is used to identify objects that the S3 Intelligent-Tiering configuration applies to.

## Contents
<a name="API_IntelligentTieringFilter_Contents"></a>

 ** And **   <a name="AmazonS3-Type-IntelligentTieringFilter-And"></a>
A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.  
Type: [IntelligentTieringAndOperator](API_IntelligentTieringAndOperator.md) data type  
Required: No

 ** Prefix **   <a name="AmazonS3-Type-IntelligentTieringFilter-Prefix"></a>
An object key name prefix that identifies the subset of objects to which the rule applies.  
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).
Type: String  
Required: No

 ** Tag **   <a name="AmazonS3-Type-IntelligentTieringFilter-Tag"></a>
A container of a key value name pair.  
Type: [Tag](API_Tag.md) data type  
Required: No

## See Also
<a name="API_IntelligentTieringFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/IntelligentTieringFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/IntelligentTieringFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/IntelligentTieringFilter) 

# InventoryConfiguration
<a name="API_InventoryConfiguration"></a>

Specifies the S3 Inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket inventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the *Amazon S3 API Reference*. 

## Contents
<a name="API_InventoryConfiguration_Contents"></a>

 ** Destination **   <a name="AmazonS3-Type-InventoryConfiguration-Destination"></a>
Contains information about where to publish the inventory results.  
Type: [InventoryDestination](API_InventoryDestination.md) data type  
Required: Yes

 ** Id **   <a name="AmazonS3-Type-InventoryConfiguration-Id"></a>
The ID used to identify the inventory configuration.  
Type: String  
Required: Yes

 ** IncludedObjectVersions **   <a name="AmazonS3-Type-InventoryConfiguration-IncludedObjectVersions"></a>
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.  
Type: String  
Valid Values: `All | Current`   
Required: Yes

 ** IsEnabled **   <a name="AmazonS3-Type-InventoryConfiguration-IsEnabled"></a>
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.  
Type: Boolean  
Required: Yes

 ** Schedule **   <a name="AmazonS3-Type-InventoryConfiguration-Schedule"></a>
Specifies the schedule for generating inventory results.  
Type: [InventorySchedule](API_InventorySchedule.md) data type  
Required: Yes

 ** Filter **   <a name="AmazonS3-Type-InventoryConfiguration-Filter"></a>
Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.  
Type: [InventoryFilter](API_InventoryFilter.md) data type  
Required: No

 ** OptionalFields **   <a name="AmazonS3-Type-InventoryConfiguration-OptionalFields"></a>
Contains the optional fields that are included in the inventory results.  
Type: Array of strings  
Valid Values: `Size | LastModifiedDate | StorageClass | ETag | IsMultipartUploaded | ReplicationStatus | EncryptionStatus | ObjectLockRetainUntilDate | ObjectLockMode | ObjectLockLegalHoldStatus | IntelligentTieringAccessTier | BucketKeyStatus | ChecksumAlgorithm | ObjectAccessControlList | ObjectOwner | LifecycleExpirationDate`   
Required: No

## See Also
<a name="API_InventoryConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/InventoryConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/InventoryConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/InventoryConfiguration) 

# InventoryDestination
<a name="API_InventoryDestination"></a>

Specifies the S3 Inventory configuration for an Amazon S3 bucket.

## Contents
<a name="API_InventoryDestination_Contents"></a>

 ** S3BucketDestination **   <a name="AmazonS3-Type-InventoryDestination-S3BucketDestination"></a>
Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.  
Type: [InventoryS3BucketDestination](API_InventoryS3BucketDestination.md) data type  
Required: Yes

## See Also
<a name="API_InventoryDestination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/InventoryDestination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/InventoryDestination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/InventoryDestination) 

# InventoryEncryption
<a name="API_InventoryEncryption"></a>

Contains the type of server-side encryption used to encrypt the S3 Inventory results.

## Contents
<a name="API_InventoryEncryption_Contents"></a>

 ** SSEKMS **   <a name="AmazonS3-Type-InventoryEncryption-SSEKMS"></a>
Specifies the use of SSE-KMS to encrypt delivered inventory reports.  
Type: [SSEKMS](API_SSEKMS.md) data type  
Required: No

 ** SSES3 **   <a name="AmazonS3-Type-InventoryEncryption-SSES3"></a>
Specifies the use of SSE-S3 to encrypt delivered inventory reports.  
Type: [SSES3](API_SSES3.md) data type  
Required: No

## See Also
<a name="API_InventoryEncryption_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/InventoryEncryption) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/InventoryEncryption) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/InventoryEncryption) 

# InventoryFilter
<a name="API_InventoryFilter"></a>

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

## Contents
<a name="API_InventoryFilter_Contents"></a>

 ** Prefix **   <a name="AmazonS3-Type-InventoryFilter-Prefix"></a>
The prefix that an object must have to be included in the inventory results.  
Type: String  
Required: Yes

## See Also
<a name="API_InventoryFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/InventoryFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/InventoryFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/InventoryFilter) 

# InventoryS3BucketDestination
<a name="API_InventoryS3BucketDestination"></a>

Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where S3 Inventory results are published.

## Contents
<a name="API_InventoryS3BucketDestination_Contents"></a>

 ** Bucket **   <a name="AmazonS3-Type-InventoryS3BucketDestination-Bucket"></a>
The Amazon Resource Name (ARN) of the bucket where inventory results will be published.  
Type: String  
Required: Yes

 ** Format **   <a name="AmazonS3-Type-InventoryS3BucketDestination-Format"></a>
Specifies the output format of the inventory results.  
Type: String  
Valid Values: `CSV | ORC | Parquet`   
Required: Yes

 ** AccountId **   <a name="AmazonS3-Type-InventoryS3BucketDestination-AccountId"></a>
The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.   
 Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes. 
Type: String  
Required: No

 ** Encryption **   <a name="AmazonS3-Type-InventoryS3BucketDestination-Encryption"></a>
Contains the type of server-side encryption used to encrypt the inventory results.  
Type: [InventoryEncryption](API_InventoryEncryption.md) data type  
Required: No

 ** Prefix **   <a name="AmazonS3-Type-InventoryS3BucketDestination-Prefix"></a>
The prefix that is prepended to all inventory results.  
Type: String  
Required: No

## See Also
<a name="API_InventoryS3BucketDestination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/InventoryS3BucketDestination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/InventoryS3BucketDestination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/InventoryS3BucketDestination) 

# InventorySchedule
<a name="API_InventorySchedule"></a>

Specifies the schedule for generating S3 Inventory results.

## Contents
<a name="API_InventorySchedule_Contents"></a>

 ** Frequency **   <a name="AmazonS3-Type-InventorySchedule-Frequency"></a>
Specifies how frequently inventory results are produced.  
Type: String  
Valid Values: `Daily | Weekly`   
Required: Yes

## See Also
<a name="API_InventorySchedule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/InventorySchedule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/InventorySchedule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/InventorySchedule) 

# InventoryTableConfiguration
<a name="API_InventoryTableConfiguration"></a>

 The inventory table configuration for an S3 Metadata configuration. 

## Contents
<a name="API_InventoryTableConfiguration_Contents"></a>

 ** ConfigurationState **   <a name="AmazonS3-Type-InventoryTableConfiguration-ConfigurationState"></a>
 The configuration state of the inventory table, indicating whether the inventory table is enabled or disabled.   
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: Yes

 ** EncryptionConfiguration **   <a name="AmazonS3-Type-InventoryTableConfiguration-EncryptionConfiguration"></a>
 The encryption configuration for the inventory table.   
Type: [MetadataTableEncryptionConfiguration](API_MetadataTableEncryptionConfiguration.md) data type  
Required: No

## See Also
<a name="API_InventoryTableConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/InventoryTableConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/InventoryTableConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/InventoryTableConfiguration) 

# InventoryTableConfigurationResult
<a name="API_InventoryTableConfigurationResult"></a>

 The inventory table configuration for an S3 Metadata configuration. 

## Contents
<a name="API_InventoryTableConfigurationResult_Contents"></a>

 ** ConfigurationState **   <a name="AmazonS3-Type-InventoryTableConfigurationResult-ConfigurationState"></a>
 The configuration state of the inventory table, indicating whether the inventory table is enabled or disabled.   
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: Yes

 ** Error **   <a name="AmazonS3-Type-InventoryTableConfigurationResult-Error"></a>
 If an S3 Metadata V1 `CreateBucketMetadataTableConfiguration` or V2 `CreateBucketMetadataConfiguration` request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code and error message.   
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html) so that you can expire journal table records and create a live inventory table.
Type: [ErrorDetails](API_ErrorDetails.md) data type  
Required: No

 ** TableArn **   <a name="AmazonS3-Type-InventoryTableConfigurationResult-TableArn"></a>
 The Amazon Resource Name (ARN) for the inventory table.   
Type: String  
Required: No

 ** TableName **   <a name="AmazonS3-Type-InventoryTableConfigurationResult-TableName"></a>
 The name of the inventory table.   
Type: String  
Required: No

 ** TableStatus **   <a name="AmazonS3-Type-InventoryTableConfigurationResult-TableStatus"></a>
 The status of the inventory table. The status values are:   
+  `CREATING` - The inventory table is in the process of being created in the specified AWS managed table bucket.
+  `BACKFILLING` - The inventory table is in the process of being backfilled. When you enable the inventory table for your metadata configuration, the table goes through a process known as backfilling, during which Amazon S3 scans your general purpose bucket to retrieve the initial metadata for all objects in the bucket. Depending on the number of objects in your bucket, this process can take several hours. When the backfilling process is finished, the status of your inventory table changes from `BACKFILLING` to `ACTIVE`. After backfilling is completed, updates to your objects are reflected in the inventory table within one hour.
+  `ACTIVE` - The inventory table has been created successfully, and records are being delivered to the table. 
+  `FAILED` - Amazon S3 is unable to create the inventory table, or Amazon S3 is unable to deliver records.
Type: String  
Required: No

## See Also
<a name="API_InventoryTableConfigurationResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/InventoryTableConfigurationResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/InventoryTableConfigurationResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/InventoryTableConfigurationResult) 

# InventoryTableConfigurationUpdates
<a name="API_InventoryTableConfigurationUpdates"></a>

 The specified updates to the S3 Metadata inventory table configuration. 

## Contents
<a name="API_InventoryTableConfigurationUpdates_Contents"></a>

 ** ConfigurationState **   <a name="AmazonS3-Type-InventoryTableConfigurationUpdates-ConfigurationState"></a>
 The configuration state of the inventory table, indicating whether the inventory table is enabled or disabled.   
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: Yes

 ** EncryptionConfiguration **   <a name="AmazonS3-Type-InventoryTableConfigurationUpdates-EncryptionConfiguration"></a>
 The encryption configuration for the inventory table.   
Type: [MetadataTableEncryptionConfiguration](API_MetadataTableEncryptionConfiguration.md) data type  
Required: No

## See Also
<a name="API_InventoryTableConfigurationUpdates_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/InventoryTableConfigurationUpdates) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/InventoryTableConfigurationUpdates) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/InventoryTableConfigurationUpdates) 

# JournalTableConfiguration
<a name="API_JournalTableConfiguration"></a>

 The journal table configuration for an S3 Metadata configuration. 

## Contents
<a name="API_JournalTableConfiguration_Contents"></a>

 ** RecordExpiration **   <a name="AmazonS3-Type-JournalTableConfiguration-RecordExpiration"></a>
 The journal table record expiration settings for the journal table.   
Type: [RecordExpiration](API_RecordExpiration.md) data type  
Required: Yes

 ** EncryptionConfiguration **   <a name="AmazonS3-Type-JournalTableConfiguration-EncryptionConfiguration"></a>
 The encryption configuration for the journal table.   
Type: [MetadataTableEncryptionConfiguration](API_MetadataTableEncryptionConfiguration.md) data type  
Required: No

## See Also
<a name="API_JournalTableConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/JournalTableConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/JournalTableConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/JournalTableConfiguration) 

# JournalTableConfigurationResult
<a name="API_JournalTableConfigurationResult"></a>

 The journal table configuration for the S3 Metadata configuration. 

## Contents
<a name="API_JournalTableConfigurationResult_Contents"></a>

 ** RecordExpiration **   <a name="AmazonS3-Type-JournalTableConfigurationResult-RecordExpiration"></a>
 The journal table record expiration settings for the journal table.   
Type: [RecordExpiration](API_RecordExpiration.md) data type  
Required: Yes

 ** TableName **   <a name="AmazonS3-Type-JournalTableConfigurationResult-TableName"></a>
 The name of the journal table.   
Type: String  
Required: Yes

 ** TableStatus **   <a name="AmazonS3-Type-JournalTableConfigurationResult-TableStatus"></a>
 The status of the journal table. The status values are:   
+  `CREATING` - The journal table is in the process of being created in the specified table bucket.
+  `ACTIVE` - The journal table has been created successfully, and records are being delivered to the table. 
+  `FAILED` - Amazon S3 is unable to create the journal table, or Amazon S3 is unable to deliver records.
Type: String  
Required: Yes

 ** Error **   <a name="AmazonS3-Type-JournalTableConfigurationResult-Error"></a>
 If an S3 Metadata V1 `CreateBucketMetadataTableConfiguration` or V2 `CreateBucketMetadataConfiguration` request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code and error message.   
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html) so that you can expire journal table records and create a live inventory table.
Type: [ErrorDetails](API_ErrorDetails.md) data type  
Required: No

 ** TableArn **   <a name="AmazonS3-Type-JournalTableConfigurationResult-TableArn"></a>
 The Amazon Resource Name (ARN) for the journal table.   
Type: String  
Required: No

## See Also
<a name="API_JournalTableConfigurationResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/JournalTableConfigurationResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/JournalTableConfigurationResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/JournalTableConfigurationResult) 

# JournalTableConfigurationUpdates
<a name="API_JournalTableConfigurationUpdates"></a>

 The specified updates to the S3 Metadata journal table configuration. 

## Contents
<a name="API_JournalTableConfigurationUpdates_Contents"></a>

 ** RecordExpiration **   <a name="AmazonS3-Type-JournalTableConfigurationUpdates-RecordExpiration"></a>
 The journal table record expiration settings for the journal table.   
Type: [RecordExpiration](API_RecordExpiration.md) data type  
Required: Yes

## See Also
<a name="API_JournalTableConfigurationUpdates_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/JournalTableConfigurationUpdates) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/JournalTableConfigurationUpdates) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/JournalTableConfigurationUpdates) 

# JSONInput
<a name="API_JSONInput"></a>

Specifies JSON as object's input serialization format.

## Contents
<a name="API_JSONInput_Contents"></a>

 ** Type **   <a name="AmazonS3-Type-JSONInput-Type"></a>
The type of JSON. Valid values: Document, Lines.  
Type: String  
Valid Values: `DOCUMENT | LINES`   
Required: No

## See Also
<a name="API_JSONInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/JSONInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/JSONInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/JSONInput) 

# JSONOutput
<a name="API_JSONOutput"></a>

Specifies JSON as request's output serialization format.

## Contents
<a name="API_JSONOutput_Contents"></a>

 ** RecordDelimiter **   <a name="AmazonS3-Type-JSONOutput-RecordDelimiter"></a>
The value used to separate individual records in the output. If no value is specified, Amazon S3 uses a newline character ('\$1n').  
Type: String  
Required: No

## See Also
<a name="API_JSONOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/JSONOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/JSONOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/JSONOutput) 

# LambdaFunctionConfiguration
<a name="API_LambdaFunctionConfiguration"></a>

A container for specifying the configuration for AWS Lambda notifications.

## Contents
<a name="API_LambdaFunctionConfiguration_Contents"></a>

 ** Events **   <a name="AmazonS3-Type-LambdaFunctionConfiguration-Events"></a>
The Amazon S3 bucket event for which to invoke the AWS Lambda function. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*.  
Type: Array of strings  
Valid Values: `s3:ReducedRedundancyLostObject | s3:ObjectCreated:* | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved:* | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated | s3:ObjectRestore:* | s3:ObjectRestore:Post | s3:ObjectRestore:Completed | s3:Replication:* | s3:Replication:OperationFailedReplication | s3:Replication:OperationNotTracked | s3:Replication:OperationMissedThreshold | s3:Replication:OperationReplicatedAfterThreshold | s3:ObjectRestore:Delete | s3:LifecycleTransition | s3:IntelligentTiering | s3:ObjectAcl:Put | s3:LifecycleExpiration:* | s3:LifecycleExpiration:Delete | s3:LifecycleExpiration:DeleteMarkerCreated | s3:ObjectTagging:* | s3:ObjectTagging:Put | s3:ObjectTagging:Delete`   
Required: Yes

 ** LambdaFunctionArn **   <a name="AmazonS3-Type-LambdaFunctionConfiguration-LambdaFunctionArn"></a>
The Amazon Resource Name (ARN) of the AWS Lambda function that Amazon S3 invokes when the specified event type occurs.  
Type: String  
Required: Yes

 ** Filter **   <a name="AmazonS3-Type-LambdaFunctionConfiguration-Filter"></a>
Specifies object key name filtering rules. For information about key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*.  
Type: [NotificationConfigurationFilter](API_NotificationConfigurationFilter.md) data type  
Required: No

 ** Id **   <a name="AmazonS3-Type-LambdaFunctionConfiguration-Id"></a>
An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.  
Type: String  
Required: No

## See Also
<a name="API_LambdaFunctionConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/LambdaFunctionConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/LambdaFunctionConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/LambdaFunctionConfiguration) 

# LifecycleConfiguration
<a name="API_LifecycleConfiguration"></a>

Container for lifecycle rules. You can add as many as 1000 rules.

For more information see, [Managing your storage lifecycle](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*.

## Contents
<a name="API_LifecycleConfiguration_Contents"></a>

 ** Rules **   <a name="AmazonS3-Type-LifecycleConfiguration-Rules"></a>
Specifies lifecycle configuration rules for an Amazon S3 bucket.   
Type: Array of [Rule](API_Rule.md) data types  
Required: Yes

## See Also
<a name="API_LifecycleConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/LifecycleConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/LifecycleConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/LifecycleConfiguration) 

# LifecycleExpiration
<a name="API_LifecycleExpiration"></a>

Container for the expiration for the lifecycle of the object.

For more information see, [Managing your storage lifecycle](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*.

## Contents
<a name="API_LifecycleExpiration_Contents"></a>

 ** Date **   <a name="AmazonS3-Type-LifecycleExpiration-Date"></a>
Indicates at what date the object is to be moved or deleted. The date value must conform to the ISO 8601 format. The time is always midnight UTC.  
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
Type: Timestamp  
Required: No

 ** Days **   <a name="AmazonS3-Type-LifecycleExpiration-Days"></a>
Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.  
Type: Integer  
Required: No

 ** ExpiredObjectDeleteMarker **   <a name="AmazonS3-Type-LifecycleExpiration-ExpiredObjectDeleteMarker"></a>
Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.  
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
Type: Boolean  
Required: No

## See Also
<a name="API_LifecycleExpiration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/LifecycleExpiration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/LifecycleExpiration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/LifecycleExpiration) 

# LifecycleRule
<a name="API_LifecycleRule"></a>

A lifecycle rule for individual objects in an Amazon S3 bucket.

For more information see, [Managing your storage lifecycle](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*.

## Contents
<a name="API_LifecycleRule_Contents"></a>

 ** Status **   <a name="AmazonS3-Type-LifecycleRule-Status"></a>
If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.  
Type: String  
Valid Values: `Enabled | Disabled`   
Required: Yes

 ** AbortIncompleteMultipartUpload **   <a name="AmazonS3-Type-LifecycleRule-AbortIncompleteMultipartUpload"></a>
Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see [ Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) in the *Amazon S3 User Guide*.  
Type: [AbortIncompleteMultipartUpload](API_AbortIncompleteMultipartUpload.md) data type  
Required: No

 ** Expiration **   <a name="AmazonS3-Type-LifecycleRule-Expiration"></a>
Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.  
Type: [LifecycleExpiration](API_LifecycleExpiration.md) data type  
Required: No

 ** Filter **   <a name="AmazonS3-Type-LifecycleRule-Filter"></a>
The `Filter` is used to identify objects that a Lifecycle Rule applies to. A `Filter` must have exactly one of `Prefix`, `Tag`, `ObjectSizeGreaterThan`, `ObjectSizeLessThan`, or `And` specified. `Filter` is required if the `LifecycleRule` does not contain a `Prefix` element.  
For more information about `Tag` filters, see [Adding filters to Lifecycle rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-filters.html) in the *Amazon S3 User Guide*.  
 `Tag` filters are not supported for directory buckets.
Type: [LifecycleRuleFilter](API_LifecycleRuleFilter.md) data type  
Required: No

 ** ID **   <a name="AmazonS3-Type-LifecycleRule-ID"></a>
Unique identifier for the rule. The value cannot be longer than 255 characters.  
Type: String  
Required: No

 ** NoncurrentVersionExpiration **   <a name="AmazonS3-Type-LifecycleRule-NoncurrentVersionExpiration"></a>
Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.  
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
Type: [NoncurrentVersionExpiration](API_NoncurrentVersionExpiration.md) data type  
Required: No

 ** NoncurrentVersionTransitions **   <a name="AmazonS3-Type-LifecycleRule-NoncurrentVersionTransitions"></a>
Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.  
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
Type: Array of [NoncurrentVersionTransition](API_NoncurrentVersionTransition.md) data types  
Required: No

 ** Prefix **   <a name="AmazonS3-Type-LifecycleRule-Prefix"></a>
 *This member has been deprecated.*   
 The general purpose bucket prefix that identifies one or more objects to which the rule applies. We recommend using `Filter` instead of `Prefix` for new PUTs. Previous configurations where a prefix is defined will continue to operate as before.  
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).
Type: String  
Required: No

 ** Transitions **   <a name="AmazonS3-Type-LifecycleRule-Transitions"></a>
Specifies when an Amazon S3 object transitions to a specified storage class.  
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
Type: Array of [Transition](API_Transition.md) data types  
Required: No

## See Also
<a name="API_LifecycleRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/LifecycleRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/LifecycleRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/LifecycleRule) 

# LifecycleRuleAndOperator
<a name="API_LifecycleRuleAndOperator"></a>

This is used in a Lifecycle Rule Filter to apply a logical AND to two or more predicates. The Lifecycle Rule will apply to any object matching all of the predicates configured inside the And operator.

## Contents
<a name="API_LifecycleRuleAndOperator_Contents"></a>

 ** ObjectSizeGreaterThan **   <a name="AmazonS3-Type-LifecycleRuleAndOperator-ObjectSizeGreaterThan"></a>
Minimum object size to which the rule applies.  
Type: Long  
Required: No

 ** ObjectSizeLessThan **   <a name="AmazonS3-Type-LifecycleRuleAndOperator-ObjectSizeLessThan"></a>
Maximum object size to which the rule applies.  
Type: Long  
Required: No

 ** Prefix **   <a name="AmazonS3-Type-LifecycleRuleAndOperator-Prefix"></a>
Prefix identifying one or more objects to which the rule applies.  
Type: String  
Required: No

 ** Tags **   <a name="AmazonS3-Type-LifecycleRuleAndOperator-Tags"></a>
All of these tags must exist in the object's tag set in order for the rule to apply.  
Type: Array of [Tag](API_Tag.md) data types  
Required: No

## See Also
<a name="API_LifecycleRuleAndOperator_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/LifecycleRuleAndOperator) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/LifecycleRuleAndOperator) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/LifecycleRuleAndOperator) 

# LifecycleRuleFilter
<a name="API_LifecycleRuleFilter"></a>

The `Filter` is used to identify objects that a Lifecycle Rule applies to. A `Filter` can have exactly one of `Prefix`, `Tag`, `ObjectSizeGreaterThan`, `ObjectSizeLessThan`, or `And` specified. If the `Filter` element is left empty, the Lifecycle Rule applies to all objects in the bucket.

## Contents
<a name="API_LifecycleRuleFilter_Contents"></a>

 ** And **   <a name="AmazonS3-Type-LifecycleRuleFilter-And"></a>
This is used in a Lifecycle Rule Filter to apply a logical AND to two or more predicates. The Lifecycle Rule will apply to any object matching all of the predicates configured inside the And operator.  
Type: [LifecycleRuleAndOperator](API_LifecycleRuleAndOperator.md) data type  
Required: No

 ** ObjectSizeGreaterThan **   <a name="AmazonS3-Type-LifecycleRuleFilter-ObjectSizeGreaterThan"></a>
Minimum object size to which the rule applies.  
Type: Long  
Required: No

 ** ObjectSizeLessThan **   <a name="AmazonS3-Type-LifecycleRuleFilter-ObjectSizeLessThan"></a>
Maximum object size to which the rule applies.  
Type: Long  
Required: No

 ** Prefix **   <a name="AmazonS3-Type-LifecycleRuleFilter-Prefix"></a>
Prefix identifying one or more objects to which the rule applies.  
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).
Type: String  
Required: No

 ** Tag **   <a name="AmazonS3-Type-LifecycleRuleFilter-Tag"></a>
This tag must exist in the object's tag set in order for the rule to apply.  
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
Type: [Tag](API_Tag.md) data type  
Required: No

## See Also
<a name="API_LifecycleRuleFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/LifecycleRuleFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/LifecycleRuleFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/LifecycleRuleFilter) 

# LocationInfo
<a name="API_LocationInfo"></a>

Specifies the location where the bucket will be created.

For directory buckets, the location type is Availability Zone or Local Zone. For more information about directory buckets, see [Working with directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html) in the *Amazon S3 User Guide*.

**Note**  
This functionality is only supported by directory buckets.

## Contents
<a name="API_LocationInfo_Contents"></a>

 ** Name **   <a name="AmazonS3-Type-LocationInfo-Name"></a>
The name of the location where the bucket will be created.  
For directory buckets, the name of the location is the Zone ID of the Availability Zone (AZ) or Local Zone (LZ) where the bucket will be created. An example AZ ID value is `usw2-az1`.  
Type: String  
Required: No

 ** Type **   <a name="AmazonS3-Type-LocationInfo-Type"></a>
The type of location where the bucket will be created.  
Type: String  
Valid Values: `AvailabilityZone | LocalZone`   
Required: No

## See Also
<a name="API_LocationInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/LocationInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/LocationInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/LocationInfo) 

# LoggingEnabled
<a name="API_LoggingEnabled"></a>

Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more information, see [PUT Bucket logging](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html) in the *Amazon S3 API Reference*.

## Contents
<a name="API_LoggingEnabled_Contents"></a>

 ** TargetBucket **   <a name="AmazonS3-Type-LoggingEnabled-TargetBucket"></a>
Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case, you should choose a different `TargetPrefix` for each source bucket so that the delivered log files can be distinguished by key.  
Type: String  
Required: Yes

 ** TargetPrefix **   <a name="AmazonS3-Type-LoggingEnabled-TargetPrefix"></a>
A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.  
Type: String  
Required: Yes

 ** TargetGrants **   <a name="AmazonS3-Type-LoggingEnabled-TargetGrants"></a>
Container for granting information.  
Buckets that use the bucket owner enforced setting for Object Ownership don't support target grants. For more information, see [Permissions for server access log delivery](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general) in the *Amazon S3 User Guide*.  
Type: Array of [TargetGrant](API_TargetGrant.md) data types  
Required: No

 ** TargetObjectKeyFormat **   <a name="AmazonS3-Type-LoggingEnabled-TargetObjectKeyFormat"></a>
Amazon S3 key format for log objects.  
Type: [TargetObjectKeyFormat](API_TargetObjectKeyFormat.md) data type  
Required: No

## See Also
<a name="API_LoggingEnabled_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/LoggingEnabled) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/LoggingEnabled) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/LoggingEnabled) 

# MetadataConfiguration
<a name="API_MetadataConfiguration"></a>

 The S3 Metadata configuration for a general purpose bucket. 

## Contents
<a name="API_MetadataConfiguration_Contents"></a>

 ** JournalTableConfiguration **   <a name="AmazonS3-Type-MetadataConfiguration-JournalTableConfiguration"></a>
 The journal table configuration for a metadata configuration.   
Type: [JournalTableConfiguration](API_JournalTableConfiguration.md) data type  
Required: Yes

 ** InventoryTableConfiguration **   <a name="AmazonS3-Type-MetadataConfiguration-InventoryTableConfiguration"></a>
 The inventory table configuration for a metadata configuration.   
Type: [InventoryTableConfiguration](API_InventoryTableConfiguration.md) data type  
Required: No

## See Also
<a name="API_MetadataConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/MetadataConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/MetadataConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/MetadataConfiguration) 

# MetadataConfigurationResult
<a name="API_MetadataConfigurationResult"></a>

 The S3 Metadata configuration for a general purpose bucket. 

## Contents
<a name="API_MetadataConfigurationResult_Contents"></a>

 ** DestinationResult **   <a name="AmazonS3-Type-MetadataConfigurationResult-DestinationResult"></a>
 The destination settings for a metadata configuration.   
Type: [DestinationResult](API_DestinationResult.md) data type  
Required: Yes

 ** InventoryTableConfigurationResult **   <a name="AmazonS3-Type-MetadataConfigurationResult-InventoryTableConfigurationResult"></a>
 The inventory table configuration for a metadata configuration.   
Type: [InventoryTableConfigurationResult](API_InventoryTableConfigurationResult.md) data type  
Required: No

 ** JournalTableConfigurationResult **   <a name="AmazonS3-Type-MetadataConfigurationResult-JournalTableConfigurationResult"></a>
 The journal table configuration for a metadata configuration.   
Type: [JournalTableConfigurationResult](API_JournalTableConfigurationResult.md) data type  
Required: No

## See Also
<a name="API_MetadataConfigurationResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/MetadataConfigurationResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/MetadataConfigurationResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/MetadataConfigurationResult) 

# MetadataEntry
<a name="API_MetadataEntry"></a>

A metadata key-value pair to store with an object.

## Contents
<a name="API_MetadataEntry_Contents"></a>

 ** Name **   <a name="AmazonS3-Type-MetadataEntry-Name"></a>
Name of the object.  
Type: String  
Required: No

 ** Value **   <a name="AmazonS3-Type-MetadataEntry-Value"></a>
Value of the object.  
Type: String  
Required: No

## See Also
<a name="API_MetadataEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/MetadataEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/MetadataEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/MetadataEntry) 

# MetadataTableConfiguration
<a name="API_MetadataTableConfiguration"></a>

 The V1 S3 Metadata configuration for a general purpose bucket. 

**Note**  
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html) so that you can expire journal table records and create a live inventory table.

## Contents
<a name="API_MetadataTableConfiguration_Contents"></a>

 ** S3TablesDestination **   <a name="AmazonS3-Type-MetadataTableConfiguration-S3TablesDestination"></a>
 The destination information for the metadata table configuration. The destination table bucket must be in the same Region and AWS account as the general purpose bucket. The specified metadata table name must be unique within the `aws_s3_metadata` namespace in the destination table bucket.   
Type: [S3TablesDestination](API_S3TablesDestination.md) data type  
Required: Yes

## See Also
<a name="API_MetadataTableConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/MetadataTableConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/MetadataTableConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/MetadataTableConfiguration) 

# MetadataTableConfigurationResult
<a name="API_MetadataTableConfigurationResult"></a>

 The V1 S3 Metadata configuration for a general purpose bucket. The destination table bucket must be in the same Region and AWS account as the general purpose bucket. The specified metadata table name must be unique within the `aws_s3_metadata` namespace in the destination table bucket. 

**Note**  
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html) so that you can expire journal table records and create a live inventory table.

## Contents
<a name="API_MetadataTableConfigurationResult_Contents"></a>

 ** S3TablesDestinationResult **   <a name="AmazonS3-Type-MetadataTableConfigurationResult-S3TablesDestinationResult"></a>
 The destination information for the metadata table configuration. The destination table bucket must be in the same Region and AWS account as the general purpose bucket. The specified metadata table name must be unique within the `aws_s3_metadata` namespace in the destination table bucket.   
Type: [S3TablesDestinationResult](API_S3TablesDestinationResult.md) data type  
Required: Yes

## See Also
<a name="API_MetadataTableConfigurationResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/MetadataTableConfigurationResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/MetadataTableConfigurationResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/MetadataTableConfigurationResult) 

# MetadataTableEncryptionConfiguration
<a name="API_MetadataTableEncryptionConfiguration"></a>

 The encryption settings for an S3 Metadata journal table or inventory table configuration. 

## Contents
<a name="API_MetadataTableEncryptionConfiguration_Contents"></a>

 ** SseAlgorithm **   <a name="AmazonS3-Type-MetadataTableEncryptionConfiguration-SseAlgorithm"></a>
 The encryption type specified for a metadata table. To specify server-side encryption with AWS Key Management Service (AWS KMS) keys (SSE-KMS), use the `aws:kms` value. To specify server-side encryption with Amazon S3 managed keys (SSE-S3), use the `AES256` value.   
Type: String  
Valid Values: `aws:kms | AES256`   
Required: Yes

 ** KmsKeyArn **   <a name="AmazonS3-Type-MetadataTableEncryptionConfiguration-KmsKeyArn"></a>
 If server-side encryption with AWS Key Management Service (AWS KMS) keys (SSE-KMS) is specified, you must also specify the KMS key Amazon Resource Name (ARN). You must specify a customer-managed KMS key that's located in the same Region as the general purpose bucket that corresponds to the metadata table configuration.   
Type: String  
Required: No

## See Also
<a name="API_MetadataTableEncryptionConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/MetadataTableEncryptionConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/MetadataTableEncryptionConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/MetadataTableEncryptionConfiguration) 

# Metrics
<a name="API_Metrics"></a>

 A container specifying replication metrics-related settings enabling replication metrics and events.

## Contents
<a name="API_Metrics_Contents"></a>

 ** Status **   <a name="AmazonS3-Type-Metrics-Status"></a>
 Specifies whether the replication metrics are enabled.   
Type: String  
Valid Values: `Enabled | Disabled`   
Required: Yes

 ** EventThreshold **   <a name="AmazonS3-Type-Metrics-EventThreshold"></a>
 A container specifying the time threshold for emitting the `s3:Replication:OperationMissedThreshold` event.   
Type: [ReplicationTimeValue](API_ReplicationTimeValue.md) data type  
Required: No

## See Also
<a name="API_Metrics_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/Metrics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/Metrics) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/Metrics) 

# MetricsAndOperator
<a name="API_MetricsAndOperator"></a>

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.

## Contents
<a name="API_MetricsAndOperator_Contents"></a>

 ** AccessPointArn **   <a name="AmazonS3-Type-MetricsAndOperator-AccessPointArn"></a>
The access point ARN used when evaluating an `AND` predicate.  
Type: String  
Required: No

 ** Prefix **   <a name="AmazonS3-Type-MetricsAndOperator-Prefix"></a>
The prefix used when evaluating an AND predicate.  
Type: String  
Required: No

 ** Tags **   <a name="AmazonS3-Type-MetricsAndOperator-Tags"></a>
The list of tags used when evaluating an AND predicate.  
 `Tag` filters are not supported for directory buckets.
Type: Array of [Tag](API_Tag.md) data types  
Required: No

## See Also
<a name="API_MetricsAndOperator_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/MetricsAndOperator) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/MetricsAndOperator) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/MetricsAndOperator) 

# MetricsConfiguration
<a name="API_MetricsConfiguration"></a>

Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html).

## Contents
<a name="API_MetricsConfiguration_Contents"></a>

 ** Id **   <a name="AmazonS3-Type-MetricsConfiguration-Id"></a>
The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.  
Type: String  
Required: Yes

 ** Filter **   <a name="AmazonS3-Type-MetricsConfiguration-Filter"></a>
Specifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator).  
Metrics configurations for directory buckets do not support tag filters.
Type: [MetricsFilter](API_MetricsFilter.md) data type  
Required: No

## See Also
<a name="API_MetricsConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/MetricsConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/MetricsConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/MetricsConfiguration) 

# MetricsFilter
<a name="API_MetricsFilter"></a>

Specifies a metrics configuration filter. The metrics configuration only includes objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator). For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html).

## Contents
<a name="API_MetricsFilter_Contents"></a>

 ** AccessPointArn **   <a name="AmazonS3-Type-MetricsFilter-AccessPointArn"></a>
The access point ARN used when evaluating a metrics filter.  
Type: String  
Required: No

 ** And **   <a name="AmazonS3-Type-MetricsFilter-And"></a>
A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.  
Type: [MetricsAndOperator](API_MetricsAndOperator.md) data type  
Required: No

 ** Prefix **   <a name="AmazonS3-Type-MetricsFilter-Prefix"></a>
The prefix used when evaluating a metrics filter.  
Type: String  
Required: No

 ** Tag **   <a name="AmazonS3-Type-MetricsFilter-Tag"></a>
The tag used when evaluating a metrics filter.  
 `Tag` filters are not supported for directory buckets.
Type: [Tag](API_Tag.md) data type  
Required: No

## See Also
<a name="API_MetricsFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/MetricsFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/MetricsFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/MetricsFilter) 

# MultipartUpload
<a name="API_MultipartUpload"></a>

Container for the `MultipartUpload` for the Amazon S3 object.

## Contents
<a name="API_MultipartUpload_Contents"></a>

 ** ChecksumAlgorithm **   <a name="AmazonS3-Type-MultipartUpload-ChecksumAlgorithm"></a>
The algorithm that was used to create a checksum of the object.  
Type: String  
Valid Values: `CRC32 | CRC32C | SHA1 | SHA256 | CRC64NVME`   
Required: No

 ** ChecksumType **   <a name="AmazonS3-Type-MultipartUpload-ChecksumType"></a>
The checksum type that is used to calculate the object’s checksum value. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Valid Values: `COMPOSITE | FULL_OBJECT`   
Required: No

 ** Initiated **   <a name="AmazonS3-Type-MultipartUpload-Initiated"></a>
Date and time at which the multipart upload was initiated.  
Type: Timestamp  
Required: No

 ** Initiator **   <a name="AmazonS3-Type-MultipartUpload-Initiator"></a>
Identifies who initiated the multipart upload.  
Type: [Initiator](API_Initiator.md) data type  
Required: No

 ** Key **   <a name="AmazonS3-Type-MultipartUpload-Key"></a>
Key of the object for which the multipart upload was initiated.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** Owner **   <a name="AmazonS3-Type-MultipartUpload-Owner"></a>
Specifies the owner of the object that is part of the multipart upload.   
 **Directory buckets** - The bucket owner is returned as the object owner for all the objects.
Type: [Owner](API_Owner.md) data type  
Required: No

 ** StorageClass **   <a name="AmazonS3-Type-MultipartUpload-StorageClass"></a>
The class of storage used to store the object.  
 **Directory buckets** - Directory buckets only support `EXPRESS_ONEZONE` (the S3 Express One Zone storage class) in Availability Zones and `ONEZONE_IA` (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
Type: String  
Valid Values: `STANDARD | REDUCED_REDUNDANCY | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_IR | SNOW | EXPRESS_ONEZONE | FSX_OPENZFS | FSX_ONTAP`   
Required: No

 ** UploadId **   <a name="AmazonS3-Type-MultipartUpload-UploadId"></a>
Upload ID that identifies the multipart upload.  
Type: String  
Required: No

## See Also
<a name="API_MultipartUpload_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/MultipartUpload) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/MultipartUpload) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/MultipartUpload) 

# NoncurrentVersionExpiration
<a name="API_NoncurrentVersionExpiration"></a>

Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.

**Note**  
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

## Contents
<a name="API_NoncurrentVersionExpiration_Contents"></a>

 ** NewerNoncurrentVersions **   <a name="AmazonS3-Type-NoncurrentVersionExpiration-NewerNoncurrentVersions"></a>
Specifies how many noncurrent versions Amazon S3 will retain. You can specify up to 100 noncurrent versions to retain. Amazon S3 will permanently delete any additional noncurrent versions beyond the specified number to retain. For more information about noncurrent versions, see [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) in the *Amazon S3 User Guide*.  
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
Type: Integer  
Required: No

 ** NoncurrentDays **   <a name="AmazonS3-Type-NoncurrentVersionExpiration-NoncurrentDays"></a>
Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. The value must be a non-zero positive integer. For information about the noncurrent days calculations, see [How Amazon S3 Calculates When an Object Became Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) in the *Amazon S3 User Guide*.  
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
Type: Integer  
Required: No

## See Also
<a name="API_NoncurrentVersionExpiration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/NoncurrentVersionExpiration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/NoncurrentVersionExpiration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/NoncurrentVersionExpiration) 

# NoncurrentVersionTransition
<a name="API_NoncurrentVersionTransition"></a>

Container for the transition rule that describes when noncurrent objects transition to the `STANDARD_IA`, `ONEZONE_IA`, `INTELLIGENT_TIERING`, `GLACIER_IR`, `GLACIER`, or `DEEP_ARCHIVE` storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the `STANDARD_IA`, `ONEZONE_IA`, `INTELLIGENT_TIERING`, `GLACIER_IR`, `GLACIER`, or `DEEP_ARCHIVE` storage class at a specific period in the object's lifetime.

## Contents
<a name="API_NoncurrentVersionTransition_Contents"></a>

 ** NewerNoncurrentVersions **   <a name="AmazonS3-Type-NoncurrentVersionTransition-NewerNoncurrentVersions"></a>
Specifies how many noncurrent versions Amazon S3 will retain in the same storage class before transitioning objects. You can specify up to 100 noncurrent versions to retain. Amazon S3 will transition any additional noncurrent versions beyond the specified number to retain. For more information about noncurrent versions, see [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) in the *Amazon S3 User Guide*.  
Type: Integer  
Required: No

 ** NoncurrentDays **   <a name="AmazonS3-Type-NoncurrentVersionTransition-NoncurrentDays"></a>
Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see [How Amazon S3 Calculates How Long an Object Has Been Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) in the *Amazon S3 User Guide*.  
Type: Integer  
Required: No

 ** StorageClass **   <a name="AmazonS3-Type-NoncurrentVersionTransition-StorageClass"></a>
The class of storage used to store the object.  
Type: String  
Valid Values: `GLACIER | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | DEEP_ARCHIVE | GLACIER_IR`   
Required: No

## See Also
<a name="API_NoncurrentVersionTransition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/NoncurrentVersionTransition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/NoncurrentVersionTransition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/NoncurrentVersionTransition) 

# NotificationConfiguration
<a name="API_NotificationConfiguration"></a>

A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket.

## Contents
<a name="API_NotificationConfiguration_Contents"></a>

 ** EventBridgeConfiguration **   <a name="AmazonS3-Type-NotificationConfiguration-EventBridgeConfiguration"></a>
Enables delivery of events to Amazon EventBridge.  
Type: [EventBridgeConfiguration](API_EventBridgeConfiguration.md) data type  
Required: No

 ** LambdaFunctionConfigurations **   <a name="AmazonS3-Type-NotificationConfiguration-LambdaFunctionConfigurations"></a>
Describes the AWS Lambda functions to invoke and the events for which to invoke them.  
Type: Array of [LambdaFunctionConfiguration](API_LambdaFunctionConfiguration.md) data types  
Required: No

 ** QueueConfigurations **   <a name="AmazonS3-Type-NotificationConfiguration-QueueConfigurations"></a>
The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.  
Type: Array of [QueueConfiguration](API_QueueConfiguration.md) data types  
Required: No

 ** TopicConfigurations **   <a name="AmazonS3-Type-NotificationConfiguration-TopicConfigurations"></a>
The topic to which notifications are sent and the events for which notifications are generated.  
Type: Array of [TopicConfiguration](API_TopicConfiguration.md) data types  
Required: No

## See Also
<a name="API_NotificationConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/NotificationConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/NotificationConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/NotificationConfiguration) 

# NotificationConfigurationDeprecated
<a name="API_NotificationConfigurationDeprecated"></a>

## Contents
<a name="API_NotificationConfigurationDeprecated_Contents"></a>

 ** CloudFunctionConfiguration **   <a name="AmazonS3-Type-NotificationConfigurationDeprecated-CloudFunctionConfiguration"></a>
Container for specifying the AWS Lambda notification configuration.  
Type: [CloudFunctionConfiguration](API_CloudFunctionConfiguration.md) data type  
Required: No

 ** QueueConfiguration **   <a name="AmazonS3-Type-NotificationConfigurationDeprecated-QueueConfiguration"></a>
This data type is deprecated. This data type specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.   
Type: [QueueConfigurationDeprecated](API_QueueConfigurationDeprecated.md) data type  
Required: No

 ** TopicConfiguration **   <a name="AmazonS3-Type-NotificationConfigurationDeprecated-TopicConfiguration"></a>
This data type is deprecated. A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.   
Type: [TopicConfigurationDeprecated](API_TopicConfigurationDeprecated.md) data type  
Required: No

## See Also
<a name="API_NotificationConfigurationDeprecated_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/NotificationConfigurationDeprecated) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/NotificationConfigurationDeprecated) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/NotificationConfigurationDeprecated) 

# NotificationConfigurationFilter
<a name="API_NotificationConfigurationFilter"></a>

Specifies object key name filtering rules. For information about key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*.

## Contents
<a name="API_NotificationConfigurationFilter_Contents"></a>

 ** Key **   <a name="AmazonS3-Type-NotificationConfigurationFilter-Key"></a>
A container for object key name prefix and suffix filtering rules.  
Type: [S3KeyFilter](API_S3KeyFilter.md) data type  
Required: No

## See Also
<a name="API_NotificationConfigurationFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/NotificationConfigurationFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/NotificationConfigurationFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/NotificationConfigurationFilter) 

# Object
<a name="API_Object"></a>

An object consists of data and its descriptive metadata.

## Contents
<a name="API_Object_Contents"></a>

 ** ChecksumAlgorithm **   <a name="AmazonS3-Type-Object-ChecksumAlgorithm"></a>
The algorithm that was used to create a checksum of the object.  
Type: Array of strings  
Valid Values: `CRC32 | CRC32C | SHA1 | SHA256 | CRC64NVME`   
Required: No

 ** ChecksumType **   <a name="AmazonS3-Type-Object-ChecksumType"></a>
The checksum type that is used to calculate the object’s checksum value. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Valid Values: `COMPOSITE | FULL_OBJECT`   
Required: No

 ** ETag **   <a name="AmazonS3-Type-Object-ETag"></a>
The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:  
+ Objects created by the PUT Object, POST Object, or Copy operation, or through the AWS Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.
+ Objects created by the PUT Object, POST Object, or Copy operation, or through the AWS Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.
+ If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption. If an object is larger than 16 MB, the AWS Management Console will upload or copy that object as a Multipart Upload, and therefore the ETag will not be an MD5 digest.
 **Directory buckets** - MD5 is not supported by directory buckets.
Type: String  
Required: No

 ** Key **   <a name="AmazonS3-Type-Object-Key"></a>
The name that you assign to an object. You use the object key to retrieve the object.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** LastModified **   <a name="AmazonS3-Type-Object-LastModified"></a>
Creation date of the object.  
Type: Timestamp  
Required: No

 ** Owner **   <a name="AmazonS3-Type-Object-Owner"></a>
The owner of the object  
 **Directory buckets** - The bucket owner is returned as the object owner.
Type: [Owner](API_Owner.md) data type  
Required: No

 ** RestoreStatus **   <a name="AmazonS3-Type-Object-RestoreStatus"></a>
Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see [ Working with archived objects](https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html) in the *Amazon S3 User Guide*.  
This functionality is not supported for directory buckets. Directory buckets only support `EXPRESS_ONEZONE` (the S3 Express One Zone storage class) in Availability Zones and `ONEZONE_IA` (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
Type: [RestoreStatus](API_RestoreStatus.md) data type  
Required: No

 ** Size **   <a name="AmazonS3-Type-Object-Size"></a>
Size in bytes of the object  
Type: Long  
Required: No

 ** StorageClass **   <a name="AmazonS3-Type-Object-StorageClass"></a>
The class of storage used to store the object.  
 **Directory buckets** - Directory buckets only support `EXPRESS_ONEZONE` (the S3 Express One Zone storage class) in Availability Zones and `ONEZONE_IA` (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
Type: String  
Valid Values: `STANDARD | REDUCED_REDUNDANCY | GLACIER | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | DEEP_ARCHIVE | OUTPOSTS | GLACIER_IR | SNOW | EXPRESS_ONEZONE | FSX_OPENZFS | FSX_ONTAP`   
Required: No

## See Also
<a name="API_Object_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/Object) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/Object) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/Object) 

# ObjectEncryption
<a name="API_ObjectEncryption"></a>

 The updated server-side encryption type for this object. The `UpdateObjectEncryption` operation supports the SSE-S3 and SSE-KMS encryption types. 

Valid Values: `SSES3` \$1 `SSEKMS` 

## Contents
<a name="API_ObjectEncryption_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** SSEKMS **   <a name="AmazonS3-Type-ObjectEncryption-SSEKMS"></a>
 Specifies to update the object encryption type to server-side encryption with AWS Key Management Service (AWS KMS) keys (SSE-KMS).   
Type: [SSEKMSEncryption](API_SSEKMSEncryption.md) data type  
Required: No

## See Also
<a name="API_ObjectEncryption_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ObjectEncryption) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ObjectEncryption) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ObjectEncryption) 

# ObjectIdentifier
<a name="API_ObjectIdentifier"></a>

Object Identifier is unique value to identify objects.

## Contents
<a name="API_ObjectIdentifier_Contents"></a>

 ** Key **   <a name="AmazonS3-Type-ObjectIdentifier-Key"></a>
Key name of the object.  
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).
Type: String  
Length Constraints: Minimum length of 1.  
Required: Yes

 ** ETag **   <a name="AmazonS3-Type-ObjectIdentifier-ETag"></a>
An entity tag (ETag) is an identifier assigned by a web server to a specific version of a resource found at a URL. This header field makes the request method conditional on `ETags`.   
Entity tags (ETags) for S3 Express One Zone are random alphanumeric strings unique to the object. 
Type: String  
Required: No

 ** LastModifiedTime **   <a name="AmazonS3-Type-ObjectIdentifier-LastModifiedTime"></a>
If present, the objects are deleted only if its modification times matches the provided `Timestamp`.   
This functionality is only supported for directory buckets.
Type: Timestamp  
Required: No

 ** Size **   <a name="AmazonS3-Type-ObjectIdentifier-Size"></a>
If present, the objects are deleted only if its size matches the provided size in bytes.   
This functionality is only supported for directory buckets.
Type: Long  
Required: No

 ** VersionId **   <a name="AmazonS3-Type-ObjectIdentifier-VersionId"></a>
Version ID for the specific version of the object to delete.  
This functionality is not supported for directory buckets.
Type: String  
Required: No

## See Also
<a name="API_ObjectIdentifier_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ObjectIdentifier) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ObjectIdentifier) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ObjectIdentifier) 

# ObjectLockConfiguration
<a name="API_ObjectLockConfiguration"></a>

The container element for Object Lock configuration parameters.

## Contents
<a name="API_ObjectLockConfiguration_Contents"></a>

 ** ObjectLockEnabled **   <a name="AmazonS3-Type-ObjectLockConfiguration-ObjectLockEnabled"></a>
Indicates whether this bucket has an Object Lock configuration enabled. Enable `ObjectLockEnabled` when you apply `ObjectLockConfiguration` to a bucket.   
Type: String  
Valid Values: `Enabled`   
Required: No

 ** Rule **   <a name="AmazonS3-Type-ObjectLockConfiguration-Rule"></a>
Specifies the Object Lock rule for the specified object. Enable the this rule when you apply `ObjectLockConfiguration` to a bucket. Bucket settings require both a mode and a period. The period can be either `Days` or `Years` but you must select one. You cannot specify `Days` and `Years` at the same time.  
Type: [ObjectLockRule](API_ObjectLockRule.md) data type  
Required: No

## See Also
<a name="API_ObjectLockConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ObjectLockConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ObjectLockConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ObjectLockConfiguration) 

# ObjectLockLegalHold
<a name="API_ObjectLockLegalHold"></a>

A legal hold configuration for an object.

## Contents
<a name="API_ObjectLockLegalHold_Contents"></a>

 ** Status **   <a name="AmazonS3-Type-ObjectLockLegalHold-Status"></a>
Indicates whether the specified object has a legal hold in place.  
Type: String  
Valid Values: `ON | OFF`   
Required: No

## See Also
<a name="API_ObjectLockLegalHold_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ObjectLockLegalHold) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ObjectLockLegalHold) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ObjectLockLegalHold) 

# ObjectLockRetention
<a name="API_ObjectLockRetention"></a>

A Retention configuration for an object.

## Contents
<a name="API_ObjectLockRetention_Contents"></a>

 ** Mode **   <a name="AmazonS3-Type-ObjectLockRetention-Mode"></a>
Indicates the Retention mode for the specified object.  
Type: String  
Valid Values: `GOVERNANCE | COMPLIANCE`   
Required: No

 ** RetainUntilDate **   <a name="AmazonS3-Type-ObjectLockRetention-RetainUntilDate"></a>
The date on which this Object Lock Retention will expire.  
Type: Timestamp  
Required: No

## See Also
<a name="API_ObjectLockRetention_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ObjectLockRetention) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ObjectLockRetention) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ObjectLockRetention) 

# ObjectLockRule
<a name="API_ObjectLockRule"></a>

The container element for an Object Lock rule.

## Contents
<a name="API_ObjectLockRule_Contents"></a>

 ** DefaultRetention **   <a name="AmazonS3-Type-ObjectLockRule-DefaultRetention"></a>
The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket. Bucket settings require both a mode and a period. The period can be either `Days` or `Years` but you must select one. You cannot specify `Days` and `Years` at the same time.  
Type: [DefaultRetention](API_DefaultRetention.md) data type  
Required: No

## See Also
<a name="API_ObjectLockRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ObjectLockRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ObjectLockRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ObjectLockRule) 

# ObjectPart
<a name="API_ObjectPart"></a>

A container for elements related to an individual part.

## Contents
<a name="API_ObjectPart_Contents"></a>

 ** ChecksumCRC32 **   <a name="AmazonS3-Type-ObjectPart-ChecksumCRC32"></a>
The Base64 encoded, 32-bit `CRC32` checksum of the part. This checksum is present if the multipart upload request was created with the `CRC32` checksum algorithm. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ChecksumCRC32C **   <a name="AmazonS3-Type-ObjectPart-ChecksumCRC32C"></a>
The Base64 encoded, 32-bit `CRC32C` checksum of the part. This checksum is present if the multipart upload request was created with the `CRC32C` checksum algorithm. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ChecksumCRC64NVME **   <a name="AmazonS3-Type-ObjectPart-ChecksumCRC64NVME"></a>
The Base64 encoded, 64-bit `CRC64NVME` checksum of the part. This checksum is present if the multipart upload request was created with the `CRC64NVME` checksum algorithm, or if the object was uploaded without a checksum (and Amazon S3 added the default checksum, `CRC64NVME`, to the uploaded object). For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ChecksumSHA1 **   <a name="AmazonS3-Type-ObjectPart-ChecksumSHA1"></a>
The Base64 encoded, 160-bit `SHA1` checksum of the part. This checksum is present if the multipart upload request was created with the `SHA1` checksum algorithm. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ChecksumSHA256 **   <a name="AmazonS3-Type-ObjectPart-ChecksumSHA256"></a>
The Base64 encoded, 256-bit `SHA256` checksum of the part. This checksum is present if the multipart upload request was created with the `SHA256` checksum algorithm. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** PartNumber **   <a name="AmazonS3-Type-ObjectPart-PartNumber"></a>
The part number identifying the part. This value is a positive integer between 1 and 10,000.  
Type: Integer  
Required: No

 ** Size **   <a name="AmazonS3-Type-ObjectPart-Size"></a>
The size of the uploaded part in bytes.  
Type: Long  
Required: No

## See Also
<a name="API_ObjectPart_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ObjectPart) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ObjectPart) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ObjectPart) 

# ObjectVersion
<a name="API_ObjectVersion"></a>

The version of an object.

## Contents
<a name="API_ObjectVersion_Contents"></a>

 ** ChecksumAlgorithm **   <a name="AmazonS3-Type-ObjectVersion-ChecksumAlgorithm"></a>
The algorithm that was used to create a checksum of the object.  
Type: Array of strings  
Valid Values: `CRC32 | CRC32C | SHA1 | SHA256 | CRC64NVME`   
Required: No

 ** ChecksumType **   <a name="AmazonS3-Type-ObjectVersion-ChecksumType"></a>
The checksum type that is used to calculate the object’s checksum value. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Valid Values: `COMPOSITE | FULL_OBJECT`   
Required: No

 ** ETag **   <a name="AmazonS3-Type-ObjectVersion-ETag"></a>
The entity tag is an MD5 hash of that version of the object.  
Type: String  
Required: No

 ** IsLatest **   <a name="AmazonS3-Type-ObjectVersion-IsLatest"></a>
Specifies whether the object is (true) or is not (false) the latest version of an object.  
Type: Boolean  
Required: No

 ** Key **   <a name="AmazonS3-Type-ObjectVersion-Key"></a>
The object key.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** LastModified **   <a name="AmazonS3-Type-ObjectVersion-LastModified"></a>
Date and time when the object was last modified.  
Type: Timestamp  
Required: No

 ** Owner **   <a name="AmazonS3-Type-ObjectVersion-Owner"></a>
Specifies the owner of the object.  
Type: [Owner](API_Owner.md) data type  
Required: No

 ** RestoreStatus **   <a name="AmazonS3-Type-ObjectVersion-RestoreStatus"></a>
Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see [ Working with archived objects](https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html) in the *Amazon S3 User Guide*.  
Type: [RestoreStatus](API_RestoreStatus.md) data type  
Required: No

 ** Size **   <a name="AmazonS3-Type-ObjectVersion-Size"></a>
Size in bytes of the object.  
Type: Long  
Required: No

 ** StorageClass **   <a name="AmazonS3-Type-ObjectVersion-StorageClass"></a>
The class of storage used to store the object.  
Type: String  
Valid Values: `STANDARD`   
Required: No

 ** VersionId **   <a name="AmazonS3-Type-ObjectVersion-VersionId"></a>
Version ID of an object.  
Type: String  
Required: No

## See Also
<a name="API_ObjectVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ObjectVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ObjectVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ObjectVersion) 

# OutputLocation
<a name="API_OutputLocation"></a>

Describes the location where the restore job's output is stored.

## Contents
<a name="API_OutputLocation_Contents"></a>

 ** S3 **   <a name="AmazonS3-Type-OutputLocation-S3"></a>
Describes an S3 location that will receive the results of the restore request.  
Type: [S3Location](API_S3Location.md) data type  
Required: No

## See Also
<a name="API_OutputLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/OutputLocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/OutputLocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/OutputLocation) 

# OutputSerialization
<a name="API_OutputSerialization"></a>

Describes how results of the Select job are serialized.

## Contents
<a name="API_OutputSerialization_Contents"></a>

 ** CSV **   <a name="AmazonS3-Type-OutputSerialization-CSV"></a>
Describes the serialization of CSV-encoded Select results.  
Type: [CSVOutput](API_CSVOutput.md) data type  
Required: No

 ** JSON **   <a name="AmazonS3-Type-OutputSerialization-JSON"></a>
Specifies JSON as request's output serialization format.  
Type: [JSONOutput](API_JSONOutput.md) data type  
Required: No

## See Also
<a name="API_OutputSerialization_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/OutputSerialization) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/OutputSerialization) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/OutputSerialization) 

# Owner
<a name="API_Owner"></a>

Container for the owner's display name and ID.

## Contents
<a name="API_Owner_Contents"></a>

 ** DisplayName **   <a name="AmazonS3-Type-Owner-DisplayName"></a>
  
Type: String  
Required: No

 ** ID **   <a name="AmazonS3-Type-Owner-ID"></a>
Container for the ID of the owner.  
Type: String  
Required: No

## See Also
<a name="API_Owner_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/Owner) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/Owner) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/Owner) 

# OwnershipControls
<a name="API_OwnershipControls"></a>

The container element for a bucket's ownership controls.

## Contents
<a name="API_OwnershipControls_Contents"></a>

 ** Rules **   <a name="AmazonS3-Type-OwnershipControls-Rules"></a>
The container element for an ownership control rule.  
Type: Array of [OwnershipControlsRule](API_OwnershipControlsRule.md) data types  
Required: Yes

## See Also
<a name="API_OwnershipControls_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/OwnershipControls) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/OwnershipControls) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/OwnershipControls) 

# OwnershipControlsRule
<a name="API_OwnershipControlsRule"></a>

The container element for an ownership control rule.

## Contents
<a name="API_OwnershipControlsRule_Contents"></a>

 ** ObjectOwnership **   <a name="AmazonS3-Type-OwnershipControlsRule-ObjectOwnership"></a>
The container element for object ownership for a bucket's ownership controls.  
 `BucketOwnerPreferred` - Objects uploaded to the bucket change ownership to the bucket owner if the objects are uploaded with the `bucket-owner-full-control` canned ACL.  
 `ObjectWriter` - The uploading account will own the object if the object is uploaded with the `bucket-owner-full-control` canned ACL.  
 `BucketOwnerEnforced` - Access control lists (ACLs) are disabled and no longer affect permissions. The bucket owner automatically owns and has full control over every object in the bucket. The bucket only accepts PUT requests that don't specify an ACL or specify bucket owner full control ACLs (such as the predefined `bucket-owner-full-control` canned ACL or a custom ACL in XML format that grants the same permissions).  
By default, `ObjectOwnership` is set to `BucketOwnerEnforced` and ACLs are disabled. We recommend keeping ACLs disabled, except in uncommon use cases where you must control access for each object individually. For more information about S3 Object Ownership, see [Controlling ownership of objects and disabling ACLs for your bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*.   
This functionality is not supported for directory buckets. Directory buckets use the bucket owner enforced setting for S3 Object Ownership.
Type: String  
Valid Values: `BucketOwnerPreferred | ObjectWriter | BucketOwnerEnforced`   
Required: Yes

## See Also
<a name="API_OwnershipControlsRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/OwnershipControlsRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/OwnershipControlsRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/OwnershipControlsRule) 

# ParquetInput
<a name="API_ParquetInput"></a>

Container for Parquet.

## Contents
<a name="API_ParquetInput_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_ParquetInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ParquetInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ParquetInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ParquetInput) 

# Part
<a name="API_Part"></a>

Container for elements related to a part.

## Contents
<a name="API_Part_Contents"></a>

 ** ChecksumCRC32 **   <a name="AmazonS3-Type-Part-ChecksumCRC32"></a>
The Base64 encoded, 32-bit `CRC32` checksum of the part. This checksum is present if the object was uploaded with the `CRC32` checksum algorithm. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ChecksumCRC32C **   <a name="AmazonS3-Type-Part-ChecksumCRC32C"></a>
The Base64 encoded, 32-bit `CRC32C` checksum of the part. This checksum is present if the object was uploaded with the `CRC32C` checksum algorithm. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ChecksumCRC64NVME **   <a name="AmazonS3-Type-Part-ChecksumCRC64NVME"></a>
The Base64 encoded, 64-bit `CRC64NVME` checksum of the part. This checksum is present if the multipart upload request was created with the `CRC64NVME` checksum algorithm, or if the object was uploaded without a checksum (and Amazon S3 added the default checksum, `CRC64NVME`, to the uploaded object). For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ChecksumSHA1 **   <a name="AmazonS3-Type-Part-ChecksumSHA1"></a>
The Base64 encoded, 160-bit `SHA1` checksum of the part. This checksum is present if the object was uploaded with the `SHA1` checksum algorithm. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ChecksumSHA256 **   <a name="AmazonS3-Type-Part-ChecksumSHA256"></a>
The Base64 encoded, 256-bit `SHA256` checksum of the part. This checksum is present if the object was uploaded with the `SHA256` checksum algorithm. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: No

 ** ETag **   <a name="AmazonS3-Type-Part-ETag"></a>
Entity tag returned when the part was uploaded.  
Type: String  
Required: No

 ** LastModified **   <a name="AmazonS3-Type-Part-LastModified"></a>
Date and time at which the part was uploaded.  
Type: Timestamp  
Required: No

 ** PartNumber **   <a name="AmazonS3-Type-Part-PartNumber"></a>
Part number identifying the part. This is a positive integer between 1 and 10,000.  
Type: Integer  
Required: No

 ** Size **   <a name="AmazonS3-Type-Part-Size"></a>
Size in bytes of the uploaded part data.  
Type: Long  
Required: No

## See Also
<a name="API_Part_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/Part) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/Part) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/Part) 

# PartitionedPrefix
<a name="API_PartitionedPrefix"></a>

Amazon S3 keys for log objects are partitioned in the following format:

 `[DestinationPrefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]` 

PartitionedPrefix defaults to EventTime delivery when server access logs are delivered.

## Contents
<a name="API_PartitionedPrefix_Contents"></a>

 ** PartitionDateSource **   <a name="AmazonS3-Type-PartitionedPrefix-PartitionDateSource"></a>
Specifies the partition date source for the partitioned prefix. `PartitionDateSource` can be `EventTime` or `DeliveryTime`.  
For `DeliveryTime`, the time in the log file names corresponds to the delivery time for the log files.   
 For `EventTime`, The logs delivered are for a specific day only. The year, month, and day correspond to the day on which the event occurred, and the hour, minutes and seconds are set to 00 in the key.  
Type: String  
Valid Values: `EventTime | DeliveryTime`   
Required: No

## See Also
<a name="API_PartitionedPrefix_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/PartitionedPrefix) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/PartitionedPrefix) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/PartitionedPrefix) 

# PolicyStatus
<a name="API_PolicyStatus"></a>

The container element for a bucket's policy status.

## Contents
<a name="API_PolicyStatus_Contents"></a>

 ** IsPublic **   <a name="AmazonS3-Type-PolicyStatus-IsPublic"></a>
The policy status for this bucket. `TRUE` indicates that this bucket is public. `FALSE` indicates that the bucket is not public.  
Type: Boolean  
Required: No

## See Also
<a name="API_PolicyStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/PolicyStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/PolicyStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/PolicyStatus) 

# Progress
<a name="API_Progress"></a>

This data type contains information about progress of an operation.

## Contents
<a name="API_Progress_Contents"></a>

 ** BytesProcessed **   <a name="AmazonS3-Type-Progress-BytesProcessed"></a>
The current number of uncompressed object bytes processed.  
Type: Long  
Required: No

 ** BytesReturned **   <a name="AmazonS3-Type-Progress-BytesReturned"></a>
The current number of bytes of records payload data returned.  
Type: Long  
Required: No

 ** BytesScanned **   <a name="AmazonS3-Type-Progress-BytesScanned"></a>
The current number of object bytes scanned.  
Type: Long  
Required: No

## See Also
<a name="API_Progress_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/Progress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/Progress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/Progress) 

# ProgressEvent
<a name="API_ProgressEvent"></a>

This data type contains information about the progress event of an operation.

## Contents
<a name="API_ProgressEvent_Contents"></a>

 ** Details **   <a name="AmazonS3-Type-ProgressEvent-Details"></a>
The Progress event details.  
Type: [Progress](API_Progress.md) data type  
Required: No

## See Also
<a name="API_ProgressEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ProgressEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ProgressEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ProgressEvent) 

# PublicAccessBlockConfiguration
<a name="API_PublicAccessBlockConfiguration"></a>

The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. Bucket-level settings work alongside account-level settings (which may inherit from organization-level policies). For more information about when Amazon S3 considers a bucket or object public, see [The Meaning of "Public"](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) in the *Amazon S3 User Guide*. 

## Contents
<a name="API_PublicAccessBlockConfiguration_Contents"></a>

 ** BlockPublicAcls **   <a name="AmazonS3-Type-PublicAccessBlockConfiguration-BlockPublicAcls"></a>
Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to `TRUE` causes the following behavior:  
+ PUT Bucket ACL and PUT Object ACL calls fail if the specified ACL is public.
+ PUT Object calls fail if the request includes a public ACL.
+ PUT Bucket calls fail if the request includes a public ACL.
Enabling this setting doesn't affect existing policies or ACLs.  
Type: Boolean  
Required: No

 ** BlockPublicPolicy **   <a name="AmazonS3-Type-PublicAccessBlockConfiguration-BlockPublicPolicy"></a>
Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to `TRUE` causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.   
Enabling this setting doesn't affect existing bucket policies.  
Type: Boolean  
Required: No

 ** IgnorePublicAcls **   <a name="AmazonS3-Type-PublicAccessBlockConfiguration-IgnorePublicAcls"></a>
Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to `TRUE` causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket.  
Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.  
Type: Boolean  
Required: No

 ** RestrictPublicBuckets **   <a name="AmazonS3-Type-PublicAccessBlockConfiguration-RestrictPublicBuckets"></a>
Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to `TRUE` restricts access to this bucket to only AWS service principals and authorized users within this account if the bucket has a public policy.  
Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.  
Type: Boolean  
Required: No

## See Also
<a name="API_PublicAccessBlockConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/PublicAccessBlockConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/PublicAccessBlockConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/PublicAccessBlockConfiguration) 

# QueueConfiguration
<a name="API_QueueConfiguration"></a>

Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.

## Contents
<a name="API_QueueConfiguration_Contents"></a>

 ** Events **   <a name="AmazonS3-Type-QueueConfiguration-Events"></a>
A collection of bucket events for which to send notifications  
Type: Array of strings  
Valid Values: `s3:ReducedRedundancyLostObject | s3:ObjectCreated:* | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved:* | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated | s3:ObjectRestore:* | s3:ObjectRestore:Post | s3:ObjectRestore:Completed | s3:Replication:* | s3:Replication:OperationFailedReplication | s3:Replication:OperationNotTracked | s3:Replication:OperationMissedThreshold | s3:Replication:OperationReplicatedAfterThreshold | s3:ObjectRestore:Delete | s3:LifecycleTransition | s3:IntelligentTiering | s3:ObjectAcl:Put | s3:LifecycleExpiration:* | s3:LifecycleExpiration:Delete | s3:LifecycleExpiration:DeleteMarkerCreated | s3:ObjectTagging:* | s3:ObjectTagging:Put | s3:ObjectTagging:Delete`   
Required: Yes

 ** QueueArn **   <a name="AmazonS3-Type-QueueConfiguration-QueueArn"></a>
The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type.  
Type: String  
Required: Yes

 ** Filter **   <a name="AmazonS3-Type-QueueConfiguration-Filter"></a>
Specifies object key name filtering rules. For information about key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*.  
Type: [NotificationConfigurationFilter](API_NotificationConfigurationFilter.md) data type  
Required: No

 ** Id **   <a name="AmazonS3-Type-QueueConfiguration-Id"></a>
An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.  
Type: String  
Required: No

## See Also
<a name="API_QueueConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/QueueConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/QueueConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/QueueConfiguration) 

# QueueConfigurationDeprecated
<a name="API_QueueConfigurationDeprecated"></a>

This data type is deprecated. Use [QueueConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_QueueConfiguration.html) for the same purposes. This data type specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events. 

## Contents
<a name="API_QueueConfigurationDeprecated_Contents"></a>

 ** Event **   <a name="AmazonS3-Type-QueueConfigurationDeprecated-Event"></a>
 *This member has been deprecated.*   
The bucket event for which to send notifications.  
Type: String  
Valid Values: `s3:ReducedRedundancyLostObject | s3:ObjectCreated:* | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved:* | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated | s3:ObjectRestore:* | s3:ObjectRestore:Post | s3:ObjectRestore:Completed | s3:Replication:* | s3:Replication:OperationFailedReplication | s3:Replication:OperationNotTracked | s3:Replication:OperationMissedThreshold | s3:Replication:OperationReplicatedAfterThreshold | s3:ObjectRestore:Delete | s3:LifecycleTransition | s3:IntelligentTiering | s3:ObjectAcl:Put | s3:LifecycleExpiration:* | s3:LifecycleExpiration:Delete | s3:LifecycleExpiration:DeleteMarkerCreated | s3:ObjectTagging:* | s3:ObjectTagging:Put | s3:ObjectTagging:Delete`   
Required: No

 ** Events **   <a name="AmazonS3-Type-QueueConfigurationDeprecated-Events"></a>
A collection of bucket events for which to send notifications.  
Type: Array of strings  
Valid Values: `s3:ReducedRedundancyLostObject | s3:ObjectCreated:* | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved:* | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated | s3:ObjectRestore:* | s3:ObjectRestore:Post | s3:ObjectRestore:Completed | s3:Replication:* | s3:Replication:OperationFailedReplication | s3:Replication:OperationNotTracked | s3:Replication:OperationMissedThreshold | s3:Replication:OperationReplicatedAfterThreshold | s3:ObjectRestore:Delete | s3:LifecycleTransition | s3:IntelligentTiering | s3:ObjectAcl:Put | s3:LifecycleExpiration:* | s3:LifecycleExpiration:Delete | s3:LifecycleExpiration:DeleteMarkerCreated | s3:ObjectTagging:* | s3:ObjectTagging:Put | s3:ObjectTagging:Delete`   
Required: No

 ** Id **   <a name="AmazonS3-Type-QueueConfigurationDeprecated-Id"></a>
An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.  
Type: String  
Required: No

 ** Queue **   <a name="AmazonS3-Type-QueueConfigurationDeprecated-Queue"></a>
The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type.   
Type: String  
Required: No

## See Also
<a name="API_QueueConfigurationDeprecated_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/QueueConfigurationDeprecated) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/QueueConfigurationDeprecated) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/QueueConfigurationDeprecated) 

# RecordExpiration
<a name="API_RecordExpiration"></a>

 The journal table record expiration settings for a journal table in an S3 Metadata configuration. 

## Contents
<a name="API_RecordExpiration_Contents"></a>

 ** Expiration **   <a name="AmazonS3-Type-RecordExpiration-Expiration"></a>
 Specifies whether journal table record expiration is enabled or disabled.   
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: Yes

 ** Days **   <a name="AmazonS3-Type-RecordExpiration-Days"></a>
 If you enable journal table record expiration, you can set the number of days to retain your journal table records. Journal table records must be retained for a minimum of 7 days. To set this value, specify any whole number from `7` to `2147483647`. For example, to retain your journal table records for one year, set this value to `365`.   
Type: Integer  
Required: No

## See Also
<a name="API_RecordExpiration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/RecordExpiration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/RecordExpiration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/RecordExpiration) 

# RecordsEvent
<a name="API_RecordsEvent"></a>

The container for the records event.

## Contents
<a name="API_RecordsEvent_Contents"></a>

 ** Payload **   <a name="AmazonS3-Type-RecordsEvent-Payload"></a>
The byte array of partial, one or more result records. S3 Select doesn't guarantee that a record will be self-contained in one record frame. To ensure continuous streaming of data, S3 Select might split the same record across multiple record frames instead of aggregating the results in memory. Some S3 clients (for example, the AWS SDK for Java) handle this behavior by creating a `ByteStream` out of the response by default. Other clients might not handle this behavior by default. In those cases, you must aggregate the results on the client side and parse the response.  
Type: Base64-encoded binary data object  
Required: No

## See Also
<a name="API_RecordsEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/RecordsEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/RecordsEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/RecordsEvent) 

# Redirect
<a name="API_Redirect"></a>

Specifies how requests are redirected. In the event of an error, you can specify a different error code to return.

## Contents
<a name="API_Redirect_Contents"></a>

 ** HostName **   <a name="AmazonS3-Type-Redirect-HostName"></a>
The host name to use in the redirect request.  
Type: String  
Required: No

 ** HttpRedirectCode **   <a name="AmazonS3-Type-Redirect-HttpRedirectCode"></a>
The HTTP redirect code to use on the response. Not required if one of the siblings is present.  
Type: String  
Required: No

 ** Protocol **   <a name="AmazonS3-Type-Redirect-Protocol"></a>
Protocol to use when redirecting requests. The default is the protocol that is used in the original request.  
Type: String  
Valid Values: `http | https`   
Required: No

 ** ReplaceKeyPrefixWith **   <a name="AmazonS3-Type-Redirect-ReplaceKeyPrefixWith"></a>
The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix `docs/` (objects in the `docs/` folder) to `documents/`, you can set a condition block with `KeyPrefixEquals` set to `docs/` and in the Redirect set `ReplaceKeyPrefixWith` to `/documents`. Not required if one of the siblings is present. Can be present only if `ReplaceKeyWith` is not provided.  
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).
Type: String  
Required: No

 ** ReplaceKeyWith **   <a name="AmazonS3-Type-Redirect-ReplaceKeyWith"></a>
The specific object key to use in the redirect request. For example, redirect request to `error.html`. Not required if one of the siblings is present. Can be present only if `ReplaceKeyPrefixWith` is not provided.  
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).
Type: String  
Required: No

## See Also
<a name="API_Redirect_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/Redirect) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/Redirect) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/Redirect) 

# RedirectAllRequestsTo
<a name="API_RedirectAllRequestsTo"></a>

Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.

## Contents
<a name="API_RedirectAllRequestsTo_Contents"></a>

 ** HostName **   <a name="AmazonS3-Type-RedirectAllRequestsTo-HostName"></a>
Name of the host where requests are redirected.  
Type: String  
Required: Yes

 ** Protocol **   <a name="AmazonS3-Type-RedirectAllRequestsTo-Protocol"></a>
Protocol to use when redirecting requests. The default is the protocol that is used in the original request.  
Type: String  
Valid Values: `http | https`   
Required: No

## See Also
<a name="API_RedirectAllRequestsTo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/RedirectAllRequestsTo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/RedirectAllRequestsTo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/RedirectAllRequestsTo) 

# ReplicaModifications
<a name="API_ReplicaModifications"></a>

A filter that you can specify for selection for modifications on replicas. Amazon S3 doesn't replicate replica modifications by default. In the latest version of replication configuration (when `Filter` is specified), you can specify this element and set the status to `Enabled` to replicate modifications on replicas. 

**Note**  
 If you don't specify the `Filter` element, Amazon S3 assumes that the replication configuration is the earlier version, V1. In the earlier version, this element is not allowed.

## Contents
<a name="API_ReplicaModifications_Contents"></a>

 ** Status **   <a name="AmazonS3-Type-ReplicaModifications-Status"></a>
Specifies whether Amazon S3 replicates modifications on replicas.  
Type: String  
Valid Values: `Enabled | Disabled`   
Required: Yes

## See Also
<a name="API_ReplicaModifications_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ReplicaModifications) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ReplicaModifications) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ReplicaModifications) 

# ReplicationConfiguration
<a name="API_ReplicationConfiguration"></a>

A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.

## Contents
<a name="API_ReplicationConfiguration_Contents"></a>

 ** Role **   <a name="AmazonS3-Type-ReplicationConfiguration-Role"></a>
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that Amazon S3 assumes when replicating objects. For more information, see [How to Set Up Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: Yes

 ** Rules **   <a name="AmazonS3-Type-ReplicationConfiguration-Rules"></a>
A container for one or more replication rules. A replication configuration must have at least one rule and can contain a maximum of 1,000 rules.   
Type: Array of [ReplicationRule](API_ReplicationRule.md) data types  
Required: Yes

## See Also
<a name="API_ReplicationConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ReplicationConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ReplicationConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ReplicationConfiguration) 

# ReplicationRule
<a name="API_ReplicationRule"></a>

Specifies which Amazon S3 objects to replicate and where to store the replicas.

## Contents
<a name="API_ReplicationRule_Contents"></a>

 ** Destination **   <a name="AmazonS3-Type-ReplicationRule-Destination"></a>
A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).  
Type: [Destination](API_Destination.md) data type  
Required: Yes

 ** Status **   <a name="AmazonS3-Type-ReplicationRule-Status"></a>
Specifies whether the rule is enabled.  
Type: String  
Valid Values: `Enabled | Disabled`   
Required: Yes

 ** DeleteMarkerReplication **   <a name="AmazonS3-Type-ReplicationRule-DeleteMarkerReplication"></a>
Specifies whether Amazon S3 replicates delete markers. If you specify a `Filter` in your replication configuration, you must also include a `DeleteMarkerReplication` element. If your `Filter` includes a `Tag` element, the `DeleteMarkerReplication` `Status` must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config).   
For more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html).   
If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations).
Type: [DeleteMarkerReplication](API_DeleteMarkerReplication.md) data type  
Required: No

 ** ExistingObjectReplication **   <a name="AmazonS3-Type-ReplicationRule-ExistingObjectReplication"></a>
Optional configuration to replicate existing source bucket objects.   
This parameter is no longer supported. To replicate existing objects, see [Replicating existing objects with S3 Batch Replication](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-batch-replication-batch.html) in the *Amazon S3 User Guide*.
Type: [ExistingObjectReplication](API_ExistingObjectReplication.md) data type  
Required: No

 ** Filter **   <a name="AmazonS3-Type-ReplicationRule-Filter"></a>
A filter that identifies the subset of objects to which the replication rule applies. A `Filter` must specify exactly one `Prefix`, `Tag`, or an `And` child element.  
Type: [ReplicationRuleFilter](API_ReplicationRuleFilter.md) data type  
Required: No

 ** ID **   <a name="AmazonS3-Type-ReplicationRule-ID"></a>
A unique identifier for the rule. The maximum value is 255 characters.  
Type: String  
Required: No

 ** Prefix **   <a name="AmazonS3-Type-ReplicationRule-Prefix"></a>
 *This member has been deprecated.*   
An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string.   
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).
Type: String  
Required: No

 ** Priority **   <a name="AmazonS3-Type-ReplicationRule-Priority"></a>
The priority indicates which rule has precedence whenever two or more replication rules conflict. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority.   
For more information, see [Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the *Amazon S3 User Guide*.  
Type: Integer  
Required: No

 ** SourceSelectionCriteria **   <a name="AmazonS3-Type-ReplicationRule-SourceSelectionCriteria"></a>
A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer managed key stored in AWS Key Management Service (SSE-KMS).  
Type: [SourceSelectionCriteria](API_SourceSelectionCriteria.md) data type  
Required: No

## See Also
<a name="API_ReplicationRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ReplicationRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ReplicationRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ReplicationRule) 

# ReplicationRuleAndOperator
<a name="API_ReplicationRuleAndOperator"></a>

A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. 

For example:
+ If you specify both a `Prefix` and a `Tag` filter, wrap these filters in an `And` tag. 
+ If you specify a filter based on multiple tags, wrap the `Tag` elements in an `And` tag.

## Contents
<a name="API_ReplicationRuleAndOperator_Contents"></a>

 ** Prefix **   <a name="AmazonS3-Type-ReplicationRuleAndOperator-Prefix"></a>
An object key name prefix that identifies the subset of objects to which the rule applies.  
Type: String  
Required: No

 ** Tags **   <a name="AmazonS3-Type-ReplicationRuleAndOperator-Tags"></a>
An array of tags containing key and value pairs.  
Type: Array of [Tag](API_Tag.md) data types  
Required: No

## See Also
<a name="API_ReplicationRuleAndOperator_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ReplicationRuleAndOperator) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ReplicationRuleAndOperator) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ReplicationRuleAndOperator) 

# ReplicationRuleFilter
<a name="API_ReplicationRuleFilter"></a>

A filter that identifies the subset of objects to which the replication rule applies. A `Filter` must specify exactly one `Prefix`, `Tag`, or an `And` child element.

## Contents
<a name="API_ReplicationRuleFilter_Contents"></a>

 ** And **   <a name="AmazonS3-Type-ReplicationRuleFilter-And"></a>
A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example:   
+ If you specify both a `Prefix` and a `Tag` filter, wrap these filters in an `And` tag.
+ If you specify a filter based on multiple tags, wrap the `Tag` elements in an `And` tag.
Type: [ReplicationRuleAndOperator](API_ReplicationRuleAndOperator.md) data type  
Required: No

 ** Prefix **   <a name="AmazonS3-Type-ReplicationRuleFilter-Prefix"></a>
An object key name prefix that identifies the subset of objects to which the rule applies.  
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).
Type: String  
Required: No

 ** Tag **   <a name="AmazonS3-Type-ReplicationRuleFilter-Tag"></a>
A container for specifying a tag key and value.   
The rule applies only to objects that have the tag in their tag set.  
Type: [Tag](API_Tag.md) data type  
Required: No

## See Also
<a name="API_ReplicationRuleFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ReplicationRuleFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ReplicationRuleFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ReplicationRuleFilter) 

# ReplicationTime
<a name="API_ReplicationTime"></a>

 A container specifying S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a `Metrics` block. 

## Contents
<a name="API_ReplicationTime_Contents"></a>

 ** Status **   <a name="AmazonS3-Type-ReplicationTime-Status"></a>
 Specifies whether the replication time is enabled.   
Type: String  
Valid Values: `Enabled | Disabled`   
Required: Yes

 ** Time **   <a name="AmazonS3-Type-ReplicationTime-Time"></a>
 A container specifying the time by which replication should be complete for all objects and operations on objects.   
Type: [ReplicationTimeValue](API_ReplicationTimeValue.md) data type  
Required: Yes

## See Also
<a name="API_ReplicationTime_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ReplicationTime) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ReplicationTime) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ReplicationTime) 

# ReplicationTimeValue
<a name="API_ReplicationTimeValue"></a>

 A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics `EventThreshold`. 

## Contents
<a name="API_ReplicationTimeValue_Contents"></a>

 ** Minutes **   <a name="AmazonS3-Type-ReplicationTimeValue-Minutes"></a>
 Contains an integer specifying time in minutes.   
 Valid value: 15  
Type: Integer  
Required: No

## See Also
<a name="API_ReplicationTimeValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ReplicationTimeValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ReplicationTimeValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ReplicationTimeValue) 

# RequestPaymentConfiguration
<a name="API_RequestPaymentConfiguration"></a>

Container for Payer.

## Contents
<a name="API_RequestPaymentConfiguration_Contents"></a>

 ** Payer **   <a name="AmazonS3-Type-RequestPaymentConfiguration-Payer"></a>
Specifies who pays for the download and request fees.  
Type: String  
Valid Values: `Requester | BucketOwner`   
Required: Yes

## See Also
<a name="API_RequestPaymentConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/RequestPaymentConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/RequestPaymentConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/RequestPaymentConfiguration) 

# RequestProgress
<a name="API_RequestProgress"></a>

Container for specifying if periodic `QueryProgress` messages should be sent.

## Contents
<a name="API_RequestProgress_Contents"></a>

 ** Enabled **   <a name="AmazonS3-Type-RequestProgress-Enabled"></a>
Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE, FALSE. Default value: FALSE.  
Type: Boolean  
Required: No

## See Also
<a name="API_RequestProgress_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/RequestProgress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/RequestProgress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/RequestProgress) 

# RestoreRequest
<a name="API_RestoreRequest"></a>

Container for restore job parameters.

## Contents
<a name="API_RestoreRequest_Contents"></a>

 ** Days **   <a name="AmazonS3-Type-RestoreRequest-Days"></a>
Lifetime of the active copy in days. Do not use with restores that specify `OutputLocation`.  
The Days element is required for regular restores, and must not be provided for select requests.  
Type: Integer  
Required: No

 ** Description **   <a name="AmazonS3-Type-RestoreRequest-Description"></a>
The optional description for the job.  
Type: String  
Required: No

 ** GlacierJobParameters **   <a name="AmazonS3-Type-RestoreRequest-GlacierJobParameters"></a>
S3 Glacier related parameters pertaining to this job. Do not use with restores that specify `OutputLocation`.  
Type: [GlacierJobParameters](API_GlacierJobParameters.md) data type  
Required: No

 ** OutputLocation **   <a name="AmazonS3-Type-RestoreRequest-OutputLocation"></a>
Describes the location where the restore job's output is stored.  
Type: [OutputLocation](API_OutputLocation.md) data type  
Required: No

 ** SelectParameters **   <a name="AmazonS3-Type-RestoreRequest-SelectParameters"></a>
Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. [Learn more](http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/) 
Describes the parameters for Select job types.  
Type: [SelectParameters](API_SelectParameters.md) data type  
Required: No

 ** Tier **   <a name="AmazonS3-Type-RestoreRequest-Tier"></a>
Retrieval tier at which the restore will be processed.  
Type: String  
Valid Values: `Standard | Bulk | Expedited`   
Required: No

 ** Type **   <a name="AmazonS3-Type-RestoreRequest-Type"></a>
Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. [Learn more](http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/) 
Type of restore request.  
Type: String  
Valid Values: `SELECT`   
Required: No

## See Also
<a name="API_RestoreRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/RestoreRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/RestoreRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/RestoreRequest) 

# RestoreStatus
<a name="API_RestoreStatus"></a>

Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see [ Working with archived objects](https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html) in the *Amazon S3 User Guide*.

**Note**  
This functionality is not supported for directory buckets. Directory buckets only support `EXPRESS_ONEZONE` (the S3 Express One Zone storage class) in Availability Zones and `ONEZONE_IA` (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.

## Contents
<a name="API_RestoreStatus_Contents"></a>

 ** IsRestoreInProgress **   <a name="AmazonS3-Type-RestoreStatus-IsRestoreInProgress"></a>
Specifies whether the object is currently being restored. If the object restoration is in progress, the header returns the value `TRUE`. For example:  
 `x-amz-optional-object-attributes: IsRestoreInProgress="true"`   
If the object restoration has completed, the header returns the value `FALSE`. For example:  
 `x-amz-optional-object-attributes: IsRestoreInProgress="false", RestoreExpiryDate="2012-12-21T00:00:00.000Z"`   
If the object hasn't been restored, there is no header response.  
Type: Boolean  
Required: No

 ** RestoreExpiryDate **   <a name="AmazonS3-Type-RestoreStatus-RestoreExpiryDate"></a>
Indicates when the restored copy will expire. This value is populated only if the object has already been restored. For example:  
 `x-amz-optional-object-attributes: IsRestoreInProgress="false", RestoreExpiryDate="2012-12-21T00:00:00.000Z"`   
Type: Timestamp  
Required: No

## See Also
<a name="API_RestoreStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/RestoreStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/RestoreStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/RestoreStatus) 

# RoutingRule
<a name="API_RoutingRule"></a>

Specifies the redirect behavior and when a redirect is applied. For more information about routing rules, see [Configuring advanced conditional redirects](https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html#advanced-conditional-redirects) in the *Amazon S3 User Guide*.

## Contents
<a name="API_RoutingRule_Contents"></a>

 ** Redirect **   <a name="AmazonS3-Type-RoutingRule-Redirect"></a>
Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return.  
Type: [Redirect](API_Redirect.md) data type  
Required: Yes

 ** Condition **   <a name="AmazonS3-Type-RoutingRule-Condition"></a>
A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the `/docs` folder, redirect to the `/documents` folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.  
Type: [Condition](API_Condition.md) data type  
Required: No

## See Also
<a name="API_RoutingRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/RoutingRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/RoutingRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/RoutingRule) 

# Rule
<a name="API_Rule"></a>

Specifies lifecycle rules for an Amazon S3 bucket. For more information, see [Put Bucket Lifecycle Configuration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html) in the *Amazon S3 API Reference*. For examples, see [Put Bucket Lifecycle Configuration Examples](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html#API_PutBucketLifecycleConfiguration_Examples).

## Contents
<a name="API_Rule_Contents"></a>

 ** Prefix **   <a name="AmazonS3-Type-Rule-Prefix"></a>
Object key prefix that identifies one or more objects to which this rule applies.  
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).
Type: String  
Required: Yes

 ** Status **   <a name="AmazonS3-Type-Rule-Status"></a>
If `Enabled`, the rule is currently being applied. If `Disabled`, the rule is not currently being applied.  
Type: String  
Valid Values: `Enabled | Disabled`   
Required: Yes

 ** AbortIncompleteMultipartUpload **   <a name="AmazonS3-Type-Rule-AbortIncompleteMultipartUpload"></a>
Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see [ Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) in the *Amazon S3 User Guide*.  
Type: [AbortIncompleteMultipartUpload](API_AbortIncompleteMultipartUpload.md) data type  
Required: No

 ** Expiration **   <a name="AmazonS3-Type-Rule-Expiration"></a>
Specifies the expiration for the lifecycle of the object.  
Type: [LifecycleExpiration](API_LifecycleExpiration.md) data type  
Required: No

 ** ID **   <a name="AmazonS3-Type-Rule-ID"></a>
Unique identifier for the rule. The value can't be longer than 255 characters.  
Type: String  
Required: No

 ** NoncurrentVersionExpiration **   <a name="AmazonS3-Type-Rule-NoncurrentVersionExpiration"></a>
Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.  
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
Type: [NoncurrentVersionExpiration](API_NoncurrentVersionExpiration.md) data type  
Required: No

 ** NoncurrentVersionTransition **   <a name="AmazonS3-Type-Rule-NoncurrentVersionTransition"></a>
Container for the transition rule that describes when noncurrent objects transition to the `STANDARD_IA`, `ONEZONE_IA`, `INTELLIGENT_TIERING`, `GLACIER_IR`, `GLACIER`, or `DEEP_ARCHIVE` storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the `STANDARD_IA`, `ONEZONE_IA`, `INTELLIGENT_TIERING`, `GLACIER_IR`, `GLACIER`, or `DEEP_ARCHIVE` storage class at a specific period in the object's lifetime.  
Type: [NoncurrentVersionTransition](API_NoncurrentVersionTransition.md) data type  
Required: No

 ** Transition **   <a name="AmazonS3-Type-Rule-Transition"></a>
Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see [Transitioning Objects Using Amazon S3 Lifecycle](https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html) in the *Amazon S3 User Guide*.  
Type: [Transition](API_Transition.md) data type  
Required: No

## See Also
<a name="API_Rule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/Rule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/Rule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/Rule) 

# S3KeyFilter
<a name="API_S3KeyFilter"></a>

A container for object key name prefix and suffix filtering rules.

## Contents
<a name="API_S3KeyFilter_Contents"></a>

 ** FilterRules **   <a name="AmazonS3-Type-S3KeyFilter-FilterRules"></a>
A list of containers for the key-value pair that defines the criteria for the filter rule.  
Type: Array of [FilterRule](API_FilterRule.md) data types  
Required: No

## See Also
<a name="API_S3KeyFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/S3KeyFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/S3KeyFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/S3KeyFilter) 

# S3Location
<a name="API_S3Location"></a>

Describes an Amazon S3 location that will receive the results of the restore request.

## Contents
<a name="API_S3Location_Contents"></a>

 ** BucketName **   <a name="AmazonS3-Type-S3Location-BucketName"></a>
The name of the bucket where the restore results will be placed.  
Type: String  
Required: Yes

 ** Prefix **   <a name="AmazonS3-Type-S3Location-Prefix"></a>
The prefix that is prepended to the restore results for this request.  
Type: String  
Required: Yes

 ** AccessControlList **   <a name="AmazonS3-Type-S3Location-AccessControlList"></a>
A list of grants that control access to the staged results.  
Type: Array of [Grant](API_Grant.md) data types  
Required: No

 ** CannedACL **   <a name="AmazonS3-Type-S3Location-CannedACL"></a>
The canned ACL to apply to the restore results.  
Type: String  
Valid Values: `private | public-read | public-read-write | authenticated-read | aws-exec-read | bucket-owner-read | bucket-owner-full-control`   
Required: No

 ** Encryption **   <a name="AmazonS3-Type-S3Location-Encryption"></a>
Contains the type of server-side encryption used.  
Type: [Encryption](API_Encryption.md) data type  
Required: No

 ** StorageClass **   <a name="AmazonS3-Type-S3Location-StorageClass"></a>
The class of storage used to store the restore results.  
Type: String  
Valid Values: `STANDARD | REDUCED_REDUNDANCY | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_IR | SNOW | EXPRESS_ONEZONE | FSX_OPENZFS | FSX_ONTAP`   
Required: No

 ** Tagging **   <a name="AmazonS3-Type-S3Location-Tagging"></a>
The tag-set that is applied to the restore results.  
Type: [Tagging](API_Tagging.md) data type  
Required: No

 ** UserMetadata **   <a name="AmazonS3-Type-S3Location-UserMetadata"></a>
A list of metadata to store with the restore results in S3.  
Type: Array of [MetadataEntry](API_MetadataEntry.md) data types  
Required: No

## See Also
<a name="API_S3Location_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/S3Location) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/S3Location) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/S3Location) 

# S3TablesDestination
<a name="API_S3TablesDestination"></a>

 The destination information for a V1 S3 Metadata configuration. The destination table bucket must be in the same Region and AWS account as the general purpose bucket. The specified metadata table name must be unique within the `aws_s3_metadata` namespace in the destination table bucket. 

**Note**  
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html) so that you can expire journal table records and create a live inventory table.

## Contents
<a name="API_S3TablesDestination_Contents"></a>

 ** TableBucketArn **   <a name="AmazonS3-Type-S3TablesDestination-TableBucketArn"></a>
 The Amazon Resource Name (ARN) for the table bucket that's specified as the destination in the metadata table configuration. The destination table bucket must be in the same Region and AWS account as the general purpose bucket.   
Type: String  
Required: Yes

 ** TableName **   <a name="AmazonS3-Type-S3TablesDestination-TableName"></a>
 The name for the metadata table in your metadata table configuration. The specified metadata table name must be unique within the `aws_s3_metadata` namespace in the destination table bucket.   
Type: String  
Required: Yes

## See Also
<a name="API_S3TablesDestination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/S3TablesDestination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/S3TablesDestination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/S3TablesDestination) 

# S3TablesDestinationResult
<a name="API_S3TablesDestinationResult"></a>

 The destination information for a V1 S3 Metadata configuration. The destination table bucket must be in the same Region and AWS account as the general purpose bucket. The specified metadata table name must be unique within the `aws_s3_metadata` namespace in the destination table bucket. 

**Note**  
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using [CreateBucketMetadataConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html) so that you can expire journal table records and create a live inventory table.

## Contents
<a name="API_S3TablesDestinationResult_Contents"></a>

 ** TableArn **   <a name="AmazonS3-Type-S3TablesDestinationResult-TableArn"></a>
 The Amazon Resource Name (ARN) for the metadata table in the metadata table configuration. The specified metadata table name must be unique within the `aws_s3_metadata` namespace in the destination table bucket.   
Type: String  
Required: Yes

 ** TableBucketArn **   <a name="AmazonS3-Type-S3TablesDestinationResult-TableBucketArn"></a>
 The Amazon Resource Name (ARN) for the table bucket that's specified as the destination in the metadata table configuration. The destination table bucket must be in the same Region and AWS account as the general purpose bucket.   
Type: String  
Required: Yes

 ** TableName **   <a name="AmazonS3-Type-S3TablesDestinationResult-TableName"></a>
 The name for the metadata table in your metadata table configuration. The specified metadata table name must be unique within the `aws_s3_metadata` namespace in the destination table bucket.   
Type: String  
Required: Yes

 ** TableNamespace **   <a name="AmazonS3-Type-S3TablesDestinationResult-TableNamespace"></a>
 The table bucket namespace for the metadata table in your metadata table configuration. This value is always `aws_s3_metadata`.   
Type: String  
Required: Yes

## See Also
<a name="API_S3TablesDestinationResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/S3TablesDestinationResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/S3TablesDestinationResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/S3TablesDestinationResult) 

# ScanRange
<a name="API_ScanRange"></a>

Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. This parameter is optional, but when specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.

## Contents
<a name="API_ScanRange_Contents"></a>

 ** End **   <a name="AmazonS3-Type-ScanRange-End"></a>
Specifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried. If only the End parameter is supplied, it is interpreted to mean scan the last N bytes of the file. For example, `<scanrange><end>50</end></scanrange>` means scan the last 50 bytes.  
Type: Long  
Required: No

 ** Start **   <a name="AmazonS3-Type-ScanRange-Start"></a>
Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. If only `start` is supplied, it means scan from that point to the end of the file. For example, `<scanrange><start>50</start></scanrange>` means scan from byte 50 until the end of the file.  
Type: Long  
Required: No

## See Also
<a name="API_ScanRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ScanRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ScanRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ScanRange) 

# SelectObjectContentEventStream
<a name="API_SelectObjectContentEventStream"></a>

The container for selecting objects from a content event stream.

## Contents
<a name="API_SelectObjectContentEventStream_Contents"></a>

 ** Cont **   <a name="AmazonS3-Type-SelectObjectContentEventStream-Cont"></a>
The Continuation Event.  
Type: [ContinuationEvent](API_ContinuationEvent.md) data type  
Required: No

 ** End **   <a name="AmazonS3-Type-SelectObjectContentEventStream-End"></a>
The End Event.  
Type: [EndEvent](API_EndEvent.md) data type  
Required: No

 ** Progress **   <a name="AmazonS3-Type-SelectObjectContentEventStream-Progress"></a>
The Progress Event.  
Type: [ProgressEvent](API_ProgressEvent.md) data type  
Required: No

 ** Records **   <a name="AmazonS3-Type-SelectObjectContentEventStream-Records"></a>
The Records Event.  
Type: [RecordsEvent](API_RecordsEvent.md) data type  
Required: No

 ** Stats **   <a name="AmazonS3-Type-SelectObjectContentEventStream-Stats"></a>
The Stats Event.  
Type: [StatsEvent](API_StatsEvent.md) data type  
Required: No

## See Also
<a name="API_SelectObjectContentEventStream_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/SelectObjectContentEventStream) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/SelectObjectContentEventStream) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/SelectObjectContentEventStream) 

# SelectParameters
<a name="API_SelectParameters"></a>

**Important**  
Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. [Learn more](http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/) 

Describes the parameters for Select job types.

Learn [How to optimize querying your data in Amazon S3](http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/) using [Amazon Athena](https://docs.aws.amazon.com/athena/latest/ug/what-is.html), [S3 Object Lambda](https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html), or client-side filtering.

## Contents
<a name="API_SelectParameters_Contents"></a>

 ** Expression **   <a name="AmazonS3-Type-SelectParameters-Expression"></a>
Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. [Learn more](http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/) 
The expression that is used to query the object.  
Type: String  
Required: Yes

 ** ExpressionType **   <a name="AmazonS3-Type-SelectParameters-ExpressionType"></a>
The type of the provided expression (for example, SQL).  
Type: String  
Valid Values: `SQL`   
Required: Yes

 ** InputSerialization **   <a name="AmazonS3-Type-SelectParameters-InputSerialization"></a>
Describes the serialization format of the object.  
Type: [InputSerialization](API_InputSerialization.md) data type  
Required: Yes

 ** OutputSerialization **   <a name="AmazonS3-Type-SelectParameters-OutputSerialization"></a>
Describes how the results of the Select job are serialized.  
Type: [OutputSerialization](API_OutputSerialization.md) data type  
Required: Yes

## See Also
<a name="API_SelectParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/SelectParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/SelectParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/SelectParameters) 

# ServerSideEncryptionByDefault
<a name="API_ServerSideEncryptionByDefault"></a>

Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. For more information, see [PutBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html).

**Note**  
 **General purpose buckets** - If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an AWS KMS key (`aws/s3`) in your AWS account the first time that you add an object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. 
 **Directory buckets** - Your SSE-KMS configuration can only support 1 [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) per directory bucket's lifetime. The [AWS managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) (`aws/s3`) isn't supported. 
 **Directory buckets** - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS.

## Contents
<a name="API_ServerSideEncryptionByDefault_Contents"></a>

 ** SSEAlgorithm **   <a name="AmazonS3-Type-ServerSideEncryptionByDefault-SSEAlgorithm"></a>
Server-side encryption algorithm to use for the default encryption.  
For directory buckets, there are only two supported values for server-side encryption: `AES256` and `aws:kms`.
Type: String  
Valid Values: `AES256 | aws:fsx | aws:kms | aws:kms:dsse`   
Required: Yes

 ** KMSMasterKeyID **   <a name="AmazonS3-Type-ServerSideEncryptionByDefault-KMSMasterKeyID"></a>
 AWS Key Management Service (KMS) customer managed key ID to use for the default encryption.   
+  **General purpose buckets** - This parameter is allowed if and only if `SSEAlgorithm` is set to `aws:kms` or `aws:kms:dsse`.
+  **Directory buckets** - This parameter is allowed if and only if `SSEAlgorithm` is set to `aws:kms`.
You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS key.  
+ Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab` 
+ Key ARN: `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab` 
+ Key Alias: `alias/alias-name` 
If you are using encryption with cross-account or AWS service operations, you must use a fully qualified KMS key ARN. For more information, see [Using encryption for cross-account operations](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy).  
+  **General purpose buckets** - If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then AWS KMS resolves the key within the requester’s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner. Also, if you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log. 
+  **Directory buckets** - When you specify an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.
Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the * AWS Key Management Service Developer Guide*.
Type: String  
Required: No

## See Also
<a name="API_ServerSideEncryptionByDefault_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ServerSideEncryptionByDefault) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ServerSideEncryptionByDefault) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ServerSideEncryptionByDefault) 

# ServerSideEncryptionConfiguration
<a name="API_ServerSideEncryptionConfiguration"></a>

Specifies the default server-side-encryption configuration.

## Contents
<a name="API_ServerSideEncryptionConfiguration_Contents"></a>

 ** Rules **   <a name="AmazonS3-Type-ServerSideEncryptionConfiguration-Rules"></a>
Container for information about a particular server-side encryption configuration rule.  
Type: Array of [ServerSideEncryptionRule](API_ServerSideEncryptionRule.md) data types  
Required: Yes

## See Also
<a name="API_ServerSideEncryptionConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ServerSideEncryptionConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ServerSideEncryptionConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ServerSideEncryptionConfiguration) 

# ServerSideEncryptionRule
<a name="API_ServerSideEncryptionRule"></a>

Specifies the default server-side encryption configuration.

**Note**  
 **General purpose buckets** - If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then AWS KMS resolves the key within the requester’s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner.
 **Directory buckets** - When you specify an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.

## Contents
<a name="API_ServerSideEncryptionRule_Contents"></a>

 ** ApplyServerSideEncryptionByDefault **   <a name="AmazonS3-Type-ServerSideEncryptionRule-ApplyServerSideEncryptionByDefault"></a>
Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied.  
Type: [ServerSideEncryptionByDefault](API_ServerSideEncryptionByDefault.md) data type  
Required: No

 ** BlockedEncryptionTypes **   <a name="AmazonS3-Type-ServerSideEncryptionRule-BlockedEncryptionTypes"></a>
A bucket-level setting for Amazon S3 general purpose buckets used to prevent the upload of new objects encrypted with the specified server-side encryption type. For example, blocking an encryption type will block `PutObject`, `CopyObject`, `PostObject`, multipart upload, and replication requests to the bucket for objects with the specified encryption type. However, you can continue to read and list any pre-existing objects already encrypted with the specified encryption type. For more information, see [Blocking or unblocking SSE-C for a general purpose bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/blocking-unblocking-s3-c-encryption-gpb.html).  
Currently, this parameter only supports blocking or unblocking server-side encryption with customer-provided keys (SSE-C). For more information about SSE-C, see [Using server-side encryption with customer-provided keys (SSE-C)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html).
Type: [BlockedEncryptionTypes](API_BlockedEncryptionTypes.md) data type  
Required: No

 ** BucketKeyEnabled **   <a name="AmazonS3-Type-ServerSideEncryptionRule-BucketKeyEnabled"></a>
Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the `BucketKeyEnabled` element to `true` causes Amazon S3 to use an S3 Bucket Key.   
+  **General purpose buckets** - By default, S3 Bucket Key is not enabled. For more information, see [Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) in the *Amazon S3 User Guide*.
+  **Directory buckets** - S3 Bucket Keys are always enabled for `GET` and `PUT` operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html), [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html), [the Copy operation in Batch Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops), or [the import jobs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-import-job). In this case, Amazon S3 makes a call to AWS KMS every time a copy request is made for a KMS-encrypted object.
Type: Boolean  
Required: No

## See Also
<a name="API_ServerSideEncryptionRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ServerSideEncryptionRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ServerSideEncryptionRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ServerSideEncryptionRule) 

# SessionCredentials
<a name="API_SessionCredentials"></a>

The established temporary security credentials of the session.

**Note**  
 **Directory buckets** - These session credentials are only supported for the authentication and authorization of Zonal endpoint API operations on directory buckets.

## Contents
<a name="API_SessionCredentials_Contents"></a>

 ** AccessKeyId **   <a name="AmazonS3-Type-SessionCredentials-AccessKeyId"></a>
A unique identifier that's associated with a secret access key. The access key ID and the secret access key are used together to sign programmatic AWS requests cryptographically.   
Type: String  
Required: Yes

 ** Expiration **   <a name="AmazonS3-Type-SessionCredentials-Expiration"></a>
Temporary security credentials expire after a specified interval. After temporary credentials expire, any calls that you make with those credentials will fail. So you must generate a new set of temporary credentials. Temporary credentials cannot be extended or refreshed beyond the original specified interval.  
Type: Timestamp  
Required: Yes

 ** SecretAccessKey **   <a name="AmazonS3-Type-SessionCredentials-SecretAccessKey"></a>
A key that's used with the access key ID to cryptographically sign programmatic AWS requests. Signing a request identifies the sender and prevents the request from being altered.   
Type: String  
Required: Yes

 ** SessionToken **   <a name="AmazonS3-Type-SessionCredentials-SessionToken"></a>
A part of the temporary security credentials. The session token is used to validate the temporary security credentials.   
Type: String  
Required: Yes

## See Also
<a name="API_SessionCredentials_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/SessionCredentials) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/SessionCredentials) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/SessionCredentials) 

# SimplePrefix
<a name="API_SimplePrefix"></a>

To use simple format for S3 keys for log objects, set SimplePrefix to an empty object.

 `[DestinationPrefix][YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]` 

## Contents
<a name="API_SimplePrefix_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_SimplePrefix_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/SimplePrefix) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/SimplePrefix) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/SimplePrefix) 

# SourceSelectionCriteria
<a name="API_SourceSelectionCriteria"></a>

A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer managed key stored in AWS Key Management Service (SSE-KMS).

## Contents
<a name="API_SourceSelectionCriteria_Contents"></a>

 ** ReplicaModifications **   <a name="AmazonS3-Type-SourceSelectionCriteria-ReplicaModifications"></a>
A filter that you can specify for selections for modifications on replicas. Amazon S3 doesn't replicate replica modifications by default. In the latest version of replication configuration (when `Filter` is specified), you can specify this element and set the status to `Enabled` to replicate modifications on replicas.   
 If you don't specify the `Filter` element, Amazon S3 assumes that the replication configuration is the earlier version, V1. In the earlier version, this element is not allowed
Type: [ReplicaModifications](API_ReplicaModifications.md) data type  
Required: No

 ** SseKmsEncryptedObjects **   <a name="AmazonS3-Type-SourceSelectionCriteria-SseKmsEncryptedObjects"></a>
 A container for filter information for the selection of Amazon S3 objects encrypted with AWS KMS. If you include `SourceSelectionCriteria` in the replication configuration, this element is required.   
Type: [SseKmsEncryptedObjects](API_SseKmsEncryptedObjects.md) data type  
Required: No

## See Also
<a name="API_SourceSelectionCriteria_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/SourceSelectionCriteria) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/SourceSelectionCriteria) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/SourceSelectionCriteria) 

# SSEKMS
<a name="API_SSEKMS"></a>

Specifies the use of SSE-KMS to encrypt delivered inventory reports.

## Contents
<a name="API_SSEKMS_Contents"></a>

 ** KeyId **   <a name="AmazonS3-Type-SSEKMS-KeyId"></a>
Specifies the ID of the AWS Key Management Service (AWS KMS) symmetric encryption customer managed key to use for encrypting inventory reports.  
Type: String  
Required: Yes

## See Also
<a name="API_SSEKMS_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/SSEKMS) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/SSEKMS) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/SSEKMS) 

# SseKmsEncryptedObjects
<a name="API_SseKmsEncryptedObjects"></a>

A container for filter information for the selection of S3 objects encrypted with AWS KMS.

## Contents
<a name="API_SseKmsEncryptedObjects_Contents"></a>

 ** Status **   <a name="AmazonS3-Type-SseKmsEncryptedObjects-Status"></a>
Specifies whether Amazon S3 replicates objects created with server-side encryption using an AWS KMS key stored in AWS Key Management Service.  
Type: String  
Valid Values: `Enabled | Disabled`   
Required: Yes

## See Also
<a name="API_SseKmsEncryptedObjects_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/SseKmsEncryptedObjects) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/SseKmsEncryptedObjects) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/SseKmsEncryptedObjects) 

# SSEKMSEncryption
<a name="API_SSEKMSEncryption"></a>

 If `SSEKMS` is specified for `ObjectEncryption`, this data type specifies the AWS KMS key Amazon Resource Name (ARN) to use and whether to use an S3 Bucket Key for server-side encryption using AWS Key Management Service (AWS KMS) keys (SSE-KMS). 

## Contents
<a name="API_SSEKMSEncryption_Contents"></a>

 ** KMSKeyArn **   <a name="AmazonS3-Type-SSEKMSEncryption-KMSKeyArn"></a>
 Specifies the AWS KMS key Amazon Resource Name (ARN) to use for the updated server-side encryption type. Required if `ObjectEncryption` specifies `SSEKMS`.   
You must specify the full AWS KMS key ARN. The KMS key ID and KMS key alias aren't supported.
Pattern: (`arn:aws[-a-z0-9]*:kms:[-a-z0-9]*:[0-9]{12}:key/.+`)  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws[a-zA-Z0-9-]*:kms:[a-z0-9-]+:[0-9]{12}:key/[a-zA-Z0-9-]+`   
Required: Yes

 ** BucketKeyEnabled **   <a name="AmazonS3-Type-SSEKMSEncryption-BucketKeyEnabled"></a>
 Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS Key Management Service (AWS KMS) keys (SSE-KMS). If this value isn't specified, it defaults to `false`. Setting this value to `true` causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. For more information, see [ Using Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-key.html) in the *Amazon S3 User Guide*.   
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

## See Also
<a name="API_SSEKMSEncryption_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/SSEKMSEncryption) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/SSEKMSEncryption) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/SSEKMSEncryption) 

# SSES3
<a name="API_SSES3"></a>

Specifies the use of SSE-S3 to encrypt delivered inventory reports.

## Contents
<a name="API_SSES3_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_SSES3_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/SSES3) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/SSES3) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/SSES3) 

# Stats
<a name="API_Stats"></a>

Container for the stats details.

## Contents
<a name="API_Stats_Contents"></a>

 ** BytesProcessed **   <a name="AmazonS3-Type-Stats-BytesProcessed"></a>
The total number of uncompressed object bytes processed.  
Type: Long  
Required: No

 ** BytesReturned **   <a name="AmazonS3-Type-Stats-BytesReturned"></a>
The total number of bytes of records payload data returned.  
Type: Long  
Required: No

 ** BytesScanned **   <a name="AmazonS3-Type-Stats-BytesScanned"></a>
The total number of object bytes scanned.  
Type: Long  
Required: No

## See Also
<a name="API_Stats_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/Stats) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/Stats) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/Stats) 

# StatsEvent
<a name="API_StatsEvent"></a>

Container for the Stats Event.

## Contents
<a name="API_StatsEvent_Contents"></a>

 ** Details **   <a name="AmazonS3-Type-StatsEvent-Details"></a>
The Stats event details.  
Type: [Stats](API_Stats.md) data type  
Required: No

## See Also
<a name="API_StatsEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/StatsEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/StatsEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/StatsEvent) 

# StorageClassAnalysis
<a name="API_StorageClassAnalysis"></a>

Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes for an Amazon S3 bucket.

## Contents
<a name="API_StorageClassAnalysis_Contents"></a>

 ** DataExport **   <a name="AmazonS3-Type-StorageClassAnalysis-DataExport"></a>
Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported.  
Type: [StorageClassAnalysisDataExport](API_StorageClassAnalysisDataExport.md) data type  
Required: No

## See Also
<a name="API_StorageClassAnalysis_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/StorageClassAnalysis) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/StorageClassAnalysis) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/StorageClassAnalysis) 

# StorageClassAnalysisDataExport
<a name="API_StorageClassAnalysisDataExport"></a>

Container for data related to the storage class analysis for an Amazon S3 bucket for export.

## Contents
<a name="API_StorageClassAnalysisDataExport_Contents"></a>

 ** Destination **   <a name="AmazonS3-Type-StorageClassAnalysisDataExport-Destination"></a>
The place to store the data for an analysis.  
Type: [AnalyticsExportDestination](API_AnalyticsExportDestination.md) data type  
Required: Yes

 ** OutputSchemaVersion **   <a name="AmazonS3-Type-StorageClassAnalysisDataExport-OutputSchemaVersion"></a>
The version of the output schema to use when exporting data. Must be `V_1`.  
Type: String  
Valid Values: `V_1`   
Required: Yes

## See Also
<a name="API_StorageClassAnalysisDataExport_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/StorageClassAnalysisDataExport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/StorageClassAnalysisDataExport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/StorageClassAnalysisDataExport) 

# Tag
<a name="API_Tag"></a>

A container of a key value name pair.

## Contents
<a name="API_Tag_Contents"></a>

 ** Key **   <a name="AmazonS3-Type-Tag-Key"></a>
Name of the object key.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: Yes

 ** Value **   <a name="AmazonS3-Type-Tag-Value"></a>
Value of the tag.  
Type: String  
Required: Yes

## See Also
<a name="API_Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/Tag) 

# Tagging
<a name="API_Tagging"></a>

Container for `TagSet` elements.

## Contents
<a name="API_Tagging_Contents"></a>

 ** TagSet **   <a name="AmazonS3-Type-Tagging-TagSet"></a>
A collection for a set of tags  
Type: Array of [Tag](API_Tag.md) data types  
Required: Yes

## See Also
<a name="API_Tagging_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/Tagging) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/Tagging) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/Tagging) 

# TargetGrant
<a name="API_TargetGrant"></a>

Container for granting information.

Buckets that use the bucket owner enforced setting for Object Ownership don't support target grants. For more information, see [Permissions server access log delivery](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general) in the *Amazon S3 User Guide*.

## Contents
<a name="API_TargetGrant_Contents"></a>

 ** Grantee **   <a name="AmazonS3-Type-TargetGrant-Grantee"></a>
Container for the person being granted permissions.  
Type: [Grantee](API_Grantee.md) data type  
Required: No

 ** Permission **   <a name="AmazonS3-Type-TargetGrant-Permission"></a>
Logging permissions assigned to the grantee for the bucket.  
Type: String  
Valid Values: `FULL_CONTROL | READ | WRITE`   
Required: No

## See Also
<a name="API_TargetGrant_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/TargetGrant) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/TargetGrant) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/TargetGrant) 

# TargetObjectKeyFormat
<a name="API_TargetObjectKeyFormat"></a>

Amazon S3 key format for log objects. Only one format, PartitionedPrefix or SimplePrefix, is allowed.

## Contents
<a name="API_TargetObjectKeyFormat_Contents"></a>

 ** PartitionedPrefix **   <a name="AmazonS3-Type-TargetObjectKeyFormat-PartitionedPrefix"></a>
Partitioned S3 key for log objects.  
Type: [PartitionedPrefix](API_PartitionedPrefix.md) data type  
Required: No

 ** SimplePrefix **   <a name="AmazonS3-Type-TargetObjectKeyFormat-SimplePrefix"></a>
To use the simple format for S3 keys for log objects. To specify SimplePrefix format, set SimplePrefix to \$1\$1.  
Type: [SimplePrefix](API_SimplePrefix.md) data type  
Required: No

## See Also
<a name="API_TargetObjectKeyFormat_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/TargetObjectKeyFormat) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/TargetObjectKeyFormat) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/TargetObjectKeyFormat) 

# Tiering
<a name="API_Tiering"></a>

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead.

## Contents
<a name="API_Tiering_Contents"></a>

 ** AccessTier **   <a name="AmazonS3-Type-Tiering-AccessTier"></a>
S3 Intelligent-Tiering access tier. See [Storage class for automatically optimizing frequently and infrequently accessed objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access) for a list of access tiers in the S3 Intelligent-Tiering storage class.  
Type: String  
Valid Values: `ARCHIVE_ACCESS | DEEP_ARCHIVE_ACCESS`   
Required: Yes

 ** Days **   <a name="AmazonS3-Type-Tiering-Days"></a>
The number of consecutive days of no access after which an object will be eligible to be transitioned to the corresponding tier. The minimum number of days specified for Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least 180 days. The maximum can be up to 2 years (730 days).  
Type: Integer  
Required: Yes

## See Also
<a name="API_Tiering_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/Tiering) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/Tiering) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/Tiering) 

# TopicConfiguration
<a name="API_TopicConfiguration"></a>

A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.

## Contents
<a name="API_TopicConfiguration_Contents"></a>

 ** Events **   <a name="AmazonS3-Type-TopicConfiguration-Events"></a>
The Amazon S3 bucket event about which to send notifications. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*.  
Type: Array of strings  
Valid Values: `s3:ReducedRedundancyLostObject | s3:ObjectCreated:* | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved:* | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated | s3:ObjectRestore:* | s3:ObjectRestore:Post | s3:ObjectRestore:Completed | s3:Replication:* | s3:Replication:OperationFailedReplication | s3:Replication:OperationNotTracked | s3:Replication:OperationMissedThreshold | s3:Replication:OperationReplicatedAfterThreshold | s3:ObjectRestore:Delete | s3:LifecycleTransition | s3:IntelligentTiering | s3:ObjectAcl:Put | s3:LifecycleExpiration:* | s3:LifecycleExpiration:Delete | s3:LifecycleExpiration:DeleteMarkerCreated | s3:ObjectTagging:* | s3:ObjectTagging:Put | s3:ObjectTagging:Delete`   
Required: Yes

 ** TopicArn **   <a name="AmazonS3-Type-TopicConfiguration-TopicArn"></a>
The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type.  
Type: String  
Required: Yes

 ** Filter **   <a name="AmazonS3-Type-TopicConfiguration-Filter"></a>
Specifies object key name filtering rules. For information about key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*.  
Type: [NotificationConfigurationFilter](API_NotificationConfigurationFilter.md) data type  
Required: No

 ** Id **   <a name="AmazonS3-Type-TopicConfiguration-Id"></a>
An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.  
Type: String  
Required: No

## See Also
<a name="API_TopicConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/TopicConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/TopicConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/TopicConfiguration) 

# TopicConfigurationDeprecated
<a name="API_TopicConfigurationDeprecated"></a>

A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events. This data type is deprecated. Use [TopicConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/API_TopicConfiguration.html) instead.

## Contents
<a name="API_TopicConfigurationDeprecated_Contents"></a>

 ** Event **   <a name="AmazonS3-Type-TopicConfigurationDeprecated-Event"></a>
 *This member has been deprecated.*   
Bucket event for which to send notifications.  
Type: String  
Valid Values: `s3:ReducedRedundancyLostObject | s3:ObjectCreated:* | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved:* | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated | s3:ObjectRestore:* | s3:ObjectRestore:Post | s3:ObjectRestore:Completed | s3:Replication:* | s3:Replication:OperationFailedReplication | s3:Replication:OperationNotTracked | s3:Replication:OperationMissedThreshold | s3:Replication:OperationReplicatedAfterThreshold | s3:ObjectRestore:Delete | s3:LifecycleTransition | s3:IntelligentTiering | s3:ObjectAcl:Put | s3:LifecycleExpiration:* | s3:LifecycleExpiration:Delete | s3:LifecycleExpiration:DeleteMarkerCreated | s3:ObjectTagging:* | s3:ObjectTagging:Put | s3:ObjectTagging:Delete`   
Required: No

 ** Events **   <a name="AmazonS3-Type-TopicConfigurationDeprecated-Events"></a>
A collection of events related to objects  
Type: Array of strings  
Valid Values: `s3:ReducedRedundancyLostObject | s3:ObjectCreated:* | s3:ObjectCreated:Put | s3:ObjectCreated:Post | s3:ObjectCreated:Copy | s3:ObjectCreated:CompleteMultipartUpload | s3:ObjectRemoved:* | s3:ObjectRemoved:Delete | s3:ObjectRemoved:DeleteMarkerCreated | s3:ObjectRestore:* | s3:ObjectRestore:Post | s3:ObjectRestore:Completed | s3:Replication:* | s3:Replication:OperationFailedReplication | s3:Replication:OperationNotTracked | s3:Replication:OperationMissedThreshold | s3:Replication:OperationReplicatedAfterThreshold | s3:ObjectRestore:Delete | s3:LifecycleTransition | s3:IntelligentTiering | s3:ObjectAcl:Put | s3:LifecycleExpiration:* | s3:LifecycleExpiration:Delete | s3:LifecycleExpiration:DeleteMarkerCreated | s3:ObjectTagging:* | s3:ObjectTagging:Put | s3:ObjectTagging:Delete`   
Required: No

 ** Id **   <a name="AmazonS3-Type-TopicConfigurationDeprecated-Id"></a>
An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.  
Type: String  
Required: No

 ** Topic **   <a name="AmazonS3-Type-TopicConfigurationDeprecated-Topic"></a>
Amazon SNS topic to which Amazon S3 will publish a message to report the specified events for the bucket.  
Type: String  
Required: No

## See Also
<a name="API_TopicConfigurationDeprecated_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/TopicConfigurationDeprecated) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/TopicConfigurationDeprecated) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/TopicConfigurationDeprecated) 

# Transition
<a name="API_Transition"></a>

Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see [Transitioning Objects Using Amazon S3 Lifecycle](https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html) in the *Amazon S3 User Guide*.

## Contents
<a name="API_Transition_Contents"></a>

 ** Date **   <a name="AmazonS3-Type-Transition-Date"></a>
Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.  
Type: Timestamp  
Required: No

 ** Days **   <a name="AmazonS3-Type-Transition-Days"></a>
Indicates the number of days after creation when objects are transitioned to the specified storage class. If the specified storage class is `INTELLIGENT_TIERING`, `GLACIER_IR`, `GLACIER`, or `DEEP_ARCHIVE`, valid values are `0` or positive integers. If the specified storage class is `STANDARD_IA` or `ONEZONE_IA`, valid values are positive integers greater than `30`. Be aware that some storage classes have a minimum storage duration and that you're charged for transitioning objects before their minimum storage duration. For more information, see [ Constraints and considerations for transitions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-transition-general-considerations.html#lifecycle-configuration-constraints) in the *Amazon S3 User Guide*.  
Type: Integer  
Required: No

 ** StorageClass **   <a name="AmazonS3-Type-Transition-StorageClass"></a>
The storage class to which you want the object to transition.  
Type: String  
Valid Values: `GLACIER | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | DEEP_ARCHIVE | GLACIER_IR`   
Required: No

## See Also
<a name="API_Transition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/Transition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/Transition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/Transition) 

# VersioningConfiguration
<a name="API_VersioningConfiguration"></a>

Describes the versioning state of an Amazon S3 bucket. For more information, see [PUT Bucket versioning](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html) in the *Amazon S3 API Reference*.

## Contents
<a name="API_VersioningConfiguration_Contents"></a>

 ** MFADelete **   <a name="AmazonS3-Type-VersioningConfiguration-MFADelete"></a>
Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.  
Type: String  
Valid Values: `Enabled | Disabled`   
Required: No

 ** Status **   <a name="AmazonS3-Type-VersioningConfiguration-Status"></a>
The versioning state of the bucket.  
Type: String  
Valid Values: `Enabled | Suspended`   
Required: No

## See Also
<a name="API_VersioningConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/VersioningConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/VersioningConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/VersioningConfiguration) 

# WebsiteConfiguration
<a name="API_WebsiteConfiguration"></a>

Specifies website configuration parameters for an Amazon S3 bucket.

## Contents
<a name="API_WebsiteConfiguration_Contents"></a>

 ** ErrorDocument **   <a name="AmazonS3-Type-WebsiteConfiguration-ErrorDocument"></a>
The name of the error document for the website.  
Type: [ErrorDocument](API_ErrorDocument.md) data type  
Required: No

 ** IndexDocument **   <a name="AmazonS3-Type-WebsiteConfiguration-IndexDocument"></a>
The name of the index document for the website.  
Type: [IndexDocument](API_IndexDocument.md) data type  
Required: No

 ** RedirectAllRequestsTo **   <a name="AmazonS3-Type-WebsiteConfiguration-RedirectAllRequestsTo"></a>
The redirect behavior for every request to this bucket's website endpoint.  
If you specify this property, you can't specify any other property.
Type: [RedirectAllRequestsTo](API_RedirectAllRequestsTo.md) data type  
Required: No

 ** RoutingRules **   <a name="AmazonS3-Type-WebsiteConfiguration-RoutingRules"></a>
Rules that define when a redirect is applied and the redirect behavior.  
Type: Array of [RoutingRule](API_RoutingRule.md) data types  
Required: No

## See Also
<a name="API_WebsiteConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/WebsiteConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/WebsiteConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/WebsiteConfiguration) 

# Amazon S3 Control
<a name="API_Types_AWS_S3_Control"></a>

The following data types are supported by Amazon S3 Control:
+  [AbortIncompleteMultipartUpload](API_control_AbortIncompleteMultipartUpload.md) 
+  [AccessControlTranslation](API_control_AccessControlTranslation.md) 
+  [AccessGrantsLocationConfiguration](API_control_AccessGrantsLocationConfiguration.md) 
+  [AccessPoint](API_control_AccessPoint.md) 
+  [AccountLevel](API_control_AccountLevel.md) 
+  [ActivityMetrics](API_control_ActivityMetrics.md) 
+  [AdvancedCostOptimizationMetrics](API_control_AdvancedCostOptimizationMetrics.md) 
+  [AdvancedDataProtectionMetrics](API_control_AdvancedDataProtectionMetrics.md) 
+  [AdvancedPerformanceMetrics](API_control_AdvancedPerformanceMetrics.md) 
+  [AsyncErrorDetails](API_control_AsyncErrorDetails.md) 
+  [AsyncOperation](API_control_AsyncOperation.md) 
+  [AsyncRequestParameters](API_control_AsyncRequestParameters.md) 
+  [AsyncResponseDetails](API_control_AsyncResponseDetails.md) 
+  [AwsLambdaTransformation](API_control_AwsLambdaTransformation.md) 
+  [BucketLevel](API_control_BucketLevel.md) 
+  [CloudWatchMetrics](API_control_CloudWatchMetrics.md) 
+  [CreateBucketConfiguration](API_control_CreateBucketConfiguration.md) 
+  [CreateMultiRegionAccessPointInput](API_control_CreateMultiRegionAccessPointInput.md) 
+  [Credentials](API_control_Credentials.md) 
+  [DeleteMarkerReplication](API_control_DeleteMarkerReplication.md) 
+  [DeleteMultiRegionAccessPointInput](API_control_DeleteMultiRegionAccessPointInput.md) 
+  [Destination](API_control_Destination.md) 
+  [DetailedStatusCodesMetrics](API_control_DetailedStatusCodesMetrics.md) 
+  [DSSEKMSFilter](API_control_DSSEKMSFilter.md) 
+  [EncryptionConfiguration](API_control_EncryptionConfiguration.md) 
+  [EstablishedMultiRegionAccessPointPolicy](API_control_EstablishedMultiRegionAccessPointPolicy.md) 
+  [Exclude](API_control_Exclude.md) 
+  [ExistingObjectReplication](API_control_ExistingObjectReplication.md) 
+  [GeneratedManifestEncryption](API_control_GeneratedManifestEncryption.md) 
+  [Grantee](API_control_Grantee.md) 
+  [Include](API_control_Include.md) 
+  [JobDescriptor](API_control_JobDescriptor.md) 
+  [JobFailure](API_control_JobFailure.md) 
+  [JobListDescriptor](API_control_JobListDescriptor.md) 
+  [JobManifest](API_control_JobManifest.md) 
+  [JobManifestGenerator](API_control_JobManifestGenerator.md) 
+  [JobManifestGeneratorFilter](API_control_JobManifestGeneratorFilter.md) 
+  [JobManifestLocation](API_control_JobManifestLocation.md) 
+  [JobManifestSpec](API_control_JobManifestSpec.md) 
+  [JobOperation](API_control_JobOperation.md) 
+  [JobProgressSummary](API_control_JobProgressSummary.md) 
+  [JobReport](API_control_JobReport.md) 
+  [JobTimers](API_control_JobTimers.md) 
+  [KeyNameConstraint](API_control_KeyNameConstraint.md) 
+  [LambdaInvokeOperation](API_control_LambdaInvokeOperation.md) 
+  [LifecycleConfiguration](API_control_LifecycleConfiguration.md) 
+  [LifecycleExpiration](API_control_LifecycleExpiration.md) 
+  [LifecycleRule](API_control_LifecycleRule.md) 
+  [LifecycleRuleAndOperator](API_control_LifecycleRuleAndOperator.md) 
+  [LifecycleRuleFilter](API_control_LifecycleRuleFilter.md) 
+  [ListAccessGrantEntry](API_control_ListAccessGrantEntry.md) 
+  [ListAccessGrantsInstanceEntry](API_control_ListAccessGrantsInstanceEntry.md) 
+  [ListAccessGrantsLocationsEntry](API_control_ListAccessGrantsLocationsEntry.md) 
+  [ListCallerAccessGrantsEntry](API_control_ListCallerAccessGrantsEntry.md) 
+  [ListStorageLensConfigurationEntry](API_control_ListStorageLensConfigurationEntry.md) 
+  [ListStorageLensGroupEntry](API_control_ListStorageLensGroupEntry.md) 
+  [MatchObjectAge](API_control_MatchObjectAge.md) 
+  [MatchObjectSize](API_control_MatchObjectSize.md) 
+  [Metrics](API_control_Metrics.md) 
+  [MultiRegionAccessPointPolicyDocument](API_control_MultiRegionAccessPointPolicyDocument.md) 
+  [MultiRegionAccessPointRegionalResponse](API_control_MultiRegionAccessPointRegionalResponse.md) 
+  [MultiRegionAccessPointReport](API_control_MultiRegionAccessPointReport.md) 
+  [MultiRegionAccessPointRoute](API_control_MultiRegionAccessPointRoute.md) 
+  [MultiRegionAccessPointsAsyncResponse](API_control_MultiRegionAccessPointsAsyncResponse.md) 
+  [NoncurrentVersionExpiration](API_control_NoncurrentVersionExpiration.md) 
+  [NoncurrentVersionTransition](API_control_NoncurrentVersionTransition.md) 
+  [NotSSEFilter](API_control_NotSSEFilter.md) 
+  [ObjectEncryption](API_control_ObjectEncryption.md) 
+  [ObjectEncryptionFilter](API_control_ObjectEncryptionFilter.md) 
+  [ObjectLambdaAccessPoint](API_control_ObjectLambdaAccessPoint.md) 
+  [ObjectLambdaAccessPointAlias](API_control_ObjectLambdaAccessPointAlias.md) 
+  [ObjectLambdaConfiguration](API_control_ObjectLambdaConfiguration.md) 
+  [ObjectLambdaContentTransformation](API_control_ObjectLambdaContentTransformation.md) 
+  [ObjectLambdaTransformationConfiguration](API_control_ObjectLambdaTransformationConfiguration.md) 
+  [PolicyStatus](API_control_PolicyStatus.md) 
+  [PrefixLevel](API_control_PrefixLevel.md) 
+  [PrefixLevelStorageMetrics](API_control_PrefixLevelStorageMetrics.md) 
+  [ProposedMultiRegionAccessPointPolicy](API_control_ProposedMultiRegionAccessPointPolicy.md) 
+  [PublicAccessBlockConfiguration](API_control_PublicAccessBlockConfiguration.md) 
+  [PutMultiRegionAccessPointPolicyInput](API_control_PutMultiRegionAccessPointPolicyInput.md) 
+  [Region](API_control_Region.md) 
+  [RegionalBucket](API_control_RegionalBucket.md) 
+  [RegionReport](API_control_RegionReport.md) 
+  [ReplicaModifications](API_control_ReplicaModifications.md) 
+  [ReplicationConfiguration](API_control_ReplicationConfiguration.md) 
+  [ReplicationRule](API_control_ReplicationRule.md) 
+  [ReplicationRuleAndOperator](API_control_ReplicationRuleAndOperator.md) 
+  [ReplicationRuleFilter](API_control_ReplicationRuleFilter.md) 
+  [ReplicationTime](API_control_ReplicationTime.md) 
+  [ReplicationTimeValue](API_control_ReplicationTimeValue.md) 
+  [S3AccessControlList](API_control_S3AccessControlList.md) 
+  [S3AccessControlPolicy](API_control_S3AccessControlPolicy.md) 
+  [S3BucketDestination](API_control_S3BucketDestination.md) 
+  [S3ComputeObjectChecksumOperation](API_control_S3ComputeObjectChecksumOperation.md) 
+  [S3CopyObjectOperation](API_control_S3CopyObjectOperation.md) 
+  [S3DeleteObjectTaggingOperation](API_control_S3DeleteObjectTaggingOperation.md) 
+  [S3GeneratedManifestDescriptor](API_control_S3GeneratedManifestDescriptor.md) 
+  [S3Grant](API_control_S3Grant.md) 
+  [S3Grantee](API_control_S3Grantee.md) 
+  [S3InitiateRestoreObjectOperation](API_control_S3InitiateRestoreObjectOperation.md) 
+  [S3JobManifestGenerator](API_control_S3JobManifestGenerator.md) 
+  [S3ManifestOutputLocation](API_control_S3ManifestOutputLocation.md) 
+  [S3ObjectLockLegalHold](API_control_S3ObjectLockLegalHold.md) 
+  [S3ObjectMetadata](API_control_S3ObjectMetadata.md) 
+  [S3ObjectOwner](API_control_S3ObjectOwner.md) 
+  [S3ReplicateObjectOperation](API_control_S3ReplicateObjectOperation.md) 
+  [S3Retention](API_control_S3Retention.md) 
+  [S3SetObjectAclOperation](API_control_S3SetObjectAclOperation.md) 
+  [S3SetObjectLegalHoldOperation](API_control_S3SetObjectLegalHoldOperation.md) 
+  [S3SetObjectRetentionOperation](API_control_S3SetObjectRetentionOperation.md) 
+  [S3SetObjectTaggingOperation](API_control_S3SetObjectTaggingOperation.md) 
+  [S3Tag](API_control_S3Tag.md) 
+  [S3UpdateObjectEncryptionOperation](API_control_S3UpdateObjectEncryptionOperation.md) 
+  [S3UpdateObjectEncryptionSSEKMS](API_control_S3UpdateObjectEncryptionSSEKMS.md) 
+  [Scope](API_control_Scope.md) 
+  [SelectionCriteria](API_control_SelectionCriteria.md) 
+  [SourceSelectionCriteria](API_control_SourceSelectionCriteria.md) 
+  [SSECFilter](API_control_SSECFilter.md) 
+  [SSEKMS](API_control_SSEKMS.md) 
+  [SseKmsEncryptedObjects](API_control_SseKmsEncryptedObjects.md) 
+  [SSEKMSEncryption](API_control_SSEKMSEncryption.md) 
+  [SSEKMSFilter](API_control_SSEKMSFilter.md) 
+  [SSES3](API_control_SSES3.md) 
+  [SSES3Encryption](API_control_SSES3Encryption.md) 
+  [SSES3Filter](API_control_SSES3Filter.md) 
+  [StorageLensAwsOrg](API_control_StorageLensAwsOrg.md) 
+  [StorageLensConfiguration](API_control_StorageLensConfiguration.md) 
+  [StorageLensDataExport](API_control_StorageLensDataExport.md) 
+  [StorageLensDataExportEncryption](API_control_StorageLensDataExportEncryption.md) 
+  [StorageLensExpandedPrefixesDataExport](API_control_StorageLensExpandedPrefixesDataExport.md) 
+  [StorageLensGroup](API_control_StorageLensGroup.md) 
+  [StorageLensGroupAndOperator](API_control_StorageLensGroupAndOperator.md) 
+  [StorageLensGroupFilter](API_control_StorageLensGroupFilter.md) 
+  [StorageLensGroupLevel](API_control_StorageLensGroupLevel.md) 
+  [StorageLensGroupLevelSelectionCriteria](API_control_StorageLensGroupLevelSelectionCriteria.md) 
+  [StorageLensGroupOrOperator](API_control_StorageLensGroupOrOperator.md) 
+  [StorageLensTableDestination](API_control_StorageLensTableDestination.md) 
+  [StorageLensTag](API_control_StorageLensTag.md) 
+  [Tag](API_control_Tag.md) 
+  [Tagging](API_control_Tagging.md) 
+  [Transition](API_control_Transition.md) 
+  [VersioningConfiguration](API_control_VersioningConfiguration.md) 
+  [VpcConfiguration](API_control_VpcConfiguration.md) 

# AbortIncompleteMultipartUpload
<a name="API_control_AbortIncompleteMultipartUpload"></a>

The container for abort incomplete multipart upload

## Contents
<a name="API_control_AbortIncompleteMultipartUpload_Contents"></a>

 ** DaysAfterInitiation **   <a name="AmazonS3-Type-control_AbortIncompleteMultipartUpload-DaysAfterInitiation"></a>
Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload to the Outposts bucket.  
Type: Integer  
Required: No

## See Also
<a name="API_control_AbortIncompleteMultipartUpload_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/AbortIncompleteMultipartUpload) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/AbortIncompleteMultipartUpload) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/AbortIncompleteMultipartUpload) 

# AccessControlTranslation
<a name="API_control_AccessControlTranslation"></a>

A container for information about access control for replicas.

**Note**  
This is not supported by Amazon S3 on Outposts buckets.

## Contents
<a name="API_control_AccessControlTranslation_Contents"></a>

 ** Owner **   <a name="AmazonS3-Type-control_AccessControlTranslation-Owner"></a>
Specifies the replica ownership.  
Type: String  
Valid Values: `Destination`   
Required: Yes

## See Also
<a name="API_control_AccessControlTranslation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/AccessControlTranslation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/AccessControlTranslation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/AccessControlTranslation) 

# AccessGrantsLocationConfiguration
<a name="API_control_AccessGrantsLocationConfiguration"></a>

The configuration options of the S3 Access Grants location. It contains the `S3SubPrefix` field. The grant scope, the data to which you are granting access, is the result of appending the `Subprefix` field to the scope of the registered location.

## Contents
<a name="API_control_AccessGrantsLocationConfiguration_Contents"></a>

 ** S3SubPrefix **   <a name="AmazonS3-Type-control_AccessGrantsLocationConfiguration-S3SubPrefix"></a>
The `S3SubPrefix` is appended to the location scope creating the grant scope. Use this field to narrow the scope of the grant to a subset of the location scope. This field is required if the location scope is the default location `s3://` because you cannot create a grant for all of your S3 data in the Region and must narrow the scope. For example, if the location scope is the default location `s3://`, the `S3SubPrefx` can be a <bucket-name>/\$1, so the full grant scope path would be `s3://<bucket-name>/*`. Or the `S3SubPrefx` can be `<bucket-name>/<prefix-name>*`, so the full grant scope path would be or `s3://<bucket-name>/<prefix-name>*`.  
If the `S3SubPrefix` includes a prefix, append the wildcard character `*` after the prefix to indicate that you want to include all object key names in the bucket that start with that prefix.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Pattern: `^.+$`   
Required: No

## See Also
<a name="API_control_AccessGrantsLocationConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/AccessGrantsLocationConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/AccessGrantsLocationConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/AccessGrantsLocationConfiguration) 

# AccessPoint
<a name="API_control_AccessPoint"></a>

An access point used to access a bucket.

## Contents
<a name="API_control_AccessPoint_Contents"></a>

 ** Bucket **   <a name="AmazonS3-Type-control_AccessPoint-Bucket"></a>
The name of the bucket associated with this access point.  
Type: String  
Length Constraints: Maximum length of 255.  
Required: Yes

 ** Name **   <a name="AmazonS3-Type-control_AccessPoint-Name"></a>
The name of this access point.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Required: Yes

 ** NetworkOrigin **   <a name="AmazonS3-Type-control_AccessPoint-NetworkOrigin"></a>
Indicates whether this access point allows access from the public internet. If `VpcConfiguration` is specified for this access point, then `NetworkOrigin` is `VPC`, and the access point doesn't allow access from the public internet. Otherwise, `NetworkOrigin` is `Internet`, and the access point allows access from the public internet, subject to the access point and bucket access policies.  
Type: String  
Valid Values: `Internet | VPC`   
Required: Yes

 ** AccessPointArn **   <a name="AmazonS3-Type-control_AccessPoint-AccessPointArn"></a>
The ARN for the access point.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 128.  
Required: No

 ** Alias **   <a name="AmazonS3-Type-control_AccessPoint-Alias"></a>
The name or alias of the access point.  
Type: String  
Length Constraints: Maximum length of 63.  
Pattern: `^[0-9a-z\\-]{63}`   
Required: No

 ** BucketAccountId **   <a name="AmazonS3-Type-control_AccessPoint-BucketAccountId"></a>
The AWS account ID associated with the S3 bucket associated with this access point.  
Type: String  
Length Constraints: Maximum length of 64.  
Pattern: `^\d{12}$`   
Required: No

 ** DataSourceId **   <a name="AmazonS3-Type-control_AccessPoint-DataSourceId"></a>
A unique identifier for the data source of the access point.  
Type: String  
Length Constraints: Maximum length of 191.  
Required: No

 ** DataSourceType **   <a name="AmazonS3-Type-control_AccessPoint-DataSourceType"></a>
The type of the data source that the access point is attached to.  
Type: String  
Required: No

 ** VpcConfiguration **   <a name="AmazonS3-Type-control_AccessPoint-VpcConfiguration"></a>
The virtual private cloud (VPC) configuration for this access point, if one exists.  
This element is empty if this access point is an Amazon S3 on Outposts access point that is used by other AWS services.
Type: [VpcConfiguration](API_control_VpcConfiguration.md) data type  
Required: No

## See Also
<a name="API_control_AccessPoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/AccessPoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/AccessPoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/AccessPoint) 

# AccountLevel
<a name="API_control_AccountLevel"></a>

A container element for the account-level Amazon S3 Storage Lens configuration.

**Note**  
You must enable Storage Lens metrics consistently at both the account level and bucket level, or your request will fail.

For more information about S3 Storage Lens, see [Assessing your storage activity and usage with S3 Storage Lens](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the *Amazon S3 User Guide*. For a complete list of S3 Storage Lens metrics, see [S3 Storage Lens metrics glossary](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) in the *Amazon S3 User Guide*.

## Contents
<a name="API_control_AccountLevel_Contents"></a>

 ** BucketLevel **   <a name="AmazonS3-Type-control_AccountLevel-BucketLevel"></a>
A container element for the S3 Storage Lens bucket-level configuration.  
Type: [BucketLevel](API_control_BucketLevel.md) data type  
Required: Yes

 ** ActivityMetrics **   <a name="AmazonS3-Type-control_AccountLevel-ActivityMetrics"></a>
A container element for S3 Storage Lens activity metrics.  
Type: [ActivityMetrics](API_control_ActivityMetrics.md) data type  
Required: No

 ** AdvancedCostOptimizationMetrics **   <a name="AmazonS3-Type-control_AccountLevel-AdvancedCostOptimizationMetrics"></a>
A container element for S3 Storage Lens advanced cost-optimization metrics.  
Type: [AdvancedCostOptimizationMetrics](API_control_AdvancedCostOptimizationMetrics.md) data type  
Required: No

 ** AdvancedDataProtectionMetrics **   <a name="AmazonS3-Type-control_AccountLevel-AdvancedDataProtectionMetrics"></a>
A container element for S3 Storage Lens advanced data-protection metrics.  
Type: [AdvancedDataProtectionMetrics](API_control_AdvancedDataProtectionMetrics.md) data type  
Required: No

 ** AdvancedPerformanceMetrics **   <a name="AmazonS3-Type-control_AccountLevel-AdvancedPerformanceMetrics"></a>
A container element for S3 Storage Lens advanced performance metrics.  
Type: [AdvancedPerformanceMetrics](API_control_AdvancedPerformanceMetrics.md) data type  
Required: No

 ** DetailedStatusCodesMetrics **   <a name="AmazonS3-Type-control_AccountLevel-DetailedStatusCodesMetrics"></a>
A container element for detailed status code metrics.   
Type: [DetailedStatusCodesMetrics](API_control_DetailedStatusCodesMetrics.md) data type  
Required: No

 ** StorageLensGroupLevel **   <a name="AmazonS3-Type-control_AccountLevel-StorageLensGroupLevel"></a>
 A container element for S3 Storage Lens groups metrics.   
Type: [StorageLensGroupLevel](API_control_StorageLensGroupLevel.md) data type  
Required: No

## See Also
<a name="API_control_AccountLevel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/AccountLevel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/AccountLevel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/AccountLevel) 

# ActivityMetrics
<a name="API_control_ActivityMetrics"></a>

The container element for Amazon S3 Storage Lens activity metrics. Activity metrics show details about how your storage is requested, such as requests (for example, All requests, Get requests, Put requests), bytes uploaded or downloaded, and errors.

For more information about S3 Storage Lens, see [Assessing your storage activity and usage with S3 Storage Lens](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the *Amazon S3 User Guide*. For a complete list of S3 Storage Lens metrics, see [S3 Storage Lens metrics glossary](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) in the *Amazon S3 User Guide*.

## Contents
<a name="API_control_ActivityMetrics_Contents"></a>

 ** IsEnabled **   <a name="AmazonS3-Type-control_ActivityMetrics-IsEnabled"></a>
A container that indicates whether activity metrics are enabled.  
Type: Boolean  
Required: No

## See Also
<a name="API_control_ActivityMetrics_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/ActivityMetrics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/ActivityMetrics) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/ActivityMetrics) 

# AdvancedCostOptimizationMetrics
<a name="API_control_AdvancedCostOptimizationMetrics"></a>

The container element for Amazon S3 Storage Lens advanced cost-optimization metrics. Advanced cost-optimization metrics provide insights that you can use to manage and optimize your storage costs, for example, lifecycle rule counts for transitions, expirations, and incomplete multipart uploads.

For more information about S3 Storage Lens, see [Assessing your storage activity and usage with S3 Storage Lens](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the *Amazon S3 User Guide*. For a complete list of S3 Storage Lens metrics, see [S3 Storage Lens metrics glossary](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) in the *Amazon S3 User Guide*.

## Contents
<a name="API_control_AdvancedCostOptimizationMetrics_Contents"></a>

 ** IsEnabled **   <a name="AmazonS3-Type-control_AdvancedCostOptimizationMetrics-IsEnabled"></a>
A container that indicates whether advanced cost-optimization metrics are enabled.  
Type: Boolean  
Required: No

## See Also
<a name="API_control_AdvancedCostOptimizationMetrics_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/AdvancedCostOptimizationMetrics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/AdvancedCostOptimizationMetrics) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/AdvancedCostOptimizationMetrics) 

# AdvancedDataProtectionMetrics
<a name="API_control_AdvancedDataProtectionMetrics"></a>

The container element for Amazon S3 Storage Lens advanced data-protection metrics. Advanced data-protection metrics provide insights that you can use to perform audits and protect your data, for example replication rule counts within and across Regions.

For more information about S3 Storage Lens, see [Assessing your storage activity and usage with S3 Storage Lens](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the *Amazon S3 User Guide*. For a complete list of S3 Storage Lens metrics, see [S3 Storage Lens metrics glossary](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) in the *Amazon S3 User Guide*.

## Contents
<a name="API_control_AdvancedDataProtectionMetrics_Contents"></a>

 ** IsEnabled **   <a name="AmazonS3-Type-control_AdvancedDataProtectionMetrics-IsEnabled"></a>
A container that indicates whether advanced data-protection metrics are enabled.  
Type: Boolean  
Required: No

## See Also
<a name="API_control_AdvancedDataProtectionMetrics_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/AdvancedDataProtectionMetrics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/AdvancedDataProtectionMetrics) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/AdvancedDataProtectionMetrics) 

# AdvancedPerformanceMetrics
<a name="API_control_AdvancedPerformanceMetrics"></a>

The container element for S3 Storage Lens advanced performance metrics. Advanced performance metrics provide insights into application performance, such as request efficiency and access patterns. These metrics help you optimize your S3 storage for both cost and performance by providing detailed analytics on how your applications interact with S3 resources.

For more information about S3 Storage Lens, see [Assessing your storage activity and usage with S3 Storage Lens](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the *Amazon S3 User Guide*. For a complete list of S3 Storage Lens metrics, see [S3 Storage Lens metrics glossary](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) in the *Amazon S3 User Guide*.

## Contents
<a name="API_control_AdvancedPerformanceMetrics_Contents"></a>

 ** IsEnabled **   <a name="AmazonS3-Type-control_AdvancedPerformanceMetrics-IsEnabled"></a>
A container that indicates whether S3 Storage Lens advanced performance metrics are enabled.  
Type: Boolean  
Required: No

## See Also
<a name="API_control_AdvancedPerformanceMetrics_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/AdvancedPerformanceMetrics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/AdvancedPerformanceMetrics) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/AdvancedPerformanceMetrics) 

# AsyncErrorDetails
<a name="API_control_AsyncErrorDetails"></a>

Error details for the failed asynchronous operation.

## Contents
<a name="API_control_AsyncErrorDetails_Contents"></a>

 ** Code **   <a name="AmazonS3-Type-control_AsyncErrorDetails-Code"></a>
A string that uniquely identifies the error condition.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** Message **   <a name="AmazonS3-Type-control_AsyncErrorDetails-Message"></a>
A generic description of the error condition in English.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** RequestId **   <a name="AmazonS3-Type-control_AsyncErrorDetails-RequestId"></a>
The ID of the request associated with the error.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** Resource **   <a name="AmazonS3-Type-control_AsyncErrorDetails-Resource"></a>
The identifier of the resource associated with the error.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

## See Also
<a name="API_control_AsyncErrorDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/AsyncErrorDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/AsyncErrorDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/AsyncErrorDetails) 

# AsyncOperation
<a name="API_control_AsyncOperation"></a>

A container for the information about an asynchronous operation.

## Contents
<a name="API_control_AsyncOperation_Contents"></a>

 ** CreationTime **   <a name="AmazonS3-Type-control_AsyncOperation-CreationTime"></a>
The time that the request was sent to the service.  
Type: Timestamp  
Required: No

 ** Operation **   <a name="AmazonS3-Type-control_AsyncOperation-Operation"></a>
The specific operation for the asynchronous request.  
Type: String  
Valid Values: `CreateMultiRegionAccessPoint | DeleteMultiRegionAccessPoint | PutMultiRegionAccessPointPolicy`   
Required: No

 ** RequestParameters **   <a name="AmazonS3-Type-control_AsyncOperation-RequestParameters"></a>
The parameters associated with the request.  
Type: [AsyncRequestParameters](API_control_AsyncRequestParameters.md) data type  
Required: No

 ** RequestStatus **   <a name="AmazonS3-Type-control_AsyncOperation-RequestStatus"></a>
The current status of the request.  
Type: String  
Required: No

 ** RequestTokenARN **   <a name="AmazonS3-Type-control_AsyncOperation-RequestTokenARN"></a>
The request token associated with the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:.+`   
Required: No

 ** ResponseDetails **   <a name="AmazonS3-Type-control_AsyncOperation-ResponseDetails"></a>
The details of the response.  
Type: [AsyncResponseDetails](API_control_AsyncResponseDetails.md) data type  
Required: No

## See Also
<a name="API_control_AsyncOperation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/AsyncOperation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/AsyncOperation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/AsyncOperation) 

# AsyncRequestParameters
<a name="API_control_AsyncRequestParameters"></a>

A container for the request parameters associated with an asynchronous request.

## Contents
<a name="API_control_AsyncRequestParameters_Contents"></a>

 ** CreateMultiRegionAccessPointRequest **   <a name="AmazonS3-Type-control_AsyncRequestParameters-CreateMultiRegionAccessPointRequest"></a>
A container of the parameters for a [CreateMultiRegionAccessPoint](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html) request.  
Type: [CreateMultiRegionAccessPointInput](API_control_CreateMultiRegionAccessPointInput.md) data type  
Required: No

 ** DeleteMultiRegionAccessPointRequest **   <a name="AmazonS3-Type-control_AsyncRequestParameters-DeleteMultiRegionAccessPointRequest"></a>
A container of the parameters for a [DeleteMultiRegionAccessPoint](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html) request.  
Type: [DeleteMultiRegionAccessPointInput](API_control_DeleteMultiRegionAccessPointInput.md) data type  
Required: No

 ** PutMultiRegionAccessPointPolicyRequest **   <a name="AmazonS3-Type-control_AsyncRequestParameters-PutMultiRegionAccessPointPolicyRequest"></a>
A container of the parameters for a [PutMultiRegionAccessPoint](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPoint.html) request.  
Type: [PutMultiRegionAccessPointPolicyInput](API_control_PutMultiRegionAccessPointPolicyInput.md) data type  
Required: No

## See Also
<a name="API_control_AsyncRequestParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/AsyncRequestParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/AsyncRequestParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/AsyncRequestParameters) 

# AsyncResponseDetails
<a name="API_control_AsyncResponseDetails"></a>

A container for the response details that are returned when querying about an asynchronous request.

## Contents
<a name="API_control_AsyncResponseDetails_Contents"></a>

 ** ErrorDetails **   <a name="AmazonS3-Type-control_AsyncResponseDetails-ErrorDetails"></a>
Error details for an asynchronous request.  
Type: [AsyncErrorDetails](API_control_AsyncErrorDetails.md) data type  
Required: No

 ** MultiRegionAccessPointDetails **   <a name="AmazonS3-Type-control_AsyncResponseDetails-MultiRegionAccessPointDetails"></a>
The details for the Multi-Region Access Point.  
Type: [MultiRegionAccessPointsAsyncResponse](API_control_MultiRegionAccessPointsAsyncResponse.md) data type  
Required: No

## See Also
<a name="API_control_AsyncResponseDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/AsyncResponseDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/AsyncResponseDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/AsyncResponseDetails) 

# AwsLambdaTransformation
<a name="API_control_AwsLambdaTransformation"></a>

 AWS Lambda function used to transform objects through an Object Lambda Access Point.

## Contents
<a name="API_control_AwsLambdaTransformation_Contents"></a>

 ** FunctionArn **   <a name="AmazonS3-Type-control_AwsLambdaTransformation-FunctionArn"></a>
The Amazon Resource Name (ARN) of the AWS Lambda function.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?`   
Required: Yes

 ** FunctionPayload **   <a name="AmazonS3-Type-control_AwsLambdaTransformation-FunctionPayload"></a>
Additional JSON that provides supplemental data to the Lambda function used to transform objects.  
Type: String  
Required: No

## See Also
<a name="API_control_AwsLambdaTransformation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/AwsLambdaTransformation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/AwsLambdaTransformation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/AwsLambdaTransformation) 

# BucketLevel
<a name="API_control_BucketLevel"></a>

A container for the bucket-level configuration for Amazon S3 Storage Lens.

For more information about S3 Storage Lens, see [Assessing your storage activity and usage with S3 Storage Lens](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the *Amazon S3 User Guide*.

## Contents
<a name="API_control_BucketLevel_Contents"></a>

 ** ActivityMetrics **   <a name="AmazonS3-Type-control_BucketLevel-ActivityMetrics"></a>
A container for the bucket-level activity metrics for S3 Storage Lens.  
Type: [ActivityMetrics](API_control_ActivityMetrics.md) data type  
Required: No

 ** AdvancedCostOptimizationMetrics **   <a name="AmazonS3-Type-control_BucketLevel-AdvancedCostOptimizationMetrics"></a>
A container for bucket-level advanced cost-optimization metrics for S3 Storage Lens.  
Type: [AdvancedCostOptimizationMetrics](API_control_AdvancedCostOptimizationMetrics.md) data type  
Required: No

 ** AdvancedDataProtectionMetrics **   <a name="AmazonS3-Type-control_BucketLevel-AdvancedDataProtectionMetrics"></a>
A container for bucket-level advanced data-protection metrics for S3 Storage Lens.  
Type: [AdvancedDataProtectionMetrics](API_control_AdvancedDataProtectionMetrics.md) data type  
Required: No

 ** AdvancedPerformanceMetrics **   <a name="AmazonS3-Type-control_BucketLevel-AdvancedPerformanceMetrics"></a>
A container for bucket-level advanced performance metrics for S3 Storage Lens.  
Type: [AdvancedPerformanceMetrics](API_control_AdvancedPerformanceMetrics.md) data type  
Required: No

 ** DetailedStatusCodesMetrics **   <a name="AmazonS3-Type-control_BucketLevel-DetailedStatusCodesMetrics"></a>
A container for bucket-level detailed status code metrics for S3 Storage Lens.  
Type: [DetailedStatusCodesMetrics](API_control_DetailedStatusCodesMetrics.md) data type  
Required: No

 ** PrefixLevel **   <a name="AmazonS3-Type-control_BucketLevel-PrefixLevel"></a>
A container for the prefix-level metrics for S3 Storage Lens.   
Type: [PrefixLevel](API_control_PrefixLevel.md) data type  
Required: No

## See Also
<a name="API_control_BucketLevel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/BucketLevel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/BucketLevel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/BucketLevel) 

# CloudWatchMetrics
<a name="API_control_CloudWatchMetrics"></a>

A container for enabling Amazon CloudWatch publishing for S3 Storage Lens metrics.

For more information about publishing S3 Storage Lens metrics to CloudWatch, see [Monitor S3 Storage Lens metrics in CloudWatch](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_view_metrics_cloudwatch.html) in the *Amazon S3 User Guide*.

## Contents
<a name="API_control_CloudWatchMetrics_Contents"></a>

 ** IsEnabled **   <a name="AmazonS3-Type-control_CloudWatchMetrics-IsEnabled"></a>
A container that indicates whether CloudWatch publishing for S3 Storage Lens metrics is enabled. A value of `true` indicates that CloudWatch publishing for S3 Storage Lens metrics is enabled.  
Type: Boolean  
Required: Yes

## See Also
<a name="API_control_CloudWatchMetrics_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/CloudWatchMetrics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/CloudWatchMetrics) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/CloudWatchMetrics) 

# CreateBucketConfiguration
<a name="API_control_CreateBucketConfiguration"></a>

The container for the bucket configuration.

**Note**  
This is not supported by Amazon S3 on Outposts buckets.

## Contents
<a name="API_control_CreateBucketConfiguration_Contents"></a>

 ** LocationConstraint **   <a name="AmazonS3-Type-control_CreateBucketConfiguration-LocationConstraint"></a>
Specifies the Region where the bucket will be created. If you are creating a bucket on the US East (N. Virginia) Region (us-east-1), you do not need to specify the location.   
This is not supported by Amazon S3 on Outposts buckets.
Type: String  
Valid Values: `EU | eu-west-1 | us-west-1 | us-west-2 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | ap-northeast-1 | sa-east-1 | cn-north-1 | eu-central-1`   
Required: No

## See Also
<a name="API_control_CreateBucketConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/CreateBucketConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/CreateBucketConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/CreateBucketConfiguration) 

# CreateMultiRegionAccessPointInput
<a name="API_control_CreateMultiRegionAccessPointInput"></a>

A container for the information associated with a [CreateMultiRegionAccessPoint](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html) request. 

## Contents
<a name="API_control_CreateMultiRegionAccessPointInput_Contents"></a>

 ** Name **   <a name="AmazonS3-Type-control_CreateMultiRegionAccessPointInput-Name"></a>
The name of the Multi-Region Access Point associated with this request.  
Type: String  
Length Constraints: Maximum length of 50.  
Pattern: `^[a-z0-9][-a-z0-9]{1,48}[a-z0-9]$`   
Required: Yes

 ** Regions **   <a name="AmazonS3-Type-control_CreateMultiRegionAccessPointInput-Regions"></a>
The buckets in different Regions that are associated with the Multi-Region Access Point.  
Type: Array of [Region](API_control_Region.md) data types  
Required: Yes

 ** PublicAccessBlock **   <a name="AmazonS3-Type-control_CreateMultiRegionAccessPointInput-PublicAccessBlock"></a>
The `PublicAccessBlock` configuration that you want to apply to this Amazon S3 account. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see [The Meaning of "Public"](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) in the *Amazon S3 User Guide*.  
This data type is not supported for Amazon S3 on Outposts.  
Type: [PublicAccessBlockConfiguration](API_control_PublicAccessBlockConfiguration.md) data type  
Required: No

## See Also
<a name="API_control_CreateMultiRegionAccessPointInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/CreateMultiRegionAccessPointInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/CreateMultiRegionAccessPointInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/CreateMultiRegionAccessPointInput) 

# Credentials
<a name="API_control_Credentials"></a>

The AWS Security Token Service temporary credential that S3 Access Grants vends to grantees and client applications. 

## Contents
<a name="API_control_Credentials_Contents"></a>

 ** AccessKeyId **   <a name="AmazonS3-Type-control_Credentials-AccessKeyId"></a>
The unique access key ID of the AWS STS temporary credential that S3 Access Grants vends to grantees and client applications.   
Type: String  
Required: No

 ** Expiration **   <a name="AmazonS3-Type-control_Credentials-Expiration"></a>
The expiration date and time of the temporary credential that S3 Access Grants vends to grantees and client applications.   
Type: Timestamp  
Required: No

 ** SecretAccessKey **   <a name="AmazonS3-Type-control_Credentials-SecretAccessKey"></a>
The secret access key of the AWS STS temporary credential that S3 Access Grants vends to grantees and client applications.   
Type: String  
Required: No

 ** SessionToken **   <a name="AmazonS3-Type-control_Credentials-SessionToken"></a>
The AWS STS temporary credential that S3 Access Grants vends to grantees and client applications.   
Type: String  
Required: No

## See Also
<a name="API_control_Credentials_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/Credentials) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/Credentials) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/Credentials) 

# DeleteMarkerReplication
<a name="API_control_DeleteMarkerReplication"></a>

Specifies whether S3 on Outposts replicates delete markers. If you specify a `Filter` element in your replication configuration, you must also include a `DeleteMarkerReplication` element. If your `Filter` includes a `Tag` element, the `DeleteMarkerReplication` element's `Status` child element must be set to `Disabled`, because S3 on Outposts does not support replicating delete markers for tag-based rules.

For more information about delete marker replication, see [How delete operations affect replication](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html#outposts-replication-what-is-replicated) in the *Amazon S3 User Guide*. 

## Contents
<a name="API_control_DeleteMarkerReplication_Contents"></a>

 ** Status **   <a name="AmazonS3-Type-control_DeleteMarkerReplication-Status"></a>
Indicates whether to replicate delete markers.  
Type: String  
Valid Values: `Enabled | Disabled`   
Required: Yes

## See Also
<a name="API_control_DeleteMarkerReplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/DeleteMarkerReplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/DeleteMarkerReplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/DeleteMarkerReplication) 

# DeleteMultiRegionAccessPointInput
<a name="API_control_DeleteMultiRegionAccessPointInput"></a>

A container for the information associated with a [DeleteMultiRegionAccessPoint](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html) request.

## Contents
<a name="API_control_DeleteMultiRegionAccessPointInput_Contents"></a>

 ** Name **   <a name="AmazonS3-Type-control_DeleteMultiRegionAccessPointInput-Name"></a>
The name of the Multi-Region Access Point associated with this request.  
Type: String  
Length Constraints: Maximum length of 50.  
Pattern: `^[a-z0-9][-a-z0-9]{1,48}[a-z0-9]$`   
Required: Yes

## See Also
<a name="API_control_DeleteMultiRegionAccessPointInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/DeleteMultiRegionAccessPointInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/DeleteMultiRegionAccessPointInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/DeleteMultiRegionAccessPointInput) 

# Destination
<a name="API_control_Destination"></a>

Specifies information about the replication destination bucket and its settings for an S3 on Outposts replication configuration.

## Contents
<a name="API_control_Destination_Contents"></a>

 ** Bucket **   <a name="AmazonS3-Type-control_Destination-Bucket"></a>
The Amazon Resource Name (ARN) of the access point for the destination bucket where you want S3 on Outposts to store the replication results.  
Type: String  
Required: Yes

 ** AccessControlTranslation **   <a name="AmazonS3-Type-control_Destination-AccessControlTranslation"></a>
Specify this property only in a cross-account scenario (where the source and destination bucket owners are not the same), and you want to change replica ownership to the AWS account that owns the destination bucket. If this property is not specified in the replication configuration, the replicas are owned by same AWS account that owns the source object.  
This is not supported by Amazon S3 on Outposts buckets.
Type: [AccessControlTranslation](API_control_AccessControlTranslation.md) data type  
Required: No

 ** Account **   <a name="AmazonS3-Type-control_Destination-Account"></a>
The destination bucket owner's account ID.   
Type: String  
Length Constraints: Maximum length of 64.  
Pattern: `^\d{12}$`   
Required: No

 ** EncryptionConfiguration **   <a name="AmazonS3-Type-control_Destination-EncryptionConfiguration"></a>
A container that provides information about encryption. If `SourceSelectionCriteria` is specified, you must specify this element.  
This is not supported by Amazon S3 on Outposts buckets.
Type: [EncryptionConfiguration](API_control_EncryptionConfiguration.md) data type  
Required: No

 ** Metrics **   <a name="AmazonS3-Type-control_Destination-Metrics"></a>
 A container that specifies replication metrics-related settings.   
Type: [Metrics](API_control_Metrics.md) data type  
Required: No

 ** ReplicationTime **   <a name="AmazonS3-Type-control_Destination-ReplicationTime"></a>
A container that specifies S3 Replication Time Control (S3 RTC) settings, including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a `Metrics` block.   
This is not supported by Amazon S3 on Outposts buckets.
Type: [ReplicationTime](API_control_ReplicationTime.md) data type  
Required: No

 ** StorageClass **   <a name="AmazonS3-Type-control_Destination-StorageClass"></a>
 The storage class to use when replicating objects. All objects stored on S3 on Outposts are stored in the `OUTPOSTS` storage class. S3 on Outposts uses the `OUTPOSTS` storage class to create the object replicas.   
Values other than `OUTPOSTS` aren't supported by Amazon S3 on Outposts. 
Type: String  
Valid Values: `STANDARD | REDUCED_REDUNDANCY | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_IR`   
Required: No

## See Also
<a name="API_control_Destination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/Destination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/Destination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/Destination) 

# DetailedStatusCodesMetrics
<a name="API_control_DetailedStatusCodesMetrics"></a>

The container element for Amazon S3 Storage Lens detailed status code metrics. Detailed status code metrics generate metrics for HTTP status codes, such as `200 OK`, `403 Forbidden`, `503 Service Unavailable` and others. 

For more information about S3 Storage Lens, see [Assessing your storage activity and usage with S3 Storage Lens](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the *Amazon S3 User Guide*. For a complete list of S3 Storage Lens metrics, see [S3 Storage Lens metrics glossary](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) in the *Amazon S3 User Guide*.

## Contents
<a name="API_control_DetailedStatusCodesMetrics_Contents"></a>

 ** IsEnabled **   <a name="AmazonS3-Type-control_DetailedStatusCodesMetrics-IsEnabled"></a>
A container that indicates whether detailed status code metrics are enabled.  
Type: Boolean  
Required: No

## See Also
<a name="API_control_DetailedStatusCodesMetrics_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/DetailedStatusCodesMetrics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/DetailedStatusCodesMetrics) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/DetailedStatusCodesMetrics) 

# DSSEKMSFilter
<a name="API_control_DSSEKMSFilter"></a>

A filter that returns objects that are encrypted by dual-layer server-side encryption with AWS Key Management Service (KMS) keys (DSSE-KMS). You can further refine your filtering by optionally providing a KMS Key ARN to filter objects encrypted by a specific key.

## Contents
<a name="API_control_DSSEKMSFilter_Contents"></a>

 ** KmsKeyArn **   <a name="AmazonS3-Type-control_DSSEKMSFilter-KmsKeyArn"></a>
The Amazon Resource Name (ARN) of the customer managed KMS key to use for the filter to return objects that are encrypted by the specified key. For best performance, use keys in the same Region as the S3 Batch Operations job.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws[a-zA-Z0-9-]*:kms:[a-z0-9-]+:[0-9]{12}:key/[a-zA-Z0-9-]+`   
Required: No

## See Also
<a name="API_control_DSSEKMSFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/DSSEKMSFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/DSSEKMSFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/DSSEKMSFilter) 

# EncryptionConfiguration
<a name="API_control_EncryptionConfiguration"></a>

Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects. If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then AWS KMS resolves the key within the requester’s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner.

**Note**  
This is not supported by Amazon S3 on Outposts buckets.

## Contents
<a name="API_control_EncryptionConfiguration_Contents"></a>

 ** ReplicaKmsKeyID **   <a name="AmazonS3-Type-control_EncryptionConfiguration-ReplicaKmsKeyID"></a>
Specifies the ID of the customer managed AWS KMS key that's stored in AWS Key Management Service (AWS KMS) for the destination bucket. This ID is either the Amazon Resource Name (ARN) for the KMS key or the alias ARN for the KMS key. Amazon S3 uses this KMS key to encrypt replica objects. Amazon S3 supports only symmetric encryption KMS keys. For more information, see [Symmetric encryption KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks) in the * AWS Key Management Service Developer Guide*.  
Type: String  
Required: No

## See Also
<a name="API_control_EncryptionConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/EncryptionConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/EncryptionConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/EncryptionConfiguration) 

# EstablishedMultiRegionAccessPointPolicy
<a name="API_control_EstablishedMultiRegionAccessPointPolicy"></a>

The last established access control policy for a Multi-Region Access Point.

When you update the policy, the update is first listed as the proposed policy. After the update is finished and all Regions have been updated, the proposed policy is listed as the established policy. If both policies have the same version number, the proposed policy is the established policy.

## Contents
<a name="API_control_EstablishedMultiRegionAccessPointPolicy_Contents"></a>

 ** Policy **   <a name="AmazonS3-Type-control_EstablishedMultiRegionAccessPointPolicy-Policy"></a>
The details of the last established policy.  
Type: String  
Required: No

## See Also
<a name="API_control_EstablishedMultiRegionAccessPointPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/EstablishedMultiRegionAccessPointPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/EstablishedMultiRegionAccessPointPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/EstablishedMultiRegionAccessPointPolicy) 

# Exclude
<a name="API_control_Exclude"></a>

A container for what Amazon S3 Storage Lens will exclude.

## Contents
<a name="API_control_Exclude_Contents"></a>

 ** Buckets **   <a name="AmazonS3-Type-control_Exclude-Buckets"></a>
A container for the S3 Storage Lens bucket excludes.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `arn:[^:]+:s3:.*`   
Required: No

 ** Regions **   <a name="AmazonS3-Type-control_Exclude-Regions"></a>
A container for the S3 Storage Lens Region excludes.  
Type: Array of strings  
Length Constraints: Minimum length of 5. Maximum length of 30.  
Pattern: `[a-z0-9\-]+`   
Required: No

## See Also
<a name="API_control_Exclude_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/Exclude) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/Exclude) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/Exclude) 

# ExistingObjectReplication
<a name="API_control_ExistingObjectReplication"></a>

An optional configuration to replicate existing source bucket objects. 

**Note**  
This is not supported by Amazon S3 on Outposts buckets.

## Contents
<a name="API_control_ExistingObjectReplication_Contents"></a>

 ** Status **   <a name="AmazonS3-Type-control_ExistingObjectReplication-Status"></a>
Specifies whether Amazon S3 replicates existing source bucket objects.   
Type: String  
Valid Values: `Enabled | Disabled`   
Required: Yes

## See Also
<a name="API_control_ExistingObjectReplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/ExistingObjectReplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/ExistingObjectReplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/ExistingObjectReplication) 

# GeneratedManifestEncryption
<a name="API_control_GeneratedManifestEncryption"></a>

The encryption configuration to use when storing the generated manifest.

## Contents
<a name="API_control_GeneratedManifestEncryption_Contents"></a>

 ** SSEKMS **   <a name="AmazonS3-Type-control_GeneratedManifestEncryption-SSEKMS"></a>
Configuration details on how SSE-KMS is used to encrypt generated manifest objects.  
Type: [SSEKMSEncryption](API_control_SSEKMSEncryption.md) data type  
Required: No

 ** SSES3 **   <a name="AmazonS3-Type-control_GeneratedManifestEncryption-SSES3"></a>
Specifies the use of SSE-S3 to encrypt generated manifest objects.  
Type: [SSES3Encryption](API_control_SSES3Encryption.md) data type  
Required: No

## See Also
<a name="API_control_GeneratedManifestEncryption_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/GeneratedManifestEncryption) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/GeneratedManifestEncryption) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/GeneratedManifestEncryption) 

# Grantee
<a name="API_control_Grantee"></a>

The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to AWS IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.

## Contents
<a name="API_control_Grantee_Contents"></a>

 ** GranteeIdentifier **   <a name="AmazonS3-Type-control_Grantee-GranteeIdentifier"></a>
The unique identifier of the `Grantee`. If the grantee type is `IAM`, the identifier is the IAM Amazon Resource Name (ARN) of the user or role. If the grantee type is a directory user or group, the identifier is 128-bit universally unique identifier (UUID) in the format `a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`. You can obtain this UUID from your AWS IAM Identity Center instance.  
Type: String  
Required: No

 ** GranteeType **   <a name="AmazonS3-Type-control_Grantee-GranteeType"></a>
The type of the grantee to which access has been granted. It can be one of the following values:  
+  `IAM` - An IAM user or role.
+  `DIRECTORY_USER` - Your corporate directory user. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.
+  `DIRECTORY_GROUP` - Your corporate directory group. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.
Type: String  
Valid Values: `DIRECTORY_USER | DIRECTORY_GROUP | IAM`   
Required: No

## See Also
<a name="API_control_Grantee_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/Grantee) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/Grantee) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/Grantee) 

# Include
<a name="API_control_Include"></a>

A container for what Amazon S3 Storage Lens configuration includes.

## Contents
<a name="API_control_Include_Contents"></a>

 ** Buckets **   <a name="AmazonS3-Type-control_Include-Buckets"></a>
A container for the S3 Storage Lens bucket includes.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `arn:[^:]+:s3:.*`   
Required: No

 ** Regions **   <a name="AmazonS3-Type-control_Include-Regions"></a>
A container for the S3 Storage Lens Region includes.  
Type: Array of strings  
Length Constraints: Minimum length of 5. Maximum length of 30.  
Pattern: `[a-z0-9\-]+`   
Required: No

## See Also
<a name="API_control_Include_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/Include) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/Include) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/Include) 

# JobDescriptor
<a name="API_control_JobDescriptor"></a>

A container element for the job configuration and status information returned by a `Describe Job` request.

## Contents
<a name="API_control_JobDescriptor_Contents"></a>

 ** ConfirmationRequired **   <a name="AmazonS3-Type-control_JobDescriptor-ConfirmationRequired"></a>
Indicates whether confirmation is required before Amazon S3 begins running the specified job. Confirmation is required only for jobs created through the Amazon S3 console.  
Type: Boolean  
Required: No

 ** CreationTime **   <a name="AmazonS3-Type-control_JobDescriptor-CreationTime"></a>
A timestamp indicating when this job was created.  
Type: Timestamp  
Required: No

 ** Description **   <a name="AmazonS3-Type-control_JobDescriptor-Description"></a>
The description for this job, if one was provided in this job's `Create Job` request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** FailureReasons **   <a name="AmazonS3-Type-control_JobDescriptor-FailureReasons"></a>
If the specified job failed, this field contains information describing the failure.  
Type: Array of [JobFailure](API_control_JobFailure.md) data types  
Required: No

 ** GeneratedManifestDescriptor **   <a name="AmazonS3-Type-control_JobDescriptor-GeneratedManifestDescriptor"></a>
The attribute of the JobDescriptor containing details about the job's generated manifest.  
Type: [S3GeneratedManifestDescriptor](API_control_S3GeneratedManifestDescriptor.md) data type  
Required: No

 ** JobArn **   <a name="AmazonS3-Type-control_JobDescriptor-JobArn"></a>
The Amazon Resource Name (ARN) for this job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:[^:]+:s3:[a-zA-Z0-9\-]+:\d{12}:job\/.*`   
Required: No

 ** JobId **   <a name="AmazonS3-Type-control_JobDescriptor-JobId"></a>
The ID for the specified job.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 36.  
Pattern: `[a-zA-Z0-9\-\_]+`   
Required: No

 ** Manifest **   <a name="AmazonS3-Type-control_JobDescriptor-Manifest"></a>
The configuration information for the specified job's manifest object.  
Type: [JobManifest](API_control_JobManifest.md) data type  
Required: No

 ** ManifestGenerator **   <a name="AmazonS3-Type-control_JobDescriptor-ManifestGenerator"></a>
The manifest generator that was used to generate a job manifest for this job.  
Type: [JobManifestGenerator](API_control_JobManifestGenerator.md) data type  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** Operation **   <a name="AmazonS3-Type-control_JobDescriptor-Operation"></a>
The operation that the specified job is configured to run on the objects listed in the manifest.  
Type: [JobOperation](API_control_JobOperation.md) data type  
Required: No

 ** Priority **   <a name="AmazonS3-Type-control_JobDescriptor-Priority"></a>
The priority of the specified job.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2147483647.  
Required: No

 ** ProgressSummary **   <a name="AmazonS3-Type-control_JobDescriptor-ProgressSummary"></a>
Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.  
Type: [JobProgressSummary](API_control_JobProgressSummary.md) data type  
Required: No

 ** Report **   <a name="AmazonS3-Type-control_JobDescriptor-Report"></a>
Contains the configuration information for the job-completion report if you requested one in the `Create Job` request.  
Type: [JobReport](API_control_JobReport.md) data type  
Required: No

 ** RoleArn **   <a name="AmazonS3-Type-control_JobDescriptor-RoleArn"></a>
The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to run the tasks for this job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:[^:]+:iam::\d{12}:role/.*`   
Required: No

 ** Status **   <a name="AmazonS3-Type-control_JobDescriptor-Status"></a>
The current status of the specified job.  
Type: String  
Valid Values: `Active | Cancelled | Cancelling | Complete | Completing | Failed | Failing | New | Paused | Pausing | Preparing | Ready | Suspended`   
Required: No

 ** StatusUpdateReason **   <a name="AmazonS3-Type-control_JobDescriptor-StatusUpdateReason"></a>
The reason for updating the job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** SuspendedCause **   <a name="AmazonS3-Type-control_JobDescriptor-SuspendedCause"></a>
The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters the `Suspended` state to await confirmation before running. After you confirm the job, it automatically exits the `Suspended` state.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** SuspendedDate **   <a name="AmazonS3-Type-control_JobDescriptor-SuspendedDate"></a>
The timestamp when this job was suspended, if it has been suspended.  
Type: Timestamp  
Required: No

 ** TerminationDate **   <a name="AmazonS3-Type-control_JobDescriptor-TerminationDate"></a>
A timestamp indicating when this job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.  
Type: Timestamp  
Required: No

## See Also
<a name="API_control_JobDescriptor_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/JobDescriptor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/JobDescriptor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/JobDescriptor) 

# JobFailure
<a name="API_control_JobFailure"></a>

If this job failed, this element indicates why the job failed.

## Contents
<a name="API_control_JobFailure_Contents"></a>

 ** FailureCode **   <a name="AmazonS3-Type-control_JobFailure-FailureCode"></a>
The failure code, if any, for the specified job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

 ** FailureReason **   <a name="AmazonS3-Type-control_JobFailure-FailureReason"></a>
The failure reason, if any, for the specified job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## See Also
<a name="API_control_JobFailure_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/JobFailure) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/JobFailure) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/JobFailure) 

# JobListDescriptor
<a name="API_control_JobListDescriptor"></a>

Contains the configuration and status information for a single job retrieved as part of a job list.

## Contents
<a name="API_control_JobListDescriptor_Contents"></a>

 ** CreationTime **   <a name="AmazonS3-Type-control_JobListDescriptor-CreationTime"></a>
A timestamp indicating when the specified job was created.  
Type: Timestamp  
Required: No

 ** Description **   <a name="AmazonS3-Type-control_JobListDescriptor-Description"></a>
The user-specified description that was included in the specified job's `Create Job` request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** JobId **   <a name="AmazonS3-Type-control_JobListDescriptor-JobId"></a>
The ID for the specified job.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 36.  
Pattern: `[a-zA-Z0-9\-\_]+`   
Required: No

 ** Operation **   <a name="AmazonS3-Type-control_JobListDescriptor-Operation"></a>
The operation that the specified job is configured to run on every object listed in the manifest.  
Type: String  
Valid Values: `LambdaInvoke | S3PutObjectCopy | S3PutObjectAcl | S3PutObjectTagging | S3DeleteObjectTagging | S3InitiateRestoreObject | S3PutObjectLegalHold | S3PutObjectRetention | S3ReplicateObject | S3ComputeObjectChecksum | S3UpdateObjectEncryption`   
Required: No

 ** Priority **   <a name="AmazonS3-Type-control_JobListDescriptor-Priority"></a>
The current priority for the specified job.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2147483647.  
Required: No

 ** ProgressSummary **   <a name="AmazonS3-Type-control_JobListDescriptor-ProgressSummary"></a>
Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.  
Type: [JobProgressSummary](API_control_JobProgressSummary.md) data type  
Required: No

 ** Status **   <a name="AmazonS3-Type-control_JobListDescriptor-Status"></a>
The specified job's current status.  
Type: String  
Valid Values: `Active | Cancelled | Cancelling | Complete | Completing | Failed | Failing | New | Paused | Pausing | Preparing | Ready | Suspended`   
Required: No

 ** TerminationDate **   <a name="AmazonS3-Type-control_JobListDescriptor-TerminationDate"></a>
A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.  
Type: Timestamp  
Required: No

## See Also
<a name="API_control_JobListDescriptor_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/JobListDescriptor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/JobListDescriptor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/JobListDescriptor) 

# JobManifest
<a name="API_control_JobManifest"></a>

Contains the configuration information for a job's manifest.

## Contents
<a name="API_control_JobManifest_Contents"></a>

 ** Location **   <a name="AmazonS3-Type-control_JobManifest-Location"></a>
Contains the information required to locate the specified job's manifest. Manifests can't be imported from directory buckets. For more information, see [Directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html).  
Type: [JobManifestLocation](API_control_JobManifestLocation.md) data type  
Required: Yes

 ** Spec **   <a name="AmazonS3-Type-control_JobManifest-Spec"></a>
Describes the format of the specified job's manifest. If the manifest is in CSV format, also describes the columns contained within the manifest.  
Type: [JobManifestSpec](API_control_JobManifestSpec.md) data type  
Required: Yes

## See Also
<a name="API_control_JobManifest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/JobManifest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/JobManifest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/JobManifest) 

# JobManifestGenerator
<a name="API_control_JobManifestGenerator"></a>

Configures the type of the job's ManifestGenerator.

## Contents
<a name="API_control_JobManifestGenerator_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** S3JobManifestGenerator **   <a name="AmazonS3-Type-control_JobManifestGenerator-S3JobManifestGenerator"></a>
The S3 job ManifestGenerator's configuration details.  
Type: [S3JobManifestGenerator](API_control_S3JobManifestGenerator.md) data type  
Required: No

## See Also
<a name="API_control_JobManifestGenerator_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/JobManifestGenerator) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/JobManifestGenerator) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/JobManifestGenerator) 

# JobManifestGeneratorFilter
<a name="API_control_JobManifestGeneratorFilter"></a>

The filter used to describe a set of objects for the job's manifest.

## Contents
<a name="API_control_JobManifestGeneratorFilter_Contents"></a>

 ** CreatedAfter **   <a name="AmazonS3-Type-control_JobManifestGeneratorFilter-CreatedAfter"></a>
If provided, the generated manifest includes only source bucket objects that were created after this time.  
Type: Timestamp  
Required: No

 ** CreatedBefore **   <a name="AmazonS3-Type-control_JobManifestGeneratorFilter-CreatedBefore"></a>
If provided, the generated manifest includes only source bucket objects that were created before this time.  
Type: Timestamp  
Required: No

 ** EligibleForReplication **   <a name="AmazonS3-Type-control_JobManifestGeneratorFilter-EligibleForReplication"></a>
Include objects in the generated manifest only if they are eligible for replication according to the Replication configuration on the source bucket.  
Type: Boolean  
Required: No

 ** KeyNameConstraint **   <a name="AmazonS3-Type-control_JobManifestGeneratorFilter-KeyNameConstraint"></a>
If provided, the generated manifest includes only source bucket objects whose object keys match the string constraints specified for `MatchAnyPrefix`, `MatchAnySuffix`, and `MatchAnySubstring`.  
Type: [KeyNameConstraint](API_control_KeyNameConstraint.md) data type  
Required: No

 ** MatchAnyObjectEncryption **   <a name="AmazonS3-Type-control_JobManifestGeneratorFilter-MatchAnyObjectEncryption"></a>
If provided, the generated object list includes only source bucket objects with the indicated server-side encryption type (SSE-S3, SSE-KMS, DSSE-KMS, SSE-C, or NOT-SSE).  
Type: Array of [ObjectEncryptionFilter](API_control_ObjectEncryptionFilter.md) data types  
Array Members: Fixed number of 1 item.  
Required: No

 ** MatchAnyStorageClass **   <a name="AmazonS3-Type-control_JobManifestGeneratorFilter-MatchAnyStorageClass"></a>
If provided, the generated manifest includes only source bucket objects that are stored with the specified storage class.  
Type: Array of strings  
Valid Values: `STANDARD | STANDARD_IA | ONEZONE_IA | GLACIER | INTELLIGENT_TIERING | DEEP_ARCHIVE | GLACIER_IR`   
Required: No

 ** ObjectReplicationStatuses **   <a name="AmazonS3-Type-control_JobManifestGeneratorFilter-ObjectReplicationStatuses"></a>
If provided, the generated manifest includes only source bucket objects that have one of the specified Replication statuses.  
Type: Array of strings  
Valid Values: `COMPLETED | FAILED | REPLICA | NONE`   
Required: No

 ** ObjectSizeGreaterThanBytes **   <a name="AmazonS3-Type-control_JobManifestGeneratorFilter-ObjectSizeGreaterThanBytes"></a>
If provided, the generated manifest includes only source bucket objects whose file size is greater than the specified number of bytes.  
Type: Long  
Required: No

 ** ObjectSizeLessThanBytes **   <a name="AmazonS3-Type-control_JobManifestGeneratorFilter-ObjectSizeLessThanBytes"></a>
If provided, the generated manifest includes only source bucket objects whose file size is less than the specified number of bytes.  
Type: Long  
Required: No

## See Also
<a name="API_control_JobManifestGeneratorFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/JobManifestGeneratorFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/JobManifestGeneratorFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/JobManifestGeneratorFilter) 

# JobManifestLocation
<a name="API_control_JobManifestLocation"></a>

Contains the information required to locate a manifest object. Manifests can't be imported from directory buckets. For more information, see [Directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html).

## Contents
<a name="API_control_JobManifestLocation_Contents"></a>

 ** ETag **   <a name="AmazonS3-Type-control_JobManifestLocation-ETag"></a>
The ETag for the specified manifest object.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** ObjectArn **   <a name="AmazonS3-Type-control_JobManifestLocation-ObjectArn"></a>
The Amazon Resource Name (ARN) for a manifest object.  
When you're using XML requests, you must replace special characters (such as carriage returns) in object keys with their equivalent XML entity codes. For more information, see [ XML-related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints) in the *Amazon S3 User Guide*.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Pattern: `arn:[^:]+:s3:.*`   
Required: Yes

 ** ObjectVersionId **   <a name="AmazonS3-Type-control_JobManifestLocation-ObjectVersionId"></a>
The optional version ID to identify a specific version of the manifest object.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Required: No

## See Also
<a name="API_control_JobManifestLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/JobManifestLocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/JobManifestLocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/JobManifestLocation) 

# JobManifestSpec
<a name="API_control_JobManifestSpec"></a>

Describes the format of a manifest. If the manifest is in CSV format, also describes the columns contained within the manifest.

## Contents
<a name="API_control_JobManifestSpec_Contents"></a>

 ** Format **   <a name="AmazonS3-Type-control_JobManifestSpec-Format"></a>
Indicates which of the available formats the specified manifest uses.  
Type: String  
Valid Values: `S3BatchOperations_CSV_20180820 | S3InventoryReport_CSV_20161130`   
Required: Yes

 ** Fields **   <a name="AmazonS3-Type-control_JobManifestSpec-Fields"></a>
If the specified manifest object is in the `S3BatchOperations_CSV_20180820` format, this element describes which columns contain the required data.  
Type: Array of strings  
Valid Values: `Ignore | Bucket | Key | VersionId`   
Required: No

## See Also
<a name="API_control_JobManifestSpec_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/JobManifestSpec) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/JobManifestSpec) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/JobManifestSpec) 

# JobOperation
<a name="API_control_JobOperation"></a>

The operation that you want this job to perform on every object listed in the manifest. For more information about the available operations, see [Operations](https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-operations.html) in the *Amazon S3 User Guide*.

## Contents
<a name="API_control_JobOperation_Contents"></a>

 ** LambdaInvoke **   <a name="AmazonS3-Type-control_JobOperation-LambdaInvoke"></a>
Directs the specified job to invoke an AWS Lambda function on every object in the manifest.  
Type: [LambdaInvokeOperation](API_control_LambdaInvokeOperation.md) data type  
Required: No

 ** S3ComputeObjectChecksum **   <a name="AmazonS3-Type-control_JobOperation-S3ComputeObjectChecksum"></a>
Directs the specified job to compute checksum values for every object in the manifest.  
Type: [S3ComputeObjectChecksumOperation](API_control_S3ComputeObjectChecksumOperation.md) data type  
Required: No

 ** S3DeleteObjectTagging **   <a name="AmazonS3-Type-control_JobOperation-S3DeleteObjectTagging"></a>
Directs the specified job to execute a DELETE Object tagging call on every object in the manifest.  
This functionality is not supported by directory buckets.
Type: [S3DeleteObjectTaggingOperation](API_control_S3DeleteObjectTaggingOperation.md) data type  
Required: No

 ** S3InitiateRestoreObject **   <a name="AmazonS3-Type-control_JobOperation-S3InitiateRestoreObject"></a>
Directs the specified job to initiate restore requests for every archived object in the manifest.  
This functionality is not supported by directory buckets.
Type: [S3InitiateRestoreObjectOperation](API_control_S3InitiateRestoreObjectOperation.md) data type  
Required: No

 ** S3PutObjectAcl **   <a name="AmazonS3-Type-control_JobOperation-S3PutObjectAcl"></a>
Directs the specified job to run a `PutObjectAcl` call on every object in the manifest.  
This functionality is not supported by directory buckets.
Type: [S3SetObjectAclOperation](API_control_S3SetObjectAclOperation.md) data type  
Required: No

 ** S3PutObjectCopy **   <a name="AmazonS3-Type-control_JobOperation-S3PutObjectCopy"></a>
Directs the specified job to run a PUT Copy object call on every object in the manifest.  
Type: [S3CopyObjectOperation](API_control_S3CopyObjectOperation.md) data type  
Required: No

 ** S3PutObjectLegalHold **   <a name="AmazonS3-Type-control_JobOperation-S3PutObjectLegalHold"></a>
Contains the configuration for an S3 Object Lock legal hold operation that an S3 Batch Operations job passes to every object to the underlying `PutObjectLegalHold` API operation. For more information, see [Using S3 Object Lock legal hold with S3 Batch Operations](https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-legal-hold.html) in the *Amazon S3 User Guide*.  
This functionality is not supported by directory buckets.
Type: [S3SetObjectLegalHoldOperation](API_control_S3SetObjectLegalHoldOperation.md) data type  
Required: No

 ** S3PutObjectRetention **   <a name="AmazonS3-Type-control_JobOperation-S3PutObjectRetention"></a>
Contains the configuration parameters for the Object Lock retention action for an S3 Batch Operations job. Batch Operations passes every object to the underlying `PutObjectRetention` API operation. For more information, see [Using S3 Object Lock retention with S3 Batch Operations](https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html) in the *Amazon S3 User Guide*.  
This functionality is not supported by directory buckets.
Type: [S3SetObjectRetentionOperation](API_control_S3SetObjectRetentionOperation.md) data type  
Required: No

 ** S3PutObjectTagging **   <a name="AmazonS3-Type-control_JobOperation-S3PutObjectTagging"></a>
Directs the specified job to run a PUT Object tagging call on every object in the manifest.  
This functionality is not supported by directory buckets.
Type: [S3SetObjectTaggingOperation](API_control_S3SetObjectTaggingOperation.md) data type  
Required: No

 ** S3ReplicateObject **   <a name="AmazonS3-Type-control_JobOperation-S3ReplicateObject"></a>
Directs the specified job to invoke `ReplicateObject` on every object in the job's manifest.  
This functionality is not supported by directory buckets.
Type: [S3ReplicateObjectOperation](API_control_S3ReplicateObjectOperation.md) data type  
Required: No

 ** S3UpdateObjectEncryption **   <a name="AmazonS3-Type-control_JobOperation-S3UpdateObjectEncryption"></a>
Updates the server-side encryption type of an existing encrypted object in a general purpose bucket. You can use the `UpdateObjectEncryption` operation to change encrypted objects from server-side encryption with Amazon S3 managed keys (SSE-S3) to server-side encryption with AWS Key Management Service (AWS KMS) keys (SSE-KMS), or to apply S3 Bucket Keys. You can also use the `UpdateObjectEncryption` operation to change the customer-managed KMS key used to encrypt your data so that you can comply with custom key-rotation standards.  
Type: [S3UpdateObjectEncryptionOperation](API_control_S3UpdateObjectEncryptionOperation.md) data type  
Required: No

## See Also
<a name="API_control_JobOperation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/JobOperation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/JobOperation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/JobOperation) 

# JobProgressSummary
<a name="API_control_JobProgressSummary"></a>

Describes the total number of tasks that the specified job has started, the number of tasks that succeeded, and the number of tasks that failed.

## Contents
<a name="API_control_JobProgressSummary_Contents"></a>

 ** NumberOfTasksFailed **   <a name="AmazonS3-Type-control_JobProgressSummary-NumberOfTasksFailed"></a>
  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** NumberOfTasksSucceeded **   <a name="AmazonS3-Type-control_JobProgressSummary-NumberOfTasksSucceeded"></a>
  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** Timers **   <a name="AmazonS3-Type-control_JobProgressSummary-Timers"></a>
The JobTimers attribute of a job's progress summary.  
Type: [JobTimers](API_control_JobTimers.md) data type  
Required: No

 ** TotalNumberOfTasks **   <a name="AmazonS3-Type-control_JobProgressSummary-TotalNumberOfTasks"></a>
  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

## See Also
<a name="API_control_JobProgressSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/JobProgressSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/JobProgressSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/JobProgressSummary) 

# JobReport
<a name="API_control_JobReport"></a>

Contains the configuration parameters for a job-completion report.

## Contents
<a name="API_control_JobReport_Contents"></a>

 ** Enabled **   <a name="AmazonS3-Type-control_JobReport-Enabled"></a>
Indicates whether the specified job will generate a job-completion report.  
Type: Boolean  
Required: Yes

 ** Bucket **   <a name="AmazonS3-Type-control_JobReport-Bucket"></a>
The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.  
 **Directory buckets** - Directory buckets aren't supported as a location for Batch Operations to store job completion reports.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `arn:[^:]+:s3:.*`   
Required: No

 ** ExpectedBucketOwner **   <a name="AmazonS3-Type-control_JobReport-ExpectedBucketOwner"></a>
Lists the AWS account ID that owns the target bucket, where the completion report is received.  
Type: String  
Length Constraints: Maximum length of 64.  
Pattern: `^\d{12}$`   
Required: No

 ** Format **   <a name="AmazonS3-Type-control_JobReport-Format"></a>
The format of the specified job-completion report.  
Type: String  
Valid Values: `Report_CSV_20180820`   
Required: No

 ** Prefix **   <a name="AmazonS3-Type-control_JobReport-Prefix"></a>
An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 stores the job-completion report at `<prefix>/job-<job-id>/report.json`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Required: No

 ** ReportScope **   <a name="AmazonS3-Type-control_JobReport-ReportScope"></a>
Indicates whether the job-completion report will include details of all tasks or only failed tasks.  
Type: String  
Valid Values: `AllTasks | FailedTasksOnly`   
Required: No

## See Also
<a name="API_control_JobReport_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/JobReport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/JobReport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/JobReport) 

# JobTimers
<a name="API_control_JobTimers"></a>

Provides timing details for the job.

## Contents
<a name="API_control_JobTimers_Contents"></a>

 ** ElapsedTimeInActiveSeconds **   <a name="AmazonS3-Type-control_JobTimers-ElapsedTimeInActiveSeconds"></a>
Indicates the elapsed time in seconds the job has been in the Active job state.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

## See Also
<a name="API_control_JobTimers_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/JobTimers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/JobTimers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/JobTimers) 

# KeyNameConstraint
<a name="API_control_KeyNameConstraint"></a>

If provided, the generated manifest includes only source bucket objects whose object keys match the string constraints specified for `MatchAnyPrefix`, `MatchAnySuffix`, and `MatchAnySubstring`.

## Contents
<a name="API_control_KeyNameConstraint_Contents"></a>

 ** MatchAnyPrefix **   <a name="AmazonS3-Type-control_KeyNameConstraint-MatchAnyPrefix"></a>
If provided, the generated manifest includes objects where the specified string appears at the start of the object key string. Each KeyNameConstraint filter accepts an array of strings with a length of 1 string.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** MatchAnySubstring **   <a name="AmazonS3-Type-control_KeyNameConstraint-MatchAnySubstring"></a>
If provided, the generated manifest includes objects where the specified string appears anywhere within the object key string. Each KeyNameConstraint filter accepts an array of strings with a length of 1 string.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** MatchAnySuffix **   <a name="AmazonS3-Type-control_KeyNameConstraint-MatchAnySuffix"></a>
If provided, the generated manifest includes objects where the specified string appears at the end of the object key string. Each KeyNameConstraint filter accepts an array of strings with a length of 1 string.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

## See Also
<a name="API_control_KeyNameConstraint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/KeyNameConstraint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/KeyNameConstraint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/KeyNameConstraint) 

# LambdaInvokeOperation
<a name="API_control_LambdaInvokeOperation"></a>

Contains the configuration parameters for a `Lambda Invoke` operation.

## Contents
<a name="API_control_LambdaInvokeOperation_Contents"></a>

 ** FunctionArn **   <a name="AmazonS3-Type-control_LambdaInvokeOperation-FunctionArn"></a>
The Amazon Resource Name (ARN) for the AWS Lambda function that the specified job will invoke on every object in the manifest.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?`   
Required: No

 ** InvocationSchemaVersion **   <a name="AmazonS3-Type-control_LambdaInvokeOperation-InvocationSchemaVersion"></a>
Specifies the schema version for the payload that Batch Operations sends when invoking an AWS Lambda function. Version `1.0` is the default. Version `2.0` is required when you use Batch Operations to invoke AWS Lambda functions that act on directory buckets, or if you need to specify `UserArguments`. For more information, see [Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and AWS Lambda](https://aws.amazon.com/blogs/storage/automate-object-processing-in-amazon-s3-directory-buckets-with-s3-batch-operations-and-aws-lambda/) in the * AWS Storage Blog*.  
Ensure that your AWS Lambda function code expects `InvocationSchemaVersion` **2.0** and uses bucket name rather than bucket ARN. If the `InvocationSchemaVersion` does not match what your AWS Lambda function expects, your function might not work as expected.
 **Directory buckets** - To initiate AWS Lambda function to perform custom actions on objects in directory buckets, you must specify `2.0`.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

 ** UserArguments **   <a name="AmazonS3-Type-control_LambdaInvokeOperation-UserArguments"></a>
Key-value pairs that are passed in the payload that Batch Operations sends when invoking an AWS Lambda function. You must specify `InvocationSchemaVersion` **2.0** for `LambdaInvoke` operations that include `UserArguments`. For more information, see [Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and AWS Lambda](https://aws.amazon.com/blogs/storage/automate-object-processing-in-amazon-s3-directory-buckets-with-s3-batch-operations-and-aws-lambda/) in the * AWS Storage Blog*.  
Type: String to string map  
Map Entries: Maximum number of 10 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 64.  
Value Length Constraints: Maximum length of 1024.  
Required: No

## See Also
<a name="API_control_LambdaInvokeOperation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/LambdaInvokeOperation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/LambdaInvokeOperation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/LambdaInvokeOperation) 

# LifecycleConfiguration
<a name="API_control_LifecycleConfiguration"></a>

The container for the Outposts bucket lifecycle configuration.

## Contents
<a name="API_control_LifecycleConfiguration_Contents"></a>

 ** Rules **   <a name="AmazonS3-Type-control_LifecycleConfiguration-Rules"></a>
A lifecycle rule for individual objects in an Outposts bucket.   
Type: Array of [LifecycleRule](API_control_LifecycleRule.md) data types  
Required: No

## See Also
<a name="API_control_LifecycleConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/LifecycleConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/LifecycleConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/LifecycleConfiguration) 

# LifecycleExpiration
<a name="API_control_LifecycleExpiration"></a>

The container of the Outposts bucket lifecycle expiration.

## Contents
<a name="API_control_LifecycleExpiration_Contents"></a>

 ** Date **   <a name="AmazonS3-Type-control_LifecycleExpiration-Date"></a>
Indicates at what date the object is to be deleted. Should be in GMT ISO 8601 format.  
Type: Timestamp  
Required: No

 ** Days **   <a name="AmazonS3-Type-control_LifecycleExpiration-Days"></a>
Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.  
Type: Integer  
Required: No

 ** ExpiredObjectDeleteMarker **   <a name="AmazonS3-Type-control_LifecycleExpiration-ExpiredObjectDeleteMarker"></a>
Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired. If set to false, the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy. To learn more about delete markers, see [Working with delete markers](https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeleteMarker.html).  
Type: Boolean  
Required: No

## See Also
<a name="API_control_LifecycleExpiration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/LifecycleExpiration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/LifecycleExpiration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/LifecycleExpiration) 

# LifecycleRule
<a name="API_control_LifecycleRule"></a>

The container for the Outposts bucket lifecycle rule.

## Contents
<a name="API_control_LifecycleRule_Contents"></a>

 ** Status **   <a name="AmazonS3-Type-control_LifecycleRule-Status"></a>
If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.  
Type: String  
Valid Values: `Enabled | Disabled`   
Required: Yes

 ** AbortIncompleteMultipartUpload **   <a name="AmazonS3-Type-control_LifecycleRule-AbortIncompleteMultipartUpload"></a>
Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 waits before permanently removing all parts of the upload. For more information, see [ Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) in the *Amazon S3 User Guide*.  
Type: [AbortIncompleteMultipartUpload](API_control_AbortIncompleteMultipartUpload.md) data type  
Required: No

 ** Expiration **   <a name="AmazonS3-Type-control_LifecycleRule-Expiration"></a>
Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.  
Type: [LifecycleExpiration](API_control_LifecycleExpiration.md) data type  
Required: No

 ** Filter **   <a name="AmazonS3-Type-control_LifecycleRule-Filter"></a>
The container for the filter of lifecycle rule.  
Type: [LifecycleRuleFilter](API_control_LifecycleRuleFilter.md) data type  
Required: No

 ** ID **   <a name="AmazonS3-Type-control_LifecycleRule-ID"></a>
Unique identifier for the rule. The value cannot be longer than 255 characters.  
Type: String  
Required: No

 ** NoncurrentVersionExpiration **   <a name="AmazonS3-Type-control_LifecycleRule-NoncurrentVersionExpiration"></a>
The noncurrent version expiration of the lifecycle rule.  
Type: [NoncurrentVersionExpiration](API_control_NoncurrentVersionExpiration.md) data type  
Required: No

 ** NoncurrentVersionTransitions **   <a name="AmazonS3-Type-control_LifecycleRule-NoncurrentVersionTransitions"></a>
 Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.   
This is not supported by Amazon S3 on Outposts buckets.
Type: Array of [NoncurrentVersionTransition](API_control_NoncurrentVersionTransition.md) data types  
Required: No

 ** Transitions **   <a name="AmazonS3-Type-control_LifecycleRule-Transitions"></a>
Specifies when an Amazon S3 object transitions to a specified storage class.  
This is not supported by Amazon S3 on Outposts buckets.
Type: Array of [Transition](API_control_Transition.md) data types  
Required: No

## See Also
<a name="API_control_LifecycleRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/LifecycleRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/LifecycleRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/LifecycleRule) 

# LifecycleRuleAndOperator
<a name="API_control_LifecycleRuleAndOperator"></a>

The container for the Outposts bucket lifecycle rule and operator.

## Contents
<a name="API_control_LifecycleRuleAndOperator_Contents"></a>

 ** ObjectSizeGreaterThan **   <a name="AmazonS3-Type-control_LifecycleRuleAndOperator-ObjectSizeGreaterThan"></a>
The non-inclusive minimum object size for the lifecycle rule. Setting this property to 7 means the rule applies to objects with a size that is greater than 7.   
Type: Long  
Required: No

 ** ObjectSizeLessThan **   <a name="AmazonS3-Type-control_LifecycleRuleAndOperator-ObjectSizeLessThan"></a>
The non-inclusive maximum object size for the lifecycle rule. Setting this property to 77 means the rule applies to objects with a size that is less than 77.   
Type: Long  
Required: No

 ** Prefix **   <a name="AmazonS3-Type-control_LifecycleRuleAndOperator-Prefix"></a>
Prefix identifying one or more objects to which the rule applies.  
Type: String  
Required: No

 ** Tags **   <a name="AmazonS3-Type-control_LifecycleRuleAndOperator-Tags"></a>
All of these tags must exist in the object's tag set in order for the rule to apply.  
Type: Array of [S3Tag](API_control_S3Tag.md) data types  
Required: No

## See Also
<a name="API_control_LifecycleRuleAndOperator_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/LifecycleRuleAndOperator) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/LifecycleRuleAndOperator) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/LifecycleRuleAndOperator) 

# LifecycleRuleFilter
<a name="API_control_LifecycleRuleFilter"></a>

The container for the filter of the lifecycle rule.

## Contents
<a name="API_control_LifecycleRuleFilter_Contents"></a>

 ** And **   <a name="AmazonS3-Type-control_LifecycleRuleFilter-And"></a>
The container for the `AND` condition for the lifecycle rule.  
Type: [LifecycleRuleAndOperator](API_control_LifecycleRuleAndOperator.md) data type  
Required: No

 ** ObjectSizeGreaterThan **   <a name="AmazonS3-Type-control_LifecycleRuleFilter-ObjectSizeGreaterThan"></a>
Minimum object size to which the rule applies.  
Type: Long  
Required: No

 ** ObjectSizeLessThan **   <a name="AmazonS3-Type-control_LifecycleRuleFilter-ObjectSizeLessThan"></a>
Maximum object size to which the rule applies.  
Type: Long  
Required: No

 ** Prefix **   <a name="AmazonS3-Type-control_LifecycleRuleFilter-Prefix"></a>
Prefix identifying one or more objects to which the rule applies.  
When you're using XML requests, you must replace special characters (such as carriage returns) in object keys with their equivalent XML entity codes. For more information, see [ XML-related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints) in the *Amazon S3 User Guide*.
Type: String  
Required: No

 ** Tag **   <a name="AmazonS3-Type-control_LifecycleRuleFilter-Tag"></a>
A container for a key-value name pair.  
Type: [S3Tag](API_control_S3Tag.md) data type  
Required: No

## See Also
<a name="API_control_LifecycleRuleFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/LifecycleRuleFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/LifecycleRuleFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/LifecycleRuleFilter) 

# ListAccessGrantEntry
<a name="API_control_ListAccessGrantEntry"></a>

Information about the access grant.

## Contents
<a name="API_control_ListAccessGrantEntry_Contents"></a>

 ** AccessGrantArn **   <a name="AmazonS3-Type-control_ListAccessGrantEntry-AccessGrantArn"></a>
The Amazon Resource Name (ARN) of the access grant.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:[a-z\-]+:s3:[a-z0-9\-]+:\d{12}:access\-grants\/grant/[a-zA-Z0-9\-]+`   
Required: No

 ** AccessGrantId **   <a name="AmazonS3-Type-control_ListAccessGrantEntry-AccessGrantId"></a>
The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9\-]+`   
Required: No

 ** AccessGrantsLocationConfiguration **   <a name="AmazonS3-Type-control_ListAccessGrantEntry-AccessGrantsLocationConfiguration"></a>
The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access.   
Type: [AccessGrantsLocationConfiguration](API_control_AccessGrantsLocationConfiguration.md) data type  
Required: No

 ** AccessGrantsLocationId **   <a name="AmazonS3-Type-control_ListAccessGrantEntry-AccessGrantsLocationId"></a>
The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID `default` to the default location `s3://` and assigns an auto-generated ID to other locations that you register.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9\-]+`   
Required: No

 ** ApplicationArn **   <a name="AmazonS3-Type-control_ListAccessGrantEntry-ApplicationArn"></a>
The Amazon Resource Name (ARN) of an AWS IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.   
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:[^:]+:sso::\d{12}:application/.*$`   
Required: No

 ** CreatedAt **   <a name="AmazonS3-Type-control_ListAccessGrantEntry-CreatedAt"></a>
The date and time when you created the S3 Access Grants instance.   
Type: Timestamp  
Required: No

 ** Grantee **   <a name="AmazonS3-Type-control_ListAccessGrantEntry-Grantee"></a>
The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to AWS IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.  
Type: [Grantee](API_control_Grantee.md) data type  
Required: No

 ** GrantScope **   <a name="AmazonS3-Type-control_ListAccessGrantEntry-GrantScope"></a>
The S3 path of the data to which you are granting access. It is the result of appending the `Subprefix` to the location scope.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Pattern: `^.+$`   
Required: No

 ** Permission **   <a name="AmazonS3-Type-control_ListAccessGrantEntry-Permission"></a>
The type of access granted to your S3 data, which can be set to one of the following values:  
+  `READ` – Grant read-only access to the S3 data.
+  `WRITE` – Grant write-only access to the S3 data.
+  `READWRITE` – Grant both read and write access to the S3 data.
Type: String  
Valid Values: `READ | WRITE | READWRITE`   
Required: No

## See Also
<a name="API_control_ListAccessGrantEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/ListAccessGrantEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/ListAccessGrantEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/ListAccessGrantEntry) 

# ListAccessGrantsInstanceEntry
<a name="API_control_ListAccessGrantsInstanceEntry"></a>

Information about the S3 Access Grants instance.

## Contents
<a name="API_control_ListAccessGrantsInstanceEntry_Contents"></a>

 ** AccessGrantsInstanceArn **   <a name="AmazonS3-Type-control_ListAccessGrantsInstanceEntry-AccessGrantsInstanceArn"></a>
The Amazon Resource Name (ARN) of the S3 Access Grants instance.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:[a-z\-]+:s3:[a-z0-9\-]+:\d{12}:access\-grants\/[a-zA-Z0-9\-]+`   
Required: No

 ** AccessGrantsInstanceId **   <a name="AmazonS3-Type-control_ListAccessGrantsInstanceEntry-AccessGrantsInstanceId"></a>
The ID of the S3 Access Grants instance. The ID is `default`. You can have one S3 Access Grants instance per Region per account.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9\-]+`   
Required: No

 ** CreatedAt **   <a name="AmazonS3-Type-control_ListAccessGrantsInstanceEntry-CreatedAt"></a>
The date and time when you created the S3 Access Grants instance.   
Type: Timestamp  
Required: No

 ** IdentityCenterApplicationArn **   <a name="AmazonS3-Type-control_ListAccessGrantsInstanceEntry-IdentityCenterApplicationArn"></a>
If you associated your S3 Access Grants instance with an AWS IAM Identity Center instance, this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance application; a subresource of the original Identity Center instance. S3 Access Grants creates this Identity Center application for the specific S3 Access Grants instance.   
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:[^:]+:sso::\d{12}:application/.*$`   
Required: No

 ** IdentityCenterArn **   <a name="AmazonS3-Type-control_ListAccessGrantsInstanceEntry-IdentityCenterArn"></a>
 *This member has been deprecated.*   
If you associated your S3 Access Grants instance with an AWS IAM Identity Center instance, this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance application; a subresource of the original Identity Center instance. S3 Access Grants creates this Identity Center application for the specific S3 Access Grants instance.   
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:[^:]+:sso::(\d{12}){0,1}:instance/.*$`   
Required: No

 ** IdentityCenterInstanceArn **   <a name="AmazonS3-Type-control_ListAccessGrantsInstanceEntry-IdentityCenterInstanceArn"></a>
The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance that you are associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate identity directory that you added to the IAM Identity Center. You can use the [ListInstances](https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_ListInstances.html) API operation to retrieve a list of your Identity Center instances and their ARNs.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:[^:]+:sso::(\d{12}){0,1}:instance/.*$`   
Required: No

## See Also
<a name="API_control_ListAccessGrantsInstanceEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/ListAccessGrantsInstanceEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/ListAccessGrantsInstanceEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/ListAccessGrantsInstanceEntry) 

# ListAccessGrantsLocationsEntry
<a name="API_control_ListAccessGrantsLocationsEntry"></a>

A container for information about the registered location.

## Contents
<a name="API_control_ListAccessGrantsLocationsEntry_Contents"></a>

 ** AccessGrantsLocationArn **   <a name="AmazonS3-Type-control_ListAccessGrantsLocationsEntry-AccessGrantsLocationArn"></a>
The Amazon Resource Name (ARN) of the registered location.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:[a-z\-]+:s3:[a-z0-9\-]+:\d{12}:access\-grants\/location/[a-zA-Z0-9\-]+`   
Required: No

 ** AccessGrantsLocationId **   <a name="AmazonS3-Type-control_ListAccessGrantsLocationsEntry-AccessGrantsLocationId"></a>
The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID `default` to the default location `s3://` and assigns an auto-generated ID to other locations that you register.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9\-]+`   
Required: No

 ** CreatedAt **   <a name="AmazonS3-Type-control_ListAccessGrantsLocationsEntry-CreatedAt"></a>
The date and time when you registered the location.   
Type: Timestamp  
Required: No

 ** IAMRoleArn **   <a name="AmazonS3-Type-control_ListAccessGrantsLocationsEntry-IAMRoleArn"></a>
The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered location.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:[^:]+:iam::\d{12}:role/.*`   
Required: No

 ** LocationScope **   <a name="AmazonS3-Type-control_ListAccessGrantsLocationsEntry-LocationScope"></a>
The S3 path to the location that you are registering. The location scope can be the default S3 location `s3://`, the S3 path to a bucket `s3://<bucket>`, or the S3 path to a bucket and prefix `s3://<bucket>/<prefix>`. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the `engineering/` prefix or object key names that start with the `marketing/campaigns/` prefix.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Pattern: `^.+$`   
Required: No

## See Also
<a name="API_control_ListAccessGrantsLocationsEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/ListAccessGrantsLocationsEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/ListAccessGrantsLocationsEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/ListAccessGrantsLocationsEntry) 

# ListCallerAccessGrantsEntry
<a name="API_control_ListCallerAccessGrantsEntry"></a>

Part of `ListCallerAccessGrantsResult`. Each entry includes the permission level (READ, WRITE, or READWRITE) and the grant scope of the access grant. If the grant also includes an application ARN, the grantee can only access the S3 data through this application.

## Contents
<a name="API_control_ListCallerAccessGrantsEntry_Contents"></a>

 ** ApplicationArn **   <a name="AmazonS3-Type-control_ListCallerAccessGrantsEntry-ApplicationArn"></a>
The Amazon Resource Name (ARN) of an AWS IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.   
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:[^:]+:sso::\d{12}:application/.*$`   
Required: No

 ** GrantScope **   <a name="AmazonS3-Type-control_ListCallerAccessGrantsEntry-GrantScope"></a>
The S3 path of the data to which you have been granted access.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Pattern: `^.+$`   
Required: No

 ** Permission **   <a name="AmazonS3-Type-control_ListCallerAccessGrantsEntry-Permission"></a>
The type of permission granted, which can be one of the following values:  
+  `READ` - Grants read-only access to the S3 data.
+  `WRITE` - Grants write-only access to the S3 data.
+  `READWRITE` - Grants both read and write access to the S3 data.
Type: String  
Valid Values: `READ | WRITE | READWRITE`   
Required: No

## See Also
<a name="API_control_ListCallerAccessGrantsEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/ListCallerAccessGrantsEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/ListCallerAccessGrantsEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/ListCallerAccessGrantsEntry) 

# ListStorageLensConfigurationEntry
<a name="API_control_ListStorageLensConfigurationEntry"></a>

Part of `ListStorageLensConfigurationResult`. Each entry includes the description of the S3 Storage Lens configuration, its home Region, whether it is enabled, its Amazon Resource Name (ARN), and config ID.

## Contents
<a name="API_control_ListStorageLensConfigurationEntry_Contents"></a>

 ** HomeRegion **   <a name="AmazonS3-Type-control_ListStorageLensConfigurationEntry-HomeRegion"></a>
A container for the S3 Storage Lens home Region. Your metrics data is stored and retained in your designated S3 Storage Lens home Region.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 30.  
Pattern: `[a-z0-9\-]+`   
Required: Yes

 ** Id **   <a name="AmazonS3-Type-control_ListStorageLensConfigurationEntry-Id"></a>
A container for the S3 Storage Lens configuration ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9\-\_\.]+`   
Required: Yes

 ** StorageLensArn **   <a name="AmazonS3-Type-control_ListStorageLensConfigurationEntry-StorageLensArn"></a>
The ARN of the S3 Storage Lens configuration. This property is read-only.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:[a-z\-]+:s3:[a-z0-9\-]+:\d{12}:storage\-lens\/.*`   
Required: Yes

 ** IsEnabled **   <a name="AmazonS3-Type-control_ListStorageLensConfigurationEntry-IsEnabled"></a>
A container for whether the S3 Storage Lens configuration is enabled. This property is required.  
Type: Boolean  
Required: No

## See Also
<a name="API_control_ListStorageLensConfigurationEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/ListStorageLensConfigurationEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/ListStorageLensConfigurationEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/ListStorageLensConfigurationEntry) 

# ListStorageLensGroupEntry
<a name="API_control_ListStorageLensGroupEntry"></a>

 Each entry contains a Storage Lens group that exists in the specified home Region. 

## Contents
<a name="API_control_ListStorageLensGroupEntry_Contents"></a>

 ** HomeRegion **   <a name="AmazonS3-Type-control_ListStorageLensGroupEntry-HomeRegion"></a>
 Contains the AWS Region where the Storage Lens group was created.   
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 30.  
Pattern: `[a-z0-9\-]+`   
Required: Yes

 ** Name **   <a name="AmazonS3-Type-control_ListStorageLensGroupEntry-Name"></a>
 Contains the name of the Storage Lens group that exists in the specified home Region.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9\-\_]+`   
Required: Yes

 ** StorageLensGroupArn **   <a name="AmazonS3-Type-control_ListStorageLensGroupEntry-StorageLensGroupArn"></a>
 Contains the Amazon Resource Name (ARN) of the Storage Lens group. This property is read-only.   
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Pattern: `arn:[a-z\-]+:s3:[a-z0-9\-]+:\d{12}:storage\-lens\-group\/.*`   
Required: Yes

## See Also
<a name="API_control_ListStorageLensGroupEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/ListStorageLensGroupEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/ListStorageLensGroupEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/ListStorageLensGroupEntry) 

# MatchObjectAge
<a name="API_control_MatchObjectAge"></a>

 A filter condition that specifies the object age range of included objects in days. Only integers are supported. 

## Contents
<a name="API_control_MatchObjectAge_Contents"></a>

 ** DaysGreaterThan **   <a name="AmazonS3-Type-control_MatchObjectAge-DaysGreaterThan"></a>
 Specifies the maximum object age in days. Must be a positive whole number, greater than the minimum object age and less than or equal to 2,147,483,647.   
Type: Integer  
Required: No

 ** DaysLessThan **   <a name="AmazonS3-Type-control_MatchObjectAge-DaysLessThan"></a>
 Specifies the minimum object age in days. The value must be a positive whole number, greater than 0 and less than or equal to 2,147,483,647.   
Type: Integer  
Required: No

## See Also
<a name="API_control_MatchObjectAge_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/MatchObjectAge) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/MatchObjectAge) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/MatchObjectAge) 

# MatchObjectSize
<a name="API_control_MatchObjectSize"></a>

 A filter condition that specifies the object size range of included objects in bytes. Only integers are supported. 

## Contents
<a name="API_control_MatchObjectSize_Contents"></a>

 ** BytesGreaterThan **   <a name="AmazonS3-Type-control_MatchObjectSize-BytesGreaterThan"></a>
 Specifies the minimum object size in Bytes. The value must be a positive number, greater than 0 and less than 50 TB.   
Type: Long  
Required: No

 ** BytesLessThan **   <a name="AmazonS3-Type-control_MatchObjectSize-BytesLessThan"></a>
 Specifies the maximum object size in Bytes. The value must be a positive number, greater than the minimum object size and less than 50 TB.   
Type: Long  
Required: No

## See Also
<a name="API_control_MatchObjectSize_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/MatchObjectSize) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/MatchObjectSize) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/MatchObjectSize) 

# Metrics
<a name="API_control_Metrics"></a>

A container that specifies replication metrics-related settings.

## Contents
<a name="API_control_Metrics_Contents"></a>

 ** Status **   <a name="AmazonS3-Type-control_Metrics-Status"></a>
Specifies whether replication metrics are enabled.   
Type: String  
Valid Values: `Enabled | Disabled`   
Required: Yes

 ** EventThreshold **   <a name="AmazonS3-Type-control_Metrics-EventThreshold"></a>
A container that specifies the time threshold for emitting the `s3:Replication:OperationMissedThreshold` event.   
This is not supported by Amazon S3 on Outposts buckets.
Type: [ReplicationTimeValue](API_control_ReplicationTimeValue.md) data type  
Required: No

## See Also
<a name="API_control_Metrics_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/Metrics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/Metrics) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/Metrics) 

# MultiRegionAccessPointPolicyDocument
<a name="API_control_MultiRegionAccessPointPolicyDocument"></a>

The Multi-Region Access Point access control policy.

When you update the policy, the update is first listed as the proposed policy. After the update is finished and all Regions have been updated, the proposed policy is listed as the established policy. If both policies have the same version number, the proposed policy is the established policy.

## Contents
<a name="API_control_MultiRegionAccessPointPolicyDocument_Contents"></a>

 ** Established **   <a name="AmazonS3-Type-control_MultiRegionAccessPointPolicyDocument-Established"></a>
The last established policy for the Multi-Region Access Point.  
Type: [EstablishedMultiRegionAccessPointPolicy](API_control_EstablishedMultiRegionAccessPointPolicy.md) data type  
Required: No

 ** Proposed **   <a name="AmazonS3-Type-control_MultiRegionAccessPointPolicyDocument-Proposed"></a>
The proposed policy for the Multi-Region Access Point.  
Type: [ProposedMultiRegionAccessPointPolicy](API_control_ProposedMultiRegionAccessPointPolicy.md) data type  
Required: No

## See Also
<a name="API_control_MultiRegionAccessPointPolicyDocument_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/MultiRegionAccessPointPolicyDocument) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/MultiRegionAccessPointPolicyDocument) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/MultiRegionAccessPointPolicyDocument) 

# MultiRegionAccessPointRegionalResponse
<a name="API_control_MultiRegionAccessPointRegionalResponse"></a>

Status information for a single Multi-Region Access Point Region.

## Contents
<a name="API_control_MultiRegionAccessPointRegionalResponse_Contents"></a>

 ** Name **   <a name="AmazonS3-Type-control_MultiRegionAccessPointRegionalResponse-Name"></a>
The name of the Region in the Multi-Region Access Point.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

 ** RequestStatus **   <a name="AmazonS3-Type-control_MultiRegionAccessPointRegionalResponse-RequestStatus"></a>
The current status of the Multi-Region Access Point in this Region.  
Type: String  
Required: No

## See Also
<a name="API_control_MultiRegionAccessPointRegionalResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/MultiRegionAccessPointRegionalResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/MultiRegionAccessPointRegionalResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/MultiRegionAccessPointRegionalResponse) 

# MultiRegionAccessPointReport
<a name="API_control_MultiRegionAccessPointReport"></a>

A collection of statuses for a Multi-Region Access Point in the various Regions it supports.

## Contents
<a name="API_control_MultiRegionAccessPointReport_Contents"></a>

 ** Alias **   <a name="AmazonS3-Type-control_MultiRegionAccessPointReport-Alias"></a>
The alias for the Multi-Region Access Point. For more information about the distinction between the name and the alias of an Multi-Region Access Point, see [Rules for naming Amazon S3 Multi-Region Access Points](https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html#multi-region-access-point-naming).  
Type: String  
Length Constraints: Maximum length of 63.  
Pattern: `^[a-z][a-z0-9]*[.]mrap$`   
Required: No

 ** CreatedAt **   <a name="AmazonS3-Type-control_MultiRegionAccessPointReport-CreatedAt"></a>
When the Multi-Region Access Point create request was received.  
Type: Timestamp  
Required: No

 ** Name **   <a name="AmazonS3-Type-control_MultiRegionAccessPointReport-Name"></a>
The name of the Multi-Region Access Point.  
Type: String  
Length Constraints: Maximum length of 50.  
Pattern: `^[a-z0-9][-a-z0-9]{1,48}[a-z0-9]$`   
Required: No

 ** PublicAccessBlock **   <a name="AmazonS3-Type-control_MultiRegionAccessPointReport-PublicAccessBlock"></a>
The `PublicAccessBlock` configuration that you want to apply to this Amazon S3 account. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see [The Meaning of "Public"](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) in the *Amazon S3 User Guide*.  
This data type is not supported for Amazon S3 on Outposts.  
Type: [PublicAccessBlockConfiguration](API_control_PublicAccessBlockConfiguration.md) data type  
Required: No

 ** Regions **   <a name="AmazonS3-Type-control_MultiRegionAccessPointReport-Regions"></a>
A collection of the Regions and buckets associated with the Multi-Region Access Point.  
Type: Array of [RegionReport](API_control_RegionReport.md) data types  
Required: No

 ** Status **   <a name="AmazonS3-Type-control_MultiRegionAccessPointReport-Status"></a>
The current status of the Multi-Region Access Point.  
 `CREATING` and `DELETING` are temporary states that exist while the request is propagating and being completed. If a Multi-Region Access Point has a status of `PARTIALLY_CREATED`, you can retry creation or send a request to delete the Multi-Region Access Point. If a Multi-Region Access Point has a status of `PARTIALLY_DELETED`, you can retry a delete request to finish the deletion of the Multi-Region Access Point.  
Type: String  
Valid Values: `READY | INCONSISTENT_ACROSS_REGIONS | CREATING | PARTIALLY_CREATED | PARTIALLY_DELETED | DELETING`   
Required: No

## See Also
<a name="API_control_MultiRegionAccessPointReport_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/MultiRegionAccessPointReport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/MultiRegionAccessPointReport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/MultiRegionAccessPointReport) 

# MultiRegionAccessPointRoute
<a name="API_control_MultiRegionAccessPointRoute"></a>

A structure for a Multi-Region Access Point that indicates where Amazon S3 traffic can be routed. Routes can be either active or passive. Active routes can process Amazon S3 requests through the Multi-Region Access Point, but passive routes are not eligible to process Amazon S3 requests. 

Each route contains the Amazon S3 bucket name and the AWS Region that the bucket is located in. The route also includes the `TrafficDialPercentage` value, which shows whether the bucket and Region are active (indicated by a value of `100`) or passive (indicated by a value of `0`).

## Contents
<a name="API_control_MultiRegionAccessPointRoute_Contents"></a>

 ** TrafficDialPercentage **   <a name="AmazonS3-Type-control_MultiRegionAccessPointRoute-TrafficDialPercentage"></a>
The traffic state for the specified bucket or AWS Region.   
A value of `0` indicates a passive state, which means that no new traffic will be routed to the Region.   
A value of `100` indicates an active state, which means that traffic will be routed to the specified Region.   
When the routing configuration for a Region is changed from active to passive, any in-progress operations (uploads, copies, deletes, and so on) to the formerly active Region will continue to run to until a final success or failure status is reached.  
If all Regions in the routing configuration are designated as passive, you'll receive an `InvalidRequest` error.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: Yes

 ** Bucket **   <a name="AmazonS3-Type-control_MultiRegionAccessPointRoute-Bucket"></a>
The name of the Amazon S3 bucket for which you'll submit a routing configuration change. Either the `Bucket` or the `Region` value must be provided. If both are provided, the bucket must be in the specified Region.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Required: No

 ** Region **   <a name="AmazonS3-Type-control_MultiRegionAccessPointRoute-Region"></a>
The AWS Region to which you'll be submitting a routing configuration change. Either the `Bucket` or the `Region` value must be provided. If both are provided, the bucket must be in the specified Region.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

## See Also
<a name="API_control_MultiRegionAccessPointRoute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/MultiRegionAccessPointRoute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/MultiRegionAccessPointRoute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/MultiRegionAccessPointRoute) 

# MultiRegionAccessPointsAsyncResponse
<a name="API_control_MultiRegionAccessPointsAsyncResponse"></a>

The Multi-Region Access Point details that are returned when querying about an asynchronous request.

## Contents
<a name="API_control_MultiRegionAccessPointsAsyncResponse_Contents"></a>

 ** Regions **   <a name="AmazonS3-Type-control_MultiRegionAccessPointsAsyncResponse-Regions"></a>
A collection of status information for the different Regions that a Multi-Region Access Point supports.  
Type: Array of [MultiRegionAccessPointRegionalResponse](API_control_MultiRegionAccessPointRegionalResponse.md) data types  
Required: No

## See Also
<a name="API_control_MultiRegionAccessPointsAsyncResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/MultiRegionAccessPointsAsyncResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/MultiRegionAccessPointsAsyncResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/MultiRegionAccessPointsAsyncResponse) 

# NoncurrentVersionExpiration
<a name="API_control_NoncurrentVersionExpiration"></a>

The container of the noncurrent version expiration.

## Contents
<a name="API_control_NoncurrentVersionExpiration_Contents"></a>

 ** NewerNoncurrentVersions **   <a name="AmazonS3-Type-control_NoncurrentVersionExpiration-NewerNoncurrentVersions"></a>
Specifies how many noncurrent versions S3 on Outposts will retain. If there are this many more recent noncurrent versions, S3 on Outposts will take the associated action. For more information about noncurrent versions, see [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) in the *Amazon S3 User Guide*.  
Type: Integer  
Required: No

 ** NoncurrentDays **   <a name="AmazonS3-Type-control_NoncurrentVersionExpiration-NoncurrentDays"></a>
Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see [How Amazon S3 Calculates When an Object Became Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) in the *Amazon S3 User Guide*.  
Type: Integer  
Required: No

## See Also
<a name="API_control_NoncurrentVersionExpiration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/NoncurrentVersionExpiration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/NoncurrentVersionExpiration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/NoncurrentVersionExpiration) 

# NoncurrentVersionTransition
<a name="API_control_NoncurrentVersionTransition"></a>

The container for the noncurrent version transition.

## Contents
<a name="API_control_NoncurrentVersionTransition_Contents"></a>

 ** NoncurrentDays **   <a name="AmazonS3-Type-control_NoncurrentVersionTransition-NoncurrentDays"></a>
Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see [ How Amazon S3 Calculates How Long an Object Has Been Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) in the *Amazon S3 User Guide*.  
Type: Integer  
Required: No

 ** StorageClass **   <a name="AmazonS3-Type-control_NoncurrentVersionTransition-StorageClass"></a>
The class of storage used to store the object.  
Type: String  
Valid Values: `GLACIER | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | DEEP_ARCHIVE`   
Required: No

## See Also
<a name="API_control_NoncurrentVersionTransition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/NoncurrentVersionTransition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/NoncurrentVersionTransition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/NoncurrentVersionTransition) 

# NotSSEFilter
<a name="API_control_NotSSEFilter"></a>

A filter that returns objects that aren't server-side encrypted.

## Contents
<a name="API_control_NotSSEFilter_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_control_NotSSEFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/NotSSEFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/NotSSEFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/NotSSEFilter) 

# ObjectEncryption
<a name="API_control_ObjectEncryption"></a>

The updated server-side encryption type for this object. The `UpdateObjectEncryption` operation supports the SSE-KMS encryption type.

Valid Values: `SSEKMS` 

## Contents
<a name="API_control_ObjectEncryption_Contents"></a>

 ** SSEKMS **   <a name="AmazonS3-Type-control_ObjectEncryption-SSEKMS"></a>
Specifies to update the object encryption type to server-side encryption with AWS Key Management Service (AWS KMS) keys (SSE-KMS).  
Type: [S3UpdateObjectEncryptionSSEKMS](API_control_S3UpdateObjectEncryptionSSEKMS.md) data type  
Required: No

## See Also
<a name="API_control_ObjectEncryption_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/ObjectEncryption) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/ObjectEncryption) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/ObjectEncryption) 

# ObjectEncryptionFilter
<a name="API_control_ObjectEncryptionFilter"></a>

An optional filter for the S3JobManifestGenerator that identifies the subset of objects by encryption type.

## Contents
<a name="API_control_ObjectEncryptionFilter_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** DSSEKMS **   <a name="AmazonS3-Type-control_ObjectEncryptionFilter-DSSEKMS"></a>
Filters for objects that are encrypted by dual-layer server-side encryption with AWS Key Management Service (KMS) keys (DSSE-KMS).  
Type: [DSSEKMSFilter](API_control_DSSEKMSFilter.md) data type  
Required: No

 ** NOTSSE **   <a name="AmazonS3-Type-control_ObjectEncryptionFilter-NOTSSE"></a>
Filters for objects that are not encrypted by server-side encryption.  
Type: [NotSSEFilter](API_control_NotSSEFilter.md) data type  
Required: No

 ** SSEC **   <a name="AmazonS3-Type-control_ObjectEncryptionFilter-SSEC"></a>
Filters for objects that are encrypted by server-side encryption with customer-provided keys (SSE-C).  
Type: [SSECFilter](API_control_SSECFilter.md) data type  
Required: No

 ** SSEKMS **   <a name="AmazonS3-Type-control_ObjectEncryptionFilter-SSEKMS"></a>
Filters for objects that are encrypted by server-side encryption with AWS Key Management Service (KMS) keys (SSE-KMS).  
Type: [SSEKMSFilter](API_control_SSEKMSFilter.md) data type  
Required: No

 ** SSES3 **   <a name="AmazonS3-Type-control_ObjectEncryptionFilter-SSES3"></a>
Filters for objects that are encrypted by server-side encryption with Amazon S3 managed keys (SSE-S3).  
Type: [SSES3Filter](API_control_SSES3Filter.md) data type  
Required: No

## See Also
<a name="API_control_ObjectEncryptionFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/ObjectEncryptionFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/ObjectEncryptionFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/ObjectEncryptionFilter) 

# ObjectLambdaAccessPoint
<a name="API_control_ObjectLambdaAccessPoint"></a>

An access point with an attached AWS Lambda function used to access transformed data from an Amazon S3 bucket.

## Contents
<a name="API_control_ObjectLambdaAccessPoint_Contents"></a>

 ** Name **   <a name="AmazonS3-Type-control_ObjectLambdaAccessPoint-Name"></a>
The name of the Object Lambda Access Point.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 45.  
Pattern: `^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$`   
Required: Yes

 ** Alias **   <a name="AmazonS3-Type-control_ObjectLambdaAccessPoint-Alias"></a>
The alias of the Object Lambda Access Point.  
Type: [ObjectLambdaAccessPointAlias](API_control_ObjectLambdaAccessPointAlias.md) data type  
Required: No

 ** ObjectLambdaAccessPointArn **   <a name="AmazonS3-Type-control_ObjectLambdaAccessPoint-ObjectLambdaAccessPointArn"></a>
Specifies the ARN for the Object Lambda Access Point.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:[^:]+:s3-object-lambda:[^:]*:\d{12}:accesspoint/.*`   
Required: No

## See Also
<a name="API_control_ObjectLambdaAccessPoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/ObjectLambdaAccessPoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/ObjectLambdaAccessPoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/ObjectLambdaAccessPoint) 

# ObjectLambdaAccessPointAlias
<a name="API_control_ObjectLambdaAccessPointAlias"></a>

The alias of an Object Lambda Access Point. For more information, see [How to use a bucket-style alias for your S3 bucket Object Lambda Access Point](https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-use.html#ol-access-points-alias).

## Contents
<a name="API_control_ObjectLambdaAccessPointAlias_Contents"></a>

 ** Status **   <a name="AmazonS3-Type-control_ObjectLambdaAccessPointAlias-Status"></a>
The status of the Object Lambda Access Point alias. If the status is `PROVISIONING`, the Object Lambda Access Point is provisioning the alias and the alias is not ready for use yet. If the status is `READY`, the Object Lambda Access Point alias is successfully provisioned and ready for use.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 16.  
Valid Values: `PROVISIONING | READY`   
Required: No

 ** Value **   <a name="AmazonS3-Type-control_ObjectLambdaAccessPointAlias-Value"></a>
The alias value of the Object Lambda Access Point.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `^[0-9a-z\\-]{3,63}`   
Required: No

## See Also
<a name="API_control_ObjectLambdaAccessPointAlias_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/ObjectLambdaAccessPointAlias) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/ObjectLambdaAccessPointAlias) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/ObjectLambdaAccessPointAlias) 

# ObjectLambdaConfiguration
<a name="API_control_ObjectLambdaConfiguration"></a>

A configuration used when creating an Object Lambda Access Point.

## Contents
<a name="API_control_ObjectLambdaConfiguration_Contents"></a>

 ** SupportingAccessPoint **   <a name="AmazonS3-Type-control_ObjectLambdaConfiguration-SupportingAccessPoint"></a>
Standard access point associated with the Object Lambda Access Point.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:[^:]+:s3:[^:]*:\d{12}:accesspoint/.*`   
Required: Yes

 ** TransformationConfigurations **   <a name="AmazonS3-Type-control_ObjectLambdaConfiguration-TransformationConfigurations"></a>
A container for transformation configurations for an Object Lambda Access Point.  
Type: Array of [ObjectLambdaTransformationConfiguration](API_control_ObjectLambdaTransformationConfiguration.md) data types  
Required: Yes

 ** AllowedFeatures **   <a name="AmazonS3-Type-control_ObjectLambdaConfiguration-AllowedFeatures"></a>
A container for allowed features. Valid inputs are `GetObject-Range`, `GetObject-PartNumber`, `HeadObject-Range`, and `HeadObject-PartNumber`.  
Type: Array of strings  
Valid Values: `GetObject-Range | GetObject-PartNumber | HeadObject-Range | HeadObject-PartNumber`   
Required: No

 ** CloudWatchMetricsEnabled **   <a name="AmazonS3-Type-control_ObjectLambdaConfiguration-CloudWatchMetricsEnabled"></a>
A container for whether the CloudWatch metrics configuration is enabled.  
Type: Boolean  
Required: No

## See Also
<a name="API_control_ObjectLambdaConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/ObjectLambdaConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/ObjectLambdaConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/ObjectLambdaConfiguration) 

# ObjectLambdaContentTransformation
<a name="API_control_ObjectLambdaContentTransformation"></a>

A container for AwsLambdaTransformation.

## Contents
<a name="API_control_ObjectLambdaContentTransformation_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** AwsLambda **   <a name="AmazonS3-Type-control_ObjectLambdaContentTransformation-AwsLambda"></a>
A container for an AWS Lambda function.  
Type: [AwsLambdaTransformation](API_control_AwsLambdaTransformation.md) data type  
Required: No

## See Also
<a name="API_control_ObjectLambdaContentTransformation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/ObjectLambdaContentTransformation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/ObjectLambdaContentTransformation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/ObjectLambdaContentTransformation) 

# ObjectLambdaTransformationConfiguration
<a name="API_control_ObjectLambdaTransformationConfiguration"></a>

A configuration used when creating an Object Lambda Access Point transformation.

## Contents
<a name="API_control_ObjectLambdaTransformationConfiguration_Contents"></a>

 ** Actions **   <a name="AmazonS3-Type-control_ObjectLambdaTransformationConfiguration-Actions"></a>
A container for the action of an Object Lambda Access Point configuration. Valid inputs are `GetObject`, `ListObjects`, `HeadObject`, and `ListObjectsV2`.  
Type: Array of strings  
Valid Values: `GetObject | HeadObject | ListObjects | ListObjectsV2`   
Required: Yes

 ** ContentTransformation **   <a name="AmazonS3-Type-control_ObjectLambdaTransformationConfiguration-ContentTransformation"></a>
A container for the content transformation of an Object Lambda Access Point configuration.  
Type: [ObjectLambdaContentTransformation](API_control_ObjectLambdaContentTransformation.md) data type  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## See Also
<a name="API_control_ObjectLambdaTransformationConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/ObjectLambdaTransformationConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/ObjectLambdaTransformationConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/ObjectLambdaTransformationConfiguration) 

# PolicyStatus
<a name="API_control_PolicyStatus"></a>

Indicates whether this access point policy is public. For more information about how Amazon S3 evaluates policies to determine whether they are public, see [The Meaning of "Public"](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) in the *Amazon S3 User Guide*. 

## Contents
<a name="API_control_PolicyStatus_Contents"></a>

 ** IsPublic **   <a name="AmazonS3-Type-control_PolicyStatus-IsPublic"></a>
  
Type: Boolean  
Required: No

## See Also
<a name="API_control_PolicyStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/PolicyStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/PolicyStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/PolicyStatus) 

# PrefixLevel
<a name="API_control_PrefixLevel"></a>

A container for the prefix-level configuration.

## Contents
<a name="API_control_PrefixLevel_Contents"></a>

 ** StorageMetrics **   <a name="AmazonS3-Type-control_PrefixLevel-StorageMetrics"></a>
A container for the prefix-level storage metrics for S3 Storage Lens.  
Type: [PrefixLevelStorageMetrics](API_control_PrefixLevelStorageMetrics.md) data type  
Required: Yes

## See Also
<a name="API_control_PrefixLevel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/PrefixLevel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/PrefixLevel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/PrefixLevel) 

# PrefixLevelStorageMetrics
<a name="API_control_PrefixLevelStorageMetrics"></a>

A container for the prefix-level storage metrics for S3 Storage Lens.

## Contents
<a name="API_control_PrefixLevelStorageMetrics_Contents"></a>

 ** IsEnabled **   <a name="AmazonS3-Type-control_PrefixLevelStorageMetrics-IsEnabled"></a>
A container for whether prefix-level storage metrics are enabled.  
Type: Boolean  
Required: No

 ** SelectionCriteria **   <a name="AmazonS3-Type-control_PrefixLevelStorageMetrics-SelectionCriteria"></a>
  
Type: [SelectionCriteria](API_control_SelectionCriteria.md) data type  
Required: No

## See Also
<a name="API_control_PrefixLevelStorageMetrics_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/PrefixLevelStorageMetrics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/PrefixLevelStorageMetrics) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/PrefixLevelStorageMetrics) 

# ProposedMultiRegionAccessPointPolicy
<a name="API_control_ProposedMultiRegionAccessPointPolicy"></a>

The proposed access control policy for the Multi-Region Access Point.

When you update the policy, the update is first listed as the proposed policy. After the update is finished and all Regions have been updated, the proposed policy is listed as the established policy. If both policies have the same version number, the proposed policy is the established policy.

## Contents
<a name="API_control_ProposedMultiRegionAccessPointPolicy_Contents"></a>

 ** Policy **   <a name="AmazonS3-Type-control_ProposedMultiRegionAccessPointPolicy-Policy"></a>
The details of the proposed policy.  
Type: String  
Required: No

## See Also
<a name="API_control_ProposedMultiRegionAccessPointPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/ProposedMultiRegionAccessPointPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/ProposedMultiRegionAccessPointPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/ProposedMultiRegionAccessPointPolicy) 

# PublicAccessBlockConfiguration
<a name="API_control_PublicAccessBlockConfiguration"></a>

The `PublicAccessBlock` configuration that you want to apply to this Amazon S3 account. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see [The Meaning of "Public"](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) in the *Amazon S3 User Guide*.

This data type is not supported for Amazon S3 on Outposts.

## Contents
<a name="API_control_PublicAccessBlockConfiguration_Contents"></a>

 ** BlockPublicAcls **   <a name="AmazonS3-Type-control_PublicAccessBlockConfiguration-BlockPublicAcls"></a>
Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to `TRUE` causes the following behavior:  
+  `PutBucketAcl` and `PutObjectAcl` calls fail if the specified ACL is public.
+ PUT Object calls fail if the request includes a public ACL.
+ PUT Bucket calls fail if the request includes a public ACL.
Enabling this setting doesn't affect existing policies or ACLs.  
This property is not supported for Amazon S3 on Outposts.  
Type: Boolean  
Required: No

 ** BlockPublicPolicy **   <a name="AmazonS3-Type-control_PublicAccessBlockConfiguration-BlockPublicPolicy"></a>
Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to `TRUE` causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.   
Enabling this setting doesn't affect existing bucket policies.  
This property is not supported for Amazon S3 on Outposts.  
Type: Boolean  
Required: No

 ** IgnorePublicAcls **   <a name="AmazonS3-Type-control_PublicAccessBlockConfiguration-IgnorePublicAcls"></a>
Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to `TRUE` causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.   
Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.  
This property is not supported for Amazon S3 on Outposts.  
Type: Boolean  
Required: No

 ** RestrictPublicBuckets **   <a name="AmazonS3-Type-control_PublicAccessBlockConfiguration-RestrictPublicBuckets"></a>
Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to `TRUE` restricts access to buckets with public policies to only AWS service principals and authorized users within this account.  
Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.  
This property is not supported for Amazon S3 on Outposts.  
Type: Boolean  
Required: No

## See Also
<a name="API_control_PublicAccessBlockConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/PublicAccessBlockConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/PublicAccessBlockConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/PublicAccessBlockConfiguration) 

# PutMultiRegionAccessPointPolicyInput
<a name="API_control_PutMultiRegionAccessPointPolicyInput"></a>

A container for the information associated with a [PutMultiRegionAccessPoint](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPoint.html) request.

## Contents
<a name="API_control_PutMultiRegionAccessPointPolicyInput_Contents"></a>

 ** Name **   <a name="AmazonS3-Type-control_PutMultiRegionAccessPointPolicyInput-Name"></a>
The name of the Multi-Region Access Point associated with the request.  
Type: String  
Length Constraints: Maximum length of 50.  
Pattern: `^[a-z0-9][-a-z0-9]{1,48}[a-z0-9]$`   
Required: Yes

 ** Policy **   <a name="AmazonS3-Type-control_PutMultiRegionAccessPointPolicyInput-Policy"></a>
The policy details for the `PutMultiRegionAccessPoint` request.  
Type: String  
Required: Yes

## See Also
<a name="API_control_PutMultiRegionAccessPointPolicyInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/PutMultiRegionAccessPointPolicyInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/PutMultiRegionAccessPointPolicyInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/PutMultiRegionAccessPointPolicyInput) 

# Region
<a name="API_control_Region"></a>

A Region that supports a Multi-Region Access Point as well as the associated bucket for the Region.

## Contents
<a name="API_control_Region_Contents"></a>

 ** Bucket **   <a name="AmazonS3-Type-control_Region-Bucket"></a>
The name of the associated bucket for the Region.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Required: Yes

 ** BucketAccountId **   <a name="AmazonS3-Type-control_Region-BucketAccountId"></a>
The AWS account ID that owns the Amazon S3 bucket that's associated with this Multi-Region Access Point.  
Type: String  
Length Constraints: Maximum length of 64.  
Pattern: `^\d{12}$`   
Required: No

## See Also
<a name="API_control_Region_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/Region) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/Region) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/Region) 

# RegionalBucket
<a name="API_control_RegionalBucket"></a>

The container for the regional bucket.

## Contents
<a name="API_control_RegionalBucket_Contents"></a>

 ** Bucket **   <a name="AmazonS3-Type-control_RegionalBucket-Bucket"></a>
  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Required: Yes

 ** CreationDate **   <a name="AmazonS3-Type-control_RegionalBucket-CreationDate"></a>
The creation date of the regional bucket  
Type: Timestamp  
Required: Yes

 ** PublicAccessBlockEnabled **   <a name="AmazonS3-Type-control_RegionalBucket-PublicAccessBlockEnabled"></a>
  
Type: Boolean  
Required: Yes

 ** BucketArn **   <a name="AmazonS3-Type-control_RegionalBucket-BucketArn"></a>
The Amazon Resource Name (ARN) for the regional bucket.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 128.  
Required: No

 ** OutpostId **   <a name="AmazonS3-Type-control_RegionalBucket-OutpostId"></a>
The AWS Outposts ID of the regional bucket.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

## See Also
<a name="API_control_RegionalBucket_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/RegionalBucket) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/RegionalBucket) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/RegionalBucket) 

# RegionReport
<a name="API_control_RegionReport"></a>

A combination of a bucket and Region that's part of a Multi-Region Access Point.

## Contents
<a name="API_control_RegionReport_Contents"></a>

 ** Bucket **   <a name="AmazonS3-Type-control_RegionReport-Bucket"></a>
The name of the bucket.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Required: No

 ** BucketAccountId **   <a name="AmazonS3-Type-control_RegionReport-BucketAccountId"></a>
The AWS account ID that owns the Amazon S3 bucket that's associated with this Multi-Region Access Point.  
Type: String  
Length Constraints: Maximum length of 64.  
Pattern: `^\d{12}$`   
Required: No

 ** Region **   <a name="AmazonS3-Type-control_RegionReport-Region"></a>
The name of the Region.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

## See Also
<a name="API_control_RegionReport_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/RegionReport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/RegionReport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/RegionReport) 

# ReplicaModifications
<a name="API_control_ReplicaModifications"></a>

A filter that you can use to specify whether replica modification sync is enabled. S3 on Outposts replica modification sync can help you keep object metadata synchronized between replicas and source objects. By default, S3 on Outposts replicates metadata from the source objects to the replicas only. When replica modification sync is enabled, S3 on Outposts replicates metadata changes made to the replica copies back to the source object, making the replication bidirectional.

To replicate object metadata modifications on replicas, you can specify this element and set the `Status` of this element to `Enabled`.

**Note**  
You must enable replica modification sync on the source and destination buckets to replicate replica metadata changes between the source and the replicas.

## Contents
<a name="API_control_ReplicaModifications_Contents"></a>

 ** Status **   <a name="AmazonS3-Type-control_ReplicaModifications-Status"></a>
Specifies whether S3 on Outposts replicates modifications to object metadata on replicas.  
Type: String  
Valid Values: `Enabled | Disabled`   
Required: Yes

## See Also
<a name="API_control_ReplicaModifications_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/ReplicaModifications) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/ReplicaModifications) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/ReplicaModifications) 

# ReplicationConfiguration
<a name="API_control_ReplicationConfiguration"></a>

A container for one or more replication rules. A replication configuration must have at least one rule and you can add up to 100 rules. The maximum size of a replication configuration is 128 KB.

## Contents
<a name="API_control_ReplicationConfiguration_Contents"></a>

 ** Role **   <a name="AmazonS3-Type-control_ReplicationConfiguration-Role"></a>
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that S3 on Outposts assumes when replicating objects. For information about S3 replication on Outposts configuration, see [Setting up replication](https://docs.aws.amazon.com/AmazonS3/latest/userguide/outposts-replication-how-setup.html) in the *Amazon S3 User Guide*.  
Type: String  
Required: Yes

 ** Rules **   <a name="AmazonS3-Type-control_ReplicationConfiguration-Rules"></a>
A container for one or more replication rules. A replication configuration must have at least one rule and can contain an array of 100 rules at the most.   
Type: Array of [ReplicationRule](API_control_ReplicationRule.md) data types  
Required: Yes

## See Also
<a name="API_control_ReplicationConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/ReplicationConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/ReplicationConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/ReplicationConfiguration) 

# ReplicationRule
<a name="API_control_ReplicationRule"></a>

Specifies which S3 on Outposts objects to replicate and where to store the replicas.

## Contents
<a name="API_control_ReplicationRule_Contents"></a>

 ** Bucket **   <a name="AmazonS3-Type-control_ReplicationRule-Bucket"></a>
The Amazon Resource Name (ARN) of the access point for the source Outposts bucket that you want S3 on Outposts to replicate the objects from.  
Type: String  
Required: Yes

 ** Destination **   <a name="AmazonS3-Type-control_ReplicationRule-Destination"></a>
A container for information about the replication destination and its configurations.  
Type: [Destination](API_control_Destination.md) data type  
Required: Yes

 ** Status **   <a name="AmazonS3-Type-control_ReplicationRule-Status"></a>
Specifies whether the rule is enabled.  
Type: String  
Valid Values: `Enabled | Disabled`   
Required: Yes

 ** DeleteMarkerReplication **   <a name="AmazonS3-Type-control_ReplicationRule-DeleteMarkerReplication"></a>
Specifies whether S3 on Outposts replicates delete markers. If you specify a `Filter` element in your replication configuration, you must also include a `DeleteMarkerReplication` element. If your `Filter` includes a `Tag` element, the `DeleteMarkerReplication` element's `Status` child element must be set to `Disabled`, because S3 on Outposts doesn't support replicating delete markers for tag-based rules.  
For more information about delete marker replication, see [How delete operations affect replication](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html#outposts-replication-what-is-replicated) in the *Amazon S3 User Guide*.   
Type: [DeleteMarkerReplication](API_control_DeleteMarkerReplication.md) data type  
Required: No

 ** ExistingObjectReplication **   <a name="AmazonS3-Type-control_ReplicationRule-ExistingObjectReplication"></a>
An optional configuration to replicate existing source bucket objects.   
This is not supported by Amazon S3 on Outposts buckets.
Type: [ExistingObjectReplication](API_control_ExistingObjectReplication.md) data type  
Required: No

 ** Filter **   <a name="AmazonS3-Type-control_ReplicationRule-Filter"></a>
A filter that identifies the subset of objects to which the replication rule applies. A `Filter` element must specify exactly one `Prefix`, `Tag`, or `And` child element.  
Type: [ReplicationRuleFilter](API_control_ReplicationRuleFilter.md) data type  
Required: No

 ** ID **   <a name="AmazonS3-Type-control_ReplicationRule-ID"></a>
A unique identifier for the rule. The maximum value is 255 characters.  
Type: String  
Required: No

 ** Prefix **   <a name="AmazonS3-Type-control_ReplicationRule-Prefix"></a>
 *This member has been deprecated.*   
An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in an Outposts bucket, specify an empty string.  
When you're using XML requests, you must replace special characters (such as carriage returns) in object keys with their equivalent XML entity codes. For more information, see [ XML-related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints) in the *Amazon S3 User Guide*.
Type: String  
Required: No

 ** Priority **   <a name="AmazonS3-Type-control_ReplicationRule-Priority"></a>
The priority indicates which rule has precedence whenever two or more replication rules conflict. S3 on Outposts attempts to replicate objects according to all replication rules. However, if there are two or more rules with the same destination Outposts bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority.   
For more information, see [Creating replication rules on Outposts](https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication-between-outposts.html) in the *Amazon S3 User Guide*.  
Type: Integer  
Required: No

 ** SourceSelectionCriteria **   <a name="AmazonS3-Type-control_ReplicationRule-SourceSelectionCriteria"></a>
A container that describes additional filters for identifying the source Outposts objects that you want to replicate. You can choose to enable or disable the replication of these objects.  
Type: [SourceSelectionCriteria](API_control_SourceSelectionCriteria.md) data type  
Required: No

## See Also
<a name="API_control_ReplicationRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/ReplicationRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/ReplicationRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/ReplicationRule) 

# ReplicationRuleAndOperator
<a name="API_control_ReplicationRuleAndOperator"></a>

A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. 

For example:
+ If you specify both a `Prefix` and a `Tag` filter, wrap these filters in an `And` element. 
+ If you specify a filter based on multiple tags, wrap the `Tag` elements in an `And` element.

## Contents
<a name="API_control_ReplicationRuleAndOperator_Contents"></a>

 ** Prefix **   <a name="AmazonS3-Type-control_ReplicationRuleAndOperator-Prefix"></a>
An object key name prefix that identifies the subset of objects that the rule applies to.  
Type: String  
Required: No

 ** Tags **   <a name="AmazonS3-Type-control_ReplicationRuleAndOperator-Tags"></a>
An array of tags that contain key and value pairs.  
Type: Array of [S3Tag](API_control_S3Tag.md) data types  
Required: No

## See Also
<a name="API_control_ReplicationRuleAndOperator_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/ReplicationRuleAndOperator) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/ReplicationRuleAndOperator) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/ReplicationRuleAndOperator) 

# ReplicationRuleFilter
<a name="API_control_ReplicationRuleFilter"></a>

A filter that identifies the subset of objects to which the replication rule applies. A `Filter` element must specify exactly one `Prefix`, `Tag`, or `And` child element.

## Contents
<a name="API_control_ReplicationRuleFilter_Contents"></a>

 ** And **   <a name="AmazonS3-Type-control_ReplicationRuleFilter-And"></a>
A container for specifying rule filters. The filters determine the subset of objects that the rule applies to. This element is required only if you specify more than one filter. For example:   
+ If you specify both a `Prefix` and a `Tag` filter, wrap these filters in an `And` element.
+ If you specify a filter based on multiple tags, wrap the `Tag` elements in an `And` element.
Type: [ReplicationRuleAndOperator](API_control_ReplicationRuleAndOperator.md) data type  
Required: No

 ** Prefix **   <a name="AmazonS3-Type-control_ReplicationRuleFilter-Prefix"></a>
An object key name prefix that identifies the subset of objects that the rule applies to.  
When you're using XML requests, you must replace special characters (such as carriage returns) in object keys with their equivalent XML entity codes. For more information, see [ XML-related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints) in the *Amazon S3 User Guide*.
Type: String  
Required: No

 ** Tag **   <a name="AmazonS3-Type-control_ReplicationRuleFilter-Tag"></a>
A container for a key-value name pair.  
Type: [S3Tag](API_control_S3Tag.md) data type  
Required: No

## See Also
<a name="API_control_ReplicationRuleFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/ReplicationRuleFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/ReplicationRuleFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/ReplicationRuleFilter) 

# ReplicationTime
<a name="API_control_ReplicationTime"></a>

A container that specifies S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated.

**Note**  
This is not supported by Amazon S3 on Outposts buckets.

## Contents
<a name="API_control_ReplicationTime_Contents"></a>

 ** Status **   <a name="AmazonS3-Type-control_ReplicationTime-Status"></a>
Specifies whether S3 Replication Time Control (S3 RTC) is enabled.   
Type: String  
Valid Values: `Enabled | Disabled`   
Required: Yes

 ** Time **   <a name="AmazonS3-Type-control_ReplicationTime-Time"></a>
A container that specifies the time by which replication should be complete for all objects and operations on objects.   
Type: [ReplicationTimeValue](API_control_ReplicationTimeValue.md) data type  
Required: Yes

## See Also
<a name="API_control_ReplicationTime_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/ReplicationTime) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/ReplicationTime) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/ReplicationTime) 

# ReplicationTimeValue
<a name="API_control_ReplicationTimeValue"></a>

A container that specifies the time value for S3 Replication Time Control (S3 RTC). This value is also used for the replication metrics `EventThreshold` element. 

**Note**  
This is not supported by Amazon S3 on Outposts buckets.

## Contents
<a name="API_control_ReplicationTimeValue_Contents"></a>

 ** Minutes **   <a name="AmazonS3-Type-control_ReplicationTimeValue-Minutes"></a>
Contains an integer that specifies the time period in minutes.   
Valid value: 15  
Type: Integer  
Required: No

## See Also
<a name="API_control_ReplicationTimeValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/ReplicationTimeValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/ReplicationTimeValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/ReplicationTimeValue) 

# S3AccessControlList
<a name="API_control_S3AccessControlList"></a>



## Contents
<a name="API_control_S3AccessControlList_Contents"></a>

 ** Owner **   <a name="AmazonS3-Type-control_S3AccessControlList-Owner"></a>
  
Type: [S3ObjectOwner](API_control_S3ObjectOwner.md) data type  
Required: Yes

 ** Grants **   <a name="AmazonS3-Type-control_S3AccessControlList-Grants"></a>
  
Type: Array of [S3Grant](API_control_S3Grant.md) data types  
Required: No

## See Also
<a name="API_control_S3AccessControlList_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/S3AccessControlList) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/S3AccessControlList) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/S3AccessControlList) 

# S3AccessControlPolicy
<a name="API_control_S3AccessControlPolicy"></a>



## Contents
<a name="API_control_S3AccessControlPolicy_Contents"></a>

 ** AccessControlList **   <a name="AmazonS3-Type-control_S3AccessControlPolicy-AccessControlList"></a>
  
Type: [S3AccessControlList](API_control_S3AccessControlList.md) data type  
Required: No

 ** CannedAccessControlList **   <a name="AmazonS3-Type-control_S3AccessControlPolicy-CannedAccessControlList"></a>
  
Type: String  
Valid Values: `private | public-read | public-read-write | aws-exec-read | authenticated-read | bucket-owner-read | bucket-owner-full-control`   
Required: No

## See Also
<a name="API_control_S3AccessControlPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/S3AccessControlPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/S3AccessControlPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/S3AccessControlPolicy) 

# S3BucketDestination
<a name="API_control_S3BucketDestination"></a>

A container for the bucket where the Amazon S3 Storage Lens metrics export files are located.

## Contents
<a name="API_control_S3BucketDestination_Contents"></a>

 ** AccountId **   <a name="AmazonS3-Type-control_S3BucketDestination-AccountId"></a>
The account ID of the owner of the S3 Storage Lens metrics export bucket.  
Type: String  
Length Constraints: Maximum length of 64.  
Pattern: `^\d{12}$`   
Required: Yes

 ** Arn **   <a name="AmazonS3-Type-control_S3BucketDestination-Arn"></a>
The Amazon Resource Name (ARN) of the bucket. This property is read-only and follows the following format: ` arn:aws:s3:us-east-1:example-account-id:bucket/your-destination-bucket-name `   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `arn:[^:]+:s3:.*`   
Required: Yes

 ** Format **   <a name="AmazonS3-Type-control_S3BucketDestination-Format"></a>
  
Type: String  
Valid Values: `CSV | Parquet`   
Required: Yes

 ** OutputSchemaVersion **   <a name="AmazonS3-Type-control_S3BucketDestination-OutputSchemaVersion"></a>
The schema version of the export file.  
Type: String  
Valid Values: `V_1`   
Required: Yes

 ** Encryption **   <a name="AmazonS3-Type-control_S3BucketDestination-Encryption"></a>
The container for the type encryption of the metrics exports in this bucket.  
Type: [StorageLensDataExportEncryption](API_control_StorageLensDataExportEncryption.md) data type  
Required: No

 ** Prefix **   <a name="AmazonS3-Type-control_S3BucketDestination-Prefix"></a>
The prefix of the destination bucket where the metrics export will be delivered.  
Type: String  
Required: No

## See Also
<a name="API_control_S3BucketDestination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/S3BucketDestination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/S3BucketDestination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/S3BucketDestination) 

# S3ComputeObjectChecksumOperation
<a name="API_control_S3ComputeObjectChecksumOperation"></a>

Directs the specified job to invoke the ComputeObjectChecksum operation on every object listed in the job's manifest.

## Contents
<a name="API_control_S3ComputeObjectChecksumOperation_Contents"></a>

 ** ChecksumAlgorithm **   <a name="AmazonS3-Type-control_S3ComputeObjectChecksumOperation-ChecksumAlgorithm"></a>
Indicates the algorithm that you want Amazon S3 to use to create the checksum. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the Amazon S3 User Guide.  
Type: String  
Valid Values: `CRC32 | CRC32C | CRC64NVME | MD5 | SHA1 | SHA256`   
Required: No

 ** ChecksumType **   <a name="AmazonS3-Type-control_S3ComputeObjectChecksumOperation-ChecksumType"></a>
Indicates the checksum type that you want Amazon S3 to use to calculate the object's checksum value. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the Amazon S3 User Guide.  
Type: String  
Valid Values: `FULL_OBJECT | COMPOSITE`   
Required: No

## See Also
<a name="API_control_S3ComputeObjectChecksumOperation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/S3ComputeObjectChecksumOperation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/S3ComputeObjectChecksumOperation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/S3ComputeObjectChecksumOperation) 

# S3CopyObjectOperation
<a name="API_control_S3CopyObjectOperation"></a>

Contains the configuration parameters for a PUT Copy object operation. S3 Batch Operations passes every object to the underlying `CopyObject` API operation. For more information about the parameters for this operation, see [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectCOPY.html).

## Contents
<a name="API_control_S3CopyObjectOperation_Contents"></a>

 ** AccessControlGrants **   <a name="AmazonS3-Type-control_S3CopyObjectOperation-AccessControlGrants"></a>
  
This functionality is not supported by directory buckets.
Type: Array of [S3Grant](API_control_S3Grant.md) data types  
Required: No

 ** BucketKeyEnabled **   <a name="AmazonS3-Type-control_S3CopyObjectOperation-BucketKeyEnabled"></a>
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to `true` causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.  
Specifying this header with an *Copy* action doesn’t affect *bucket-level* settings for S3 Bucket Key.  
 **Directory buckets** - S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through [the Copy operation in Batch Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops). In this case, Amazon S3 makes a call to AWS KMS every time a copy request is made for a KMS-encrypted object.
Type: Boolean  
Required: No

 ** CannedAccessControlList **   <a name="AmazonS3-Type-control_S3CopyObjectOperation-CannedAccessControlList"></a>
  
This functionality is not supported by directory buckets.
Type: String  
Valid Values: `private | public-read | public-read-write | aws-exec-read | authenticated-read | bucket-owner-read | bucket-owner-full-control`   
Required: No

 ** ChecksumAlgorithm **   <a name="AmazonS3-Type-control_S3CopyObjectOperation-ChecksumAlgorithm"></a>
Indicates the algorithm that you want Amazon S3 to use to create the checksum. For more information, see [ Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.  
Type: String  
Valid Values: `CRC32 | CRC32C | SHA1 | SHA256 | CRC64NVME`   
Required: No

 ** MetadataDirective **   <a name="AmazonS3-Type-control_S3CopyObjectOperation-MetadataDirective"></a>
  
Type: String  
Valid Values: `COPY | REPLACE`   
Required: No

 ** ModifiedSinceConstraint **   <a name="AmazonS3-Type-control_S3CopyObjectOperation-ModifiedSinceConstraint"></a>
  
Type: Timestamp  
Required: No

 ** NewObjectMetadata **   <a name="AmazonS3-Type-control_S3CopyObjectOperation-NewObjectMetadata"></a>
If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects. If you specify an empty set, the new objects will have no tags. Otherwise, Amazon S3 assigns the supplied tags to the new objects.  
Type: [S3ObjectMetadata](API_control_S3ObjectMetadata.md) data type  
Required: No

 ** NewObjectTagging **   <a name="AmazonS3-Type-control_S3CopyObjectOperation-NewObjectTagging"></a>
Specifies a list of tags to add to the destination objects after they are copied. If `NewObjectTagging` is not specified, the tags of the source objects are copied to destination objects by default.  
 **Directory buckets** - Tags aren't supported by directory buckets. If your source objects have tags and your destination bucket is a directory bucket, specify an empty tag set in the `NewObjectTagging` field to prevent copying the source object tags to the directory bucket.
Type: Array of [S3Tag](API_control_S3Tag.md) data types  
Required: No

 ** ObjectLockLegalHoldStatus **   <a name="AmazonS3-Type-control_S3CopyObjectOperation-ObjectLockLegalHoldStatus"></a>
The legal hold status to be applied to all objects in the Batch Operations job.  
This functionality is not supported by directory buckets.
Type: String  
Valid Values: `OFF | ON`   
Required: No

 ** ObjectLockMode **   <a name="AmazonS3-Type-control_S3CopyObjectOperation-ObjectLockMode"></a>
The retention mode to be applied to all objects in the Batch Operations job.  
This functionality is not supported by directory buckets.
Type: String  
Valid Values: `COMPLIANCE | GOVERNANCE`   
Required: No

 ** ObjectLockRetainUntilDate **   <a name="AmazonS3-Type-control_S3CopyObjectOperation-ObjectLockRetainUntilDate"></a>
The date when the applied object retention configuration expires on all objects in the Batch Operations job.  
This functionality is not supported by directory buckets.
Type: Timestamp  
Required: No

 ** RedirectLocation **   <a name="AmazonS3-Type-control_S3CopyObjectOperation-RedirectLocation"></a>
If the destination bucket is configured as a website, specifies an optional metadata property for website redirects, `x-amz-website-redirect-location`. Allows webpage redirects if the object copy is accessed through a website endpoint.  
This functionality is not supported by directory buckets.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** RequesterPays **   <a name="AmazonS3-Type-control_S3CopyObjectOperation-RequesterPays"></a>
  
This functionality is not supported by directory buckets.
Type: Boolean  
Required: No

 ** SSEAwsKmsKeyId **   <a name="AmazonS3-Type-control_S3CopyObjectOperation-SSEAwsKmsKeyId"></a>
Specifies the AWS KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't exist in the same account that's issuing the command, you must use the full Key ARN not the Key ID.  
 **Directory buckets** - If you specify `SSEAlgorithm` with `KMS`, you must specify the ` SSEAwsKmsKeyId` parameter with the ID (Key ID or Key ARN) of the AWS KMS symmetric encryption customer managed key to use. Otherwise, you get an HTTP `400 Bad Request` error. The key alias format of the KMS key isn't supported. To encrypt new object copies in a directory bucket with SSE-KMS, you must specify SSE-KMS as the directory bucket's default encryption configuration with a KMS key (specifically, a [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk)). The [AWS managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) (`aws/s3`) isn't supported. Your SSE-KMS configuration can only support 1 [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) per directory bucket for the lifetime of the bucket. After you specify a customer managed key for SSE-KMS as the bucket default encryption, you can't override the customer managed key for the bucket's SSE-KMS configuration. Then, when you specify server-side encryption settings for new object copies with SSE-KMS, you must make sure the encryption key is the same customer managed key that you specified for the directory bucket's default encryption configuration. 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Required: No

 ** StorageClass **   <a name="AmazonS3-Type-control_S3CopyObjectOperation-StorageClass"></a>
Specify the storage class for the destination objects in a `Copy` operation.  
 **Directory buckets ** - This functionality is not supported by directory buckets. 
Type: String  
Valid Values: `STANDARD | STANDARD_IA | ONEZONE_IA | GLACIER | INTELLIGENT_TIERING | DEEP_ARCHIVE | GLACIER_IR`   
Required: No

 ** TargetKeyPrefix **   <a name="AmazonS3-Type-control_S3CopyObjectOperation-TargetKeyPrefix"></a>
Specifies the folder prefix that you want the objects to be copied into. For example, to copy objects into a folder named `Folder1` in the destination bucket, set the `TargetKeyPrefix` property to `Folder1`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** TargetResource **   <a name="AmazonS3-Type-control_S3CopyObjectOperation-TargetResource"></a>
Specifies the destination bucket Amazon Resource Name (ARN) for the batch copy operation.  
+  **General purpose buckets** - For example, to copy objects to a general purpose bucket named `destinationBucket`, set the `TargetResource` property to `arn:aws:s3:::destinationBucket`.
+  **Directory buckets** - For example, to copy objects to a directory bucket named `destinationBucket` in the Availability Zone identified by the AZ ID `usw2-az1`, set the `TargetResource` property to `arn:aws:s3express:region:account_id:/bucket/destination_bucket_base_name--usw2-az1--x-s3`. A directory bucket as a destination bucket can be in Availability Zone or Local Zone. 
**Note**  
Copying objects across different AWS Regions isn't supported when the source or destination bucket is in AWS Local Zones. The source and destination buckets must have the same parent AWS Region. Otherwise, you get an HTTP `400 Bad Request` error with the error code `InvalidRequest`.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `arn:[^:]+:(s3|s3express):.*`   
Required: No

 ** UnModifiedSinceConstraint **   <a name="AmazonS3-Type-control_S3CopyObjectOperation-UnModifiedSinceConstraint"></a>
  
Type: Timestamp  
Required: No

## See Also
<a name="API_control_S3CopyObjectOperation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/S3CopyObjectOperation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/S3CopyObjectOperation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/S3CopyObjectOperation) 

# S3DeleteObjectTaggingOperation
<a name="API_control_S3DeleteObjectTaggingOperation"></a>

Contains no configuration parameters because the DELETE Object tagging (`DeleteObjectTagging`) API operation accepts only the bucket name and key name as parameters, which are defined in the job's manifest.

## Contents
<a name="API_control_S3DeleteObjectTaggingOperation_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_control_S3DeleteObjectTaggingOperation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/S3DeleteObjectTaggingOperation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/S3DeleteObjectTaggingOperation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/S3DeleteObjectTaggingOperation) 

# S3GeneratedManifestDescriptor
<a name="API_control_S3GeneratedManifestDescriptor"></a>

Describes the specified job's generated manifest. Batch Operations jobs created with a ManifestGenerator populate details of this descriptor after execution of the ManifestGenerator.

## Contents
<a name="API_control_S3GeneratedManifestDescriptor_Contents"></a>

 ** Format **   <a name="AmazonS3-Type-control_S3GeneratedManifestDescriptor-Format"></a>
The format of the generated manifest.  
Type: String  
Valid Values: `S3InventoryReport_CSV_20211130`   
Required: No

 ** Location **   <a name="AmazonS3-Type-control_S3GeneratedManifestDescriptor-Location"></a>
Contains the information required to locate a manifest object. Manifests can't be imported from directory buckets. For more information, see [Directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html).  
Type: [JobManifestLocation](API_control_JobManifestLocation.md) data type  
Required: No

## See Also
<a name="API_control_S3GeneratedManifestDescriptor_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/S3GeneratedManifestDescriptor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/S3GeneratedManifestDescriptor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/S3GeneratedManifestDescriptor) 

# S3Grant
<a name="API_control_S3Grant"></a>



## Contents
<a name="API_control_S3Grant_Contents"></a>

 ** Grantee **   <a name="AmazonS3-Type-control_S3Grant-Grantee"></a>
  
Type: [S3Grantee](API_control_S3Grantee.md) data type  
Required: No

 ** Permission **   <a name="AmazonS3-Type-control_S3Grant-Permission"></a>
  
Type: String  
Valid Values: `FULL_CONTROL | READ | WRITE | READ_ACP | WRITE_ACP`   
Required: No

## See Also
<a name="API_control_S3Grant_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/S3Grant) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/S3Grant) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/S3Grant) 

# S3Grantee
<a name="API_control_S3Grantee"></a>



## Contents
<a name="API_control_S3Grantee_Contents"></a>

 ** DisplayName **   <a name="AmazonS3-Type-control_S3Grantee-DisplayName"></a>
  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** Identifier **   <a name="AmazonS3-Type-control_S3Grantee-Identifier"></a>
  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** TypeIdentifier **   <a name="AmazonS3-Type-control_S3Grantee-TypeIdentifier"></a>
  
Type: String  
Valid Values: `id | emailAddress | uri`   
Required: No

## See Also
<a name="API_control_S3Grantee_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/S3Grantee) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/S3Grantee) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/S3Grantee) 

# S3InitiateRestoreObjectOperation
<a name="API_control_S3InitiateRestoreObjectOperation"></a>

Contains the configuration parameters for a POST Object restore job. S3 Batch Operations passes every object to the underlying `RestoreObject` API operation. For more information about the parameters for this operation, see [RestoreObject](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOSTrestore.html#RESTObjectPOSTrestore-restore-request).

## Contents
<a name="API_control_S3InitiateRestoreObjectOperation_Contents"></a>

 ** ExpirationInDays **   <a name="AmazonS3-Type-control_S3InitiateRestoreObjectOperation-ExpirationInDays"></a>
This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains available in Amazon S3. S3 Initiate Restore Object jobs that target S3 Glacier and S3 Glacier Deep Archive objects require `ExpirationInDays` set to 1 or greater.  
Conversely, do *not* set `ExpirationInDays` when creating S3 Initiate Restore Object jobs that target S3 Intelligent-Tiering Archive Access and Deep Archive Access tier objects. Objects in S3 Intelligent-Tiering archive access tiers are not subject to restore expiry, so specifying `ExpirationInDays` results in restore request failure.  
S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class objects or on S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier objects, but not both types in the same job. If you need to restore objects of both types you *must* create separate Batch Operations jobs.   
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** GlacierJobTier **   <a name="AmazonS3-Type-control_S3InitiateRestoreObjectOperation-GlacierJobTier"></a>
S3 Batch Operations supports `STANDARD` and `BULK` retrieval tiers, but not the `EXPEDITED` retrieval tier.  
Type: String  
Valid Values: `BULK | STANDARD`   
Required: No

## See Also
<a name="API_control_S3InitiateRestoreObjectOperation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/S3InitiateRestoreObjectOperation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/S3InitiateRestoreObjectOperation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/S3InitiateRestoreObjectOperation) 

# S3JobManifestGenerator
<a name="API_control_S3JobManifestGenerator"></a>

The container for the service that will create the S3 manifest.

## Contents
<a name="API_control_S3JobManifestGenerator_Contents"></a>

 ** EnableManifestOutput **   <a name="AmazonS3-Type-control_S3JobManifestGenerator-EnableManifestOutput"></a>
Determines whether or not to write the job's generated manifest to a bucket.  
Type: Boolean  
Required: Yes

 ** SourceBucket **   <a name="AmazonS3-Type-control_S3JobManifestGenerator-SourceBucket"></a>
The ARN of the source bucket used by the ManifestGenerator.  
 **Directory buckets** - Directory buckets aren't supported as the source buckets used by `S3JobManifestGenerator` to generate the job manifest.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `arn:[^:]+:s3:.*`   
Required: Yes

 ** ExpectedBucketOwner **   <a name="AmazonS3-Type-control_S3JobManifestGenerator-ExpectedBucketOwner"></a>
The AWS account ID that owns the bucket the generated manifest is written to. If provided the generated manifest bucket's owner AWS account ID must match this value, else the job fails.  
Type: String  
Length Constraints: Maximum length of 64.  
Pattern: `^\d{12}$`   
Required: No

 ** Filter **   <a name="AmazonS3-Type-control_S3JobManifestGenerator-Filter"></a>
Specifies rules the S3JobManifestGenerator should use to decide whether an object in the source bucket should or should not be included in the generated job manifest.  
Type: [JobManifestGeneratorFilter](API_control_JobManifestGeneratorFilter.md) data type  
Required: No

 ** ManifestOutputLocation **   <a name="AmazonS3-Type-control_S3JobManifestGenerator-ManifestOutputLocation"></a>
Specifies the location the generated manifest will be written to. Manifests can't be written to directory buckets. For more information, see [Directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html).  
Type: [S3ManifestOutputLocation](API_control_S3ManifestOutputLocation.md) data type  
Required: No

## See Also
<a name="API_control_S3JobManifestGenerator_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/S3JobManifestGenerator) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/S3JobManifestGenerator) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/S3JobManifestGenerator) 

# S3ManifestOutputLocation
<a name="API_control_S3ManifestOutputLocation"></a>

Location details for where the generated manifest should be written.

## Contents
<a name="API_control_S3ManifestOutputLocation_Contents"></a>

 ** Bucket **   <a name="AmazonS3-Type-control_S3ManifestOutputLocation-Bucket"></a>
The bucket ARN the generated manifest should be written to.  
 **Directory buckets** - Directory buckets aren't supported as the buckets to store the generated manifest.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `arn:[^:]+:s3:.*`   
Required: Yes

 ** ManifestFormat **   <a name="AmazonS3-Type-control_S3ManifestOutputLocation-ManifestFormat"></a>
The format of the generated manifest.  
Type: String  
Valid Values: `S3InventoryReport_CSV_20211130`   
Required: Yes

 ** ExpectedManifestBucketOwner **   <a name="AmazonS3-Type-control_S3ManifestOutputLocation-ExpectedManifestBucketOwner"></a>
The Account ID that owns the bucket the generated manifest is written to.  
Type: String  
Length Constraints: Maximum length of 64.  
Pattern: `^\d{12}$`   
Required: No

 ** ManifestEncryption **   <a name="AmazonS3-Type-control_S3ManifestOutputLocation-ManifestEncryption"></a>
Specifies what encryption should be used when the generated manifest objects are written.  
Type: [GeneratedManifestEncryption](API_control_GeneratedManifestEncryption.md) data type  
Required: No

 ** ManifestPrefix **   <a name="AmazonS3-Type-control_S3ManifestOutputLocation-ManifestPrefix"></a>
Prefix identifying one or more objects to which the manifest applies.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Required: No

## See Also
<a name="API_control_S3ManifestOutputLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/S3ManifestOutputLocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/S3ManifestOutputLocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/S3ManifestOutputLocation) 

# S3ObjectLockLegalHold
<a name="API_control_S3ObjectLockLegalHold"></a>

Whether S3 Object Lock legal hold will be applied to objects in an S3 Batch Operations job.

## Contents
<a name="API_control_S3ObjectLockLegalHold_Contents"></a>

 ** Status **   <a name="AmazonS3-Type-control_S3ObjectLockLegalHold-Status"></a>
The Object Lock legal hold status to be applied to all objects in the Batch Operations job.  
Type: String  
Valid Values: `OFF | ON`   
Required: Yes

## See Also
<a name="API_control_S3ObjectLockLegalHold_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/S3ObjectLockLegalHold) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/S3ObjectLockLegalHold) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/S3ObjectLockLegalHold) 

# S3ObjectMetadata
<a name="API_control_S3ObjectMetadata"></a>



## Contents
<a name="API_control_S3ObjectMetadata_Contents"></a>

 ** CacheControl **   <a name="AmazonS3-Type-control_S3ObjectMetadata-CacheControl"></a>
  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** ContentDisposition **   <a name="AmazonS3-Type-control_S3ObjectMetadata-ContentDisposition"></a>
  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** ContentEncoding **   <a name="AmazonS3-Type-control_S3ObjectMetadata-ContentEncoding"></a>
  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** ContentLanguage **   <a name="AmazonS3-Type-control_S3ObjectMetadata-ContentLanguage"></a>
  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** ContentLength **   <a name="AmazonS3-Type-control_S3ObjectMetadata-ContentLength"></a>
 *This member has been deprecated.*   
  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** ContentMD5 **   <a name="AmazonS3-Type-control_S3ObjectMetadata-ContentMD5"></a>
 *This member has been deprecated.*   
  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** ContentType **   <a name="AmazonS3-Type-control_S3ObjectMetadata-ContentType"></a>
  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** HttpExpiresDate **   <a name="AmazonS3-Type-control_S3ObjectMetadata-HttpExpiresDate"></a>
  
Type: Timestamp  
Required: No

 ** RequesterCharged **   <a name="AmazonS3-Type-control_S3ObjectMetadata-RequesterCharged"></a>
 *This member has been deprecated.*   
  
Type: Boolean  
Required: No

 ** SSEAlgorithm **   <a name="AmazonS3-Type-control_S3ObjectMetadata-SSEAlgorithm"></a>
The server-side encryption algorithm used when storing objects in Amazon S3.  
 **Directory buckets ** - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (`AES256`) and server-side encryption with AWS KMS keys (SSE-KMS) (`KMS`). For more information, see [Protecting data with server-side encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html) in the *Amazon S3 User Guide*. For [the Copy operation in Batch Operations](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops), see [S3CopyObjectOperation](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_S3CopyObjectOperation.html).  
Type: String  
Valid Values: `AES256 | KMS`   
Required: No

 ** UserMetadata **   <a name="AmazonS3-Type-control_S3ObjectMetadata-UserMetadata"></a>
  
Type: String to string map  
Map Entries: Maximum number of 8192 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 1024.  
Value Length Constraints: Maximum length of 1024.  
Required: No

## See Also
<a name="API_control_S3ObjectMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/S3ObjectMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/S3ObjectMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/S3ObjectMetadata) 

# S3ObjectOwner
<a name="API_control_S3ObjectOwner"></a>



## Contents
<a name="API_control_S3ObjectOwner_Contents"></a>

 ** DisplayName **   <a name="AmazonS3-Type-control_S3ObjectOwner-DisplayName"></a>
  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** ID **   <a name="AmazonS3-Type-control_S3ObjectOwner-ID"></a>
  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

## See Also
<a name="API_control_S3ObjectOwner_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/S3ObjectOwner) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/S3ObjectOwner) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/S3ObjectOwner) 

# S3ReplicateObjectOperation
<a name="API_control_S3ReplicateObjectOperation"></a>

Directs the specified job to invoke `ReplicateObject` on every object in the job's manifest.

## Contents
<a name="API_control_S3ReplicateObjectOperation_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_control_S3ReplicateObjectOperation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/S3ReplicateObjectOperation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/S3ReplicateObjectOperation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/S3ReplicateObjectOperation) 

# S3Retention
<a name="API_control_S3Retention"></a>

Contains the S3 Object Lock retention mode to be applied to all objects in the S3 Batch Operations job. If you don't provide `Mode` and `RetainUntilDate` data types in your operation, you will remove the retention from your objects. For more information, see [Using S3 Object Lock retention with S3 Batch Operations](https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html) in the *Amazon S3 User Guide*.

## Contents
<a name="API_control_S3Retention_Contents"></a>

 ** Mode **   <a name="AmazonS3-Type-control_S3Retention-Mode"></a>
The Object Lock retention mode to be applied to all objects in the Batch Operations job.  
Type: String  
Valid Values: `COMPLIANCE | GOVERNANCE`   
Required: No

 ** RetainUntilDate **   <a name="AmazonS3-Type-control_S3Retention-RetainUntilDate"></a>
The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.  
Type: Timestamp  
Required: No

## See Also
<a name="API_control_S3Retention_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/S3Retention) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/S3Retention) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/S3Retention) 

# S3SetObjectAclOperation
<a name="API_control_S3SetObjectAclOperation"></a>

Contains the configuration parameters for a PUT Object ACL operation. S3 Batch Operations passes every object to the underlying `PutObjectAcl` API operation. For more information about the parameters for this operation, see [PutObjectAcl](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUTacl.html).

## Contents
<a name="API_control_S3SetObjectAclOperation_Contents"></a>

 ** AccessControlPolicy **   <a name="AmazonS3-Type-control_S3SetObjectAclOperation-AccessControlPolicy"></a>
  
Type: [S3AccessControlPolicy](API_control_S3AccessControlPolicy.md) data type  
Required: No

## See Also
<a name="API_control_S3SetObjectAclOperation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/S3SetObjectAclOperation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/S3SetObjectAclOperation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/S3SetObjectAclOperation) 

# S3SetObjectLegalHoldOperation
<a name="API_control_S3SetObjectLegalHoldOperation"></a>

Contains the configuration for an S3 Object Lock legal hold operation that an S3 Batch Operations job passes to every object to the underlying `PutObjectLegalHold` API operation. For more information, see [Using S3 Object Lock legal hold with S3 Batch Operations](https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-legal-hold.html) in the *Amazon S3 User Guide*.

**Note**  
This functionality is not supported by directory buckets.

## Contents
<a name="API_control_S3SetObjectLegalHoldOperation_Contents"></a>

 ** LegalHold **   <a name="AmazonS3-Type-control_S3SetObjectLegalHoldOperation-LegalHold"></a>
Contains the Object Lock legal hold status to be applied to all objects in the Batch Operations job.  
Type: [S3ObjectLockLegalHold](API_control_S3ObjectLockLegalHold.md) data type  
Required: Yes

## See Also
<a name="API_control_S3SetObjectLegalHoldOperation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/S3SetObjectLegalHoldOperation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/S3SetObjectLegalHoldOperation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/S3SetObjectLegalHoldOperation) 

# S3SetObjectRetentionOperation
<a name="API_control_S3SetObjectRetentionOperation"></a>

Contains the configuration parameters for the Object Lock retention action for an S3 Batch Operations job. Batch Operations passes every object to the underlying `PutObjectRetention` API operation. For more information, see [Using S3 Object Lock retention with S3 Batch Operations](https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html) in the *Amazon S3 User Guide*.

**Note**  
This functionality is not supported by directory buckets.

## Contents
<a name="API_control_S3SetObjectRetentionOperation_Contents"></a>

 ** Retention **   <a name="AmazonS3-Type-control_S3SetObjectRetentionOperation-Retention"></a>
Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see [Using S3 Object Lock retention with S3 Batch Operations](https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html) in the *Amazon S3 User Guide*.  
Type: [S3Retention](API_control_S3Retention.md) data type  
Required: Yes

 ** BypassGovernanceRetention **   <a name="AmazonS3-Type-control_S3SetObjectRetentionOperation-BypassGovernanceRetention"></a>
Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock ` GOVERNANCE` type in place.  
Type: Boolean  
Required: No

## See Also
<a name="API_control_S3SetObjectRetentionOperation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/S3SetObjectRetentionOperation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/S3SetObjectRetentionOperation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/S3SetObjectRetentionOperation) 

# S3SetObjectTaggingOperation
<a name="API_control_S3SetObjectTaggingOperation"></a>

Contains the configuration parameters for a PUT Object Tagging operation. S3 Batch Operations passes every object to the underlying `PutObjectTagging` API operation. For more information about the parameters for this operation, see [PutObjectTagging](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUTtagging.html).

## Contents
<a name="API_control_S3SetObjectTaggingOperation_Contents"></a>

 ** TagSet **   <a name="AmazonS3-Type-control_S3SetObjectTaggingOperation-TagSet"></a>
  
Type: Array of [S3Tag](API_control_S3Tag.md) data types  
Required: No

## See Also
<a name="API_control_S3SetObjectTaggingOperation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/S3SetObjectTaggingOperation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/S3SetObjectTaggingOperation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/S3SetObjectTaggingOperation) 

# S3Tag
<a name="API_control_S3Tag"></a>

A container for a key-value name pair.

## Contents
<a name="API_control_S3Tag_Contents"></a>

 ** Key **   <a name="AmazonS3-Type-control_S3Tag-Key"></a>
Key of the tag  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

 ** Value **   <a name="AmazonS3-Type-control_S3Tag-Value"></a>
Value of the tag  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

## See Also
<a name="API_control_S3Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/S3Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/S3Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/S3Tag) 

# S3UpdateObjectEncryptionOperation
<a name="API_control_S3UpdateObjectEncryptionOperation"></a>

With the `UpdateObjectEncryption` operation, you can atomically update the server-side encryption type of an existing object in a general purpose bucket without any data movement.

## Contents
<a name="API_control_S3UpdateObjectEncryptionOperation_Contents"></a>

 ** ObjectEncryption **   <a name="AmazonS3-Type-control_S3UpdateObjectEncryptionOperation-ObjectEncryption"></a>
The updated server-side encryption type for this S3 object. The `UpdateObjectEncryption` operation supports the SSE-KMS encryption type.  
Type: [ObjectEncryption](API_control_ObjectEncryption.md) data type  
Required: No

## See Also
<a name="API_control_S3UpdateObjectEncryptionOperation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/S3UpdateObjectEncryptionOperation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/S3UpdateObjectEncryptionOperation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/S3UpdateObjectEncryptionOperation) 

# S3UpdateObjectEncryptionSSEKMS
<a name="API_control_S3UpdateObjectEncryptionSSEKMS"></a>

If `SSEKMS` is specified for `UpdateObjectEncryption`, this data type specifies the AWS KMS key Amazon Resource Name (ARN) to use and whether to use an S3 Bucket Key for server-side encryption using AWS Key Management Service (AWS KMS) keys (SSE-KMS).

## Contents
<a name="API_control_S3UpdateObjectEncryptionSSEKMS_Contents"></a>

 ** KMSKeyArn **   <a name="AmazonS3-Type-control_S3UpdateObjectEncryptionSSEKMS-KMSKeyArn"></a>
Specifies the AWS KMS key Amazon Resource Name (ARN) to use for the updated server-side encryption type. Required if `UpdateObjectEncryption` specifies `SSEKMS`.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws[a-zA-Z0-9-]*:kms:[a-z0-9-]+:[0-9]{12}:key/[a-zA-Z0-9-]+`   
Required: Yes

 ** BucketKeyEnabled **   <a name="AmazonS3-Type-control_S3UpdateObjectEncryptionSSEKMS-BucketKeyEnabled"></a>
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS Key Management Service (AWS KMS) keys (SSE-KMS). If this value isn't specified, it defaults to `false`. Setting this value to `true` causes Amazon S3 to use an S3 Bucket Key for update object encryption with SSE-KMS.  
Type: Boolean  
Required: No

## See Also
<a name="API_control_S3UpdateObjectEncryptionSSEKMS_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/S3UpdateObjectEncryptionSSEKMS) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/S3UpdateObjectEncryptionSSEKMS) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/S3UpdateObjectEncryptionSSEKMS) 

# Scope
<a name="API_control_Scope"></a>

You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both.

For more information, see [Manage the scope of your access points for directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-directory-buckets-manage-scope.html).

## Contents
<a name="API_control_Scope_Contents"></a>

 ** Permissions **   <a name="AmazonS3-Type-control_Scope-Permissions"></a>
You can include one or more API operations as permissions.  
Type: Array of strings  
Valid Values: `GetObject | GetObjectAttributes | ListMultipartUploadParts | ListBucket | ListBucketMultipartUploads | PutObject | DeleteObject | AbortMultipartUpload`   
Required: No

 ** Prefixes **   <a name="AmazonS3-Type-control_Scope-Prefixes"></a>
You can specify any amount of prefixes, but the total length of characters of all prefixes must be less than 256 bytes in size.  
Type: Array of strings  
Required: No

## See Also
<a name="API_control_Scope_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/Scope) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/Scope) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/Scope) 

# SelectionCriteria
<a name="API_control_SelectionCriteria"></a>



## Contents
<a name="API_control_SelectionCriteria_Contents"></a>

 ** Delimiter **   <a name="AmazonS3-Type-control_SelectionCriteria-Delimiter"></a>
A container for the delimiter of the selection criteria being used.  
Type: String  
Length Constraints: Maximum length of 1.  
Required: No

 ** MaxDepth **   <a name="AmazonS3-Type-control_SelectionCriteria-MaxDepth"></a>
The max depth of the selection criteria  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 10.  
Required: No

 ** MinStorageBytesPercentage **   <a name="AmazonS3-Type-control_SelectionCriteria-MinStorageBytesPercentage"></a>
The minimum number of storage bytes percentage whose metrics will be selected.  
You must choose a value greater than or equal to `1.0`.
Type: Double  
Valid Range: Minimum value of 0.1. Maximum value of 100.  
Required: No

## See Also
<a name="API_control_SelectionCriteria_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/SelectionCriteria) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/SelectionCriteria) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/SelectionCriteria) 

# SourceSelectionCriteria
<a name="API_control_SourceSelectionCriteria"></a>

A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects.

## Contents
<a name="API_control_SourceSelectionCriteria_Contents"></a>

 ** ReplicaModifications **   <a name="AmazonS3-Type-control_SourceSelectionCriteria-ReplicaModifications"></a>
A filter that you can use to specify whether replica modification sync is enabled. S3 on Outposts replica modification sync can help you keep object metadata synchronized between replicas and source objects. By default, S3 on Outposts replicates metadata from the source objects to the replicas only. When replica modification sync is enabled, S3 on Outposts replicates metadata changes made to the replica copies back to the source object, making the replication bidirectional.  
To replicate object metadata modifications on replicas, you can specify this element and set the `Status` of this element to `Enabled`.  
You must enable replica modification sync on the source and destination buckets to replicate replica metadata changes between the source and the replicas.
Type: [ReplicaModifications](API_control_ReplicaModifications.md) data type  
Required: No

 ** SseKmsEncryptedObjects **   <a name="AmazonS3-Type-control_SourceSelectionCriteria-SseKmsEncryptedObjects"></a>
A filter that you can use to select Amazon S3 objects that are encrypted with server-side encryption by using AWS Key Management Service (AWS KMS) keys. If you include `SourceSelectionCriteria` in the replication configuration, this element is required.   
This is not supported by Amazon S3 on Outposts buckets.
Type: [SseKmsEncryptedObjects](API_control_SseKmsEncryptedObjects.md) data type  
Required: No

## See Also
<a name="API_control_SourceSelectionCriteria_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/SourceSelectionCriteria) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/SourceSelectionCriteria) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/SourceSelectionCriteria) 

# SSECFilter
<a name="API_control_SSECFilter"></a>

A filter that returns objects that are encrypted by server-side encryption with customer-provided keys (SSE-C).

## Contents
<a name="API_control_SSECFilter_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_control_SSECFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/SSECFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/SSECFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/SSECFilter) 

# SSEKMS
<a name="API_control_SSEKMS"></a>



## Contents
<a name="API_control_SSEKMS_Contents"></a>

 ** KeyId **   <a name="AmazonS3-Type-control_SSEKMS-KeyId"></a>
A container for the ARN of the SSE-KMS encryption. This property is read-only and follows the following format: ` arn:aws:kms:us-east-1:example-account-id:key/example-9a73-4afc-8d29-8f5900cef44e `   
Type: String  
Required: Yes

## See Also
<a name="API_control_SSEKMS_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/SSEKMS) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/SSEKMS) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/SSEKMS) 

# SseKmsEncryptedObjects
<a name="API_control_SseKmsEncryptedObjects"></a>

A container for filter information that you can use to select S3 objects that are encrypted with AWS Key Management Service (AWS KMS).

**Note**  
This is not supported by Amazon S3 on Outposts buckets.

## Contents
<a name="API_control_SseKmsEncryptedObjects_Contents"></a>

 ** Status **   <a name="AmazonS3-Type-control_SseKmsEncryptedObjects-Status"></a>
Specifies whether Amazon S3 replicates objects that are created with server-side encryption by using an AWS KMS key stored in AWS Key Management Service.  
Type: String  
Valid Values: `Enabled | Disabled`   
Required: Yes

## See Also
<a name="API_control_SseKmsEncryptedObjects_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/SseKmsEncryptedObjects) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/SseKmsEncryptedObjects) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/SseKmsEncryptedObjects) 

# SSEKMSEncryption
<a name="API_control_SSEKMSEncryption"></a>

Configuration for the use of SSE-KMS to encrypt generated manifest objects.

## Contents
<a name="API_control_SSEKMSEncryption_Contents"></a>

 ** KeyId **   <a name="AmazonS3-Type-control_SSEKMSEncryption-KeyId"></a>
Specifies the ID of the AWS Key Management Service (AWS KMS) symmetric encryption customer managed key to use for encrypting generated manifest objects.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Required: Yes

## See Also
<a name="API_control_SSEKMSEncryption_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/SSEKMSEncryption) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/SSEKMSEncryption) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/SSEKMSEncryption) 

# SSEKMSFilter
<a name="API_control_SSEKMSFilter"></a>

A filter that returns objects that are encrypted by server-side encryption with AWS KMS (SSE-KMS).

## Contents
<a name="API_control_SSEKMSFilter_Contents"></a>

 ** BucketKeyEnabled **   <a name="AmazonS3-Type-control_SSEKMSFilter-BucketKeyEnabled"></a>
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS Key Management Service (AWS KMS) keys (SSE-KMS). If specified, will filter SSE-KMS encrypted objects by S3 Bucket Key status.  
Type: Boolean  
Required: No

 ** KmsKeyArn **   <a name="AmazonS3-Type-control_SSEKMSFilter-KmsKeyArn"></a>
The Amazon Resource Name (ARN) of the customer managed KMS key to use for the filter to return objects that are encrypted by the specified key. For best performance, use keys in the same Region as the S3 Batch Operations job.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws[a-zA-Z0-9-]*:kms:[a-z0-9-]+:[0-9]{12}:key/[a-zA-Z0-9-]+`   
Required: No

## See Also
<a name="API_control_SSEKMSFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/SSEKMSFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/SSEKMSFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/SSEKMSFilter) 

# SSES3
<a name="API_control_SSES3"></a>



## Contents
<a name="API_control_SSES3_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_control_SSES3_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/SSES3) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/SSES3) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/SSES3) 

# SSES3Encryption
<a name="API_control_SSES3Encryption"></a>

Configuration for the use of SSE-S3 to encrypt generated manifest objects.

## Contents
<a name="API_control_SSES3Encryption_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_control_SSES3Encryption_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/SSES3Encryption) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/SSES3Encryption) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/SSES3Encryption) 

# SSES3Filter
<a name="API_control_SSES3Filter"></a>

A filter that returns objects that are encrypted by server-side encryption with Amazon S3 managed keys (SSE-S3).

## Contents
<a name="API_control_SSES3Filter_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_control_SSES3Filter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/SSES3Filter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/SSES3Filter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/SSES3Filter) 

# StorageLensAwsOrg
<a name="API_control_StorageLensAwsOrg"></a>

The AWS organization for your S3 Storage Lens.

## Contents
<a name="API_control_StorageLensAwsOrg_Contents"></a>

 ** Arn **   <a name="AmazonS3-Type-control_StorageLensAwsOrg-Arn"></a>
A container for the Amazon Resource Name (ARN) of the AWS organization. This property is read-only and follows the following format: ` arn:aws:organizations:us-east-1:example-account-id:organization/o-ex2l495dck `   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:[a-z\-]+:organizations::\d{12}:organization\/o-[a-z0-9]{10,32}`   
Required: Yes

## See Also
<a name="API_control_StorageLensAwsOrg_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/StorageLensAwsOrg) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/StorageLensAwsOrg) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/StorageLensAwsOrg) 

# StorageLensConfiguration
<a name="API_control_StorageLensConfiguration"></a>

A container for the Amazon S3 Storage Lens configuration.

## Contents
<a name="API_control_StorageLensConfiguration_Contents"></a>

 ** AccountLevel **   <a name="AmazonS3-Type-control_StorageLensConfiguration-AccountLevel"></a>
A container for all the account-level configurations of your S3 Storage Lens configuration.  
Type: [AccountLevel](API_control_AccountLevel.md) data type  
Required: Yes

 ** Id **   <a name="AmazonS3-Type-control_StorageLensConfiguration-Id"></a>
A container for the Amazon S3 Storage Lens configuration ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9\-\_\.]+`   
Required: Yes

 ** IsEnabled **   <a name="AmazonS3-Type-control_StorageLensConfiguration-IsEnabled"></a>
A container for whether the S3 Storage Lens configuration is enabled.  
Type: Boolean  
Required: Yes

 ** AwsOrg **   <a name="AmazonS3-Type-control_StorageLensConfiguration-AwsOrg"></a>
A container for the AWS organization for this S3 Storage Lens configuration.  
Type: [StorageLensAwsOrg](API_control_StorageLensAwsOrg.md) data type  
Required: No

 ** DataExport **   <a name="AmazonS3-Type-control_StorageLensConfiguration-DataExport"></a>
A container to specify the properties of your S3 Storage Lens metrics export including, the destination, schema and format.  
Type: [StorageLensDataExport](API_control_StorageLensDataExport.md) data type  
Required: No

 ** Exclude **   <a name="AmazonS3-Type-control_StorageLensConfiguration-Exclude"></a>
A container for what is excluded in this configuration. This container can only be valid if there is no `Include` container submitted, and it's not empty.   
Type: [Exclude](API_control_Exclude.md) data type  
Required: No

 ** ExpandedPrefixesDataExport **   <a name="AmazonS3-Type-control_StorageLensConfiguration-ExpandedPrefixesDataExport"></a>
A container that configures your S3 Storage Lens expanded prefixes metrics report.   
Type: [StorageLensExpandedPrefixesDataExport](API_control_StorageLensExpandedPrefixesDataExport.md) data type  
Required: No

 ** Include **   <a name="AmazonS3-Type-control_StorageLensConfiguration-Include"></a>
A container for what is included in this configuration. This container can only be valid if there is no `Exclude` container submitted, and it's not empty.   
Type: [Include](API_control_Include.md) data type  
Required: No

 ** PrefixDelimiter **   <a name="AmazonS3-Type-control_StorageLensConfiguration-PrefixDelimiter"></a>
A container for all prefix delimiters that are used for object keys in this S3 Storage Lens configuration. The prefix delimiters determine how S3 Storage Lens counts prefix depth, by separating the hierarchical levels in object keys.  
+ If either a prefix delimiter or existing delimiter is undefined, Amazon S3 uses the delimiter that’s defined.
+ If both the prefix delimiter and existing delimiter are undefined, S3 uses `/` as the default delimiter.
+ When custom delimiters are used, both the prefix delimiter and existing delimiter must specify the same special character. Otherwise, your request results in an error.
Type: String  
Length Constraints: Maximum length of 1.  
Required: No

 ** StorageLensArn **   <a name="AmazonS3-Type-control_StorageLensConfiguration-StorageLensArn"></a>
The Amazon Resource Name (ARN) of the S3 Storage Lens configuration. This property is read-only and follows the following format: ` arn:aws:s3:us-east-1:example-account-id:storage-lens/your-dashboard-name `   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:[a-z\-]+:s3:[a-z0-9\-]+:\d{12}:storage\-lens\/.*`   
Required: No

## See Also
<a name="API_control_StorageLensConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/StorageLensConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/StorageLensConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/StorageLensConfiguration) 

# StorageLensDataExport
<a name="API_control_StorageLensDataExport"></a>

A container to specify the properties of your S3 Storage Lens metrics export, including the destination, schema, and format.

## Contents
<a name="API_control_StorageLensDataExport_Contents"></a>

 ** CloudWatchMetrics **   <a name="AmazonS3-Type-control_StorageLensDataExport-CloudWatchMetrics"></a>
A container for enabling Amazon CloudWatch publishing for S3 Storage Lens metrics.  
Type: [CloudWatchMetrics](API_control_CloudWatchMetrics.md) data type  
Required: No

 ** S3BucketDestination **   <a name="AmazonS3-Type-control_StorageLensDataExport-S3BucketDestination"></a>
A container for the bucket where the S3 Storage Lens metrics export will be located.  
This bucket must be located in the same Region as the storage lens configuration. 
Type: [S3BucketDestination](API_control_S3BucketDestination.md) data type  
Required: No

 ** StorageLensTableDestination **   <a name="AmazonS3-Type-control_StorageLensDataExport-StorageLensTableDestination"></a>
A container for configuring S3 Storage Lens data exports to read-only S3 table buckets.  
Type: [StorageLensTableDestination](API_control_StorageLensTableDestination.md) data type  
Required: No

## See Also
<a name="API_control_StorageLensDataExport_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/StorageLensDataExport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/StorageLensDataExport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/StorageLensDataExport) 

# StorageLensDataExportEncryption
<a name="API_control_StorageLensDataExportEncryption"></a>

A container for the encryption of the S3 Storage Lens metrics exports.

## Contents
<a name="API_control_StorageLensDataExportEncryption_Contents"></a>

 ** SSEKMS **   <a name="AmazonS3-Type-control_StorageLensDataExportEncryption-SSEKMS"></a>
  
Type: [SSEKMS](API_control_SSEKMS.md) data type  
Required: No

 ** SSES3 **   <a name="AmazonS3-Type-control_StorageLensDataExportEncryption-SSES3"></a>
  
Type: [SSES3](API_control_SSES3.md) data type  
Required: No

## See Also
<a name="API_control_StorageLensDataExportEncryption_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/StorageLensDataExportEncryption) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/StorageLensDataExportEncryption) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/StorageLensDataExportEncryption) 

# StorageLensExpandedPrefixesDataExport
<a name="API_control_StorageLensExpandedPrefixesDataExport"></a>

A container for your S3 Storage Lens expanded prefix metrics report configuration. Unlike the default Storage Lens metrics report, the enhanced prefix metrics report includes all S3 Storage Lens storage and activity data related to the full list of prefixes in your Storage Lens configuration.

## Contents
<a name="API_control_StorageLensExpandedPrefixesDataExport_Contents"></a>

 ** S3BucketDestination **   <a name="AmazonS3-Type-control_StorageLensExpandedPrefixesDataExport-S3BucketDestination"></a>
A container for the bucket where the Amazon S3 Storage Lens metrics export files are located.  
Type: [S3BucketDestination](API_control_S3BucketDestination.md) data type  
Required: No

 ** StorageLensTableDestination **   <a name="AmazonS3-Type-control_StorageLensExpandedPrefixesDataExport-StorageLensTableDestination"></a>
A container for the bucket where the S3 Storage Lens metric export files are located. At least one export destination must be specified.  
Type: [StorageLensTableDestination](API_control_StorageLensTableDestination.md) data type  
Required: No

## See Also
<a name="API_control_StorageLensExpandedPrefixesDataExport_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/StorageLensExpandedPrefixesDataExport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/StorageLensExpandedPrefixesDataExport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/StorageLensExpandedPrefixesDataExport) 

# StorageLensGroup
<a name="API_control_StorageLensGroup"></a>

A custom grouping of objects that include filters for prefixes, suffixes, object tags, object size, or object age. You can create an S3 Storage Lens group that includes a single filter or multiple filter conditions. To specify multiple filter conditions, you use `AND` or `OR` logical operators. 

## Contents
<a name="API_control_StorageLensGroup_Contents"></a>

 ** Filter **   <a name="AmazonS3-Type-control_StorageLensGroup-Filter"></a>
Sets the criteria for the Storage Lens group data that is displayed. For multiple filter conditions, the `AND` or `OR` logical operator is used.  
Type: [StorageLensGroupFilter](API_control_StorageLensGroupFilter.md) data type  
Required: Yes

 ** Name **   <a name="AmazonS3-Type-control_StorageLensGroup-Name"></a>
 Contains the name of the Storage Lens group.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9\-\_]+`   
Required: Yes

 ** StorageLensGroupArn **   <a name="AmazonS3-Type-control_StorageLensGroup-StorageLensGroupArn"></a>
 Contains the Amazon Resource Name (ARN) of the Storage Lens group. This property is read-only.   
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Pattern: `arn:[a-z\-]+:s3:[a-z0-9\-]+:\d{12}:storage\-lens\-group\/.*`   
Required: No

## See Also
<a name="API_control_StorageLensGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/StorageLensGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/StorageLensGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/StorageLensGroup) 

# StorageLensGroupAndOperator
<a name="API_control_StorageLensGroupAndOperator"></a>

 A logical operator that allows multiple filter conditions to be joined for more complex comparisons of Storage Lens group data. 

## Contents
<a name="API_control_StorageLensGroupAndOperator_Contents"></a>

 ** MatchAnyPrefix **   <a name="AmazonS3-Type-control_StorageLensGroupAndOperator-MatchAnyPrefix"></a>
 Contains a list of prefixes. At least one prefix must be specified. Up to 10 prefixes are allowed.   
Type: Array of strings  
Required: No

 ** MatchAnySuffix **   <a name="AmazonS3-Type-control_StorageLensGroupAndOperator-MatchAnySuffix"></a>
 Contains a list of suffixes. At least one suffix must be specified. Up to 10 suffixes are allowed.   
Type: Array of strings  
Required: No

 ** MatchAnyTag **   <a name="AmazonS3-Type-control_StorageLensGroupAndOperator-MatchAnyTag"></a>
 Contains the list of object tags. At least one object tag must be specified. Up to 10 object tags are allowed.   
Type: Array of [S3Tag](API_control_S3Tag.md) data types  
Required: No

 ** MatchObjectAge **   <a name="AmazonS3-Type-control_StorageLensGroupAndOperator-MatchObjectAge"></a>
 Contains `DaysGreaterThan` and `DaysLessThan` to define the object age range (minimum and maximum number of days).   
Type: [MatchObjectAge](API_control_MatchObjectAge.md) data type  
Required: No

 ** MatchObjectSize **   <a name="AmazonS3-Type-control_StorageLensGroupAndOperator-MatchObjectSize"></a>
 Contains `BytesGreaterThan` and `BytesLessThan` to define the object size range (minimum and maximum number of Bytes).   
Type: [MatchObjectSize](API_control_MatchObjectSize.md) data type  
Required: No

## See Also
<a name="API_control_StorageLensGroupAndOperator_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/StorageLensGroupAndOperator) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/StorageLensGroupAndOperator) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/StorageLensGroupAndOperator) 

# StorageLensGroupFilter
<a name="API_control_StorageLensGroupFilter"></a>

The filter element sets the criteria for the Storage Lens group data that is displayed. For multiple filter conditions, the `AND` or `OR` logical operator is used.

## Contents
<a name="API_control_StorageLensGroupFilter_Contents"></a>

 ** And **   <a name="AmazonS3-Type-control_StorageLensGroupFilter-And"></a>
A logical operator that allows multiple filter conditions to be joined for more complex comparisons of Storage Lens group data. Objects must match all of the listed filter conditions that are joined by the `And` logical operator. Only one of each filter condition is allowed.  
Type: [StorageLensGroupAndOperator](API_control_StorageLensGroupAndOperator.md) data type  
Required: No

 ** MatchAnyPrefix **   <a name="AmazonS3-Type-control_StorageLensGroupFilter-MatchAnyPrefix"></a>
 Contains a list of prefixes. At least one prefix must be specified. Up to 10 prefixes are allowed.   
Type: Array of strings  
Required: No

 ** MatchAnySuffix **   <a name="AmazonS3-Type-control_StorageLensGroupFilter-MatchAnySuffix"></a>
 Contains a list of suffixes. At least one suffix must be specified. Up to 10 suffixes are allowed.   
Type: Array of strings  
Required: No

 ** MatchAnyTag **   <a name="AmazonS3-Type-control_StorageLensGroupFilter-MatchAnyTag"></a>
 Contains the list of S3 object tags. At least one object tag must be specified. Up to 10 object tags are allowed.   
Type: Array of [S3Tag](API_control_S3Tag.md) data types  
Required: No

 ** MatchObjectAge **   <a name="AmazonS3-Type-control_StorageLensGroupFilter-MatchObjectAge"></a>
 Contains `DaysGreaterThan` and `DaysLessThan` to define the object age range (minimum and maximum number of days).   
Type: [MatchObjectAge](API_control_MatchObjectAge.md) data type  
Required: No

 ** MatchObjectSize **   <a name="AmazonS3-Type-control_StorageLensGroupFilter-MatchObjectSize"></a>
 Contains `BytesGreaterThan` and `BytesLessThan` to define the object size range (minimum and maximum number of Bytes).   
Type: [MatchObjectSize](API_control_MatchObjectSize.md) data type  
Required: No

 ** Or **   <a name="AmazonS3-Type-control_StorageLensGroupFilter-Or"></a>
A single logical operator that allows multiple filter conditions to be joined. Objects can match any of the listed filter conditions, which are joined by the `Or` logical operator. Only one of each filter condition is allowed.   
Type: [StorageLensGroupOrOperator](API_control_StorageLensGroupOrOperator.md) data type  
Required: No

## See Also
<a name="API_control_StorageLensGroupFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/StorageLensGroupFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/StorageLensGroupFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/StorageLensGroupFilter) 

# StorageLensGroupLevel
<a name="API_control_StorageLensGroupLevel"></a>

 Specifies the Storage Lens groups to include in the Storage Lens group aggregation. 

## Contents
<a name="API_control_StorageLensGroupLevel_Contents"></a>

 ** SelectionCriteria **   <a name="AmazonS3-Type-control_StorageLensGroupLevel-SelectionCriteria"></a>
 Indicates which Storage Lens group ARNs to include or exclude in the Storage Lens group aggregation. If this value is left null, then all Storage Lens groups are selected.   
Type: [StorageLensGroupLevelSelectionCriteria](API_control_StorageLensGroupLevelSelectionCriteria.md) data type  
Required: No

## See Also
<a name="API_control_StorageLensGroupLevel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/StorageLensGroupLevel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/StorageLensGroupLevel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/StorageLensGroupLevel) 

# StorageLensGroupLevelSelectionCriteria
<a name="API_control_StorageLensGroupLevelSelectionCriteria"></a>

 Indicates which Storage Lens group ARNs to include or exclude in the Storage Lens group aggregation. You can only attach Storage Lens groups to your Storage Lens dashboard if they're included in your Storage Lens group aggregation. If this value is left null, then all Storage Lens groups are selected. 

## Contents
<a name="API_control_StorageLensGroupLevelSelectionCriteria_Contents"></a>

 ** Exclude **   <a name="AmazonS3-Type-control_StorageLensGroupLevelSelectionCriteria-Exclude"></a>
 Indicates which Storage Lens group ARNs to exclude from the Storage Lens group aggregation.   
Type: Array of strings  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Pattern: `arn:[a-z\-]+:s3:[a-z0-9\-]+:\d{12}:storage\-lens\-group\/.*`   
Required: No

 ** Include **   <a name="AmazonS3-Type-control_StorageLensGroupLevelSelectionCriteria-Include"></a>
 Indicates which Storage Lens group ARNs to include in the Storage Lens group aggregation.   
Type: Array of strings  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Pattern: `arn:[a-z\-]+:s3:[a-z0-9\-]+:\d{12}:storage\-lens\-group\/.*`   
Required: No

## See Also
<a name="API_control_StorageLensGroupLevelSelectionCriteria_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/StorageLensGroupLevelSelectionCriteria) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/StorageLensGroupLevelSelectionCriteria) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/StorageLensGroupLevelSelectionCriteria) 

# StorageLensGroupOrOperator
<a name="API_control_StorageLensGroupOrOperator"></a>

A container element for specifying `Or` rule conditions. The rule conditions determine the subset of objects to which the `Or` rule applies. Objects can match any of the listed filter conditions, which are joined by the `Or` logical operator. Only one of each filter condition is allowed.

## Contents
<a name="API_control_StorageLensGroupOrOperator_Contents"></a>

 ** MatchAnyPrefix **   <a name="AmazonS3-Type-control_StorageLensGroupOrOperator-MatchAnyPrefix"></a>
 Filters objects that match any of the specified prefixes.   
Type: Array of strings  
Required: No

 ** MatchAnySuffix **   <a name="AmazonS3-Type-control_StorageLensGroupOrOperator-MatchAnySuffix"></a>
 Filters objects that match any of the specified suffixes.   
Type: Array of strings  
Required: No

 ** MatchAnyTag **   <a name="AmazonS3-Type-control_StorageLensGroupOrOperator-MatchAnyTag"></a>
 Filters objects that match any of the specified S3 object tags.   
Type: Array of [S3Tag](API_control_S3Tag.md) data types  
Required: No

 ** MatchObjectAge **   <a name="AmazonS3-Type-control_StorageLensGroupOrOperator-MatchObjectAge"></a>
 Filters objects that match the specified object age range.   
Type: [MatchObjectAge](API_control_MatchObjectAge.md) data type  
Required: No

 ** MatchObjectSize **   <a name="AmazonS3-Type-control_StorageLensGroupOrOperator-MatchObjectSize"></a>
 Filters objects that match the specified object size range.   
Type: [MatchObjectSize](API_control_MatchObjectSize.md) data type  
Required: No

## See Also
<a name="API_control_StorageLensGroupOrOperator_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/StorageLensGroupOrOperator) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/StorageLensGroupOrOperator) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/StorageLensGroupOrOperator) 

# StorageLensTableDestination
<a name="API_control_StorageLensTableDestination"></a>

A container for configuring your S3 Storage Lens reports to export to read-only S3 table buckets. This parameter enables you to store your Storage Lens metrics in a structured, queryable table format in Apache Iceberg.

For more information about S3 Storage Lens, see [Assessing your storage activity and usage with S3 Storage Lens](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the *Amazon S3 User Guide*.

## Contents
<a name="API_control_StorageLensTableDestination_Contents"></a>

 ** IsEnabled **   <a name="AmazonS3-Type-control_StorageLensTableDestination-IsEnabled"></a>
A container that indicates whether the export to read-only S3 table buckets is enabled for your S3 Storage Lens configuration. When set to true, Storage Lens reports are automatically exported to tables in addition to other configured destinations.  
Type: Boolean  
Required: Yes

 ** Encryption **   <a name="AmazonS3-Type-control_StorageLensTableDestination-Encryption"></a>
A container for the encryption of the S3 Storage Lens metrics exports.  
Type: [StorageLensDataExportEncryption](API_control_StorageLensDataExportEncryption.md) data type  
Required: No

## See Also
<a name="API_control_StorageLensTableDestination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/StorageLensTableDestination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/StorageLensTableDestination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/StorageLensTableDestination) 

# StorageLensTag
<a name="API_control_StorageLensTag"></a>



## Contents
<a name="API_control_StorageLensTag_Contents"></a>

 ** Key **   <a name="AmazonS3-Type-control_StorageLensTag-Key"></a>
  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

 ** Value **   <a name="AmazonS3-Type-control_StorageLensTag-Value"></a>
  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

## See Also
<a name="API_control_StorageLensTag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/StorageLensTag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/StorageLensTag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/StorageLensTag) 

# Tag
<a name="API_control_Tag"></a>

 A key-value pair that you use to label your resources. You can add tags to new resources when you create them, or you can add tags to existing resources. Tags can help you organize, track costs for, and control access to resources. 

## Contents
<a name="API_control_Tag_Contents"></a>

 ** Key **   <a name="AmazonS3-Type-control_Tag-Key"></a>
The key of the key-value pair of a tag added to your AWS resource. A tag key can be up to 128 Unicode characters in length and is case-sensitive. System created tags that begin with `aws:` aren’t supported.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

 ** Value **   <a name="AmazonS3-Type-control_Tag-Value"></a>
 The value of the key-value pair of a tag added to your AWS resource. A tag value can be up to 256 Unicode characters in length and is case-sensitive.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

## See Also
<a name="API_control_Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/Tag) 

# Tagging
<a name="API_control_Tagging"></a>



## Contents
<a name="API_control_Tagging_Contents"></a>

 ** TagSet **   <a name="AmazonS3-Type-control_Tagging-TagSet"></a>
A collection for a set of tags.  
Type: Array of [S3Tag](API_control_S3Tag.md) data types  
Required: Yes

## See Also
<a name="API_control_Tagging_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/Tagging) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/Tagging) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/Tagging) 

# Transition
<a name="API_control_Transition"></a>

Specifies when an object transitions to a specified storage class. For more information about Amazon S3 Lifecycle configuration rules, see [ Transitioning objects using Amazon S3 Lifecycle](https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html) in the *Amazon S3 User Guide*.

## Contents
<a name="API_control_Transition_Contents"></a>

 ** Date **   <a name="AmazonS3-Type-control_Transition-Date"></a>
Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.  
Type: Timestamp  
Required: No

 ** Days **   <a name="AmazonS3-Type-control_Transition-Days"></a>
Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.  
Type: Integer  
Required: No

 ** StorageClass **   <a name="AmazonS3-Type-control_Transition-StorageClass"></a>
The storage class to which you want the object to transition.  
Type: String  
Valid Values: `GLACIER | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | DEEP_ARCHIVE`   
Required: No

## See Also
<a name="API_control_Transition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/Transition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/Transition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/Transition) 

# VersioningConfiguration
<a name="API_control_VersioningConfiguration"></a>

Describes the versioning state of an Amazon S3 on Outposts bucket. For more information, see [PutBucketVersioning](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketVersioning.html).

## Contents
<a name="API_control_VersioningConfiguration_Contents"></a>

 ** MFADelete **   <a name="AmazonS3-Type-control_VersioningConfiguration-MFADelete"></a>
Specifies whether MFA delete is enabled or disabled in the bucket versioning configuration for the S3 on Outposts bucket.  
Type: String  
Valid Values: `Enabled | Disabled`   
Required: No

 ** Status **   <a name="AmazonS3-Type-control_VersioningConfiguration-Status"></a>
Sets the versioning state of the S3 on Outposts bucket.  
Type: String  
Valid Values: `Enabled | Suspended`   
Required: No

## See Also
<a name="API_control_VersioningConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/VersioningConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/VersioningConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/VersioningConfiguration) 

# VpcConfiguration
<a name="API_control_VpcConfiguration"></a>

The virtual private cloud (VPC) configuration for an access point.

## Contents
<a name="API_control_VpcConfiguration_Contents"></a>

 ** VpcId **   <a name="AmazonS3-Type-control_VpcConfiguration-VpcId"></a>
If this field is specified, this access point will only allow connections from the specified VPC ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

## See Also
<a name="API_control_VpcConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3control-2018-08-20/VpcConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3control-2018-08-20/VpcConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3control-2018-08-20/VpcConfiguration) 

# Amazon S3 Files
<a name="API_Types_Amazon_S3_Files"></a>

The following data types are supported by Amazon S3 Files:
+  [CreationPermissions](API_S3Files_CreationPermissions.md) 
+  [ExpirationDataRule](API_S3Files_ExpirationDataRule.md) 
+  [ImportDataRule](API_S3Files_ImportDataRule.md) 
+  [ListAccessPointsDescription](API_S3Files_ListAccessPointsDescription.md) 
+  [ListFileSystemsDescription](API_S3Files_ListFileSystemsDescription.md) 
+  [ListMountTargetsDescription](API_S3Files_ListMountTargetsDescription.md) 
+  [PosixUser](API_S3Files_PosixUser.md) 
+  [RootDirectory](API_S3Files_RootDirectory.md) 
+  [Tag](API_S3Files_Tag.md) 

# CreationPermissions
<a name="API_S3Files_CreationPermissions"></a>

Specifies the permissions to set on newly created directories within the file system.

## Contents
<a name="API_S3Files_CreationPermissions_Contents"></a>

 ** ownerGid **   <a name="AmazonS3-Type-S3Files_CreationPermissions-ownerGid"></a>
The POSIX group ID to assign to newly created directories.  
Type: Long  
Valid Range: Minimum value of 0. Maximum value of 4294967295.  
Required: Yes

 ** ownerUid **   <a name="AmazonS3-Type-S3Files_CreationPermissions-ownerUid"></a>
The POSIX user ID to assign to newly created directories.  
Type: Long  
Valid Range: Minimum value of 0. Maximum value of 4294967295.  
Required: Yes

 ** permissions **   <a name="AmazonS3-Type-S3Files_CreationPermissions-permissions"></a>
The octal permissions to assign to newly created directories.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 4.  
Pattern: `[0-7]{3,4}`   
Required: Yes

## See Also
<a name="API_S3Files_CreationPermissions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3files-2025-05-05/CreationPermissions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3files-2025-05-05/CreationPermissions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3files-2025-05-05/CreationPermissions) 

# ExpirationDataRule
<a name="API_S3Files_ExpirationDataRule"></a>

Specifies a rule that controls when cached data expires from the file system based on last access time.

## Contents
<a name="API_S3Files_ExpirationDataRule_Contents"></a>

 ** daysAfterLastAccess **   <a name="AmazonS3-Type-S3Files_ExpirationDataRule-daysAfterLastAccess"></a>
The number of days after last access before cached data expires from the file system.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 365.  
Required: Yes

## See Also
<a name="API_S3Files_ExpirationDataRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3files-2025-05-05/ExpirationDataRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3files-2025-05-05/ExpirationDataRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3files-2025-05-05/ExpirationDataRule) 

# ImportDataRule
<a name="API_S3Files_ImportDataRule"></a>

Specifies a rule that controls how data is imported from S3 into the file system.

## Contents
<a name="API_S3Files_ImportDataRule_Contents"></a>

 ** prefix **   <a name="AmazonS3-Type-S3Files_ImportDataRule-prefix"></a>
The S3 key prefix that scopes this import rule. Only objects with keys beginning with this prefix are subject to the rule.  
Type: String  
Pattern: `(|.*/)`   
Required: Yes

 ** sizeLessThan **   <a name="AmazonS3-Type-S3Files_ImportDataRule-sizeLessThan"></a>
The upper size limit in bytes for this import rule. Only objects with a size strictly less than this value will have data imported into the file system.  
Type: Long  
Valid Range: Minimum value of 0. Maximum value of 52673613135872.  
Required: Yes

 ** trigger **   <a name="AmazonS3-Type-S3Files_ImportDataRule-trigger"></a>
The event that triggers data import. Valid values are `ON_DIRECTORY_FIRST_ACCESS` (import when a directory is first accessed) and `ON_FILE_ACCESS` (import when a file is accessed).  
Type: String  
Valid Values: `ON_DIRECTORY_FIRST_ACCESS | ON_FILE_ACCESS`   
Required: Yes

## See Also
<a name="API_S3Files_ImportDataRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3files-2025-05-05/ImportDataRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3files-2025-05-05/ImportDataRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3files-2025-05-05/ImportDataRule) 

# ListAccessPointsDescription
<a name="API_S3Files_ListAccessPointsDescription"></a>

Contains information about an S3 File System Access Point returned in list operations.

## Contents
<a name="API_S3Files_ListAccessPointsDescription_Contents"></a>

 ** accessPointArn **   <a name="AmazonS3-Type-S3Files_ListAccessPointsDescription-accessPointArn"></a>
The Amazon Resource Name (ARN) of the access point.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}/access-point/fsap-[0-9a-f]{17,40}`   
Required: Yes

 ** accessPointId **   <a name="AmazonS3-Type-S3Files_ListAccessPointsDescription-accessPointId"></a>
The ID of the access point.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `(arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}/access-point/fsap-[0-9a-f]{17,40}|fsap-[0-9a-f]{17,40})`   
Required: Yes

 ** fileSystemId **   <a name="AmazonS3-Type-S3Files_ListAccessPointsDescription-fileSystemId"></a>
The ID of the S3 File System.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `(arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}|fs-[0-9a-f]{17,40})`   
Required: Yes

 ** ownerId **   <a name="AmazonS3-Type-S3Files_ListAccessPointsDescription-ownerId"></a>
The AWS account ID of the access point owner.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 12.  
Pattern: `(\d{12})|(\d{4}-{4}-\d{4})`   
Required: Yes

 ** status **   <a name="AmazonS3-Type-S3Files_ListAccessPointsDescription-status"></a>
The current status of the access point.  
Type: String  
Valid Values: `available | creating | deleting | deleted | error | updating`   
Required: Yes

 ** name **   <a name="AmazonS3-Type-S3Files_ListAccessPointsDescription-name"></a>
The name of the access point.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`   
Required: No

 ** posixUser **   <a name="AmazonS3-Type-S3Files_ListAccessPointsDescription-posixUser"></a>
The POSIX identity configured for this access point.  
Type: [PosixUser](API_S3Files_PosixUser.md) object  
Required: No

 ** rootDirectory **   <a name="AmazonS3-Type-S3Files_ListAccessPointsDescription-rootDirectory"></a>
The root directory configuration for this access point.  
Type: [RootDirectory](API_S3Files_RootDirectory.md) object  
Required: No

## See Also
<a name="API_S3Files_ListAccessPointsDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3files-2025-05-05/ListAccessPointsDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3files-2025-05-05/ListAccessPointsDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3files-2025-05-05/ListAccessPointsDescription) 

# ListFileSystemsDescription
<a name="API_S3Files_ListFileSystemsDescription"></a>

Contains information about an S3 File System returned in list operations.

## Contents
<a name="API_S3Files_ListFileSystemsDescription_Contents"></a>

 ** bucket **   <a name="AmazonS3-Type-S3Files_ListFileSystemsDescription-bucket"></a>
The Amazon Resource Name (ARN) of the S3 bucket.  
Type: String  
Pattern: `(arn:aws[a-zA-Z0-9-]*:s3:::.+)`   
Required: Yes

 ** creationTime **   <a name="AmazonS3-Type-S3Files_ListFileSystemsDescription-creationTime"></a>
The time when the file system was created.  
Type: Timestamp  
Required: Yes

 ** fileSystemArn **   <a name="AmazonS3-Type-S3Files_ListFileSystemsDescription-fileSystemArn"></a>
The Amazon Resource Name (ARN) of the file system.  
Type: String  
Pattern: `(arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40})`   
Required: Yes

 ** fileSystemId **   <a name="AmazonS3-Type-S3Files_ListFileSystemsDescription-fileSystemId"></a>
The ID of the file system.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `(arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}|fs-[0-9a-f]{17,40})`   
Required: Yes

 ** ownerId **   <a name="AmazonS3-Type-S3Files_ListFileSystemsDescription-ownerId"></a>
The AWS account ID of the file system owner.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 12.  
Pattern: `(\d{12})|(\d{4}-{4}-\d{4})`   
Required: Yes

 ** roleArn **   <a name="AmazonS3-Type-S3Files_ListFileSystemsDescription-roleArn"></a>
The Amazon Resource Name (ARN) of the IAM role used for S3 access.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
Required: Yes

 ** status **   <a name="AmazonS3-Type-S3Files_ListFileSystemsDescription-status"></a>
The current status of the file system.  
Type: String  
Valid Values: `available | creating | deleting | deleted | error | updating`   
Required: Yes

 ** name **   <a name="AmazonS3-Type-S3Files_ListFileSystemsDescription-name"></a>
The name of the file system.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`   
Required: No

 ** statusMessage **   <a name="AmazonS3-Type-S3Files_ListFileSystemsDescription-statusMessage"></a>
Additional information about the file system status.  
Type: String  
Required: No

## See Also
<a name="API_S3Files_ListFileSystemsDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3files-2025-05-05/ListFileSystemsDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3files-2025-05-05/ListFileSystemsDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3files-2025-05-05/ListFileSystemsDescription) 

# ListMountTargetsDescription
<a name="API_S3Files_ListMountTargetsDescription"></a>

Contains information about a mount target returned in list operations.

## Contents
<a name="API_S3Files_ListMountTargetsDescription_Contents"></a>

 ** mountTargetId **   <a name="AmazonS3-Type-S3Files_ListMountTargetsDescription-mountTargetId"></a>
The ID of the mount target.  
Type: String  
Length Constraints: Minimum length of 22. Maximum length of 45.  
Pattern: `fsmt-[0-9a-f]{17,40}`   
Required: Yes

 ** ownerId **   <a name="AmazonS3-Type-S3Files_ListMountTargetsDescription-ownerId"></a>
The AWS account ID of the mount target owner.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 12.  
Pattern: `(\d{12})|(\d{4}-{4}-\d{4})`   
Required: Yes

 ** subnetId **   <a name="AmazonS3-Type-S3Files_ListMountTargetsDescription-subnetId"></a>
The ID of the subnet where the mount target is located.  
Type: String  
Length Constraints: Minimum length of 15. Maximum length of 47.  
Pattern: `subnet-[0-9a-f]{8,40}`   
Required: Yes

 ** availabilityZoneId **   <a name="AmazonS3-Type-S3Files_ListMountTargetsDescription-availabilityZoneId"></a>
The Availability Zone ID where the mount target is located.  
Type: String  
Required: No

 ** fileSystemId **   <a name="AmazonS3-Type-S3Files_ListMountTargetsDescription-fileSystemId"></a>
The ID of the S3 File System.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `(arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}|fs-[0-9a-f]{17,40})`   
Required: No

 ** ipv4Address **   <a name="AmazonS3-Type-S3Files_ListMountTargetsDescription-ipv4Address"></a>
The IPv4 address of the mount target.  
Type: String  
Length Constraints: Minimum length of 7. Maximum length of 15.  
Pattern: `[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}`   
Required: No

 ** ipv6Address **   <a name="AmazonS3-Type-S3Files_ListMountTargetsDescription-ipv6Address"></a>
The IPv6 address of the mount target.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 39.  
Required: No

 ** networkInterfaceId **   <a name="AmazonS3-Type-S3Files_ListMountTargetsDescription-networkInterfaceId"></a>
The ID of the network interface associated with the mount target.  
Type: String  
Required: No

 ** status **   <a name="AmazonS3-Type-S3Files_ListMountTargetsDescription-status"></a>
The current status of the mount target.  
Type: String  
Valid Values: `available | creating | deleting | deleted | error | updating`   
Required: No

 ** statusMessage **   <a name="AmazonS3-Type-S3Files_ListMountTargetsDescription-statusMessage"></a>
Additional information about the mount target status.  
Type: String  
Required: No

 ** vpcId **   <a name="AmazonS3-Type-S3Files_ListMountTargetsDescription-vpcId"></a>
The ID of the VPC where the mount target is located.  
Type: String  
Required: No

## See Also
<a name="API_S3Files_ListMountTargetsDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3files-2025-05-05/ListMountTargetsDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3files-2025-05-05/ListMountTargetsDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3files-2025-05-05/ListMountTargetsDescription) 

# PosixUser
<a name="API_S3Files_PosixUser"></a>

Specifies the POSIX identity with uid, gid, and secondary group IDs for user enforcement.

## Contents
<a name="API_S3Files_PosixUser_Contents"></a>

 ** gid **   <a name="AmazonS3-Type-S3Files_PosixUser-gid"></a>
The POSIX group ID.  
Type: Long  
Valid Range: Minimum value of 0. Maximum value of 4294967295.  
Required: Yes

 ** uid **   <a name="AmazonS3-Type-S3Files_PosixUser-uid"></a>
The POSIX user ID.  
Type: Long  
Valid Range: Minimum value of 0. Maximum value of 4294967295.  
Required: Yes

 ** secondaryGids **   <a name="AmazonS3-Type-S3Files_PosixUser-secondaryGids"></a>
An array of secondary POSIX group IDs.  
Type: Array of longs  
Valid Range: Minimum value of 0. Maximum value of 4294967295.  
Required: No

## See Also
<a name="API_S3Files_PosixUser_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3files-2025-05-05/PosixUser) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3files-2025-05-05/PosixUser) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3files-2025-05-05/PosixUser) 

# RootDirectory
<a name="API_S3Files_RootDirectory"></a>

Specifies the root directory path and optional creation permissions for newly created directories.

## Contents
<a name="API_S3Files_RootDirectory_Contents"></a>

 ** creationPermissions **   <a name="AmazonS3-Type-S3Files_RootDirectory-creationPermissions"></a>
The permissions to set on newly created directories.  
Type: [CreationPermissions](API_S3Files_CreationPermissions.md) object  
Required: No

 ** path **   <a name="AmazonS3-Type-S3Files_RootDirectory-path"></a>
The path to use as the root directory for the access point.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(\/|(\/(?!\.)+[^$#<>;;`|&?{}^*/\n]+){1,4})`   
Required: No

## See Also
<a name="API_S3Files_RootDirectory_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3files-2025-05-05/RootDirectory) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3files-2025-05-05/RootDirectory) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3files-2025-05-05/RootDirectory) 

# Tag
<a name="API_S3Files_Tag"></a>

A key-value pair for resource tagging.

## Contents
<a name="API_S3Files_Tag_Contents"></a>

 ** key **   <a name="AmazonS3-Type-S3Files_Tag-key"></a>
The tag key. The key can't start with `aws:`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]+)`   
Required: Yes

 ** value **   <a name="AmazonS3-Type-S3Files_Tag-value"></a>
The tag value.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`   
Required: Yes

## See Also
<a name="API_S3Files_Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3files-2025-05-05/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3files-2025-05-05/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3files-2025-05-05/Tag) 

# Amazon S3 on Outposts
<a name="API_Types_Amazon_S3_on_Outposts"></a>

The following data types are supported by Amazon S3 on Outposts:
+  [Endpoint](API_s3outposts_Endpoint.md) 
+  [FailedReason](API_s3outposts_FailedReason.md) 
+  [NetworkInterface](API_s3outposts_NetworkInterface.md) 
+  [Outpost](API_s3outposts_Outpost.md) 

# Endpoint
<a name="API_s3outposts_Endpoint"></a>

Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to AWS Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see [ Accessing S3 on Outposts using VPC-only access points](https://docs.aws.amazon.com/AmazonS3/latest/userguide/WorkingWithS3Outposts.html) in the *Amazon Simple Storage Service User Guide*.

## Contents
<a name="API_s3outposts_Endpoint_Contents"></a>

 ** AccessType **   <a name="AmazonS3-Type-s3outposts_Endpoint-AccessType"></a>
The type of connectivity used to access the Amazon S3 on Outposts endpoint.  
Type: String  
Valid Values: `Private | CustomerOwnedIp`   
Required: No

 ** CidrBlock **   <a name="AmazonS3-Type-s3outposts_Endpoint-CidrBlock"></a>
The VPC CIDR committed by this endpoint.  
Type: String  
Required: No

 ** CreationTime **   <a name="AmazonS3-Type-s3outposts_Endpoint-CreationTime"></a>
The time the endpoint was created.  
Type: Timestamp  
Required: No

 ** CustomerOwnedIpv4Pool **   <a name="AmazonS3-Type-s3outposts_Endpoint-CustomerOwnedIpv4Pool"></a>
The ID of the customer-owned IPv4 address pool used for the endpoint.  
Type: String  
Pattern: `^ipv4pool-coip-([0-9a-f]{17})$`   
Required: No

 ** EndpointArn **   <a name="AmazonS3-Type-s3outposts_Endpoint-EndpointArn"></a>
The Amazon Resource Name (ARN) of the endpoint.  
Type: String  
Pattern: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):s3-outposts:[a-z\-0-9]*:[0-9]{12}:outpost/(op-[a-f0-9]{17}|ec2)/endpoint/[a-zA-Z0-9]{19}$`   
Required: No

 ** FailedReason **   <a name="AmazonS3-Type-s3outposts_Endpoint-FailedReason"></a>
The failure reason, if any, for a create or delete endpoint operation.  
Type: [FailedReason](API_s3outposts_FailedReason.md) object  
Required: No

 ** NetworkInterfaces **   <a name="AmazonS3-Type-s3outposts_Endpoint-NetworkInterfaces"></a>
The network interface of the endpoint.  
Type: Array of [NetworkInterface](API_s3outposts_NetworkInterface.md) objects  
Required: No

 ** OutpostsId **   <a name="AmazonS3-Type-s3outposts_Endpoint-OutpostsId"></a>
The ID of the AWS Outposts.  
Type: String  
Pattern: `^(op-[a-f0-9]{17}|\d{12}|ec2)$`   
Required: No

 ** SecurityGroupId **   <a name="AmazonS3-Type-s3outposts_Endpoint-SecurityGroupId"></a>
The ID of the security group used for the endpoint.  
Type: String  
Pattern: `^sg-([0-9a-f]{8}|[0-9a-f]{17})$`   
Required: No

 ** Status **   <a name="AmazonS3-Type-s3outposts_Endpoint-Status"></a>
The status of the endpoint.  
Type: String  
Valid Values: `Pending | Available | Deleting | Create_Failed | Delete_Failed`   
Required: No

 ** SubnetId **   <a name="AmazonS3-Type-s3outposts_Endpoint-SubnetId"></a>
The ID of the subnet used for the endpoint.  
Type: String  
Pattern: `^subnet-([0-9a-f]{8}|[0-9a-f]{17})$`   
Required: No

 ** VpcId **   <a name="AmazonS3-Type-s3outposts_Endpoint-VpcId"></a>
The ID of the VPC used for the endpoint.  
Type: String  
Required: No

## See Also
<a name="API_s3outposts_Endpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3outposts-2017-07-25/Endpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3outposts-2017-07-25/Endpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3outposts-2017-07-25/Endpoint) 

# FailedReason
<a name="API_s3outposts_FailedReason"></a>

The failure reason, if any, for a create or delete endpoint operation.

## Contents
<a name="API_s3outposts_FailedReason_Contents"></a>

 ** ErrorCode **   <a name="AmazonS3-Type-s3outposts_FailedReason-ErrorCode"></a>
The failure code, if any, for a create or delete endpoint operation.  
Type: String  
Required: No

 ** Message **   <a name="AmazonS3-Type-s3outposts_FailedReason-Message"></a>
Additional error details describing the endpoint failure and recommended action.  
Type: String  
Required: No

## See Also
<a name="API_s3outposts_FailedReason_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3outposts-2017-07-25/FailedReason) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3outposts-2017-07-25/FailedReason) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3outposts-2017-07-25/FailedReason) 

# NetworkInterface
<a name="API_s3outposts_NetworkInterface"></a>

The container for the network interface.

## Contents
<a name="API_s3outposts_NetworkInterface_Contents"></a>

 ** NetworkInterfaceId **   <a name="AmazonS3-Type-s3outposts_NetworkInterface-NetworkInterfaceId"></a>
The ID for the network interface.  
Type: String  
Required: No

## See Also
<a name="API_s3outposts_NetworkInterface_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3outposts-2017-07-25/NetworkInterface) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3outposts-2017-07-25/NetworkInterface) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3outposts-2017-07-25/NetworkInterface) 

# Outpost
<a name="API_s3outposts_Outpost"></a>

Contains the details for the Outpost object.

## Contents
<a name="API_s3outposts_Outpost_Contents"></a>

 ** CapacityInBytes **   <a name="AmazonS3-Type-s3outposts_Outpost-CapacityInBytes"></a>
The Amazon S3 capacity of the outpost in bytes.  
Type: Long  
Required: No

 ** OutpostArn **   <a name="AmazonS3-Type-s3outposts_Outpost-OutpostArn"></a>
Specifies the unique Amazon Resource Name (ARN) for the outpost.  
Type: String  
Pattern: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):outposts:[a-z\-0-9]*:[0-9]{12}:outpost/(op-[a-f0-9]{17}|ec2)$`   
Required: No

 ** OutpostId **   <a name="AmazonS3-Type-s3outposts_Outpost-OutpostId"></a>
Specifies the unique identifier for the outpost.  
Type: String  
Pattern: `^(op-[a-f0-9]{17}|\d{12}|ec2)$`   
Required: No

 ** OwnerId **   <a name="AmazonS3-Type-s3outposts_Outpost-OwnerId"></a>
Returns the AWS account ID of the outpost owner. Useful for comparing owned versus shared outposts.  
Type: String  
Pattern: `^\d{12}$`   
Required: No

 ** S3OutpostArn **   <a name="AmazonS3-Type-s3outposts_Outpost-S3OutpostArn"></a>
Specifies the unique S3 on Outposts ARN for use with AWS Resource Access Manager (AWS RAM).  
Type: String  
Pattern: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):s3-outposts:[a-z\-0-9]*:[0-9]{12}:outpost/(op-[a-f0-9]{17}|\d{12})/s3$`   
Required: No

## See Also
<a name="API_s3outposts_Outpost_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3outposts-2017-07-25/Outpost) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3outposts-2017-07-25/Outpost) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3outposts-2017-07-25/Outpost) 

# Amazon S3 Tables
<a name="API_Types_Amazon_S3_Tables"></a>

The following data types are supported by Amazon S3 Tables:
+  [EncryptionConfiguration](API_s3Buckets_EncryptionConfiguration.md) 
+  [IcebergCompactionSettings](API_s3Buckets_IcebergCompactionSettings.md) 
+  [IcebergMetadata](API_s3Buckets_IcebergMetadata.md) 
+  [IcebergPartitionField](API_s3Buckets_IcebergPartitionField.md) 
+  [IcebergPartitionSpec](API_s3Buckets_IcebergPartitionSpec.md) 
+  [IcebergSchema](API_s3Buckets_IcebergSchema.md) 
+  [IcebergSchemaV2](API_s3Buckets_IcebergSchemaV2.md) 
+  [IcebergSnapshotManagementSettings](API_s3Buckets_IcebergSnapshotManagementSettings.md) 
+  [IcebergSortField](API_s3Buckets_IcebergSortField.md) 
+  [IcebergSortOrder](API_s3Buckets_IcebergSortOrder.md) 
+  [IcebergUnreferencedFileRemovalSettings](API_s3Buckets_IcebergUnreferencedFileRemovalSettings.md) 
+  [LastSuccessfulReplicatedUpdate](API_s3Buckets_LastSuccessfulReplicatedUpdate.md) 
+  [ManagedTableInformation](API_s3Buckets_ManagedTableInformation.md) 
+  [NamespaceSummary](API_s3Buckets_NamespaceSummary.md) 
+  [ReplicationDestination](API_s3Buckets_ReplicationDestination.md) 
+  [ReplicationDestinationStatusModel](API_s3Buckets_ReplicationDestinationStatusModel.md) 
+  [ReplicationInformation](API_s3Buckets_ReplicationInformation.md) 
+  [SchemaField](API_s3Buckets_SchemaField.md) 
+  [SchemaV2Field](API_s3Buckets_SchemaV2Field.md) 
+  [StorageClassConfiguration](API_s3Buckets_StorageClassConfiguration.md) 
+  [TableBucketMaintenanceConfigurationValue](API_s3Buckets_TableBucketMaintenanceConfigurationValue.md) 
+  [TableBucketMaintenanceSettings](API_s3Buckets_TableBucketMaintenanceSettings.md) 
+  [TableBucketReplicationConfiguration](API_s3Buckets_TableBucketReplicationConfiguration.md) 
+  [TableBucketReplicationRule](API_s3Buckets_TableBucketReplicationRule.md) 
+  [TableBucketSummary](API_s3Buckets_TableBucketSummary.md) 
+  [TableMaintenanceConfigurationValue](API_s3Buckets_TableMaintenanceConfigurationValue.md) 
+  [TableMaintenanceJobStatusValue](API_s3Buckets_TableMaintenanceJobStatusValue.md) 
+  [TableMaintenanceSettings](API_s3Buckets_TableMaintenanceSettings.md) 
+  [TableMetadata](API_s3Buckets_TableMetadata.md) 
+  [TableRecordExpirationConfigurationValue](API_s3Buckets_TableRecordExpirationConfigurationValue.md) 
+  [TableRecordExpirationJobMetrics](API_s3Buckets_TableRecordExpirationJobMetrics.md) 
+  [TableRecordExpirationSettings](API_s3Buckets_TableRecordExpirationSettings.md) 
+  [TableReplicationConfiguration](API_s3Buckets_TableReplicationConfiguration.md) 
+  [TableReplicationRule](API_s3Buckets_TableReplicationRule.md) 
+  [TableSummary](API_s3Buckets_TableSummary.md) 

# EncryptionConfiguration
<a name="API_s3Buckets_EncryptionConfiguration"></a>

Configuration specifying how data should be encrypted. This structure defines the encryption algorithm and optional KMS key to be used for server-side encryption.

## Contents
<a name="API_s3Buckets_EncryptionConfiguration_Contents"></a>

 ** sseAlgorithm **   <a name="AmazonS3-Type-s3Buckets_EncryptionConfiguration-sseAlgorithm"></a>
The server-side encryption algorithm to use. Valid values are `AES256` for S3-managed encryption keys, or `aws:kms` for AWS KMS-managed encryption keys. If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see [Permissions requirements for S3 Tables SSE-KMS encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-kms-permissions.html).  
Type: String  
Valid Values: `AES256 | aws:kms`   
Required: Yes

 ** kmsKeyArn **   <a name="AmazonS3-Type-s3Buckets_EncryptionConfiguration-kmsKeyArn"></a>
The Amazon Resource Name (ARN) of the KMS key to use for encryption. This field is required only when `sseAlgorithm` is set to `aws:kms`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `(arn:aws[-a-z0-9]*:kms:[-a-z0-9]*:[0-9]{12}:key/.+)`   
Required: No

## See Also
<a name="API_s3Buckets_EncryptionConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/EncryptionConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/EncryptionConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/EncryptionConfiguration) 

# IcebergCompactionSettings
<a name="API_s3Buckets_IcebergCompactionSettings"></a>

Contains details about the compaction settings for an Iceberg table.

## Contents
<a name="API_s3Buckets_IcebergCompactionSettings_Contents"></a>

 ** strategy **   <a name="AmazonS3-Type-s3Buckets_IcebergCompactionSettings-strategy"></a>
The compaction strategy to use for the table. This determines how files are selected and combined during compaction operations.  
Type: String  
Valid Values: `auto | binpack | sort | z-order`   
Required: No

 ** targetFileSizeMB **   <a name="AmazonS3-Type-s3Buckets_IcebergCompactionSettings-targetFileSizeMB"></a>
The target file size for the table in MB.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 2147483647.  
Required: No

## See Also
<a name="API_s3Buckets_IcebergCompactionSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/IcebergCompactionSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/IcebergCompactionSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/IcebergCompactionSettings) 

# IcebergMetadata
<a name="API_s3Buckets_IcebergMetadata"></a>

Contains details about the metadata for an Iceberg table.

## Contents
<a name="API_s3Buckets_IcebergMetadata_Contents"></a>

 ** partitionSpec **   <a name="AmazonS3-Type-s3Buckets_IcebergMetadata-partitionSpec"></a>
The partition specification for the Iceberg table. Partitioning organizes data into separate files based on the values of one or more fields, which can improve query performance by reducing the amount of data scanned. Each partition field applies a transform (such as identity, year, month, or bucket) to a single field.  
Type: [IcebergPartitionSpec](API_s3Buckets_IcebergPartitionSpec.md) object  
Required: No

 ** properties **   <a name="AmazonS3-Type-s3Buckets_IcebergMetadata-properties"></a>
A map of custom configuration properties for the Iceberg table.  
Type: String to string map  
Required: No

 ** schema **   <a name="AmazonS3-Type-s3Buckets_IcebergMetadata-schema"></a>
The schema for an Iceberg table. Use this property to define table schemas with primitive types only. For schemas that include nested or complex types such as `struct`, `list`, or `map`, use `schemaV2` instead.  
Type: [IcebergSchema](API_s3Buckets_IcebergSchema.md) object  
Required: No

 ** schemaV2 **   <a name="AmazonS3-Type-s3Buckets_IcebergMetadata-schemaV2"></a>
The schema for an Iceberg table using the V2 format. Use this property to define table schemas that include nested or complex data types such as `struct`, `list`, or `map`, in addition to primitive types. For schemas with only primitive types, you can use either `schema` or `schemaV2`.  
Type: [IcebergSchemaV2](API_s3Buckets_IcebergSchemaV2.md) object  
Required: No

 ** writeOrder **   <a name="AmazonS3-Type-s3Buckets_IcebergMetadata-writeOrder"></a>
The sort order for the Iceberg table. Sort order defines how data is sorted within data files, which can improve query performance by enabling more efficient data skipping and filtering.  
Type: [IcebergSortOrder](API_s3Buckets_IcebergSortOrder.md) object  
Required: No

## See Also
<a name="API_s3Buckets_IcebergMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/IcebergMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/IcebergMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/IcebergMetadata) 

# IcebergPartitionField
<a name="API_s3Buckets_IcebergPartitionField"></a>

Defines a single partition field in an Iceberg partition specification.

## Contents
<a name="API_s3Buckets_IcebergPartitionField_Contents"></a>

 ** name **   <a name="AmazonS3-Type-s3Buckets_IcebergPartitionField-name"></a>
The name for this partition field. This name is used in the partitioned file paths.  
Type: String  
Required: Yes

 ** source-id **   <a name="AmazonS3-Type-s3Buckets_IcebergPartitionField-source-id"></a>
The ID of the source schema field to partition by. This must reference a valid field ID from the table schema.  
Type: Integer  
Required: Yes

 ** transform **   <a name="AmazonS3-Type-s3Buckets_IcebergPartitionField-transform"></a>
The partition transform to apply to the source field. Supported transforms include `identity`, `year`, `month`, `day`, `hour`, `bucket`, and `truncate`. For more information, see the [Apache Iceberg partition transforms documentation](https://iceberg.apache.org/spec/#partition-transforms).  
Type: String  
Required: Yes

 ** field-id **   <a name="AmazonS3-Type-s3Buckets_IcebergPartitionField-field-id"></a>
An optional unique identifier for this partition field. If not specified, S3 Tables automatically assigns a field ID.  
Type: Integer  
Required: No

## See Also
<a name="API_s3Buckets_IcebergPartitionField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/IcebergPartitionField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/IcebergPartitionField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/IcebergPartitionField) 

# IcebergPartitionSpec
<a name="API_s3Buckets_IcebergPartitionSpec"></a>

Defines how data in an Iceberg table is partitioned. Partitioning helps optimize query performance by organizing data into separate files based on field values. Each partition field specifies a transform to apply to a source field.

## Contents
<a name="API_s3Buckets_IcebergPartitionSpec_Contents"></a>

 ** fields **   <a name="AmazonS3-Type-s3Buckets_IcebergPartitionSpec-fields"></a>
The list of partition fields that define how the table data is partitioned. Each field specifies a source field and a transform to apply. This field is required if `partitionSpec` is provided.  
Type: Array of [IcebergPartitionField](API_s3Buckets_IcebergPartitionField.md) objects  
Required: Yes

 ** spec-id **   <a name="AmazonS3-Type-s3Buckets_IcebergPartitionSpec-spec-id"></a>
The unique identifier for this partition specification. If not specified, defaults to `0`.  
Type: Integer  
Required: No

## See Also
<a name="API_s3Buckets_IcebergPartitionSpec_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/IcebergPartitionSpec) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/IcebergPartitionSpec) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/IcebergPartitionSpec) 

# IcebergSchema
<a name="API_s3Buckets_IcebergSchema"></a>

Contains details about the schema for an Iceberg table.

## Contents
<a name="API_s3Buckets_IcebergSchema_Contents"></a>

 ** fields **   <a name="AmazonS3-Type-s3Buckets_IcebergSchema-fields"></a>
The schema fields for the table  
Type: Array of [SchemaField](API_s3Buckets_SchemaField.md) objects  
Required: Yes

## See Also
<a name="API_s3Buckets_IcebergSchema_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/IcebergSchema) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/IcebergSchema) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/IcebergSchema) 

# IcebergSchemaV2
<a name="API_s3Buckets_IcebergSchemaV2"></a>

Contains details about the schema for an Iceberg table using the V2 format. This schema format supports nested and complex data types such as `struct`, `list`, and `map`, in addition to primitive types.

## Contents
<a name="API_s3Buckets_IcebergSchemaV2_Contents"></a>

 ** fields **   <a name="AmazonS3-Type-s3Buckets_IcebergSchemaV2-fields"></a>
The schema fields for the table. Each field defines a column in the table, including its name, type, and whether it is required.  
Type: Array of [SchemaV2Field](API_s3Buckets_SchemaV2Field.md) objects  
Required: Yes

 ** type **   <a name="AmazonS3-Type-s3Buckets_IcebergSchemaV2-type"></a>
The type of the top-level schema, which is always a `struct` type as defined in the [Apache Iceberg specification](https://iceberg.apache.org/spec/#schemas-and-data-types). This value must be `struct`.  
Type: String  
Valid Values: `struct`   
Required: Yes

 ** identifier-field-ids **   <a name="AmazonS3-Type-s3Buckets_IcebergSchemaV2-identifier-field-ids"></a>
A list of field IDs that are used as the identifier fields for the table. Identifier fields uniquely identify a row in the table.  
Type: Array of integers  
Required: No

 ** schema-id **   <a name="AmazonS3-Type-s3Buckets_IcebergSchemaV2-schema-id"></a>
An optional unique identifier for the schema. Schema IDs are used by Apache Iceberg to track schema evolution.  
Type: Integer  
Required: No

## See Also
<a name="API_s3Buckets_IcebergSchemaV2_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/IcebergSchemaV2) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/IcebergSchemaV2) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/IcebergSchemaV2) 

# IcebergSnapshotManagementSettings
<a name="API_s3Buckets_IcebergSnapshotManagementSettings"></a>

Contains details about the snapshot management settings for an Iceberg table. The oldest snapshot expires when its age exceeds the `maxSnapshotAgeHours` and the total number of snapshots exceeds the value for the minimum number of snapshots to keep `minSnapshotsToKeep`.

## Contents
<a name="API_s3Buckets_IcebergSnapshotManagementSettings_Contents"></a>

 ** maxSnapshotAgeHours **   <a name="AmazonS3-Type-s3Buckets_IcebergSnapshotManagementSettings-maxSnapshotAgeHours"></a>
The maximum age of a snapshot before it can be expired.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 2147483647.  
Required: No

 ** minSnapshotsToKeep **   <a name="AmazonS3-Type-s3Buckets_IcebergSnapshotManagementSettings-minSnapshotsToKeep"></a>
The minimum number of snapshots to keep.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 2147483647.  
Required: No

## See Also
<a name="API_s3Buckets_IcebergSnapshotManagementSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/IcebergSnapshotManagementSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/IcebergSnapshotManagementSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/IcebergSnapshotManagementSettings) 

# IcebergSortField
<a name="API_s3Buckets_IcebergSortField"></a>

Defines a single sort field in an Iceberg sort order specification.

## Contents
<a name="API_s3Buckets_IcebergSortField_Contents"></a>

 ** direction **   <a name="AmazonS3-Type-s3Buckets_IcebergSortField-direction"></a>
The sort direction. Valid values are `asc` for ascending order or `desc` for descending order.  
Type: String  
Valid Values: `asc | desc`   
Required: Yes

 ** null-order **   <a name="AmazonS3-Type-s3Buckets_IcebergSortField-null-order"></a>
Specifies how null values are ordered. Valid values are `nulls-first` to place nulls before non-null values, or `nulls-last` to place nulls after non-null values.  
Type: String  
Valid Values: `nulls-first | nulls-last`   
Required: Yes

 ** source-id **   <a name="AmazonS3-Type-s3Buckets_IcebergSortField-source-id"></a>
The ID of the source schema field to sort by. This must reference a valid field ID from the table schema.  
Type: Integer  
Required: Yes

 ** transform **   <a name="AmazonS3-Type-s3Buckets_IcebergSortField-transform"></a>
The transform to apply to the source field before sorting. Use `identity` to sort by the field value directly, or specify other transforms as needed.  
Type: String  
Required: Yes

## See Also
<a name="API_s3Buckets_IcebergSortField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/IcebergSortField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/IcebergSortField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/IcebergSortField) 

# IcebergSortOrder
<a name="API_s3Buckets_IcebergSortOrder"></a>

Defines the sort order for data within an Iceberg table. Sorting data can improve query performance by enabling more efficient data skipping.

## Contents
<a name="API_s3Buckets_IcebergSortOrder_Contents"></a>

 ** fields **   <a name="AmazonS3-Type-s3Buckets_IcebergSortOrder-fields"></a>
The list of sort fields that define how data is sorted within files. Each field specifies a source field, sort direction, and null ordering. This field is required if `writeOrder` is provided.  
Type: Array of [IcebergSortField](API_s3Buckets_IcebergSortField.md) objects  
Required: Yes

 ** order-id **   <a name="AmazonS3-Type-s3Buckets_IcebergSortOrder-order-id"></a>
The unique identifier for this sort order. If not specified, defaults to `1`. The order ID is used by Apache Iceberg to track sort order evolution.  
Type: Integer  
Required: Yes

## See Also
<a name="API_s3Buckets_IcebergSortOrder_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/IcebergSortOrder) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/IcebergSortOrder) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/IcebergSortOrder) 

# IcebergUnreferencedFileRemovalSettings
<a name="API_s3Buckets_IcebergUnreferencedFileRemovalSettings"></a>

Contains details about the unreferenced file removal settings for an Iceberg table bucket.

## Contents
<a name="API_s3Buckets_IcebergUnreferencedFileRemovalSettings_Contents"></a>

 ** nonCurrentDays **   <a name="AmazonS3-Type-s3Buckets_IcebergUnreferencedFileRemovalSettings-nonCurrentDays"></a>
The number of days an object has to be non-current before it is deleted.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 2147483647.  
Required: No

 ** unreferencedDays **   <a name="AmazonS3-Type-s3Buckets_IcebergUnreferencedFileRemovalSettings-unreferencedDays"></a>
The number of days an object has to be unreferenced before it is marked as non-current.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 2147483647.  
Required: No

## See Also
<a name="API_s3Buckets_IcebergUnreferencedFileRemovalSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/IcebergUnreferencedFileRemovalSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/IcebergUnreferencedFileRemovalSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/IcebergUnreferencedFileRemovalSettings) 

# LastSuccessfulReplicatedUpdate
<a name="API_s3Buckets_LastSuccessfulReplicatedUpdate"></a>

Contains information about the most recent successful replication update to a destination.

## Contents
<a name="API_s3Buckets_LastSuccessfulReplicatedUpdate_Contents"></a>

 ** metadataLocation **   <a name="AmazonS3-Type-s3Buckets_LastSuccessfulReplicatedUpdate-metadataLocation"></a>
The S3 location of the metadata that was successfully replicated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** timestamp **   <a name="AmazonS3-Type-s3Buckets_LastSuccessfulReplicatedUpdate-timestamp"></a>
The timestamp when the replication update completed successfully.  
Type: Timestamp  
Required: Yes

## See Also
<a name="API_s3Buckets_LastSuccessfulReplicatedUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/LastSuccessfulReplicatedUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/LastSuccessfulReplicatedUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/LastSuccessfulReplicatedUpdate) 

# ManagedTableInformation
<a name="API_s3Buckets_ManagedTableInformation"></a>

Contains information about tables that are managed by S3 Tables, including replication information for replica tables.

## Contents
<a name="API_s3Buckets_ManagedTableInformation_Contents"></a>

 ** replicationInformation **   <a name="AmazonS3-Type-s3Buckets_ManagedTableInformation-replicationInformation"></a>
If this table is a replica, contains information about the source table from which it is replicated.  
Type: [ReplicationInformation](API_s3Buckets_ReplicationInformation.md) object  
Required: No

## See Also
<a name="API_s3Buckets_ManagedTableInformation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/ManagedTableInformation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/ManagedTableInformation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/ManagedTableInformation) 

# NamespaceSummary
<a name="API_s3Buckets_NamespaceSummary"></a>

Contains details about a namespace.

## Contents
<a name="API_s3Buckets_NamespaceSummary_Contents"></a>

 ** createdAt **   <a name="AmazonS3-Type-s3Buckets_NamespaceSummary-createdAt"></a>
The date and time the namespace was created at.  
Type: Timestamp  
Required: Yes

 ** createdBy **   <a name="AmazonS3-Type-s3Buckets_NamespaceSummary-createdBy"></a>
The ID of the account that created the namespace.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `[0-9].*`   
Required: Yes

 ** namespace **   <a name="AmazonS3-Type-s3Buckets_NamespaceSummary-namespace"></a>
The name of the namespace.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[0-9a-z_]*`   
Required: Yes

 ** ownerAccountId **   <a name="AmazonS3-Type-s3Buckets_NamespaceSummary-ownerAccountId"></a>
The ID of the account that owns the namespace.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `[0-9].*`   
Required: Yes

 ** namespaceId **   <a name="AmazonS3-Type-s3Buckets_NamespaceSummary-namespaceId"></a>
The system-assigned unique identifier for the namespace.  
Type: String  
Required: No

 ** tableBucketId **   <a name="AmazonS3-Type-s3Buckets_NamespaceSummary-tableBucketId"></a>
The system-assigned unique identifier for the table bucket that contains this namespace.  
Type: String  
Required: No

## See Also
<a name="API_s3Buckets_NamespaceSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/NamespaceSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/NamespaceSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/NamespaceSummary) 

# ReplicationDestination
<a name="API_s3Buckets_ReplicationDestination"></a>

Specifies a destination table bucket for replication.

## Contents
<a name="API_s3Buckets_ReplicationDestination_Contents"></a>

 ** destinationTableBucketARN **   <a name="AmazonS3-Type-s3Buckets_ReplicationDestination-destinationTableBucketARN"></a>
The Amazon Resource Name (ARN) of the destination table bucket where tables will be replicated.  
Type: String  
Pattern: `(arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:bucket/[a-z0-9_-]{3,63})`   
Required: Yes

## See Also
<a name="API_s3Buckets_ReplicationDestination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/ReplicationDestination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/ReplicationDestination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/ReplicationDestination) 

# ReplicationDestinationStatusModel
<a name="API_s3Buckets_ReplicationDestinationStatusModel"></a>

Contains status information for a replication destination, including the current replication state, last successful update, and any error messages.

## Contents
<a name="API_s3Buckets_ReplicationDestinationStatusModel_Contents"></a>

 ** destinationTableBucketArn **   <a name="AmazonS3-Type-s3Buckets_ReplicationDestinationStatusModel-destinationTableBucketArn"></a>
The Amazon Resource Name (ARN) of the destination table bucket.  
Type: String  
Pattern: `(arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:bucket/[a-z0-9_-]{3,63})`   
Required: Yes

 ** replicationStatus **   <a name="AmazonS3-Type-s3Buckets_ReplicationDestinationStatusModel-replicationStatus"></a>
The current status of replication to this destination.  
Type: String  
Valid Values: `pending | completed | failed`   
Required: Yes

 ** destinationTableArn **   <a name="AmazonS3-Type-s3Buckets_ReplicationDestinationStatusModel-destinationTableArn"></a>
The Amazon Resource Name (ARN) of the destination table.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `(arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:bucket/[a-z0-9_-]{3,63}/table/[a-zA-Z0-9-_]{1,255})`   
Required: No

 ** failureMessage **   <a name="AmazonS3-Type-s3Buckets_ReplicationDestinationStatusModel-failureMessage"></a>
If replication has failed, this field contains an error message describing the failure reason.  
Type: String  
Required: No

 ** lastSuccessfulReplicatedUpdate **   <a name="AmazonS3-Type-s3Buckets_ReplicationDestinationStatusModel-lastSuccessfulReplicatedUpdate"></a>
Information about the most recent successful replication update to this destination.  
Type: [LastSuccessfulReplicatedUpdate](API_s3Buckets_LastSuccessfulReplicatedUpdate.md) object  
Required: No

## See Also
<a name="API_s3Buckets_ReplicationDestinationStatusModel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/ReplicationDestinationStatusModel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/ReplicationDestinationStatusModel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/ReplicationDestinationStatusModel) 

# ReplicationInformation
<a name="API_s3Buckets_ReplicationInformation"></a>

Contains information about the source of a replicated table.

## Contents
<a name="API_s3Buckets_ReplicationInformation_Contents"></a>

 ** sourceTableARN **   <a name="AmazonS3-Type-s3Buckets_ReplicationInformation-sourceTableARN"></a>
The Amazon Resource Name (ARN) of the source table from which this table is replicated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `(arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:bucket/[a-z0-9_-]{3,63}/table/[a-zA-Z0-9-_]{1,255})`   
Required: Yes

## See Also
<a name="API_s3Buckets_ReplicationInformation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/ReplicationInformation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/ReplicationInformation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/ReplicationInformation) 

# SchemaField
<a name="API_s3Buckets_SchemaField"></a>

Contains details about a schema field.

## Contents
<a name="API_s3Buckets_SchemaField_Contents"></a>

 ** name **   <a name="AmazonS3-Type-s3Buckets_SchemaField-name"></a>
The name of the field.  
Type: String  
Required: Yes

 ** type **   <a name="AmazonS3-Type-s3Buckets_SchemaField-type"></a>
The field type. S3 Tables supports all Apache Iceberg primitive types. For more information, see the [Apache Iceberg documentation](https://iceberg.apache.org/spec/#primitive-types).  
Type: String  
Required: Yes

 ** id **   <a name="AmazonS3-Type-s3Buckets_SchemaField-id"></a>
An optional unique identifier for the schema field. Field IDs are used by Apache Iceberg to track schema evolution and maintain compatibility across schema changes. If not specified, S3 Tables automatically assigns field IDs.  
Type: Integer  
Required: No

 ** required **   <a name="AmazonS3-Type-s3Buckets_SchemaField-required"></a>
A Boolean value that specifies whether values are required for each row in this field. By default, this is `false` and null values are allowed in the field. If this is `true` the field does not allow null values.  
Type: Boolean  
Required: No

## See Also
<a name="API_s3Buckets_SchemaField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/SchemaField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/SchemaField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/SchemaField) 

# SchemaV2Field
<a name="API_s3Buckets_SchemaV2Field"></a>

Contains details about a schema field in the V2 format. This field format supports nested and complex data types such as `struct`, `list`, and `map`, in addition to primitive types.

## Contents
<a name="API_s3Buckets_SchemaV2Field_Contents"></a>

 ** id **   <a name="AmazonS3-Type-s3Buckets_SchemaV2Field-id"></a>
The unique identifier for the schema field. Field IDs are used by Apache Iceberg to track schema evolution and maintain compatibility across schema changes.  
Type: Integer  
Required: Yes

 ** name **   <a name="AmazonS3-Type-s3Buckets_SchemaV2Field-name"></a>
The name of the field.  
Type: String  
Required: Yes

 ** required **   <a name="AmazonS3-Type-s3Buckets_SchemaV2Field-required"></a>
A Boolean value that specifies whether values are required for each row in this field. If this is `true`, the field does not allow null values.  
Type: Boolean  
Required: Yes

 ** type **   <a name="AmazonS3-Type-s3Buckets_SchemaV2Field-type"></a>
The data type of the field. This can be a primitive type string such as `boolean`, `int`, `long`, `float`, `double`, `string`, `binary`, `date`, `timestamp`, or `timestamptz`, or a complex type represented as a JSON object for nested types such as `struct`, `list`, or `map`. For more information, see the [Apache Iceberg schemas and data types documentation](https://iceberg.apache.org/spec/#schemas-and-data-types).  
Type: JSON value  
Required: Yes

 ** doc **   <a name="AmazonS3-Type-s3Buckets_SchemaV2Field-doc"></a>
An optional description of the field.  
Type: String  
Required: No

## See Also
<a name="API_s3Buckets_SchemaV2Field_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/SchemaV2Field) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/SchemaV2Field) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/SchemaV2Field) 

# StorageClassConfiguration
<a name="API_s3Buckets_StorageClassConfiguration"></a>

The configuration details for the storage class of tables or table buckets. This allows you to optimize storage costs by selecting the appropriate storage class based on your access patterns and performance requirements.

## Contents
<a name="API_s3Buckets_StorageClassConfiguration_Contents"></a>

 ** storageClass **   <a name="AmazonS3-Type-s3Buckets_StorageClassConfiguration-storageClass"></a>
The storage class for the table or table bucket. Valid values include storage classes optimized for different access patterns and cost profiles.  
Type: String  
Valid Values: `STANDARD | INTELLIGENT_TIERING`   
Required: Yes

## See Also
<a name="API_s3Buckets_StorageClassConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/StorageClassConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/StorageClassConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/StorageClassConfiguration) 

# TableBucketMaintenanceConfigurationValue
<a name="API_s3Buckets_TableBucketMaintenanceConfigurationValue"></a>

Details about the values that define the maintenance configuration for a table bucket.

## Contents
<a name="API_s3Buckets_TableBucketMaintenanceConfigurationValue_Contents"></a>

 ** settings **   <a name="AmazonS3-Type-s3Buckets_TableBucketMaintenanceConfigurationValue-settings"></a>
Contains details about the settings of the maintenance configuration.  
Type: [TableBucketMaintenanceSettings](API_s3Buckets_TableBucketMaintenanceSettings.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** status **   <a name="AmazonS3-Type-s3Buckets_TableBucketMaintenanceConfigurationValue-status"></a>
The status of the maintenance configuration.  
Type: String  
Valid Values: `enabled | disabled`   
Required: No

## See Also
<a name="API_s3Buckets_TableBucketMaintenanceConfigurationValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/TableBucketMaintenanceConfigurationValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/TableBucketMaintenanceConfigurationValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/TableBucketMaintenanceConfigurationValue) 

# TableBucketMaintenanceSettings
<a name="API_s3Buckets_TableBucketMaintenanceSettings"></a>

Contains details about the maintenance settings for the table bucket.

## Contents
<a name="API_s3Buckets_TableBucketMaintenanceSettings_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** icebergUnreferencedFileRemoval **   <a name="AmazonS3-Type-s3Buckets_TableBucketMaintenanceSettings-icebergUnreferencedFileRemoval"></a>
The unreferenced file removal settings for the table bucket.  
Type: [IcebergUnreferencedFileRemovalSettings](API_s3Buckets_IcebergUnreferencedFileRemovalSettings.md) object  
Required: No

## See Also
<a name="API_s3Buckets_TableBucketMaintenanceSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/TableBucketMaintenanceSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/TableBucketMaintenanceSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/TableBucketMaintenanceSettings) 

# TableBucketReplicationConfiguration
<a name="API_s3Buckets_TableBucketReplicationConfiguration"></a>

The replication configuration for a table bucket. This configuration defines how tables in the source bucket are replicated to destination table buckets, including the IAM role used for replication.

## Contents
<a name="API_s3Buckets_TableBucketReplicationConfiguration_Contents"></a>

 ** role **   <a name="AmazonS3-Type-s3Buckets_TableBucketReplicationConfiguration-role"></a>
The Amazon Resource Name (ARN) of the IAM role that S3 Tables assumes to replicate tables on your behalf.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:.+:iam::[0-9]{12}:role/.+`   
Required: Yes

 ** rules **   <a name="AmazonS3-Type-s3Buckets_TableBucketReplicationConfiguration-rules"></a>
An array of replication rules that define which tables to replicate and where to replicate them.  
Type: Array of [TableBucketReplicationRule](API_s3Buckets_TableBucketReplicationRule.md) objects  
Array Members: Fixed number of 1 item.  
Required: Yes

## See Also
<a name="API_s3Buckets_TableBucketReplicationConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/TableBucketReplicationConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/TableBucketReplicationConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/TableBucketReplicationConfiguration) 

# TableBucketReplicationRule
<a name="API_s3Buckets_TableBucketReplicationRule"></a>

Defines a rule for replicating tables from a source table bucket to one or more destination table buckets.

## Contents
<a name="API_s3Buckets_TableBucketReplicationRule_Contents"></a>

 ** destinations **   <a name="AmazonS3-Type-s3Buckets_TableBucketReplicationRule-destinations"></a>
An array of destination table buckets where tables should be replicated.  
Type: Array of [ReplicationDestination](API_s3Buckets_ReplicationDestination.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Required: Yes

## See Also
<a name="API_s3Buckets_TableBucketReplicationRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/TableBucketReplicationRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/TableBucketReplicationRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/TableBucketReplicationRule) 

# TableBucketSummary
<a name="API_s3Buckets_TableBucketSummary"></a>

Contains details about a table bucket.

## Contents
<a name="API_s3Buckets_TableBucketSummary_Contents"></a>

 ** arn **   <a name="AmazonS3-Type-s3Buckets_TableBucketSummary-arn"></a>
The Amazon Resource Name (ARN) of the table bucket.  
Type: String  
Pattern: `(arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:bucket/[a-z0-9_-]{3,63})`   
Required: Yes

 ** createdAt **   <a name="AmazonS3-Type-s3Buckets_TableBucketSummary-createdAt"></a>
The date and time the table bucket was created at.  
Type: Timestamp  
Required: Yes

 ** name **   <a name="AmazonS3-Type-s3Buckets_TableBucketSummary-name"></a>
The name of the table bucket.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `[0-9a-z-]*`   
Required: Yes

 ** ownerAccountId **   <a name="AmazonS3-Type-s3Buckets_TableBucketSummary-ownerAccountId"></a>
The ID of the account that owns the table bucket.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `[0-9].*`   
Required: Yes

 ** tableBucketId **   <a name="AmazonS3-Type-s3Buckets_TableBucketSummary-tableBucketId"></a>
The system-assigned unique identifier for the table bucket.  
Type: String  
Required: No

 ** type **   <a name="AmazonS3-Type-s3Buckets_TableBucketSummary-type"></a>
The type of the table bucket.  
Type: String  
Valid Values: `customer | aws`   
Required: No

## See Also
<a name="API_s3Buckets_TableBucketSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/TableBucketSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/TableBucketSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/TableBucketSummary) 

# TableMaintenanceConfigurationValue
<a name="API_s3Buckets_TableMaintenanceConfigurationValue"></a>

The values that define a maintenance configuration for a table.

## Contents
<a name="API_s3Buckets_TableMaintenanceConfigurationValue_Contents"></a>

 ** settings **   <a name="AmazonS3-Type-s3Buckets_TableMaintenanceConfigurationValue-settings"></a>
Contains details about the settings for the maintenance configuration.  
Type: [TableMaintenanceSettings](API_s3Buckets_TableMaintenanceSettings.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** status **   <a name="AmazonS3-Type-s3Buckets_TableMaintenanceConfigurationValue-status"></a>
The status of the maintenance configuration.  
Type: String  
Valid Values: `enabled | disabled`   
Required: No

## See Also
<a name="API_s3Buckets_TableMaintenanceConfigurationValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/TableMaintenanceConfigurationValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/TableMaintenanceConfigurationValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/TableMaintenanceConfigurationValue) 

# TableMaintenanceJobStatusValue
<a name="API_s3Buckets_TableMaintenanceJobStatusValue"></a>

Details about the status of a maintenance job.

## Contents
<a name="API_s3Buckets_TableMaintenanceJobStatusValue_Contents"></a>

 ** status **   <a name="AmazonS3-Type-s3Buckets_TableMaintenanceJobStatusValue-status"></a>
The status of the job.  
Type: String  
Valid Values: `Not_Yet_Run | Successful | Failed | Disabled`   
Required: Yes

 ** failureMessage **   <a name="AmazonS3-Type-s3Buckets_TableMaintenanceJobStatusValue-failureMessage"></a>
The failure message of a failed job.  
Type: String  
Required: No

 ** lastRunTimestamp **   <a name="AmazonS3-Type-s3Buckets_TableMaintenanceJobStatusValue-lastRunTimestamp"></a>
The date and time that the maintenance job was last run.  
Type: Timestamp  
Required: No

## See Also
<a name="API_s3Buckets_TableMaintenanceJobStatusValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/TableMaintenanceJobStatusValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/TableMaintenanceJobStatusValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/TableMaintenanceJobStatusValue) 

# TableMaintenanceSettings
<a name="API_s3Buckets_TableMaintenanceSettings"></a>

Contains details about maintenance settings for the table.

## Contents
<a name="API_s3Buckets_TableMaintenanceSettings_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** icebergCompaction **   <a name="AmazonS3-Type-s3Buckets_TableMaintenanceSettings-icebergCompaction"></a>
Contains details about the Iceberg compaction settings for the table.  
Type: [IcebergCompactionSettings](API_s3Buckets_IcebergCompactionSettings.md) object  
Required: No

 ** icebergSnapshotManagement **   <a name="AmazonS3-Type-s3Buckets_TableMaintenanceSettings-icebergSnapshotManagement"></a>
Contains details about the Iceberg snapshot management settings for the table.  
Type: [IcebergSnapshotManagementSettings](API_s3Buckets_IcebergSnapshotManagementSettings.md) object  
Required: No

## See Also
<a name="API_s3Buckets_TableMaintenanceSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/TableMaintenanceSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/TableMaintenanceSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/TableMaintenanceSettings) 

# TableMetadata
<a name="API_s3Buckets_TableMetadata"></a>

Contains details about the table metadata.

## Contents
<a name="API_s3Buckets_TableMetadata_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** iceberg **   <a name="AmazonS3-Type-s3Buckets_TableMetadata-iceberg"></a>
Contains details about the metadata of an Iceberg table.  
Type: [IcebergMetadata](API_s3Buckets_IcebergMetadata.md) object  
Required: No

## See Also
<a name="API_s3Buckets_TableMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/TableMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/TableMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/TableMetadata) 

# TableRecordExpirationConfigurationValue
<a name="API_s3Buckets_TableRecordExpirationConfigurationValue"></a>

The expiration configuration settings for records in a table, and the status of the configuration. If the status of the configuration is enabled, records expire and are automatically removed after the number of days specified in the record expiration settings for the table.

## Contents
<a name="API_s3Buckets_TableRecordExpirationConfigurationValue_Contents"></a>

 ** settings **   <a name="AmazonS3-Type-s3Buckets_TableRecordExpirationConfigurationValue-settings"></a>
The expiration settings for records in the table.  
Type: [TableRecordExpirationSettings](API_s3Buckets_TableRecordExpirationSettings.md) object  
Required: No

 ** status **   <a name="AmazonS3-Type-s3Buckets_TableRecordExpirationConfigurationValue-status"></a>
The status of the expiration settings for records in the table.  
Type: String  
Valid Values: `enabled | disabled`   
Required: No

## See Also
<a name="API_s3Buckets_TableRecordExpirationConfigurationValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/TableRecordExpirationConfigurationValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/TableRecordExpirationConfigurationValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/TableRecordExpirationConfigurationValue) 

# TableRecordExpirationJobMetrics
<a name="API_s3Buckets_TableRecordExpirationJobMetrics"></a>

Provides metrics for the record expiration job that most recently ran for a table. The metrics provide insight into the amount of data that was removed when the job ran.

## Contents
<a name="API_s3Buckets_TableRecordExpirationJobMetrics_Contents"></a>

 ** deletedDataFiles **   <a name="AmazonS3-Type-s3Buckets_TableRecordExpirationJobMetrics-deletedDataFiles"></a>
The total number of data files that were removed when the job ran.  
Type: Long  
Required: No

 ** deletedRecords **   <a name="AmazonS3-Type-s3Buckets_TableRecordExpirationJobMetrics-deletedRecords"></a>
The total number of records that were removed when the job ran.  
Type: Long  
Required: No

 ** removedFilesSize **   <a name="AmazonS3-Type-s3Buckets_TableRecordExpirationJobMetrics-removedFilesSize"></a>
The total size (in bytes) of the data files that were removed when the job ran.  
Type: Long  
Required: No

## See Also
<a name="API_s3Buckets_TableRecordExpirationJobMetrics_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/TableRecordExpirationJobMetrics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/TableRecordExpirationJobMetrics) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/TableRecordExpirationJobMetrics) 

# TableRecordExpirationSettings
<a name="API_s3Buckets_TableRecordExpirationSettings"></a>

The record expiration setting that specifies when records expire and are automatically removed from a table.

## Contents
<a name="API_s3Buckets_TableRecordExpirationSettings_Contents"></a>

 ** days **   <a name="AmazonS3-Type-s3Buckets_TableRecordExpirationSettings-days"></a>
If you enable record expiration for a table, you can specify the number of days to retain your table records. For example, to retain your table records for one year, set this value to `365`.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 2147483647.  
Required: No

## See Also
<a name="API_s3Buckets_TableRecordExpirationSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/TableRecordExpirationSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/TableRecordExpirationSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/TableRecordExpirationSettings) 

# TableReplicationConfiguration
<a name="API_s3Buckets_TableReplicationConfiguration"></a>

The replication configuration for an individual table. This configuration defines how the table is replicated to destination tables.

## Contents
<a name="API_s3Buckets_TableReplicationConfiguration_Contents"></a>

 ** role **   <a name="AmazonS3-Type-s3Buckets_TableReplicationConfiguration-role"></a>
The Amazon Resource Name (ARN) of the IAM role that S3 Tables assumes to replicate the table on your behalf.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:.+:iam::[0-9]{12}:role/.+`   
Required: Yes

 ** rules **   <a name="AmazonS3-Type-s3Buckets_TableReplicationConfiguration-rules"></a>
An array of replication rules that define where this table should be replicated.  
Type: Array of [TableReplicationRule](API_s3Buckets_TableReplicationRule.md) objects  
Array Members: Fixed number of 1 item.  
Required: Yes

## See Also
<a name="API_s3Buckets_TableReplicationConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/TableReplicationConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/TableReplicationConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/TableReplicationConfiguration) 

# TableReplicationRule
<a name="API_s3Buckets_TableReplicationRule"></a>

Defines a rule for replicating a table to one or more destination tables.

## Contents
<a name="API_s3Buckets_TableReplicationRule_Contents"></a>

 ** destinations **   <a name="AmazonS3-Type-s3Buckets_TableReplicationRule-destinations"></a>
An array of destination table buckets where this table should be replicated.  
Type: Array of [ReplicationDestination](API_s3Buckets_ReplicationDestination.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Required: Yes

## See Also
<a name="API_s3Buckets_TableReplicationRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/TableReplicationRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/TableReplicationRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/TableReplicationRule) 

# TableSummary
<a name="API_s3Buckets_TableSummary"></a>

Contains details about a table.

## Contents
<a name="API_s3Buckets_TableSummary_Contents"></a>

 ** createdAt **   <a name="AmazonS3-Type-s3Buckets_TableSummary-createdAt"></a>
The date and time the table was created at.  
Type: Timestamp  
Required: Yes

 ** modifiedAt **   <a name="AmazonS3-Type-s3Buckets_TableSummary-modifiedAt"></a>
The date and time the table was last modified at.  
Type: Timestamp  
Required: Yes

 ** name **   <a name="AmazonS3-Type-s3Buckets_TableSummary-name"></a>
The name of the table.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[0-9a-z_]*`   
Required: Yes

 ** namespace **   <a name="AmazonS3-Type-s3Buckets_TableSummary-namespace"></a>
The name of the namespace.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[0-9a-z_]*`   
Required: Yes

 ** tableARN **   <a name="AmazonS3-Type-s3Buckets_TableSummary-tableARN"></a>
The Amazon Resource Name (ARN) of the table.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `(arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:bucket/[a-z0-9_-]{3,63}/table/[a-zA-Z0-9-_]{1,255})`   
Required: Yes

 ** type **   <a name="AmazonS3-Type-s3Buckets_TableSummary-type"></a>
The type of the table.  
Type: String  
Valid Values: `customer | aws`   
Required: Yes

 ** managedByService **   <a name="AmazonS3-Type-s3Buckets_TableSummary-managedByService"></a>
The AWS service managing this table, if applicable. For example, a replicated table is managed by the S3 Tables replication service.  
Type: String  
Required: No

 ** namespaceId **   <a name="AmazonS3-Type-s3Buckets_TableSummary-namespaceId"></a>
The unique identifier for the namespace that contains this table.  
Type: String  
Required: No

 ** tableBucketId **   <a name="AmazonS3-Type-s3Buckets_TableSummary-tableBucketId"></a>
The unique identifier for the table bucket that contains this table.  
Type: String  
Required: No

## See Also
<a name="API_s3Buckets_TableSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3tables-2018-05-10/TableSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3tables-2018-05-10/TableSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3tables-2018-05-10/TableSummary) 

# Amazon S3 Vectors
<a name="API_Types_Amazon_S3_Vectors"></a>

The following data types are supported by Amazon S3 Vectors:
+  [EncryptionConfiguration](API_S3VectorBuckets_EncryptionConfiguration.md) 
+  [GetOutputVector](API_S3VectorBuckets_GetOutputVector.md) 
+  [Index](API_S3VectorBuckets_Index.md) 
+  [IndexSummary](API_S3VectorBuckets_IndexSummary.md) 
+  [ListOutputVector](API_S3VectorBuckets_ListOutputVector.md) 
+  [MetadataConfiguration](API_S3VectorBuckets_MetadataConfiguration.md) 
+  [PutInputVector](API_S3VectorBuckets_PutInputVector.md) 
+  [QueryOutputVector](API_S3VectorBuckets_QueryOutputVector.md) 
+  [ValidationExceptionField](API_S3VectorBuckets_ValidationExceptionField.md) 
+  [VectorBucket](API_S3VectorBuckets_VectorBucket.md) 
+  [VectorBucketSummary](API_S3VectorBuckets_VectorBucketSummary.md) 
+  [VectorData](API_S3VectorBuckets_VectorData.md) 

# EncryptionConfiguration
<a name="API_S3VectorBuckets_EncryptionConfiguration"></a>

The encryption configuration for a vector bucket or index. By default, if you don't specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically `AES256`. You can optionally override bucket level encryption settings, and set a specific encryption configuration for a vector index at the time of index creation.

## Contents
<a name="API_S3VectorBuckets_EncryptionConfiguration_Contents"></a>

 ** kmsKeyArn **   <a name="AmazonS3-Type-S3VectorBuckets_EncryptionConfiguration-kmsKeyArn"></a>
 AWS Key Management Service (KMS) customer managed key ID to use for the encryption configuration. This parameter is allowed if and only if `sseType` is set to `aws:kms`.  
To specify the KMS key, you must use the format of the KMS key Amazon Resource Name (ARN).  
For example, specify Key ARN in the following format: `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `(arn:aws[-a-z0-9]*:kms:[-a-z0-9]*:[0-9]{12}:key/.+)`   
Required: No

 ** sseType **   <a name="AmazonS3-Type-S3VectorBuckets_EncryptionConfiguration-sseType"></a>
The server-side encryption type to use for the encryption configuration of the vector bucket. By default, if you don't specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically `AES256`.  
Type: String  
Valid Values: `AES256 | aws:kms`   
Required: No

## See Also
<a name="API_S3VectorBuckets_EncryptionConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3vectors-2025-07-15/EncryptionConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3vectors-2025-07-15/EncryptionConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3vectors-2025-07-15/EncryptionConfiguration) 

# GetOutputVector
<a name="API_S3VectorBuckets_GetOutputVector"></a>

The attributes of a vector returned by the `GetVectors` operation.

## Contents
<a name="API_S3VectorBuckets_GetOutputVector_Contents"></a>

 ** key **   <a name="AmazonS3-Type-S3VectorBuckets_GetOutputVector-key"></a>
The name of the vector.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** data **   <a name="AmazonS3-Type-S3VectorBuckets_GetOutputVector-data"></a>
The vector data of the vector.   
Type: [VectorData](API_S3VectorBuckets_VectorData.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** metadata **   <a name="AmazonS3-Type-S3VectorBuckets_GetOutputVector-metadata"></a>
Metadata about the vector.   
Type: JSON value  
Required: No

## See Also
<a name="API_S3VectorBuckets_GetOutputVector_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3vectors-2025-07-15/GetOutputVector) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3vectors-2025-07-15/GetOutputVector) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3vectors-2025-07-15/GetOutputVector) 

# Index
<a name="API_S3VectorBuckets_Index"></a>

The attributes of a vector index.

## Contents
<a name="API_S3VectorBuckets_Index_Contents"></a>

 ** creationTime **   <a name="AmazonS3-Type-S3VectorBuckets_Index-creationTime"></a>
Date and time when the vector index was created.   
Type: Timestamp  
Required: Yes

 ** dataType **   <a name="AmazonS3-Type-S3VectorBuckets_Index-dataType"></a>
The data type of the vectors inserted into the vector index.   
Type: String  
Valid Values: `float32`   
Required: Yes

 ** dimension **   <a name="AmazonS3-Type-S3VectorBuckets_Index-dimension"></a>
The number of values in the vectors that are inserted into the vector index.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 4096.  
Required: Yes

 ** distanceMetric **   <a name="AmazonS3-Type-S3VectorBuckets_Index-distanceMetric"></a>
The distance metric to be used for similarity search.   
Type: String  
Valid Values: `euclidean | cosine`   
Required: Yes

 ** indexArn **   <a name="AmazonS3-Type-S3VectorBuckets_Index-indexArn"></a>
The Amazon Resource Name (ARN) of the vector index.  
Type: String  
Pattern: `arn:aws[-a-z0-9]*:s3vectors:[a-z0-9-]+:[0-9]{12}:bucket/[a-z0-9][a-z0-9-.]{1,61}[a-z0-9]/index/[a-z0-9][a-z0-9-.]{1,61}[a-z0-9]`   
Required: Yes

 ** indexName **   <a name="AmazonS3-Type-S3VectorBuckets_Index-indexName"></a>
The name of the vector index.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Required: Yes

 ** vectorBucketName **   <a name="AmazonS3-Type-S3VectorBuckets_Index-vectorBucketName"></a>
The name of the vector bucket that contains the vector index.   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Required: Yes

 ** encryptionConfiguration **   <a name="AmazonS3-Type-S3VectorBuckets_Index-encryptionConfiguration"></a>
The encryption configuration for a vector index. By default, if you don't specify, all new vectors in the vector index will use the encryption configuration of the vector bucket.  
Type: [EncryptionConfiguration](API_S3VectorBuckets_EncryptionConfiguration.md) object  
Required: No

 ** metadataConfiguration **   <a name="AmazonS3-Type-S3VectorBuckets_Index-metadataConfiguration"></a>
The metadata configuration for the vector index.   
Type: [MetadataConfiguration](API_S3VectorBuckets_MetadataConfiguration.md) object  
Required: No

## See Also
<a name="API_S3VectorBuckets_Index_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3vectors-2025-07-15/Index) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3vectors-2025-07-15/Index) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3vectors-2025-07-15/Index) 

# IndexSummary
<a name="API_S3VectorBuckets_IndexSummary"></a>

Summary information about a vector index.

## Contents
<a name="API_S3VectorBuckets_IndexSummary_Contents"></a>

 ** creationTime **   <a name="AmazonS3-Type-S3VectorBuckets_IndexSummary-creationTime"></a>
Date and time when the vector index was created.   
Type: Timestamp  
Required: Yes

 ** indexArn **   <a name="AmazonS3-Type-S3VectorBuckets_IndexSummary-indexArn"></a>
The Amazon Resource Name (ARN) of the vector index.  
Type: String  
Pattern: `arn:aws[-a-z0-9]*:s3vectors:[a-z0-9-]+:[0-9]{12}:bucket/[a-z0-9][a-z0-9-.]{1,61}[a-z0-9]/index/[a-z0-9][a-z0-9-.]{1,61}[a-z0-9]`   
Required: Yes

 ** indexName **   <a name="AmazonS3-Type-S3VectorBuckets_IndexSummary-indexName"></a>
The name of the vector index.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Required: Yes

 ** vectorBucketName **   <a name="AmazonS3-Type-S3VectorBuckets_IndexSummary-vectorBucketName"></a>
The name of the vector bucket that contains the vector index.   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Required: Yes

## See Also
<a name="API_S3VectorBuckets_IndexSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3vectors-2025-07-15/IndexSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3vectors-2025-07-15/IndexSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3vectors-2025-07-15/IndexSummary) 

# ListOutputVector
<a name="API_S3VectorBuckets_ListOutputVector"></a>

The attributes of a vector returned by the `ListVectors` operation.

## Contents
<a name="API_S3VectorBuckets_ListOutputVector_Contents"></a>

 ** key **   <a name="AmazonS3-Type-S3VectorBuckets_ListOutputVector-key"></a>
The name of the vector.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** data **   <a name="AmazonS3-Type-S3VectorBuckets_ListOutputVector-data"></a>
The vector data of the vector.   
Type: [VectorData](API_S3VectorBuckets_VectorData.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** metadata **   <a name="AmazonS3-Type-S3VectorBuckets_ListOutputVector-metadata"></a>
Metadata about the vector.   
Type: JSON value  
Required: No

## See Also
<a name="API_S3VectorBuckets_ListOutputVector_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3vectors-2025-07-15/ListOutputVector) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3vectors-2025-07-15/ListOutputVector) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3vectors-2025-07-15/ListOutputVector) 

# MetadataConfiguration
<a name="API_S3VectorBuckets_MetadataConfiguration"></a>

The metadata configuration for a vector index.

## Contents
<a name="API_S3VectorBuckets_MetadataConfiguration_Contents"></a>

 ** nonFilterableMetadataKeys **   <a name="AmazonS3-Type-S3VectorBuckets_MetadataConfiguration-nonFilterableMetadataKeys"></a>
Non-filterable metadata keys allow you to enrich vectors with additional context during storage and retrieval. Unlike default metadata keys, these keys can’t be used as query filters. Non-filterable metadata keys can be retrieved but can’t be searched, queried, or filtered. You can access non-filterable metadata keys of your vectors after finding the vectors. For more information about non-filterable metadata keys, see [Vectors](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-vectors-vectors.html) and [Limitations and restrictions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-vectors-limitations.html) in the *Amazon S3 User Guide*.   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Required: Yes

## See Also
<a name="API_S3VectorBuckets_MetadataConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3vectors-2025-07-15/MetadataConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3vectors-2025-07-15/MetadataConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3vectors-2025-07-15/MetadataConfiguration) 

# PutInputVector
<a name="API_S3VectorBuckets_PutInputVector"></a>

The attributes of a vector to add to a vector index.

## Contents
<a name="API_S3VectorBuckets_PutInputVector_Contents"></a>

 ** data **   <a name="AmazonS3-Type-S3VectorBuckets_PutInputVector-data"></a>
The vector data of the vector.   
Vector dimensions must match the dimension count that's configured for the vector index.  
+ For the `cosine` distance metric, zero vectors (vectors containing all zeros) aren't allowed.
+ For both `cosine` and `euclidean` distance metrics, vector data must contain only valid floating-point values. Invalid values such as NaN (Not a Number) or Infinity aren't allowed.
Type: [VectorData](API_S3VectorBuckets_VectorData.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** key **   <a name="AmazonS3-Type-S3VectorBuckets_PutInputVector-key"></a>
The name of the vector. The key uniquely identifies the vector in a vector index.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** metadata **   <a name="AmazonS3-Type-S3VectorBuckets_PutInputVector-metadata"></a>
Metadata about the vector. All metadata entries undergo validation to ensure they meet the format requirements for size and data types.  
Type: JSON value  
Required: No

## See Also
<a name="API_S3VectorBuckets_PutInputVector_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3vectors-2025-07-15/PutInputVector) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3vectors-2025-07-15/PutInputVector) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3vectors-2025-07-15/PutInputVector) 

# QueryOutputVector
<a name="API_S3VectorBuckets_QueryOutputVector"></a>

The attributes of a vector in the approximate nearest neighbor search.

## Contents
<a name="API_S3VectorBuckets_QueryOutputVector_Contents"></a>

 ** key **   <a name="AmazonS3-Type-S3VectorBuckets_QueryOutputVector-key"></a>
The key of the vector in the approximate nearest neighbor search.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** distance **   <a name="AmazonS3-Type-S3VectorBuckets_QueryOutputVector-distance"></a>
The measure of similarity between the vector in the response and the query vector.  
Type: Float  
Required: No

 ** metadata **   <a name="AmazonS3-Type-S3VectorBuckets_QueryOutputVector-metadata"></a>
The metadata associated with the vector, if requested.  
Type: JSON value  
Required: No

## See Also
<a name="API_S3VectorBuckets_QueryOutputVector_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3vectors-2025-07-15/QueryOutputVector) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3vectors-2025-07-15/QueryOutputVector) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3vectors-2025-07-15/QueryOutputVector) 

# ValidationExceptionField
<a name="API_S3VectorBuckets_ValidationExceptionField"></a>

Contains information about a validation exception.

## Contents
<a name="API_S3VectorBuckets_ValidationExceptionField_Contents"></a>

 ** message **   <a name="AmazonS3-Type-S3VectorBuckets_ValidationExceptionField-message"></a>
A message about the validation exception.  
Type: String  
Required: Yes

 ** path **   <a name="AmazonS3-Type-S3VectorBuckets_ValidationExceptionField-path"></a>
A path about the validation exception.  
Type: String  
Required: Yes

## See Also
<a name="API_S3VectorBuckets_ValidationExceptionField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3vectors-2025-07-15/ValidationExceptionField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3vectors-2025-07-15/ValidationExceptionField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3vectors-2025-07-15/ValidationExceptionField) 

# VectorBucket
<a name="API_S3VectorBuckets_VectorBucket"></a>

The attributes of a vector bucket. 

## Contents
<a name="API_S3VectorBuckets_VectorBucket_Contents"></a>

 ** creationTime **   <a name="AmazonS3-Type-S3VectorBuckets_VectorBucket-creationTime"></a>
Date and time when the vector bucket was created.   
Type: Timestamp  
Required: Yes

 ** vectorBucketArn **   <a name="AmazonS3-Type-S3VectorBuckets_VectorBucket-vectorBucketArn"></a>
The Amazon Resource Name (ARN) of the vector bucket.   
Type: String  
Pattern: `arn:aws[-a-z0-9]*:s3vectors:[a-z0-9-]+:[0-9]{12}:bucket/[a-z0-9][a-z0-9-.]{1,61}[a-z0-9]`   
Required: Yes

 ** vectorBucketName **   <a name="AmazonS3-Type-S3VectorBuckets_VectorBucket-vectorBucketName"></a>
The name of the vector bucket.   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Required: Yes

 ** encryptionConfiguration **   <a name="AmazonS3-Type-S3VectorBuckets_VectorBucket-encryptionConfiguration"></a>
The encryption configuration for the vector bucket.  
Type: [EncryptionConfiguration](API_S3VectorBuckets_EncryptionConfiguration.md) object  
Required: No

## See Also
<a name="API_S3VectorBuckets_VectorBucket_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3vectors-2025-07-15/VectorBucket) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3vectors-2025-07-15/VectorBucket) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3vectors-2025-07-15/VectorBucket) 

# VectorBucketSummary
<a name="API_S3VectorBuckets_VectorBucketSummary"></a>

Summary information about a vector bucket.

## Contents
<a name="API_S3VectorBuckets_VectorBucketSummary_Contents"></a>

 ** creationTime **   <a name="AmazonS3-Type-S3VectorBuckets_VectorBucketSummary-creationTime"></a>
Date and time when the vector bucket was created.   
Type: Timestamp  
Required: Yes

 ** vectorBucketArn **   <a name="AmazonS3-Type-S3VectorBuckets_VectorBucketSummary-vectorBucketArn"></a>
The Amazon Resource Name (ARN) of the vector bucket.   
Type: String  
Pattern: `arn:aws[-a-z0-9]*:s3vectors:[a-z0-9-]+:[0-9]{12}:bucket/[a-z0-9][a-z0-9-.]{1,61}[a-z0-9]`   
Required: Yes

 ** vectorBucketName **   <a name="AmazonS3-Type-S3VectorBuckets_VectorBucketSummary-vectorBucketName"></a>
The name of the vector bucket.   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Required: Yes

## See Also
<a name="API_S3VectorBuckets_VectorBucketSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3vectors-2025-07-15/VectorBucketSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3vectors-2025-07-15/VectorBucketSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3vectors-2025-07-15/VectorBucketSummary) 

# VectorData
<a name="API_S3VectorBuckets_VectorData"></a>

The vector data in different formats.

## Contents
<a name="API_S3VectorBuckets_VectorData_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** float32 **   <a name="AmazonS3-Type-S3VectorBuckets_VectorData-float32"></a>
The vector data as 32-bit floating point numbers. The number of elements in this array must exactly match the dimension of the vector index where the operation is being performed.  
Type: Array of floats  
Required: No

## See Also
<a name="API_S3VectorBuckets_VectorData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/s3vectors-2025-07-15/VectorData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3vectors-2025-07-15/VectorData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3vectors-2025-07-15/VectorData)