AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon S3 Control PutStorageLensConfiguration API operation.

Syntax

Write-S3CStorageLensConfiguration
-AccountId <String>
-S3BucketDestination_AccountId <String>
-AwsOrg_Arn <String>
-S3BucketDestination_Arn <String>
-Exclude_Bucket <String[]>
-Include_Bucket <String[]>
-ConfigId <String>
-SelectionCriteria_Delimiter <String>
-SelectionCriteria_Exclude <String[]>
-S3BucketDestination_Format <Format>
-StorageLensConfiguration_Id <String>
-SelectionCriteria_Include <String[]>
-StorageLensConfiguration_AccountLevel_ActivityMetrics_IsEnabled <Boolean>
-StorageLensConfiguration_AccountLevel_AdvancedCostOptimizationMetrics_IsEnabled <Boolean>
-StorageLensConfiguration_AccountLevel_AdvancedDataProtectionMetrics_IsEnabled <Boolean>
-StorageLensConfiguration_BucketLevel_ActivityMetrics_IsEnabled <Boolean>
-StorageLensConfiguration_BucketLevel_AdvancedCostOptimizationMetrics_IsEnabled <Boolean>
-StorageLensConfiguration_BucketLevel_AdvancedDataProtectionMetrics_IsEnabled <Boolean>
-StorageLensConfiguration_BucketLevel_DetailedStatusCodesMetrics_IsEnabled <Boolean>
-StorageMetrics_IsEnabled <Boolean>
-StorageLensConfiguration_AccountLevel_DetailedStatusCodesMetrics_IsEnabled <Boolean>
-CloudWatchMetrics_IsEnabled <Boolean>
-StorageLensConfiguration_IsEnabled <Boolean>
-SSEKMS_KeyId <String>
-SelectionCriteria_MaxDepth <Int32>
-SelectionCriteria_MinStorageBytesPercentage <Double>
-S3BucketDestination_OutputSchemaVersion <OutputSchemaVersion>
-S3BucketDestination_Prefix <String>
-Exclude_Region <String[]>
-Include_Region <String[]>
-Encryption_SSES3 <SSES3>
-StorageLensConfiguration_StorageLensArn <String>
-Tag <StorageLensTag[]>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonS3ControlConfig>

Description

This operation is not supported by directory buckets. 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. 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:PutStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide. You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

Parameters

