

# 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) 