PutStorageLensConfiguration
Note
This operation is not supported by directory buckets.
Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
Note
To use this action, you must have permission to perform the
s3:PutStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the
Amazon S3 User Guide.
Request Syntax
PUT /v20180820/storagelens/storagelensid HTTP/1.1
Host: s3-control.amazonaws.com
x-amz-account-id: AccountId
<?xml version="1.0" encoding="UTF-8"?>
<PutStorageLensConfigurationRequest xmlns="http://awss3control.amazonaws.com/doc/2018-08-20/">
<StorageLensConfiguration>
<AccountLevel>
<ActivityMetrics>
<IsEnabled>boolean</IsEnabled>
</ActivityMetrics>
<AdvancedCostOptimizationMetrics>
<IsEnabled>boolean</IsEnabled>
</AdvancedCostOptimizationMetrics>
<AdvancedDataProtectionMetrics>
<IsEnabled>boolean</IsEnabled>
</AdvancedDataProtectionMetrics>
<BucketLevel>
<ActivityMetrics>
<IsEnabled>boolean</IsEnabled>
</ActivityMetrics>
<AdvancedCostOptimizationMetrics>
<IsEnabled>boolean</IsEnabled>
</AdvancedCostOptimizationMetrics>
<AdvancedDataProtectionMetrics>
<IsEnabled>boolean</IsEnabled>
</AdvancedDataProtectionMetrics>
<DetailedStatusCodesMetrics>
<IsEnabled>boolean</IsEnabled>
</DetailedStatusCodesMetrics>
<PrefixLevel>
<StorageMetrics>
<IsEnabled>boolean</IsEnabled>
<SelectionCriteria>
<Delimiter>string</Delimiter>
<MaxDepth>integer</MaxDepth>
<MinStorageBytesPercentage>double</MinStorageBytesPercentage>
</SelectionCriteria>
</StorageMetrics>
</PrefixLevel>
</BucketLevel>
<DetailedStatusCodesMetrics>
<IsEnabled>boolean</IsEnabled>
</DetailedStatusCodesMetrics>
<StorageLensGroupLevel>
<SelectionCriteria>
<Exclude>
<Arn>string</Arn>
</Exclude>
<Include>
<Arn>string</Arn>
</Include>
</SelectionCriteria>
</StorageLensGroupLevel>
</AccountLevel>
<AwsOrg>
<Arn>string</Arn>
</AwsOrg>
<DataExport>
<CloudWatchMetrics>
<IsEnabled>boolean</IsEnabled>
</CloudWatchMetrics>
<S3BucketDestination>
<AccountId>string</AccountId>
<Arn>string</Arn>
<Encryption>
<SSE-KMS>
<KeyId>string</KeyId>
</SSE-KMS>
<SSE-S3>
</SSE-S3>
</Encryption>
<Format>string</Format>
<OutputSchemaVersion>string</OutputSchemaVersion>
<Prefix>string</Prefix>
</S3BucketDestination>
</DataExport>
<Exclude>
<Buckets>
<Arn>string</Arn>
</Buckets>
<Regions>
<Region>string</Region>
</Regions>
</Exclude>
<Id>string</Id>
<Include>
<Buckets>
<Arn>string</Arn>
</Buckets>
<Regions>
<Region>string</Region>
</Regions>
</Include>
<IsEnabled>boolean</IsEnabled>
<StorageLensArn>string</StorageLensArn>
</StorageLensConfiguration>
<Tags>
<Tag>
<Key>string</Key>
<Value>string</Value>
</Tag>
</Tags>
</PutStorageLensConfigurationRequest>URI Request Parameters
The request uses the following URI parameters.
- storagelensid
-
The ID of the S3 Storage Lens configuration.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9\-\_\.]+Required: Yes
- x-amz-account-id
-
The account ID of the requester.
Length Constraints: Maximum length of 64.
Pattern:
^\d{12}$Required: Yes
Request Body
The request accepts the following data in XML format.
- PutStorageLensConfigurationRequest
-
Root level tag for the PutStorageLensConfigurationRequest parameters.
Required: Yes
- StorageLensConfiguration
-
The S3 Storage Lens configuration.
Type: StorageLensConfiguration data type
Required: Yes
- Tags
-
The tag set of the S3 Storage Lens configuration.
Note
You can set up to a maximum of 50 tags.
Type: Array of StorageLensTag data types
Required: No
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
