GetStorageLensGroup
Retrieves the Storage Lens group configuration details.
To use this operation, you must have the permission to perform the
s3:GetStorageLensGroup action. For more information about the required Storage Lens
Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
For information about Storage Lens groups errors, see List of Amazon S3 Storage Lens error codes.
Request Syntax
GET /v20180820/storagelensgroup/name HTTP/1.1
Host: s3-control.amazonaws.com
x-amz-account-id: AccountId
URI Request Parameters
The request uses the following URI parameters.
- name
-
The name of the Storage Lens group that you're trying to retrieve the configuration details for.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9\-\_]+Required: Yes
- x-amz-account-id
-
The AWS account ID associated with the Storage Lens group that you're trying to retrieve the details for.
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"?>
<StorageLensGroup>
<Name>string</Name>
<Filter>
<And>
<MatchAnyPrefix>
<Prefix>string</Prefix>
</MatchAnyPrefix>
<MatchAnySuffix>
<Suffix>string</Suffix>
</MatchAnySuffix>
<MatchAnyTag>
<Tag>
<Key>string</Key>
<Value>string</Value>
</Tag>
</MatchAnyTag>
<MatchObjectAge>
<DaysGreaterThan>integer</DaysGreaterThan>
<DaysLessThan>integer</DaysLessThan>
</MatchObjectAge>
<MatchObjectSize>
<BytesGreaterThan>long</BytesGreaterThan>
<BytesLessThan>long</BytesLessThan>
</MatchObjectSize>
</And>
<MatchAnyPrefix>
<Prefix>string</Prefix>
</MatchAnyPrefix>
<MatchAnySuffix>
<Suffix>string</Suffix>
</MatchAnySuffix>
<MatchAnyTag>
<Tag>
<Key>string</Key>
<Value>string</Value>
</Tag>
</MatchAnyTag>
<MatchObjectAge>
<DaysGreaterThan>integer</DaysGreaterThan>
<DaysLessThan>integer</DaysLessThan>
</MatchObjectAge>
<MatchObjectSize>
<BytesGreaterThan>long</BytesGreaterThan>
<BytesLessThan>long</BytesLessThan>
</MatchObjectSize>
<Or>
<MatchAnyPrefix>
<Prefix>string</Prefix>
</MatchAnyPrefix>
<MatchAnySuffix>
<Suffix>string</Suffix>
</MatchAnySuffix>
<MatchAnyTag>
<Tag>
<Key>string</Key>
<Value>string</Value>
</Tag>
</MatchAnyTag>
<MatchObjectAge>
<DaysGreaterThan>integer</DaysGreaterThan>
<DaysLessThan>integer</DaysLessThan>
</MatchObjectAge>
<MatchObjectSize>
<BytesGreaterThan>long</BytesGreaterThan>
<BytesLessThan>long</BytesLessThan>
</MatchObjectSize>
</Or>
</Filter>
<StorageLensGroupArn>string</StorageLensGroupArn>
</StorageLensGroup>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.
- StorageLensGroup
-
Root level tag for the StorageLensGroup parameters.
Required: Yes
- Filter
-
Sets the criteria for the Storage Lens group data that is displayed. For multiple filter conditions, the
ANDorORlogical operator is used.Type: StorageLensGroupFilter data type
- Name
-
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\-\_]+ - StorageLensGroupArn
-
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\/.*
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
