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

Syntax

Start-CRSProtectedQuery
-MembershipIdentifier <String>
-Member_AccountId <String>
-SqlParameters_AnalysisTemplateArn <String>
-S3_Bucket <String>
-S3_KeyPrefix <String>
-Distribute_Location <ProtectedQueryDistributeOutputConfigurationLocation[]>
-Worker_Number <Int32>
-SqlParameters_Parameter <Hashtable>
-SqlParameters_QueryString <String>
-S3_ResultFormat <ResultFormat>
-S3_SingleFileOutput <Boolean>
-Properties_Spark <Hashtable>
-Worker_Type <WorkerComputeType>
-Type <ProtectedQueryType>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonCleanRoomsConfig>

Description

Creates a protected query that is started by Clean Rooms.

Parameters

-ClientConfig <AmazonCleanRoomsConfig>
Amazon.PowerShell.Cmdlets.CRS.AmazonCleanRoomsClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Distribute_Location <ProtectedQueryDistributeOutputConfigurationLocation[]>
A list of locations where you want to distribute the protected query results. Each location must specify either an S3 destination or a collaboration member destination.You can't specify more than one S3 location.You can't specify the query runner's account as a member location.You must include either an S3 or member output configuration for each location, but not both. 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)
AliasesResultConfiguration_OutputConfiguration_Distribute_Locations
-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)
-Member_AccountId <String>
The unique identifier for the account.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResultConfiguration_OutputConfiguration_Member_AccountId
-MembershipIdentifier <String>
A unique identifier for the membership to run this query against. Currently accepts a membership ID.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Properties_Spark <Hashtable>
The Spark configuration properties for SQL workloads. This map contains key-value pairs that configure Apache Spark settings to optimize performance for your data processing jobs. You can specify up to 50 Spark properties, with each key being 1-200 characters and each value being 0-500 characters. These properties allow you to adjust compute capacity for large datasets and complex workloads. 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)
AliasesComputeConfiguration_Worker_Properties_Spark
-S3_Bucket <String>
The S3 bucket to unload the protected query results.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResultConfiguration_OutputConfiguration_S3_Bucket
-S3_KeyPrefix <String>
The S3 prefix to unload the protected query results.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResultConfiguration_OutputConfiguration_S3_KeyPrefix
-S3_ResultFormat <ResultFormat>
Intended file format of the result.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResultConfiguration_OutputConfiguration_S3_ResultFormat
-S3_SingleFileOutput <Boolean>
Indicates whether files should be output as a single file (TRUE) or output as multiple files (FALSE). This parameter is only supported for analyses with the Spark analytics engine.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResultConfiguration_OutputConfiguration_S3_SingleFileOutput
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ProtectedQuery'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CleanRooms.Model.StartProtectedQueryResponse). Specifying the name of a property of type Amazon.CleanRooms.Model.StartProtectedQueryResponse 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)
-SqlParameters_AnalysisTemplateArn <String>
The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SqlParameters_Parameter <Hashtable>
The protected query SQL parameters. 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)
AliasesSqlParameters_Parameters
-SqlParameters_QueryString <String>
The query string to be submitted.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Type <ProtectedQueryType>
The type of the protected query to be started.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Worker_Number <Int32>
The number of workers.SQL queries support a minimum value of 2 and a maximum value of 400. PySpark jobs support a minimum value of 4 and a maximum value of 128.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeConfiguration_Worker_Number
-Worker_Type <WorkerComputeType>
The worker compute configuration type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeConfiguration_Worker_Type

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.ProtectedQuery or Amazon.CleanRooms.Model.StartProtectedQueryResponse
This cmdlet returns an Amazon.CleanRooms.Model.ProtectedQuery object. The service call response (type Amazon.CleanRooms.Model.StartProtectedQueryResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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