Get Storage Lens Configuration

s3control_get_storage_lens_configuration

R Documentation

This operation is not supported by directory buckets

Description

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.

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.

Usage

s3control_get_storage_lens_configuration(ConfigId, AccountId)

Arguments

ConfigId

[required] The ID of the Amazon S3 Storage Lens configuration.

AccountId

[required] The account ID of the requester.

Value

A list with the following syntax:

list(
  StorageLensConfiguration = list(
    Id = "string",
    AccountLevel = list(
      ActivityMetrics = list(
        IsEnabled = TRUE|FALSE
      ),
      BucketLevel = list(
        ActivityMetrics = list(
          IsEnabled = TRUE|FALSE
        ),
        PrefixLevel = list(
          StorageMetrics = list(
            IsEnabled = TRUE|FALSE,
            SelectionCriteria = list(
              Delimiter = "string",
              MaxDepth = 123,
              MinStorageBytesPercentage = 123.0
            )
          )
        ),
        AdvancedCostOptimizationMetrics = list(
          IsEnabled = TRUE|FALSE
        ),
        AdvancedDataProtectionMetrics = list(
          IsEnabled = TRUE|FALSE
        ),
        DetailedStatusCodesMetrics = list(
          IsEnabled = TRUE|FALSE
        )
      ),
      AdvancedCostOptimizationMetrics = list(
        IsEnabled = TRUE|FALSE
      ),
      AdvancedDataProtectionMetrics = list(
        IsEnabled = TRUE|FALSE
      ),
      DetailedStatusCodesMetrics = list(
        IsEnabled = TRUE|FALSE
      ),
      StorageLensGroupLevel = list(
        SelectionCriteria = list(
          Include = list(
            "string"
          ),
          Exclude = list(
            "string"
          )
        )
      )
    ),
    Include = list(
      Buckets = list(
        "string"
      ),
      Regions = list(
        "string"
      )
    ),
    Exclude = list(
      Buckets = list(
        "string"
      ),
      Regions = list(
        "string"
      )
    ),
    DataExport = list(
      S3BucketDestination = list(
        Format = "CSV"|"Parquet",
        OutputSchemaVersion = "V_1",
        AccountId = "string",
        Arn = "string",
        Prefix = "string",
        Encryption = list(
          SSES3 = list(),
          SSEKMS = list(
            KeyId = "string"
          )
        )
      ),
      CloudWatchMetrics = list(
        IsEnabled = TRUE|FALSE
      )
    ),
    IsEnabled = TRUE|FALSE,
    AwsOrg = list(
      Arn = "string"
    ),
    StorageLensArn = "string"
  )
)

Request syntax

svc$get_storage_lens_configuration(
  ConfigId = "string",
  AccountId = "string"
)