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 AWS Clean Rooms Service CreateConfiguredTableAnalysisRule API operation.

Syntax

New-CRSConfiguredTableAnalysisRule
-ConfiguredTableIdentifier <String>
-Aggregation_AggregateColumn <AggregateColumn[]>
-Custom_AllowedAnalysis <String[]>
-Custom_AllowedAnalysisProvider <String[]>
-Aggregation_AllowedJoinOperator <String[]>
-List_AllowedJoinOperator <String[]>
-AnalysisRuleType <ConfiguredTableAnalysisRuleType>
-DifferentialPrivacy_Column <DifferentialPrivacyColumn[]>
-Aggregation_DimensionColumn <String[]>
-Aggregation_JoinColumn <String[]>
-List_JoinColumn <String[]>
-Aggregation_JoinRequired <JoinRequiredOption>
-List_ListColumn <String[]>
-Aggregation_OutputConstraint <AggregationConstraint[]>
-Aggregation_ScalarFunction <String[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonCleanRoomsConfig>

Description

Creates a new analysis rule for a configured table. Currently, only one analysis rule can be created for a given configured table.

Parameters

-Aggregation_AggregateColumn <AggregateColumn[]>
The columns that query runners are allowed to use in aggregation queries.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAnalysisRulePolicy_V1_Aggregation_AggregateColumns
-Aggregation_AllowedJoinOperator <String[]>
Which logical operators (if any) are to be used in an INNER JOIN match condition. Default is AND.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAnalysisRulePolicy_V1_Aggregation_AllowedJoinOperators
-Aggregation_DimensionColumn <String[]>
The columns that query runners are allowed to select, group by, or filter by.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAnalysisRulePolicy_V1_Aggregation_DimensionColumns
-Aggregation_JoinColumn <String[]>
Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAnalysisRulePolicy_V1_Aggregation_JoinColumns
-Aggregation_JoinRequired <JoinRequiredOption>
Control that requires member who runs query to do a join with their configured table and/or other configured table in query.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAnalysisRulePolicy_V1_Aggregation_JoinRequired
-Aggregation_OutputConstraint <AggregationConstraint[]>
Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAnalysisRulePolicy_V1_Aggregation_OutputConstraints
-Aggregation_ScalarFunction <String[]>
Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAnalysisRulePolicy_V1_Aggregation_ScalarFunctions
-AnalysisRuleType <ConfiguredTableAnalysisRuleType>
The type of analysis rule.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonCleanRoomsConfig>
Amazon.PowerShell.Cmdlets.CRS.AmazonCleanRoomsClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConfiguredTableIdentifier <String>
The identifier for the configured table to create the analysis rule for. Currently accepts the configured table ID.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Custom_AllowedAnalysis <String[]>
The ARN of the analysis templates that are allowed by the custom analysis rule.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAnalysisRulePolicy_V1_Custom_AllowedAnalyses
-Custom_AllowedAnalysisProvider <String[]>
The IDs of the Amazon Web Services accounts that are allowed to query by the custom analysis rule. Required when allowedAnalyses is ANY_QUERY.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAnalysisRulePolicy_V1_Custom_AllowedAnalysisProviders
-DifferentialPrivacy_Column <DifferentialPrivacyColumn[]>
The name of the column (such as user_id) that contains the unique identifier of your users whose privacy you want to protect. If you want to turn on differential privacy for two or more tables in a collaboration, you must configure the same column as the user identifier column in both analysis rules.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAnalysisRulePolicy_V1_Custom_DifferentialPrivacy_Columns
-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)
-List_AllowedJoinOperator <String[]>
The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is AND.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAnalysisRulePolicy_V1_List_AllowedJoinOperators
-List_JoinColumn <String[]>
Columns that can be used to join a configured table with the table of the member who can query and other members' configured tables.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAnalysisRulePolicy_V1_List_JoinColumns
-List_ListColumn <String[]>
Columns that can be listed in the output.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAnalysisRulePolicy_V1_List_ListColumns
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ConfiguredTableIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^ConfiguredTableIdentifier' 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 default value is 'AnalysisRule'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CleanRooms.Model.CreateConfiguredTableAnalysisRuleResponse). Specifying the name of a property of type Amazon.CleanRooms.Model.CreateConfiguredTableAnalysisRuleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

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

Amazon.CleanRooms.Model.ConfiguredTableAnalysisRule or Amazon.CleanRooms.Model.CreateConfiguredTableAnalysisRuleResponse
This cmdlet returns an Amazon.CleanRooms.Model.ConfiguredTableAnalysisRule object. The service call response (type Amazon.CleanRooms.Model.CreateConfiguredTableAnalysisRuleResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

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