-AccountId <String>
The account ID of the requester.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-AwsOrg_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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageLensConfiguration_AwsOrg_Arn
-ClientConfig <AmazonS3ControlConfig>
Amazon.PowerShell.Cmdlets.S3C.AmazonS3ControlClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CloudWatchMetrics_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageLensConfiguration_DataExport_CloudWatchMetrics_IsEnabled
-ConfigId <String>
The ID of the S3 Storage Lens configuration.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Encryption_SSES3 <SSES3>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageLensConfiguration_DataExport_S3BucketDestination_Encryption_SSES3
-Exclude_Bucket <String[]>
A container for the S3 Storage Lens bucket excludes. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageLensConfiguration_Exclude_Buckets
-Exclude_Region <String[]>
A container for the S3 Storage Lens Region excludes. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageLensConfiguration_Exclude_Regions
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Include_Bucket <String[]>
A container for the S3 Storage Lens bucket includes. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageLensConfiguration_Include_Buckets
-Include_Region <String[]>
A container for the S3 Storage Lens Region includes. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageLensConfiguration_Include_Regions
-S3BucketDestination_AccountId <String>
The account ID of the owner of the S3 Storage Lens metrics export bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageLensConfiguration_DataExport_S3BucketDestination_AccountId
-S3BucketDestination_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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageLensConfiguration_DataExport_S3BucketDestination_Arn
-S3BucketDestination_Format <Format>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageLensConfiguration_DataExport_S3BucketDestination_Format
-S3BucketDestination_OutputSchemaVersion <OutputSchemaVersion>
The schema version of the export file.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageLensConfiguration_DataExport_S3BucketDestination_OutputSchemaVersion
-S3BucketDestination_Prefix <String>
The prefix of the destination bucket where the metrics export will be delivered.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageLensConfiguration_DataExport_S3BucketDestination_Prefix
-Select <String>
Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.S3Control.Model.PutStorageLensConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SelectionCriteria_Delimiter <String>
A container for the delimiter of the selection criteria being used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageLensConfiguration_AccountLevel_BucketLevel_PrefixLevel_StorageMetrics_SelectionCriteria_Delimiter
-SelectionCriteria_Exclude <String[]>
Indicates which Storage Lens group ARNs to exclude from the Storage Lens group aggregation. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageLensConfiguration_AccountLevel_StorageLensGroupLevel_SelectionCriteria_Exclude
-SelectionCriteria_Include <String[]>
Indicates which Storage Lens group ARNs to include in the Storage Lens group aggregation. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageLensConfiguration_AccountLevel_StorageLensGroupLevel_SelectionCriteria_Include
-SelectionCriteria_MaxDepth <Int32>
The max depth of the selection criteria
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageLensConfiguration_AccountLevel_BucketLevel_PrefixLevel_StorageMetrics_SelectionCriteria_MaxDepth
-SelectionCriteria_MinStorageBytesPercentage <Double>
The minimum number of storage bytes percentage whose metrics will be selected.You must choose a value greater than or equal to 1.0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageLensConfiguration_AccountLevel_BucketLevel_PrefixLevel_StorageMetrics_SelectionCriteria_MinStorageBytesPercentage
-SSEKMS_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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageLensConfiguration_DataExport_S3BucketDestination_Encryption_SSEKMS_KeyId
-StorageLensConfiguration_AccountLevel_ActivityMetrics_IsEnabled <Boolean>
A container that indicates whether activity metrics are enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensConfiguration_AccountLevel_AdvancedCostOptimizationMetrics_IsEnabled <Boolean>
A container that indicates whether advanced cost-optimization metrics are enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensConfiguration_AccountLevel_AdvancedDataProtectionMetrics_IsEnabled <Boolean>
A container that indicates whether advanced data-protection metrics are enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensConfiguration_AccountLevel_DetailedStatusCodesMetrics_IsEnabled <Boolean>
A container that indicates whether detailed status code metrics are enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensConfiguration_BucketLevel_ActivityMetrics_IsEnabled <Boolean>
A container that indicates whether activity metrics are enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageLensConfiguration_AccountLevel_BucketLevel_ActivityMetrics_IsEnabled
-StorageLensConfiguration_BucketLevel_AdvancedCostOptimizationMetrics_IsEnabled <Boolean>
A container that indicates whether advanced cost-optimization metrics are enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageLensConfiguration_AccountLevel_BucketLevel_AdvancedCostOptimizationMetrics_IsEnabled
-StorageLensConfiguration_BucketLevel_AdvancedDataProtectionMetrics_IsEnabled <Boolean>
A container that indicates whether advanced data-protection metrics are enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageLensConfiguration_AccountLevel_BucketLevel_AdvancedDataProtectionMetrics_IsEnabled
-StorageLensConfiguration_BucketLevel_DetailedStatusCodesMetrics_IsEnabled <Boolean>
A container that indicates whether detailed status code metrics are enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageLensConfiguration_AccountLevel_BucketLevel_DetailedStatusCodesMetrics_IsEnabled
-StorageLensConfiguration_Id <String>
A container for the Amazon S3 Storage Lens configuration ID.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensConfiguration_IsEnabled <Boolean>
A container for whether the S3 Storage Lens configuration is enabled.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensConfiguration_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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageMetrics_IsEnabled <Boolean>
A container for whether prefix-level storage metrics are enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageLensConfiguration_AccountLevel_BucketLevel_PrefixLevel_StorageMetrics_IsEnabled
-Tag <StorageLensTag[]>
The tag set of the S3 Storage Lens configuration.You can set up to a maximum of 50 tags. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

None or Amazon.S3Control.Model.PutStorageLensConfigurationResponse
This cmdlet does not generate any output.The service response (type Amazon.S3Control.Model.PutStorageLensConfigurationResponse) be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z