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 CreateStorageLensGroup API operation.

Syntax

New-S3CStorageLensGroup
-AccountId <String>
-StorageLensGroup_Filter_And_MatchObjectSize_BytesGreaterThan <Int64>
-StorageLensGroup_Filter_MatchObjectSize_BytesGreaterThan <Int64>
-StorageLensGroup_Filter_Or_MatchObjectSize_BytesGreaterThan <Int64>
-StorageLensGroup_Filter_And_MatchObjectSize_BytesLessThan <Int64>
-StorageLensGroup_Filter_MatchObjectSize_BytesLessThan <Int64>
-StorageLensGroup_Filter_Or_MatchObjectSize_BytesLessThan <Int64>
-StorageLensGroup_Filter_And_MatchObjectAge_DaysGreaterThan <Int32>
-StorageLensGroup_Filter_MatchObjectAge_DaysGreaterThan <Int32>
-StorageLensGroup_Filter_Or_MatchObjectAge_DaysGreaterThan <Int32>
-StorageLensGroup_Filter_And_MatchObjectAge_DaysLessThan <Int32>
-StorageLensGroup_Filter_MatchObjectAge_DaysLessThan <Int32>
-StorageLensGroup_Filter_Or_MatchObjectAge_DaysLessThan <Int32>
-StorageLensGroup_Filter_And_MatchAnyPrefix <String[]>
-StorageLensGroup_Filter_MatchAnyPrefix <String[]>
-StorageLensGroup_Filter_Or_MatchAnyPrefix <String[]>
-StorageLensGroup_Filter_And_MatchAnySuffix <String[]>
-StorageLensGroup_Filter_MatchAnySuffix <String[]>
-StorageLensGroup_Filter_Or_MatchAnySuffix <String[]>
-StorageLensGroup_Filter_And_MatchAnyTag <S3Tag[]>
-StorageLensGroup_Filter_MatchAnyTag <S3Tag[]>
-StorageLensGroup_Filter_Or_MatchAnyTag <S3Tag[]>
-StorageLensGroup_Name <String>
-StorageLensGroup_StorageLensGroupArn <String>
-Tag <Tag[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonS3ControlConfig>

Description

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. 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 Amazon Web Services account ID that the Storage Lens group is created from and associated with.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ClientConfig <AmazonS3ControlConfig>
Amazon.PowerShell.Cmdlets.S3C.AmazonS3ControlClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the AccountId parameter. The -PassThru parameter is deprecated, use -Select '^AccountId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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.CreateStorageLensGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensGroup_Filter_And_MatchAnyPrefix <String[]>
Contains a list of prefixes. At least one prefix must be specified. Up to 10 prefixes are allowed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensGroup_Filter_And_MatchAnySuffix <String[]>
Contains a list of suffixes. At least one suffix must be specified. Up to 10 suffixes are allowed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensGroup_Filter_And_MatchAnyTag <S3Tag[]>
Contains the list of object tags. At least one object tag must be specified. Up to 10 object tags are allowed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensGroup_Filter_And_MatchObjectAge_DaysGreaterThan <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensGroup_Filter_And_MatchObjectAge_DaysLessThan <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensGroup_Filter_And_MatchObjectSize_BytesGreaterThan <Int64>
Specifies the minimum object size in Bytes. The value must be a positive number, greater than 0 and less than 5 TB.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensGroup_Filter_And_MatchObjectSize_BytesLessThan <Int64>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensGroup_Filter_MatchAnyPrefix <String[]>
Contains a list of prefixes. At least one prefix must be specified. Up to 10 prefixes are allowed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensGroup_Filter_MatchAnySuffix <String[]>
Contains a list of suffixes. At least one suffix must be specified. Up to 10 suffixes are allowed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensGroup_Filter_MatchAnyTag <S3Tag[]>
Contains the list of S3 object tags. At least one object tag must be specified. Up to 10 object tags are allowed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensGroup_Filter_MatchObjectAge_DaysGreaterThan <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensGroup_Filter_MatchObjectAge_DaysLessThan <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensGroup_Filter_MatchObjectSize_BytesGreaterThan <Int64>
Specifies the minimum object size in Bytes. The value must be a positive number, greater than 0 and less than 5 TB.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensGroup_Filter_MatchObjectSize_BytesLessThan <Int64>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensGroup_Filter_Or_MatchAnyPrefix <String[]>
Filters objects that match any of the specified prefixes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensGroup_Filter_Or_MatchAnySuffix <String[]>
Filters objects that match any of the specified suffixes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensGroup_Filter_Or_MatchAnyTag <S3Tag[]>
Filters objects that match any of the specified S3 object tags.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensGroup_Filter_Or_MatchObjectAge_DaysGreaterThan <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensGroup_Filter_Or_MatchObjectAge_DaysLessThan <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensGroup_Filter_Or_MatchObjectSize_BytesGreaterThan <Int64>
Specifies the minimum object size in Bytes. The value must be a positive number, greater than 0 and less than 5 TB.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensGroup_Filter_Or_MatchObjectSize_BytesLessThan <Int64>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensGroup_Name <String>
Contains the name of the Storage Lens group.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageLensGroup_StorageLensGroupArn <String>
Contains the Amazon Resource Name (ARN) of the Storage Lens group. This property is read-only.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
The Amazon Web Services resource tags that you're adding to your Storage Lens group. This parameter is optional.
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.CreateStorageLensGroupResponse
This cmdlet does not generate any output.The service response (type Amazon.S3Control.Model.CreateStorageLensGroupResponse) be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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