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.
Start-ATHQueryExecution-QueryString <String>-QueryExecutionContext_Catalog <String>-ClientRequestToken <String>-QueryExecutionContext_Database <String>-EncryptionConfiguration_EncryptionOption <EncryptionOption>-ExecutionParameter <String[]>-ResultConfiguration_ExpectedBucketOwner <String>-EncryptionConfiguration_KmsKey <String>-ResultConfiguration_OutputLocation <String>-AclConfiguration_S3AclOption <S3AclOption>-WorkGroup <String>-Select <String>-PassThru <SwitchParameter>-Force <SwitchParameter>
Query
. Requires you to have access to the workgroup in which the query ran. Running queries against an external catalog requires GetDataCatalog permission to the catalog. For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide. BUCKET_OWNER_FULL_CONTROL
. If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ResultConfiguration_AclConfiguration_S3AclOption |
StartQueryExecution
request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString
, an error is returned.Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
SSE_S3
), server-side encryption with KMS-managed keys (SSE_KMS
), or client-side encryption with KMS-managed keys (CSE_KMS
) is used.If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ResultConfiguration_EncryptionConfiguration_EncryptionOption |
SSE_KMS
and CSE_KMS
, this is the KMS key ARN or ID. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ResultConfiguration_EncryptionConfiguration_KmsKey |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ExecutionParameters |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
ExpectedBucketOwner
when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner
Amazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ExpectedBucketOwner
setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
s3://path/to/query/bucket/
. To run the query, you must specify the query results location using one of the ways: either for individual queries using either this setting (client-side), or in the workgroup, using WorkGroupConfiguration. If none of them is set, Athena issues an error that no output location is provided. For more information, see Query Results. If workgroup settings override client-side settings, then the query uses the settings specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AK |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AWSProfilesLocation, ProfilesLocation |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | StoredCredentials, AWSProfileName |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RegionToCall |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SK, SecretAccessKey |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ST |
AWS Tools for PowerShell: 2.x.y.z