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.
Update-ATHWorkGroup-WorkGroup <String>-ConfigurationUpdates_AdditionalConfiguration <String>-ConfigurationUpdates_BytesScannedCutoffPerQuery <Int64>-Description <String>-EngineVersion_EffectiveEngineVersion <String>-ConfigurationUpdates_EnableMinimumEncryptionConfiguration <Boolean>-EncryptionConfiguration_EncryptionOption <EncryptionOption>-ConfigurationUpdates_EnforceWorkGroupConfiguration <Boolean>-ConfigurationUpdates_ExecutionRole <String>-ResultConfigurationUpdates_ExpectedBucketOwner <String>-CustomerContentEncryptionConfiguration_KmsKey <String>-EncryptionConfiguration_KmsKey <String>-ResultConfigurationUpdates_OutputLocation <String>-ConfigurationUpdates_PublishCloudWatchMetricsEnabled <Boolean>-ResultConfigurationUpdates_RemoveAclConfiguration <Boolean>-ConfigurationUpdates_RemoveBytesScannedCutoffPerQuery <Boolean>-ConfigurationUpdates_RemoveCustomerContentEncryptionConfiguration <Boolean>-ResultConfigurationUpdates_RemoveEncryptionConfiguration <Boolean>-ResultConfigurationUpdates_RemoveExpectedBucketOwner <Boolean>-ResultConfigurationUpdates_RemoveOutputLocation <Boolean>-ConfigurationUpdates_RequesterPaysEnabled <Boolean>-AclConfiguration_S3AclOption <S3AclOption>-EngineVersion_SelectedEngineVersion <String>-State <WorkGroupState>-Select <String>-PassThru <SwitchParameter>-Force <SwitchParameter>-ClientConfig <AmazonAthenaConfig>
ConfigurationUpdates
can be specified. 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 | ConfigurationUpdates_ResultConfigurationUpdates_AclConfiguration_S3AclOption |
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) |
EnforceWorkGroupConfiguration
setting takes precedence over the EnableMinimumEncryptionConfiguration
flag. This means that if EnforceWorkGroupConfiguration
is true, the EnableMinimumEncryptionConfiguration
flag is ignored, and the workgroup configuration for encryption is used. 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? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
true
, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries. If set to false
, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false
. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ConfigurationUpdates_CustomerContentEncryptionConfiguration_KmsKey |
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 | ConfigurationUpdates_ResultConfigurationUpdates_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 | ConfigurationUpdates_ResultConfigurationUpdates_EncryptionConfiguration_KmsKey |
CreateWorkGroup
or UpdateWorkGroup
operation, the EffectiveEngineVersion
field is ignored. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ConfigurationUpdates_EngineVersion_EffectiveEngineVersion |
ListEngineVersions
, including AUTO. The default is AUTO. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ConfigurationUpdates_EngineVersion_SelectedEngineVersion |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (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.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) |
Aliases | ConfigurationUpdates_ResultConfigurationUpdates_ExpectedBucketOwner |
s3://path/to/query/bucket/
. For more information, see Working with query results, recent queries, and output files. If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The "workgroup settings override" is specified in EnforceWorkGroupConfiguration
(true/false) in the WorkGroupConfiguration
. See WorkGroupConfiguration$EnforceWorkGroupConfiguration. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ConfigurationUpdates_ResultConfigurationUpdates_OutputLocation |
true
, indicates that the previously-specified ACL configuration for queries in this workgroup should be ignored and set to null. If set to false
or not set, and a value is present in the AclConfiguration
of ResultConfigurationUpdates
, the AclConfiguration
in the workgroup's ResultConfiguration
is updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ConfigurationUpdates_ResultConfigurationUpdates_RemoveAclConfiguration |
EncryptionConfiguration
in ResultConfigurationUpdates
(the client-side setting), the EncryptionConfiguration
in the workgroup's ResultConfiguration
will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ConfigurationUpdates_ResultConfigurationUpdates_RemoveEncryptionConfiguration |
ExpectedBucketOwner
in ResultConfigurationUpdates
(the client-side setting), the ExpectedBucketOwner
in the workgroup's ResultConfiguration
is updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ConfigurationUpdates_ResultConfigurationUpdates_RemoveExpectedBucketOwner |
OutputLocation
in ResultConfigurationUpdates
(the client-side setting), the OutputLocation
in the workgroup's ResultConfiguration
will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ConfigurationUpdates_ResultConfigurationUpdates_RemoveOutputLocation |
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) |
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