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 Amazon Athena UpdateWorkGroup API operation.

Syntax

Update-ATHWorkGroup
-WorkGroup <String>
-ConfigurationUpdates_AdditionalConfiguration <String>
-QueryResultsS3AccessGrantsConfiguration_AuthenticationType <AuthenticationType>
-ConfigurationUpdates_BytesScannedCutoffPerQuery <Int64>
-QueryResultsS3AccessGrantsConfiguration_CreateUserLevelPrefix <Boolean>
-Description <String>
-EngineVersion_EffectiveEngineVersion <String>
-ConfigurationUpdates_EnableMinimumEncryptionConfiguration <Boolean>
-QueryResultsS3AccessGrantsConfiguration_EnableS3AccessGrant <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>

Description

Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only ConfigurationUpdates can be specified.

Parameters

-AclConfiguration_S3AclOption <S3AclOption>
The Amazon S3 canned ACL that Athena should specify when storing query results. Currently the only supported canned ACL is 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)
AliasesConfigurationUpdates_ResultConfigurationUpdates_AclConfiguration_S3AclOption
-ClientConfig <AmazonAthenaConfig>
Amazon.PowerShell.Cmdlets.ATH.AmazonAthenaClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConfigurationUpdates_AdditionalConfiguration <String>
Contains a user defined string in JSON format for a Spark-enabled workgroup.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConfigurationUpdates_BytesScannedCutoffPerQuery <Int64>
The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConfigurationUpdates_EnableMinimumEncryptionConfiguration <Boolean>
Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3. When enabled, workgroup users can set encryption only to the minimum level set by the administrator or higher when they submit queries. This setting does not apply to Spark-enabled workgroups.The 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)
-ConfigurationUpdates_EnforceWorkGroupConfiguration <Boolean>
If set to "true", the settings for the workgroup override client-side settings. If set to "false" client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConfigurationUpdates_ExecutionRole <String>
The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConfigurationUpdates_PublishCloudWatchMetricsEnabled <Boolean>
Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConfigurationUpdates_RemoveBytesScannedCutoffPerQuery <Boolean>
Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConfigurationUpdates_RemoveCustomerContentEncryptionConfiguration <Boolean>
Removes content encryption configuration from an Apache Spark-enabled Athena workgroup.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConfigurationUpdates_RequesterPaysEnabled <Boolean>
If set to 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)
-CustomerContentEncryptionConfiguration_KmsKey <String>
The customer managed KMS key that is used to encrypt the user's data stores in Athena.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfigurationUpdates_CustomerContentEncryptionConfiguration_KmsKey
-Description <String>
The workgroup description.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EncryptionConfiguration_EncryptionOption <EncryptionOption>
Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (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)
AliasesConfigurationUpdates_ResultConfigurationUpdates_EncryptionConfiguration_EncryptionOption
-EncryptionConfiguration_KmsKey <String>
For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfigurationUpdates_ResultConfigurationUpdates_EncryptionConfiguration_KmsKey
-EngineVersion_EffectiveEngineVersion <String>
Read only. The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a CreateWorkGroup or UpdateWorkGroup operation, the EffectiveEngineVersion field is ignored.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfigurationUpdates_EngineVersion_EffectiveEngineVersion
-EngineVersion_SelectedEngineVersion <String>
The engine version requested by the user. Possible values are determined by the output of ListEngineVersions, including AUTO. The default is AUTO.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfigurationUpdates_EngineVersion_SelectedEngineVersion
-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)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the WorkGroup parameter. The -PassThru parameter is deprecated, use -Select '^WorkGroup' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-QueryResultsS3AccessGrantsConfiguration_AuthenticationType <AuthenticationType>
The authentication type used for Amazon S3 access grants. Currently, only DIRECTORY_IDENTITY is supported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfigurationUpdates_QueryResultsS3AccessGrantsConfiguration_AuthenticationType
-QueryResultsS3AccessGrantsConfiguration_CreateUserLevelPrefix <Boolean>
When enabled, appends the user ID as an Amazon S3 path prefix to the query result output location.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfigurationUpdates_QueryResultsS3AccessGrantsConfiguration_CreateUserLevelPrefix
-QueryResultsS3AccessGrantsConfiguration_EnableS3AccessGrant <Boolean>
Specifies whether Amazon S3 access grants are enabled for query results.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfigurationUpdates_QueryResultsS3AccessGrantsConfiguration_EnableS3AccessGrants
-ResultConfigurationUpdates_ExpectedBucketOwner <String>
The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation. If set, Athena uses the value for 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)
AliasesConfigurationUpdates_ResultConfigurationUpdates_ExpectedBucketOwner
-ResultConfigurationUpdates_OutputLocation <String>
The location in Amazon S3 where your query and calculation results are stored, such as s3://path/to/query/bucket/. 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)
AliasesConfigurationUpdates_ResultConfigurationUpdates_OutputLocation
-ResultConfigurationUpdates_RemoveAclConfiguration <Boolean>
If set to 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)
AliasesConfigurationUpdates_ResultConfigurationUpdates_RemoveAclConfiguration
-ResultConfigurationUpdates_RemoveEncryptionConfiguration <Boolean>
If set to "true", indicates that the previously-specified encryption configuration (also known as the client-side setting) 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 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)
AliasesConfigurationUpdates_ResultConfigurationUpdates_RemoveEncryptionConfiguration
-ResultConfigurationUpdates_RemoveExpectedBucketOwner <Boolean>
If set to "true", removes the Amazon Web Services account ID previously specified for ResultConfiguration$ExpectedBucketOwner. If set to "false" or not set, and a value is present in the 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)
AliasesConfigurationUpdates_ResultConfigurationUpdates_RemoveExpectedBucketOwner
-ResultConfigurationUpdates_RemoveOutputLocation <Boolean>
If set to "true", indicates that the previously-specified query results location (also known as a client-side setting) 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 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)
AliasesConfigurationUpdates_ResultConfigurationUpdates_RemoveOutputLocation
-Select <String>
Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Athena.Model.UpdateWorkGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-State <WorkGroupState>
The workgroup state that will be updated for the given workgroup.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WorkGroup <String>
The specified workgroup that will be updated.
Required?True
Position?1
Accept pipeline input?True (ByValue, 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

None or Amazon.Athena.Model.UpdateWorkGroupResponse
This cmdlet does not generate any output.The service response (type Amazon.Athena.Model.UpdateWorkGroupResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
User Guide
AWS Tools for PowerShell User Guide

Supported Version

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