GetStorageLensConfiguration
Note
This operation is not supported by directory buckets.
Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage activity and usage 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:GetStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the
Amazon S3 User Guide.
Request Syntax
GET /v20180820/storagelens/storagelensid HTTP/1.1
Host: s3-control.amazonaws.com
x-amz-account-id: AccountId
URI Request Parameters
The request uses the following URI parameters.
- storagelensid
-
The ID of the Amazon 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 does not have a request body.
Response Syntax
HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<StorageLensConfiguration>
<Id>string</Id>
<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>
<Include>
<Buckets>
<Arn>string</Arn>
</Buckets>
<Regions>
<Region>string</Region>
</Regions>
</Include>
<Exclude>
<Buckets>
<Arn>string</Arn>
</Buckets>
<Regions>
<Region>string</Region>
</Regions>
</Exclude>
<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>
<IsEnabled>boolean</IsEnabled>
<AwsOrg>
<Arn>string</Arn>
</AwsOrg>
<StorageLensArn>string</StorageLensArn>
</StorageLensConfiguration>Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in XML format by the service.
- StorageLensConfiguration
-
Root level tag for the StorageLensConfiguration parameters.
Required: Yes
- AccountLevel
-
A container for all the account-level configurations of your S3 Storage Lens configuration.
Type: AccountLevel data type
- AwsOrg
-
A container for the AWS organization for this S3 Storage Lens configuration.
Type: StorageLensAwsOrg data type
- DataExport
-
A container to specify the properties of your S3 Storage Lens metrics export including, the destination, schema and format.
Type: StorageLensDataExport data type
- Exclude
-
A container for what is excluded in this configuration. This container can only be valid if there is no
Includecontainer submitted, and it's not empty.Type: Exclude data type
- Id
-
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\-\_\.]+ - Include
-
A container for what is included in this configuration. This container can only be valid if there is no
Excludecontainer submitted, and it's not empty.Type: Include data type
- IsEnabled
-
A container for whether the S3 Storage Lens configuration is enabled.
Type: Boolean
- StorageLensArn
-
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-nameType: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
arn:[a-z\-]+:s3:[a-z0-9\-]+:\d{12}:storage\-lens\/.*
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
