put-storage-lens-configuration¶

Description¶

Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon S3 User Guide .

Note

To use this action, you must have permission to perform the s3:PutStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide .

Synopsis¶

  put-storage-lens-configuration
--config-id <value>
--account-id <value>
--storage-lens-configuration <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--config-id (string)

The ID of the S3 Storage Lens configuration.

--account-id (string)

The account ID of the requester.

--storage-lens-configuration (structure)

The S3 Storage Lens configuration.

Id -> (string)

A container for the Amazon S3 Storage Lens configuration ID.

AccountLevel -> (structure)

A container for all the account-level configurations of your S3 Storage Lens configuration.

ActivityMetrics -> (structure)

A container for the S3 Storage Lens activity metrics.

IsEnabled -> (boolean)

A container for whether the activity metrics are enabled.

BucketLevel -> (structure)

A container for the S3 Storage Lens bucket-level configuration.

ActivityMetrics -> (structure)

A container for the bucket-level activity metrics for Amazon S3 Storage Lens

IsEnabled -> (boolean)

A container for whether the activity metrics are enabled.

PrefixLevel -> (structure)

A container for the bucket-level prefix-level metrics for S3 Storage Lens

StorageMetrics -> (structure)

A container for the prefix-level storage metrics for S3 Storage Lens.

IsEnabled -> (boolean)

A container for whether prefix-level storage metrics are enabled.

SelectionCriteria -> (structure)

Delimiter -> (string)

A container for the delimiter of the selection criteria being used.

MaxDepth -> (integer)

The max depth of the selection criteria

MinStorageBytesPercentage -> (double)

The minimum number of storage bytes percentage whose metrics will be selected.

Note

You must choose a value greater than or equal to 1.0 .

Include -> (structure)

A container for what is included in this configuration. This container can only be valid if there is no Exclude container submitted, and it’s not empty.

Buckets -> (list)

A container for the S3 Storage Lens bucket includes.

(string)

Regions -> (list)

A container for the S3 Storage Lens Region includes.

(string)

Exclude -> (structure)

A container for what is excluded in this configuration. This container can only be valid if there is no Include container submitted, and it’s not empty.

Buckets -> (list)

A container for the S3 Storage Lens bucket excludes.

(string)

Regions -> (list)

A container for the S3 Storage Lens Region excludes.

(string)

DataExport -> (structure)

A container to specify the properties of your S3 Storage Lens metrics export including, the destination, schema and format.

S3BucketDestination -> (structure)

A container for the bucket where the S3 Storage Lens metrics export will be located.

Note

This bucket must be located in the same Region as the storage lens configuration.

Format -> (string)

OutputSchemaVersion -> (string)

The schema version of the export file.

AccountId -> (string)

The account ID of the owner of the S3 Storage Lens metrics export bucket.

Arn -> (string)

The Amazon Resource Name (ARN) of the bucket. This property is read-only and follows the following format: ``arn:aws:s3:us-east-1 :example-account-id :bucket/your-destination-bucket-name ``

Prefix -> (string)

The prefix of the destination bucket where the metrics export will be delivered.

Encryption -> (structure)

The container for the type encryption of the metrics exports in this bucket.

SSES3 -> (structure)

SSEKMS -> (structure)

KeyId -> (string)

A container for the ARN of the SSE-KMS encryption. This property is read-only and follows the following format: ``arn:aws:kms:us-east-1 :example-account-id :key/example-9a73-4afc-8d29-8f5900cef44e ``

CloudWatchMetrics -> (structure)

A container for enabling Amazon CloudWatch publishing for S3 Storage Lens metrics.

IsEnabled -> (boolean)

A container that indicates whether CloudWatch publishing for S3 Storage Lens metrics is enabled. A value of true indicates that CloudWatch publishing for S3 Storage Lens metrics is enabled.

IsEnabled -> (boolean)

A container for whether the S3 Storage Lens configuration is enabled.

AwsOrg -> (structure)

A container for the Amazon Web Services organization for this S3 Storage Lens configuration.

Arn -> (string)

A container for the Amazon Resource Name (ARN) of the Amazon Web Services organization. This property is read-only and follows the following format: ``arn:aws:organizations:us-east-1 :example-account-id :organization/o-ex2l495dck ``

StorageLensArn -> (string)

The Amazon Resource Name (ARN) of the S3 Storage Lens configuration. This property is read-only and follows the following format: ``arn:aws:s3:us-east-1 :example-account-id :storage-lens/your-dashboard-name ``

JSON Syntax:

{
  "Id": "string",
  "AccountLevel": {
    "ActivityMetrics": {
      "IsEnabled": true|false
    },
    "BucketLevel": {
      "ActivityMetrics": {
        "IsEnabled": true|false
      },
      "PrefixLevel": {
        "StorageMetrics": {
          "IsEnabled": true|false,
          "SelectionCriteria": {
            "Delimiter": "string",
            "MaxDepth": integer,
            "MinStorageBytesPercentage": double
          }
        }
      }
    }
  },
  "Include": {
    "Buckets": ["string", ...],
    "Regions": ["string", ...]
  },
  "Exclude": {
    "Buckets": ["string", ...],
    "Regions": ["string", ...]
  },
  "DataExport": {
    "S3BucketDestination": {
      "Format": "CSV"|"Parquet",
      "OutputSchemaVersion": "V_1",
      "AccountId": "string",
      "Arn": "string",
      "Prefix": "string",
      "Encryption": {
        "SSES3": {

        },
        "SSEKMS": {
          "KeyId": "string"
        }
      }
    },
    "CloudWatchMetrics": {
      "IsEnabled": true|false
    }
  },
  "IsEnabled": true|false,
  "AwsOrg": {
    "Arn": "string"
  },
  "StorageLensArn": "string"
}

--tags (list)

The tag set of the S3 Storage Lens configuration.

Note

You can set up to a maximum of 50 tags.

(structure)

Key -> (string)

Value -> (string)

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output¶

None

Table of Contents

Feedback

User Guide