S3Control / Client / get_storage_lens_group

get_storage_lens_group#

S3Control.Client.get_storage_lens_group(**kwargs)#

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

response = client.get_storage_lens_group(
    Name='string',
    AccountId='string'
)

Parameters:

Name (string) –
[REQUIRED]

The name of the Storage Lens group that you’re trying to retrieve the configuration details for.
AccountId (string) –
[REQUIRED]

The Amazon Web Services account ID associated with the Storage Lens group that you’re trying to retrieve the details for.

Return type:

dict

Returns:

Response Syntax

{
    'StorageLensGroup': {
        'Name': 'string',
        'Filter': {
            'MatchAnyPrefix': [
                'string',
            ],
            'MatchAnySuffix': [
                'string',
            ],
            'MatchAnyTag': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'MatchObjectAge': {
                'DaysGreaterThan': 123,
                'DaysLessThan': 123
            },
            'MatchObjectSize': {
                'BytesGreaterThan': 123,
                'BytesLessThan': 123
            },
            'And': {
                'MatchAnyPrefix': [
                    'string',
                ],
                'MatchAnySuffix': [
                    'string',
                ],
                'MatchAnyTag': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'MatchObjectAge': {
                    'DaysGreaterThan': 123,
                    'DaysLessThan': 123
                },
                'MatchObjectSize': {
                    'BytesGreaterThan': 123,
                    'BytesLessThan': 123
                }
            },
            'Or': {
                'MatchAnyPrefix': [
                    'string',
                ],
                'MatchAnySuffix': [
                    'string',
                ],
                'MatchAnyTag': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'MatchObjectAge': {
                    'DaysGreaterThan': 123,
                    'DaysLessThan': 123
                },
                'MatchObjectSize': {
                    'BytesGreaterThan': 123,
                    'BytesLessThan': 123
                }
            }
        },
        'StorageLensGroupArn': 'string'
    }
}

Response Structure

(dict) –
- StorageLensGroup (dict) –
  
  The name of the Storage Lens group that you’re trying to retrieve the configuration details for.
  - Name (string) –
    
    Contains the name of the Storage Lens group.
  - Filter (dict) –
    
    Sets the criteria for the Storage Lens group data that is displayed. For multiple filter conditions, the AND or OR logical operator is used.
    - MatchAnyPrefix (list) –
      
      Contains a list of prefixes. At least one prefix must be specified. Up to 10 prefixes are allowed.
      - (string) –
    - MatchAnySuffix (list) –
      
      Contains a list of suffixes. At least one suffix must be specified. Up to 10 suffixes are allowed.
      - (string) –
    - MatchAnyTag (list) –
      
      Contains the list of S3 object tags. At least one object tag must be specified. Up to 10 object tags are allowed.
      - (dict) –
        
        A container for a key-value name pair.
        
        Key (string) –
        
        Key of the tag
        
        Value (string) –
        
        Value of the tag
    - MatchObjectAge (dict) –
      
      Contains DaysGreaterThan and DaysLessThan to define the object age range (minimum and maximum number of days).
      - DaysGreaterThan (integer) –
        
        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.
      - DaysLessThan (integer) –
        
        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.
    - MatchObjectSize (dict) –
      
      Contains BytesGreaterThan and BytesLessThan to define the object size range (minimum and maximum number of Bytes).
      - BytesGreaterThan (integer) –
        
        Specifies the minimum object size in Bytes. The value must be a positive number, greater than 0 and less than 5 TB.
      - BytesLessThan (integer) –
        
        Specifies the maximum object size in Bytes. The value must be a positive number, greater than the minimum object size and less than 5 TB.
    - And (dict) –
      
      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.
      - MatchAnyPrefix (list) –
        
        Contains a list of prefixes. At least one prefix must be specified. Up to 10 prefixes are allowed.
        
        (string) –
      - MatchAnySuffix (list) –
        
        Contains a list of suffixes. At least one suffix must be specified. Up to 10 suffixes are allowed.
        
        (string) –
      - MatchAnyTag (list) –
        
        Contains the list of object tags. At least one object tag must be specified. Up to 10 object tags are allowed.
        
        (dict) –
        
        A container for a key-value name pair.
        
        Key (string) –
        
        Key of the tag
        
        Value (string) –
        
        Value of the tag
      - MatchObjectAge (dict) –
        
        Contains DaysGreaterThan and DaysLessThan to define the object age range (minimum and maximum number of days).
        
        DaysGreaterThan (integer) –
        
        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.
        
        DaysLessThan (integer) –
        
        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.
      - MatchObjectSize (dict) –
        
        Contains BytesGreaterThan and BytesLessThan to define the object size range (minimum and maximum number of Bytes).
        
        BytesGreaterThan (integer) –
        
        Specifies the minimum object size in Bytes. The value must be a positive number, greater than 0 and less than 5 TB.
        
        BytesLessThan (integer) –
        
        Specifies the maximum object size in Bytes. The value must be a positive number, greater than the minimum object size and less than 5 TB.
    - Or (dict) –
      
      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.
      - MatchAnyPrefix (list) –
        
        Filters objects that match any of the specified prefixes.
        
        (string) –
      - MatchAnySuffix (list) –
        
        Filters objects that match any of the specified suffixes.
        
        (string) –
      - MatchAnyTag (list) –
        
        Filters objects that match any of the specified S3 object tags.
        
        (dict) –
        
        A container for a key-value name pair.
        
        Key (string) –
        
        Key of the tag
        
        Value (string) –
        
        Value of the tag
      - MatchObjectAge (dict) –
        
        Filters objects that match the specified object age range.
        
        DaysGreaterThan (integer) –
        
        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.
        
        DaysLessThan (integer) –
        
        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.
      - MatchObjectSize (dict) –
        
        Filters objects that match the specified object size range.
        
        BytesGreaterThan (integer) –
        
        Specifies the minimum object size in Bytes. The value must be a positive number, greater than 0 and less than 5 TB.
        
        BytesLessThan (integer) –
        
        Specifies the maximum object size in Bytes. The value must be a positive number, greater than the minimum object size and less than 5 TB.
  - StorageLensGroupArn (string) –
    
    Contains the Amazon Resource Name (ARN) of the Storage Lens group. This property is read-only.