S3Control / Client / list_storage_lens_groups

list_storage_lens_groups#

S3Control.Client.list_storage_lens_groups(**kwargs)#

Lists all the Storage Lens groups in the specified home Region.

To use this operation, you must have the permission to perform the s3:ListStorageLensGroups 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.

See also: AWS API Documentation

Request Syntax

response = client.list_storage_lens_groups(
    AccountId='string',
    NextToken='string'
)
Parameters:

  • AccountId (string) –

    [REQUIRED]

    The Amazon Web Services account ID that owns the Storage Lens groups.

  • NextToken (string) – The token for the next set of results, or null if there are no more results.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'StorageLensGroupList': [
        {
            'Name': 'string',
            'StorageLensGroupArn': 'string',
            'HomeRegion': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      If NextToken is returned, there are more Storage Lens groups results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

    • StorageLensGroupList (list) –

      The list of Storage Lens groups that exist in the specified home Region.

      • (dict) –

        Each entry contains a Storage Lens group that exists in the specified home Region.

        • Name (string) –

          Contains the name of the Storage Lens group that exists in the specified home Region.

        • StorageLensGroupArn (string) –

          Contains the Amazon Resource Name (ARN) of the Storage Lens group. This property is read-only.

        • HomeRegion (string) –

          Contains the Amazon Web Services Region where the Storage Lens group was created.