S3Control / Client / create_storage_lens_group

create_storage_lens_group#

S3Control.Client.create_storage_lens_group(**kwargs)#

Creates a new S3 Storage Lens group and associates it with the specified Amazon Web Services account ID. An S3 Storage Lens group is a custom grouping of objects based on prefix, suffix, object tags, object size, object age, or a combination of these filters. For each Storage Lens group that you’ve created, you can also optionally add Amazon Web Services resource tags. For more information about S3 Storage Lens groups, see Working with S3 Storage Lens groups.

To use this operation, you must have the permission to perform the s3:CreateStorageLensGroup action. If you’re trying to create a Storage Lens group with Amazon Web Services resource tags, you must also have permission to perform the s3:TagResource 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.create_storage_lens_group(
    AccountId='string',
    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'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

AccountId (string) –
[REQUIRED]

The Amazon Web Services account ID that the Storage Lens group is created from and associated with.
StorageLensGroup (dict) –
[REQUIRED]

The Storage Lens group configuration.
- Name (string) – [REQUIRED]
  
  Contains the name of the Storage Lens group.
- Filter (dict) – [REQUIRED]
  
  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) – [REQUIRED]
        
        Key of the tag
      - Value (string) – [REQUIRED]
        
        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) – [REQUIRED]
        
        Key of the tag
        
        Value (string) – [REQUIRED]
        
        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) – [REQUIRED]
        
        Key of the tag
        
        Value (string) – [REQUIRED]
        
        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.
Tags (list) –
The Amazon Web Services resource tags that you’re adding to your Storage Lens group. This parameter is optional.
- (dict) –
  
  An Amazon Web Services resource tag that’s associated with your S3 resource. You can add tags to new objects when you upload them, or you can add object tags to existing objects.
  
  Note
  This operation is only supported for S3 Storage Lens groups and for S3 Access Grants. The tagged resource can be an S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.
  - Key (string) – [REQUIRED]
    
    The key of the key-value pair of a tag added to your Amazon Web Services 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.
  - Value (string) – [REQUIRED]
    
    The value of the key-value pair of a tag added to your Amazon Web Services resource. A tag value can be up to 256 Unicode characters in length and is case-sensitive.

Returns:

None