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

Syntax

New-ATHWorkGroup
-Name <String>
-Configuration_AdditionalConfiguration <String>
-QueryResultsS3AccessGrantsConfiguration_AuthenticationType <AuthenticationType>
-Configuration_BytesScannedCutoffPerQuery <Int64>
-QueryResultsS3AccessGrantsConfiguration_CreateUserLevelPrefix <Boolean>
-Description <String>
-EngineVersion_EffectiveEngineVersion <String>
-ManagedQueryResultsConfiguration_Enabled <Boolean>
-IdentityCenterConfiguration_EnableIdentityCenter <Boolean>
-Configuration_EnableMinimumEncryptionConfiguration <Boolean>
-QueryResultsS3AccessGrantsConfiguration_EnableS3AccessGrant <Boolean>
-EncryptionConfiguration_EncryptionOption <EncryptionOption>
-Configuration_EnforceWorkGroupConfiguration <Boolean>
-Configuration_ExecutionRole <String>
-ResultConfiguration_ExpectedBucketOwner <String>
-IdentityCenterConfiguration_IdentityCenterInstanceArn <String>
-CustomerContentEncryptionConfiguration_KmsKey <String>
-Configuration_ManagedQueryResultsConfiguration_EncryptionConfiguration_KmsKey <String>
-Configuration_ResultConfiguration_EncryptionConfiguration_KmsKey <String>
-ResultConfiguration_OutputLocation <String>
-Configuration_PublishCloudWatchMetricsEnabled <Boolean>
-Configuration_RequesterPaysEnabled <Boolean>
-AclConfiguration_S3AclOption <S3AclOption>
-EngineVersion_SelectedEngineVersion <String>
-Tag <Tag[]>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonAthenaConfig>

Description

Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.

Parameters

-AclConfiguration_S3AclOption <S3AclOption>
The Amazon S3 canned ACL that Athena should specify when storing query results, including data files inserted by Athena as the result of statements like CTAS or INSERT INTO. 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)
AliasesConfiguration_ResultConfiguration_AclConfiguration_S3AclOption
-ClientConfig <AmazonAthenaConfig>
Amazon.PowerShell.Cmdlets.ATH.AmazonAthenaClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_AdditionalConfiguration <String>
Specifies a user defined JSON string that is passed to the notebook engine.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_BytesScannedCutoffPerQuery <Int64>
The upper data usage 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)
-Configuration_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.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)
-Configuration_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)
-Configuration_ExecutionRole <String>
The ARN of the execution role used to access user resources for Spark sessions and IAM Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and IAM Identity Center enabled workgroups. The property is required for IAM Identity Center enabled workgroups.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_ManagedQueryResultsConfiguration_EncryptionConfiguration_KmsKey <String>
The ARN of an KMS key for encrypting managed query results.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_PublishCloudWatchMetricsEnabled <Boolean>
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_RequesterPaysEnabled <Boolean>
If set to true, allows members assigned to a workgroup to reference 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)
-Configuration_ResultConfiguration_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)
AliasesEncryptionConfiguration_KmsKey
-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)
AliasesConfiguration_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)
AliasesConfiguration_ResultConfiguration_EncryptionConfiguration_EncryptionOption
-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)
AliasesConfiguration_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)
AliasesConfiguration_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)
-IdentityCenterConfiguration_EnableIdentityCenter <Boolean>
Specifies whether the workgroup is IAM Identity Center supported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_IdentityCenterConfiguration_EnableIdentityCenter
-IdentityCenterConfiguration_IdentityCenterInstanceArn <String>
The IAM Identity Center instance ARN that the workgroup associates to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_IdentityCenterConfiguration_IdentityCenterInstanceArn
-ManagedQueryResultsConfiguration_Enabled <Boolean>
If set to true, allows you to store query results in Athena owned storage. If set to false, workgroup member stores query results in location specified under ResultConfiguration$OutputLocation. The default is false. A workgroup cannot have the ResultConfiguration$OutputLocation parameter when you set this field to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_ManagedQueryResultsConfiguration_Enabled
-Name <String>
The workgroup name.
Required?True
Position?1
Accept pipeline input?True (ByValue, 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)
AliasesConfiguration_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)
AliasesConfiguration_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)
AliasesConfiguration_QueryResultsS3AccessGrantsConfiguration_EnableS3AccessGrants
-ResultConfiguration_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.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)
AliasesConfiguration_ResultConfiguration_ExpectedBucketOwner
-ResultConfiguration_OutputLocation <String>
The location in Amazon S3 where your query and calculation results are stored, such as 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. 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)
AliasesConfiguration_ResultConfiguration_OutputLocation
-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.CreateWorkGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
A list of comma separated tags to add to the workgroup that is created. 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)
AliasesTags

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.CreateWorkGroupResponse
This cmdlet does not generate any output.The service response (type Amazon.Athena.Model.CreateWorkGroupResponse) be returned by specifying '-Select *'.
User Guide
AWS Tools for PowerShell User Guide

Supported Version

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