Amazon Athena

2025/06/02 - Amazon Athena - 6 updated api methods

Changes  Add support for the managed query result in the workgroup APIs. The managed query result configuration enables users to store query results to Athena owned storage.

BatchGetQueryExecution (updated) Link ¶
Changes (response)
{'QueryExecutions': {'ManagedQueryResultsConfiguration': {'Enabled': 'boolean',
                                                          'EncryptionConfiguration': {'KmsKey': 'string'}}}}

Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. Requires you to have access to the workgroup in which the queries ran. To get a list of query execution IDs, use ListQueryExecutionsInput$WorkGroup. Query executions differ from named (saved) queries. Use BatchGetNamedQueryInput to get details about named queries.

See also: AWS API Documentation

Request Syntax

client.batch_get_query_execution(
    QueryExecutionIds=[
        'string',
    ]
)
type QueryExecutionIds:

list

param QueryExecutionIds:

[REQUIRED]

An array of query execution IDs.

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'QueryExecutions': [
        {
            'QueryExecutionId': 'string',
            'Query': 'string',
            'StatementType': 'DDL'|'DML'|'UTILITY',
            'ManagedQueryResultsConfiguration': {
                'Enabled': True|False,
                'EncryptionConfiguration': {
                    'KmsKey': 'string'
                }
            },
            'ResultConfiguration': {
                'OutputLocation': 'string',
                'EncryptionConfiguration': {
                    'EncryptionOption': 'SSE_S3'|'SSE_KMS'|'CSE_KMS',
                    'KmsKey': 'string'
                },
                'ExpectedBucketOwner': 'string',
                'AclConfiguration': {
                    'S3AclOption': 'BUCKET_OWNER_FULL_CONTROL'
                }
            },
            'ResultReuseConfiguration': {
                'ResultReuseByAgeConfiguration': {
                    'Enabled': True|False,
                    'MaxAgeInMinutes': 123
                }
            },
            'QueryExecutionContext': {
                'Database': 'string',
                'Catalog': 'string'
            },
            'Status': {
                'State': 'QUEUED'|'RUNNING'|'SUCCEEDED'|'FAILED'|'CANCELLED',
                'StateChangeReason': 'string',
                'SubmissionDateTime': datetime(2015, 1, 1),
                'CompletionDateTime': datetime(2015, 1, 1),
                'AthenaError': {
                    'ErrorCategory': 123,
                    'ErrorType': 123,
                    'Retryable': True|False,
                    'ErrorMessage': 'string'
                }
            },
            'Statistics': {
                'EngineExecutionTimeInMillis': 123,
                'DataScannedInBytes': 123,
                'DataManifestLocation': 'string',
                'TotalExecutionTimeInMillis': 123,
                'QueryQueueTimeInMillis': 123,
                'ServicePreProcessingTimeInMillis': 123,
                'QueryPlanningTimeInMillis': 123,
                'ServiceProcessingTimeInMillis': 123,
                'ResultReuseInformation': {
                    'ReusedPreviousResult': True|False
                }
            },
            'WorkGroup': 'string',
            'EngineVersion': {
                'SelectedEngineVersion': 'string',
                'EffectiveEngineVersion': 'string'
            },
            'ExecutionParameters': [
                'string',
            ],
            'SubstatementType': 'string',
            'QueryResultsS3AccessGrantsConfiguration': {
                'EnableS3AccessGrants': True|False,
                'CreateUserLevelPrefix': True|False,
                'AuthenticationType': 'DIRECTORY_IDENTITY'
            }
        },
    ],
    'UnprocessedQueryExecutionIds': [
        {
            'QueryExecutionId': 'string',
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • QueryExecutions (list) --

      Information about a query execution.

      • (dict) --

        Information about a single instance of a query execution.

        • QueryExecutionId (string) --

          The unique identifier for each query execution.

        • Query (string) --

          The SQL query statements which the query execution ran.

        • StatementType (string) --

          The type of query statement that was run. DDL indicates DDL query statements. DML indicates DML (Data Manipulation Language) query statements, such as CREATE TABLE AS SELECT. UTILITY indicates query statements other than DDL and DML, such as SHOW CREATE TABLE, or DESCRIBE TABLE.

        • ManagedQueryResultsConfiguration (dict) --

          The configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results.

          • 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.

          • EncryptionConfiguration (dict) --

            If you encrypt query and calculation results in Athena owned storage, this field indicates the encryption option (for example, SSE_KMS or CSE_KMS) and key information.

            • KmsKey (string) --

              The ARN of an KMS key for encrypting managed query results.

        • ResultConfiguration (dict) --

          The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query results. These are known as "client-side settings". 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.

          • 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.

          • EncryptionConfiguration (dict) --

            If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration 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.

            • EncryptionOption (string) --

              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.

            • KmsKey (string) --

              For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.

          • 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.

          • AclConfiguration (dict) --

            Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. For more information, see WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

            • S3AclOption (string) --

              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.

        • ResultReuseConfiguration (dict) --

          Specifies the query result reuse behavior that was used for the query.

          • ResultReuseByAgeConfiguration (dict) --

            Specifies whether previous query results are reused, and if so, their maximum age.

            • Enabled (boolean) --

              True if previous query results can be reused when the query is run; otherwise, false. The default is false.

            • MaxAgeInMinutes (integer) --

              Specifies, in minutes, the maximum age of a previous query result that Athena should consider for reuse. The default is 60.

        • QueryExecutionContext (dict) --

          The database in which the query execution occurred.

          • Database (string) --

            The name of the database used in the query execution. The database must exist in the catalog.

          • Catalog (string) --

            The name of the data catalog used in the query execution.

        • Status (dict) --

          The completion date, current state, submission time, and state change reason (if applicable) for the query execution.

          • State (string) --

            The state of query execution. QUEUED indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. RUNNING indicates that the query is in execution phase. SUCCEEDED indicates that the query completed without errors. FAILED indicates that the query experienced an error and did not complete processing. CANCELLED indicates that a user input interrupted query execution.

          • StateChangeReason (string) --

            Further detail about the status of the query.

          • SubmissionDateTime (datetime) --

            The date and time that the query was submitted.

          • CompletionDateTime (datetime) --

            The date and time that the query completed.

          • AthenaError (dict) --

            Provides information about an Athena query error.

            • ErrorCategory (integer) --

              An integer value that specifies the category of a query failure error. The following list shows the category for each integer value.

              1 - System

              2 - User

              3 - Other

            • ErrorType (integer) --

              An integer value that provides specific information about an Athena query error. For the meaning of specific values, see the Error Type Reference in the Amazon Athena User Guide.

            • Retryable (boolean) --

              True if the query might succeed if resubmitted.

            • ErrorMessage (string) --

              Contains a short description of the error that occurred.

        • Statistics (dict) --

          Query execution statistics, such as the amount of data scanned, the amount of time that the query took to process, and the type of statement that was run.

          • EngineExecutionTimeInMillis (integer) --

            The number of milliseconds that the query took to execute.

          • DataScannedInBytes (integer) --

            The number of bytes in the data that was queried.

          • DataManifestLocation (string) --

            The location and file name of a data manifest file. The manifest file is saved to the Athena query results location in Amazon S3. The manifest file tracks files that the query wrote to Amazon S3. If the query fails, the manifest file also tracks files that the query intended to write. The manifest is useful for identifying orphaned files resulting from a failed query. For more information, see Working with Query Results, Output Files, and Query History in the Amazon Athena User Guide.

          • TotalExecutionTimeInMillis (integer) --

            The number of milliseconds that Athena took to run the query.

          • QueryQueueTimeInMillis (integer) --

            The number of milliseconds that the query was in your query queue waiting for resources. Note that if transient errors occur, Athena might automatically add the query back to the queue.

          • ServicePreProcessingTimeInMillis (integer) --

            The number of milliseconds that Athena took to preprocess the query before submitting the query to the query engine.

          • QueryPlanningTimeInMillis (integer) --

            The number of milliseconds that Athena took to plan the query processing flow. This includes the time spent retrieving table partitions from the data source. Note that because the query engine performs the query planning, query planning time is a subset of engine processing time.

          • ServiceProcessingTimeInMillis (integer) --

            The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.

          • ResultReuseInformation (dict) --

            Contains information about whether previous query results were reused for the query.

            • ReusedPreviousResult (boolean) --

              True if a previous query result was reused; false if the result was generated from a new run of the query.

        • WorkGroup (string) --

          The name of the workgroup in which the query ran.

        • EngineVersion (dict) --

          The engine version that executed the query.

          • SelectedEngineVersion (string) --

            The engine version requested by the user. Possible values are determined by the output of ListEngineVersions, including AUTO. The default is AUTO.

          • 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.

        • ExecutionParameters (list) --

          A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur. The list of parameters is not returned in the response.

          • (string) --

        • SubstatementType (string) --

          The kind of query statement that was run.

        • QueryResultsS3AccessGrantsConfiguration (dict) --

          Specifies whether Amazon S3 access grants are enabled for query results.

          • EnableS3AccessGrants (boolean) --

            Specifies whether Amazon S3 access grants are enabled for query results.

          • CreateUserLevelPrefix (boolean) --

            When enabled, appends the user ID as an Amazon S3 path prefix to the query result output location.

          • AuthenticationType (string) --

            The authentication type used for Amazon S3 access grants. Currently, only DIRECTORY_IDENTITY is supported.

    • UnprocessedQueryExecutionIds (list) --

      Information about the query executions that failed to run.

      • (dict) --

        Describes a query execution that failed to process.

        • QueryExecutionId (string) --

          The unique identifier of the query execution.

        • ErrorCode (string) --

          The error code returned when the query execution failed to process, if applicable.

        • ErrorMessage (string) --

          The error message returned when the query execution failed to process, if applicable.

CreateWorkGroup (updated) Link ¶
Changes (request)
{'Configuration': {'ManagedQueryResultsConfiguration': {'Enabled': 'boolean',
                                                        'EncryptionConfiguration': {'KmsKey': 'string'}}}}

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

See also: AWS API Documentation

Request Syntax

client.create_work_group(
    Name='string',
    Configuration={
        'ResultConfiguration': {
            'OutputLocation': 'string',
            'EncryptionConfiguration': {
                'EncryptionOption': 'SSE_S3'|'SSE_KMS'|'CSE_KMS',
                'KmsKey': 'string'
            },
            'ExpectedBucketOwner': 'string',
            'AclConfiguration': {
                'S3AclOption': 'BUCKET_OWNER_FULL_CONTROL'
            }
        },
        'ManagedQueryResultsConfiguration': {
            'Enabled': True|False,
            'EncryptionConfiguration': {
                'KmsKey': 'string'
            }
        },
        'EnforceWorkGroupConfiguration': True|False,
        'PublishCloudWatchMetricsEnabled': True|False,
        'BytesScannedCutoffPerQuery': 123,
        'RequesterPaysEnabled': True|False,
        'EngineVersion': {
            'SelectedEngineVersion': 'string',
            'EffectiveEngineVersion': 'string'
        },
        'AdditionalConfiguration': 'string',
        'ExecutionRole': 'string',
        'CustomerContentEncryptionConfiguration': {
            'KmsKey': 'string'
        },
        'EnableMinimumEncryptionConfiguration': True|False,
        'IdentityCenterConfiguration': {
            'EnableIdentityCenter': True|False,
            'IdentityCenterInstanceArn': 'string'
        },
        'QueryResultsS3AccessGrantsConfiguration': {
            'EnableS3AccessGrants': True|False,
            'CreateUserLevelPrefix': True|False,
            'AuthenticationType': 'DIRECTORY_IDENTITY'
        }
    },
    Description='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type Name:

string

param Name:

[REQUIRED]

The workgroup name.

type Configuration:

dict

param Configuration:

Contains configuration information for creating an Athena SQL workgroup or Spark enabled Athena workgroup. Athena SQL workgroup configuration includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified, and whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

  • ResultConfiguration (dict) --

    The configuration for the workgroup, which includes the location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided.

    • 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.

    • EncryptionConfiguration (dict) --

      If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration 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.

      • EncryptionOption (string) -- [REQUIRED]

        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.

      • KmsKey (string) --

        For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.

    • 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.

    • AclConfiguration (dict) --

      Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. For more information, see WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

      • S3AclOption (string) -- [REQUIRED]

        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.

  • ManagedQueryResultsConfiguration (dict) --

    The configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results.

    • Enabled (boolean) -- [REQUIRED]

      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.

    • EncryptionConfiguration (dict) --

      If you encrypt query and calculation results in Athena owned storage, this field indicates the encryption option (for example, SSE_KMS or CSE_KMS) and key information.

      • KmsKey (string) -- [REQUIRED]

        The ARN of an KMS key for encrypting managed query results.

  • 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.

  • PublishCloudWatchMetricsEnabled (boolean) --

    Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

  • BytesScannedCutoffPerQuery (integer) --

    The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

  • 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.

  • EngineVersion (dict) --

    The engine version that all queries running on the workgroup use. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

    • SelectedEngineVersion (string) --

      The engine version requested by the user. Possible values are determined by the output of ListEngineVersions, including AUTO. The default is AUTO.

    • 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.

  • AdditionalConfiguration (string) --

    Specifies a user defined JSON string that is passed to the notebook engine.

  • 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.

  • CustomerContentEncryptionConfiguration (dict) --

    Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.

    • KmsKey (string) -- [REQUIRED]

      The customer managed KMS key that is used to encrypt the user's data stores in Athena.

  • 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.

  • IdentityCenterConfiguration (dict) --

    Specifies whether the workgroup is IAM Identity Center supported.

    • EnableIdentityCenter (boolean) --

      Specifies whether the workgroup is IAM Identity Center supported.

    • IdentityCenterInstanceArn (string) --

      The IAM Identity Center instance ARN that the workgroup associates to.

  • QueryResultsS3AccessGrantsConfiguration (dict) --

    Specifies whether Amazon S3 access grants are enabled for query results.

    • EnableS3AccessGrants (boolean) -- [REQUIRED]

      Specifies whether Amazon S3 access grants are enabled for query results.

    • CreateUserLevelPrefix (boolean) --

      When enabled, appends the user ID as an Amazon S3 path prefix to the query result output location.

    • AuthenticationType (string) -- [REQUIRED]

      The authentication type used for Amazon S3 access grants. Currently, only DIRECTORY_IDENTITY is supported.

type Description:

string

param Description:

The workgroup description.

type Tags:

list

param Tags:

A list of comma separated tags to add to the workgroup that is created.

  • (dict) --

    A label that you assign to a resource. Athena resources include workgroups, data catalogs, and capacity reservations. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena resources by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter the resources in your account. For best practices, see Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas.

    • Key (string) --

      A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys are case-sensitive and must be unique per resource.

    • Value (string) --

      A tag value. The tag value length is from 0 to 256 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag values are case-sensitive.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

GetQueryExecution (updated) Link ¶
Changes (response)
{'QueryExecution': {'ManagedQueryResultsConfiguration': {'Enabled': 'boolean',
                                                         'EncryptionConfiguration': {'KmsKey': 'string'}}}}

Returns information about a single execution of a query if you have access to the workgroup in which the query ran. Each time a query executes, information about the query execution is saved with a unique ID.

See also: AWS API Documentation

Request Syntax

client.get_query_execution(
    QueryExecutionId='string'
)
type QueryExecutionId:

string

param QueryExecutionId:

[REQUIRED]

The unique ID of the query execution.

rtype:

dict

returns:

Response Syntax

{
    'QueryExecution': {
        'QueryExecutionId': 'string',
        'Query': 'string',
        'StatementType': 'DDL'|'DML'|'UTILITY',
        'ManagedQueryResultsConfiguration': {
            'Enabled': True|False,
            'EncryptionConfiguration': {
                'KmsKey': 'string'
            }
        },
        'ResultConfiguration': {
            'OutputLocation': 'string',
            'EncryptionConfiguration': {
                'EncryptionOption': 'SSE_S3'|'SSE_KMS'|'CSE_KMS',
                'KmsKey': 'string'
            },
            'ExpectedBucketOwner': 'string',
            'AclConfiguration': {
                'S3AclOption': 'BUCKET_OWNER_FULL_CONTROL'
            }
        },
        'ResultReuseConfiguration': {
            'ResultReuseByAgeConfiguration': {
                'Enabled': True|False,
                'MaxAgeInMinutes': 123
            }
        },
        'QueryExecutionContext': {
            'Database': 'string',
            'Catalog': 'string'
        },
        'Status': {
            'State': 'QUEUED'|'RUNNING'|'SUCCEEDED'|'FAILED'|'CANCELLED',
            'StateChangeReason': 'string',
            'SubmissionDateTime': datetime(2015, 1, 1),
            'CompletionDateTime': datetime(2015, 1, 1),
            'AthenaError': {
                'ErrorCategory': 123,
                'ErrorType': 123,
                'Retryable': True|False,
                'ErrorMessage': 'string'
            }
        },
        'Statistics': {
            'EngineExecutionTimeInMillis': 123,
            'DataScannedInBytes': 123,
            'DataManifestLocation': 'string',
            'TotalExecutionTimeInMillis': 123,
            'QueryQueueTimeInMillis': 123,
            'ServicePreProcessingTimeInMillis': 123,
            'QueryPlanningTimeInMillis': 123,
            'ServiceProcessingTimeInMillis': 123,
            'ResultReuseInformation': {
                'ReusedPreviousResult': True|False
            }
        },
        'WorkGroup': 'string',
        'EngineVersion': {
            'SelectedEngineVersion': 'string',
            'EffectiveEngineVersion': 'string'
        },
        'ExecutionParameters': [
            'string',
        ],
        'SubstatementType': 'string',
        'QueryResultsS3AccessGrantsConfiguration': {
            'EnableS3AccessGrants': True|False,
            'CreateUserLevelPrefix': True|False,
            'AuthenticationType': 'DIRECTORY_IDENTITY'
        }
    }
}

Response Structure

  • (dict) --

    • QueryExecution (dict) --

      Information about the query execution.

      • QueryExecutionId (string) --

        The unique identifier for each query execution.

      • Query (string) --

        The SQL query statements which the query execution ran.

      • StatementType (string) --

        The type of query statement that was run. DDL indicates DDL query statements. DML indicates DML (Data Manipulation Language) query statements, such as CREATE TABLE AS SELECT. UTILITY indicates query statements other than DDL and DML, such as SHOW CREATE TABLE, or DESCRIBE TABLE.

      • ManagedQueryResultsConfiguration (dict) --

        The configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results.

        • 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.

        • EncryptionConfiguration (dict) --

          If you encrypt query and calculation results in Athena owned storage, this field indicates the encryption option (for example, SSE_KMS or CSE_KMS) and key information.

          • KmsKey (string) --

            The ARN of an KMS key for encrypting managed query results.

      • ResultConfiguration (dict) --

        The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query results. These are known as "client-side settings". 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.

        • 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.

        • EncryptionConfiguration (dict) --

          If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration 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.

          • EncryptionOption (string) --

            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.

          • KmsKey (string) --

            For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.

        • 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.

        • AclConfiguration (dict) --

          Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. For more information, see WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

          • S3AclOption (string) --

            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.

      • ResultReuseConfiguration (dict) --

        Specifies the query result reuse behavior that was used for the query.

        • ResultReuseByAgeConfiguration (dict) --

          Specifies whether previous query results are reused, and if so, their maximum age.

          • Enabled (boolean) --

            True if previous query results can be reused when the query is run; otherwise, false. The default is false.

          • MaxAgeInMinutes (integer) --

            Specifies, in minutes, the maximum age of a previous query result that Athena should consider for reuse. The default is 60.

      • QueryExecutionContext (dict) --

        The database in which the query execution occurred.

        • Database (string) --

          The name of the database used in the query execution. The database must exist in the catalog.

        • Catalog (string) --

          The name of the data catalog used in the query execution.

      • Status (dict) --

        The completion date, current state, submission time, and state change reason (if applicable) for the query execution.

        • State (string) --

          The state of query execution. QUEUED indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. RUNNING indicates that the query is in execution phase. SUCCEEDED indicates that the query completed without errors. FAILED indicates that the query experienced an error and did not complete processing. CANCELLED indicates that a user input interrupted query execution.

        • StateChangeReason (string) --

          Further detail about the status of the query.

        • SubmissionDateTime (datetime) --

          The date and time that the query was submitted.

        • CompletionDateTime (datetime) --

          The date and time that the query completed.

        • AthenaError (dict) --

          Provides information about an Athena query error.

          • ErrorCategory (integer) --

            An integer value that specifies the category of a query failure error. The following list shows the category for each integer value.

            1 - System

            2 - User

            3 - Other

          • ErrorType (integer) --

            An integer value that provides specific information about an Athena query error. For the meaning of specific values, see the Error Type Reference in the Amazon Athena User Guide.

          • Retryable (boolean) --

            True if the query might succeed if resubmitted.

          • ErrorMessage (string) --

            Contains a short description of the error that occurred.

      • Statistics (dict) --

        Query execution statistics, such as the amount of data scanned, the amount of time that the query took to process, and the type of statement that was run.

        • EngineExecutionTimeInMillis (integer) --

          The number of milliseconds that the query took to execute.

        • DataScannedInBytes (integer) --

          The number of bytes in the data that was queried.

        • DataManifestLocation (string) --

          The location and file name of a data manifest file. The manifest file is saved to the Athena query results location in Amazon S3. The manifest file tracks files that the query wrote to Amazon S3. If the query fails, the manifest file also tracks files that the query intended to write. The manifest is useful for identifying orphaned files resulting from a failed query. For more information, see Working with Query Results, Output Files, and Query History in the Amazon Athena User Guide.

        • TotalExecutionTimeInMillis (integer) --

          The number of milliseconds that Athena took to run the query.

        • QueryQueueTimeInMillis (integer) --

          The number of milliseconds that the query was in your query queue waiting for resources. Note that if transient errors occur, Athena might automatically add the query back to the queue.

        • ServicePreProcessingTimeInMillis (integer) --

          The number of milliseconds that Athena took to preprocess the query before submitting the query to the query engine.

        • QueryPlanningTimeInMillis (integer) --

          The number of milliseconds that Athena took to plan the query processing flow. This includes the time spent retrieving table partitions from the data source. Note that because the query engine performs the query planning, query planning time is a subset of engine processing time.

        • ServiceProcessingTimeInMillis (integer) --

          The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.

        • ResultReuseInformation (dict) --

          Contains information about whether previous query results were reused for the query.

          • ReusedPreviousResult (boolean) --

            True if a previous query result was reused; false if the result was generated from a new run of the query.

      • WorkGroup (string) --

        The name of the workgroup in which the query ran.

      • EngineVersion (dict) --

        The engine version that executed the query.

        • SelectedEngineVersion (string) --

          The engine version requested by the user. Possible values are determined by the output of ListEngineVersions, including AUTO. The default is AUTO.

        • 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.

      • ExecutionParameters (list) --

        A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur. The list of parameters is not returned in the response.

        • (string) --

      • SubstatementType (string) --

        The kind of query statement that was run.

      • QueryResultsS3AccessGrantsConfiguration (dict) --

        Specifies whether Amazon S3 access grants are enabled for query results.

        • EnableS3AccessGrants (boolean) --

          Specifies whether Amazon S3 access grants are enabled for query results.

        • CreateUserLevelPrefix (boolean) --

          When enabled, appends the user ID as an Amazon S3 path prefix to the query result output location.

        • AuthenticationType (string) --

          The authentication type used for Amazon S3 access grants. Currently, only DIRECTORY_IDENTITY is supported.

GetQueryResults (updated) Link ¶
Changes (request)
{'QueryResultType': 'DATA_MANIFEST | DATA_ROWS'}

Streams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3. For more information, see Working with query results, recent queries, and output files in the Amazon Athena User Guide. This request does not execute the query but returns results. Use StartQueryExecution to run a query.

To stream query results successfully, the IAM principal with permission to call GetQueryResults also must have permissions to the Amazon S3 GetObject action for the Athena query results location.

See also: AWS API Documentation

Request Syntax

client.get_query_results(
    QueryExecutionId='string',
    NextToken='string',
    MaxResults=123,
    QueryResultType='DATA_MANIFEST'|'DATA_ROWS'
)
type QueryExecutionId:

string

param QueryExecutionId:

[REQUIRED]

The unique ID of the query execution.

type NextToken:

string

param NextToken:

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

type MaxResults:

integer

param MaxResults:

The maximum number of results (rows) to return in this request.

type QueryResultType:

string

param QueryResultType:

When you set this to DATA_ROWS or empty, GetQueryResults returns the query results in rows. If set to DATA_MANIFEST, it returns the manifest file in rows. Only the query types CREATE TABLE AS SELECT, UNLOAD, and INSERT can generate a manifest file. If you use DATA_MANIFEST for other query types, the query will fail.

rtype:

dict

returns:

Response Syntax

{
    'UpdateCount': 123,
    'ResultSet': {
        'Rows': [
            {
                'Data': [
                    {
                        'VarCharValue': 'string'
                    },
                ]
            },
        ],
        'ResultSetMetadata': {
            'ColumnInfo': [
                {
                    'CatalogName': 'string',
                    'SchemaName': 'string',
                    'TableName': 'string',
                    'Name': 'string',
                    'Label': 'string',
                    'Type': 'string',
                    'Precision': 123,
                    'Scale': 123,
                    'Nullable': 'NOT_NULL'|'NULLABLE'|'UNKNOWN',
                    'CaseSensitive': True|False
                },
            ]
        }
    },
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • UpdateCount (integer) --

      The number of rows inserted with a CREATE TABLE AS SELECT, INSERT INTO, or UPDATE statement.

    • ResultSet (dict) --

      The results of the query execution.

      • Rows (list) --

        The rows in the table.

        • (dict) --

          The rows that make up a query result table.

          • Data (list) --

            The data that populates a row in a query result table.

            • (dict) --

              A piece of data (a field in the table).

              • VarCharValue (string) --

                The value of the datum.

      • ResultSetMetadata (dict) --

        The metadata that describes the column structure and data types of a table of query results.

        • ColumnInfo (list) --

          Information about the columns returned in a query result metadata.

          • (dict) --

            Information about the columns in a query execution result.

            • CatalogName (string) --

              The catalog to which the query results belong.

            • SchemaName (string) --

              The schema name (database name) to which the query results belong.

            • TableName (string) --

              The table name for the query results.

            • Name (string) --

              The name of the column.

            • Label (string) --

              A column label.

            • Type (string) --

              The data type of the column.

            • Precision (integer) --

              For DECIMAL data types, specifies the total number of digits, up to 38. For performance reasons, we recommend up to 18 digits.

            • Scale (integer) --

              For DECIMAL data types, specifies the total number of digits in the fractional part of the value. Defaults to 0.

            • Nullable (string) --

              Unsupported constraint. This value always shows as UNKNOWN.

            • CaseSensitive (boolean) --

              Indicates whether values in the column are case-sensitive.

    • NextToken (string) --

      A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

GetWorkGroup (updated) Link ¶
Changes (response)
{'WorkGroup': {'Configuration': {'ManagedQueryResultsConfiguration': {'Enabled': 'boolean',
                                                                      'EncryptionConfiguration': {'KmsKey': 'string'}}}}}

Returns information about the workgroup with the specified name.

See also: AWS API Documentation

Request Syntax

client.get_work_group(
    WorkGroup='string'
)
type WorkGroup:

string

param WorkGroup:

[REQUIRED]

The name of the workgroup.

rtype:

dict

returns:

Response Syntax

{
    'WorkGroup': {
        'Name': 'string',
        'State': 'ENABLED'|'DISABLED',
        'Configuration': {
            'ResultConfiguration': {
                'OutputLocation': 'string',
                'EncryptionConfiguration': {
                    'EncryptionOption': 'SSE_S3'|'SSE_KMS'|'CSE_KMS',
                    'KmsKey': 'string'
                },
                'ExpectedBucketOwner': 'string',
                'AclConfiguration': {
                    'S3AclOption': 'BUCKET_OWNER_FULL_CONTROL'
                }
            },
            'ManagedQueryResultsConfiguration': {
                'Enabled': True|False,
                'EncryptionConfiguration': {
                    'KmsKey': 'string'
                }
            },
            'EnforceWorkGroupConfiguration': True|False,
            'PublishCloudWatchMetricsEnabled': True|False,
            'BytesScannedCutoffPerQuery': 123,
            'RequesterPaysEnabled': True|False,
            'EngineVersion': {
                'SelectedEngineVersion': 'string',
                'EffectiveEngineVersion': 'string'
            },
            'AdditionalConfiguration': 'string',
            'ExecutionRole': 'string',
            'CustomerContentEncryptionConfiguration': {
                'KmsKey': 'string'
            },
            'EnableMinimumEncryptionConfiguration': True|False,
            'IdentityCenterConfiguration': {
                'EnableIdentityCenter': True|False,
                'IdentityCenterInstanceArn': 'string'
            },
            'QueryResultsS3AccessGrantsConfiguration': {
                'EnableS3AccessGrants': True|False,
                'CreateUserLevelPrefix': True|False,
                'AuthenticationType': 'DIRECTORY_IDENTITY'
            }
        },
        'Description': 'string',
        'CreationTime': datetime(2015, 1, 1),
        'IdentityCenterApplicationArn': 'string'
    }
}

Response Structure

  • (dict) --

    • WorkGroup (dict) --

      Information about the workgroup.

      • Name (string) --

        The workgroup name.

      • State (string) --

        The state of the workgroup: ENABLED or DISABLED.

      • Configuration (dict) --

        The configuration of the workgroup, which includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for query and calculation results; whether the Amazon CloudWatch Metrics are enabled for the workgroup; whether workgroup settings override client-side settings; and the data usage limits for the amount of data scanned per query or per workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

        • ResultConfiguration (dict) --

          The configuration for the workgroup, which includes the location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided.

          • 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.

          • EncryptionConfiguration (dict) --

            If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration 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.

            • EncryptionOption (string) --

              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.

            • KmsKey (string) --

              For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.

          • 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.

          • AclConfiguration (dict) --

            Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. For more information, see WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

            • S3AclOption (string) --

              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.

        • ManagedQueryResultsConfiguration (dict) --

          The configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results.

          • 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.

          • EncryptionConfiguration (dict) --

            If you encrypt query and calculation results in Athena owned storage, this field indicates the encryption option (for example, SSE_KMS or CSE_KMS) and key information.

            • KmsKey (string) --

              The ARN of an KMS key for encrypting managed query results.

        • 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.

        • PublishCloudWatchMetricsEnabled (boolean) --

          Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

        • BytesScannedCutoffPerQuery (integer) --

          The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

        • 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.

        • EngineVersion (dict) --

          The engine version that all queries running on the workgroup use. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

          • SelectedEngineVersion (string) --

            The engine version requested by the user. Possible values are determined by the output of ListEngineVersions, including AUTO. The default is AUTO.

          • 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.

        • AdditionalConfiguration (string) --

          Specifies a user defined JSON string that is passed to the notebook engine.

        • 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.

        • CustomerContentEncryptionConfiguration (dict) --

          Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.

          • KmsKey (string) --

            The customer managed KMS key that is used to encrypt the user's data stores in Athena.

        • 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.

        • IdentityCenterConfiguration (dict) --

          Specifies whether the workgroup is IAM Identity Center supported.

          • EnableIdentityCenter (boolean) --

            Specifies whether the workgroup is IAM Identity Center supported.

          • IdentityCenterInstanceArn (string) --

            The IAM Identity Center instance ARN that the workgroup associates to.

        • QueryResultsS3AccessGrantsConfiguration (dict) --

          Specifies whether Amazon S3 access grants are enabled for query results.

          • EnableS3AccessGrants (boolean) --

            Specifies whether Amazon S3 access grants are enabled for query results.

          • CreateUserLevelPrefix (boolean) --

            When enabled, appends the user ID as an Amazon S3 path prefix to the query result output location.

          • AuthenticationType (string) --

            The authentication type used for Amazon S3 access grants. Currently, only DIRECTORY_IDENTITY is supported.

      • Description (string) --

        The workgroup description.

      • CreationTime (datetime) --

        The date and time the workgroup was created.

      • IdentityCenterApplicationArn (string) --

        The ARN of the IAM Identity Center enabled application associated with the workgroup.

UpdateWorkGroup (updated) Link ¶
Changes (request)
{'ConfigurationUpdates': {'ManagedQueryResultsConfigurationUpdates': {'Enabled': 'boolean',
                                                                      'EncryptionConfiguration': {'KmsKey': 'string'},
                                                                      'RemoveEncryptionConfiguration': 'boolean'}}}

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

See also: AWS API Documentation

Request Syntax

client.update_work_group(
    WorkGroup='string',
    Description='string',
    ConfigurationUpdates={
        'EnforceWorkGroupConfiguration': True|False,
        'ResultConfigurationUpdates': {
            'OutputLocation': 'string',
            'RemoveOutputLocation': True|False,
            'EncryptionConfiguration': {
                'EncryptionOption': 'SSE_S3'|'SSE_KMS'|'CSE_KMS',
                'KmsKey': 'string'
            },
            'RemoveEncryptionConfiguration': True|False,
            'ExpectedBucketOwner': 'string',
            'RemoveExpectedBucketOwner': True|False,
            'AclConfiguration': {
                'S3AclOption': 'BUCKET_OWNER_FULL_CONTROL'
            },
            'RemoveAclConfiguration': True|False
        },
        'ManagedQueryResultsConfigurationUpdates': {
            'Enabled': True|False,
            'EncryptionConfiguration': {
                'KmsKey': 'string'
            },
            'RemoveEncryptionConfiguration': True|False
        },
        'PublishCloudWatchMetricsEnabled': True|False,
        'BytesScannedCutoffPerQuery': 123,
        'RemoveBytesScannedCutoffPerQuery': True|False,
        'RequesterPaysEnabled': True|False,
        'EngineVersion': {
            'SelectedEngineVersion': 'string',
            'EffectiveEngineVersion': 'string'
        },
        'RemoveCustomerContentEncryptionConfiguration': True|False,
        'AdditionalConfiguration': 'string',
        'ExecutionRole': 'string',
        'CustomerContentEncryptionConfiguration': {
            'KmsKey': 'string'
        },
        'EnableMinimumEncryptionConfiguration': True|False,
        'QueryResultsS3AccessGrantsConfiguration': {
            'EnableS3AccessGrants': True|False,
            'CreateUserLevelPrefix': True|False,
            'AuthenticationType': 'DIRECTORY_IDENTITY'
        }
    },
    State='ENABLED'|'DISABLED'
)
type WorkGroup:

string

param WorkGroup:

[REQUIRED]

The specified workgroup that will be updated.

type Description:

string

param Description:

The workgroup description.

type ConfigurationUpdates:

dict

param ConfigurationUpdates:

Contains configuration updates for an Athena SQL workgroup.

  • 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.

  • ResultConfigurationUpdates (dict) --

    The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.

    • 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.

    • 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.

    • EncryptionConfiguration (dict) --

      The encryption configuration for query and calculation results.

      • EncryptionOption (string) -- [REQUIRED]

        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.

      • KmsKey (string) --

        For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.

    • 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.

    • 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.

    • 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.

    • AclConfiguration (dict) --

      The ACL configuration for the query results.

      • S3AclOption (string) -- [REQUIRED]

        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.

    • 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.

  • ManagedQueryResultsConfigurationUpdates (dict) --

    Updates configuration information for managed query results in the workgroup.

    • Enabled (boolean) --

      If set to true, specifies that Athena manages query results in Athena owned storage.

    • EncryptionConfiguration (dict) --

      If you encrypt query and calculation results in Athena owned storage, this field indicates the encryption option (for example, SSE_KMS or CSE_KMS) and key information.

      • KmsKey (string) -- [REQUIRED]

        The ARN of an KMS key for encrypting managed query results.

    • RemoveEncryptionConfiguration (boolean) --

      If set to true, it removes workgroup from Athena owned storage. The existing query results are cleaned up after 24hrs. You must provide query results in location specified under ResultConfiguration$OutputLocation.

  • PublishCloudWatchMetricsEnabled (boolean) --

    Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.

  • BytesScannedCutoffPerQuery (integer) --

    The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

  • RemoveBytesScannedCutoffPerQuery (boolean) --

    Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery

  • 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.

  • EngineVersion (dict) --

    The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

    • SelectedEngineVersion (string) --

      The engine version requested by the user. Possible values are determined by the output of ListEngineVersions, including AUTO. The default is AUTO.

    • 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.

  • RemoveCustomerContentEncryptionConfiguration (boolean) --

    Removes content encryption configuration from an Apache Spark-enabled Athena workgroup.

  • AdditionalConfiguration (string) --

    Contains a user defined string in JSON format for a Spark-enabled workgroup.

  • 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.

  • CustomerContentEncryptionConfiguration (dict) --

    Specifies the customer managed KMS key that is used to encrypt the user's data stores in Athena. When an Amazon Web Services managed key is used, this value is null. This setting does not apply to Athena SQL workgroups.

    • KmsKey (string) -- [REQUIRED]

      The customer managed KMS key that is used to encrypt the user's data stores in Athena.

  • 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.

  • QueryResultsS3AccessGrantsConfiguration (dict) --

    Specifies whether Amazon S3 access grants are enabled for query results.

    • EnableS3AccessGrants (boolean) -- [REQUIRED]

      Specifies whether Amazon S3 access grants are enabled for query results.

    • CreateUserLevelPrefix (boolean) --

      When enabled, appends the user ID as an Amazon S3 path prefix to the query result output location.

    • AuthenticationType (string) -- [REQUIRED]

      The authentication type used for Amazon S3 access grants. Currently, only DIRECTORY_IDENTITY is supported.

type State:

string

param State:

The workgroup state that will be updated for the given workgroup.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --