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

Syntax

Update-CRSIntermediateTableAnalysisRule
-AnalysisRulePolicy_V1_Custom_AdditionalAnalyses <AdditionalAnalyses>
-AnalysisRulePolicy_V1_Custom_AggregationThreshold <AggregationThreshold[]>
-AnalysisRulePolicy_V1_Custom_AllowedAdditionalAnalyses <String[]>
-AnalysisRulePolicy_V1_Custom_AllowedAnalyses <String[]>
-AnalysisRulePolicy_V1_Custom_AllowedAnalysisProvider <String[]>
-AnalysisRulePolicy_V1_Custom_ComparisonControls_AllowedColumnComparisonColumn <String[]>
-AnalysisRulePolicy_V1_Custom_ComparisonControls_AllowedLiteralComparisonColumn <String[]>
-AnalysisRulePolicy_V1_Custom_AllowedResultReceiver <String[]>
-AnalysisRuleType <IntermediateTableAnalysisRuleType>
-AnalysisRulePolicy_V1_Custom_DifferentialPrivacy_Column <DifferentialPrivacyColumn[]>
-AnalysisRulePolicy_V1_Custom_DisallowedOutputColumn <String[]>
-IntermediateTableIdentifier <String>
-MembershipIdentifier <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonCleanRoomsConfig>

Description

Updates the analysis rule policy for an intermediate table. Only the intermediate table owner can call this operation.

Parameters

-AnalysisRulePolicy_V1_Custom_AdditionalAnalyses <AdditionalAnalyses>
The setting that controls whether additional analyses are allowed on the intermediate table.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AnalysisRulePolicy_V1_Custom_AggregationThreshold <AggregationThreshold[]>
The aggregation thresholds that each query output group must satisfy. Clean Rooms filters out any group that represents fewer than the specified number of distinct identities. You can specify at most one threshold. You can't use aggregation thresholds with differential privacy, or when allowedAnalyses allows only jobs. 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)
AliasesAnalysisRulePolicy_V1_Custom_AggregationThresholds
-AnalysisRulePolicy_V1_Custom_AllowedAdditionalAnalyses <String[]>
The list of allowed additional analyses for the intermediate table. 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)
-AnalysisRulePolicy_V1_Custom_AllowedAnalyses <String[]>
The list of allowed analyses that can be performed on the intermediate table. 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)
-AnalysisRulePolicy_V1_Custom_AllowedAnalysisProvider <String[]>
The list of Amazon Web Services account IDs for the allowed analysis providers. 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)
AliasesAnalysisRulePolicy_V1_Custom_AllowedAnalysisProviders
-AnalysisRulePolicy_V1_Custom_AllowedResultReceiver <String[]>
The list of Amazon Web Services account IDs that are allowed to receive results from queries run on the intermediate table. 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)
AliasesAnalysisRulePolicy_V1_Custom_AllowedResultReceivers
-AnalysisRulePolicy_V1_Custom_ComparisonControls_AllowedColumnComparisonColumn <String[]>
The columns that a query can compare to another column, for example, in a join, a WHERE clause, a GROUP BY clause, or a window function. Clean Rooms rejects a query that uses any other column in a column-to-column comparison. Specify an empty list to block column-to-column comparison on every column. 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)
AliasesAnalysisRulePolicy_V1_Custom_ComparisonControls_AllowedColumnComparisonColumns
-AnalysisRulePolicy_V1_Custom_ComparisonControls_AllowedLiteralComparisonColumn <String[]>
The columns that a query can compare to literal values, for example, in a WHERE clause. Clean Rooms rejects a query that compares any other column to a literal value. Specify an empty list to block literal comparison on every column. You can't specify a column that you also use as an identity column in an aggregation threshold. 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)
AliasesAnalysisRulePolicy_V1_Custom_ComparisonControls_AllowedLiteralComparisonColumns
-AnalysisRulePolicy_V1_Custom_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. 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)
AliasesAnalysisRulePolicy_V1_Custom_DifferentialPrivacy_Columns
-AnalysisRulePolicy_V1_Custom_DisallowedOutputColumn <String[]>
The list of columns that are not allowed in the query output. 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)
AliasesAnalysisRulePolicy_V1_Custom_DisallowedOutputColumns
-AnalysisRuleType <IntermediateTableAnalysisRuleType>
The type of analysis rule to update. Currently, only CUSTOM is supported.
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)
-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)
-IntermediateTableIdentifier <String>
The unique identifier of the intermediate table for which to update the analysis rule.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-MembershipIdentifier <String>
The unique identifier of the membership that contains the intermediate table.
Required?True
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.UpdateIntermediateTableAnalysisRuleResponse). Specifying the name of a property of type Amazon.CleanRooms.Model.UpdateIntermediateTableAnalysisRuleResponse 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.IntermediateTableAnalysisRule or Amazon.CleanRooms.Model.UpdateIntermediateTableAnalysisRuleResponse
This cmdlet returns an Amazon.CleanRooms.Model.IntermediateTableAnalysisRule object. The service call response (type Amazon.CleanRooms.Model.UpdateIntermediateTableAnalysisRuleResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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