AWS SDK Version 3 for .NET
API 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.

Classes

NameDescription
Class BatchGetNamedQueryRequest

Container for the parameters to the BatchGetNamedQuery operation. Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings. Requires you to have access to the workgroup in which the queries were saved. Use ListNamedQueriesInput to get the list of named query IDs in the specified workgroup. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under UnprocessedNamedQueryId. Named queries differ from executed queries. Use BatchGetQueryExecutionInput to get details about each unique query execution, and ListQueryExecutionsInput to get a list of query execution IDs.

Class BatchGetNamedQueryResponse

This is the response object from the BatchGetNamedQuery operation.

Class BatchGetQueryExecutionRequest

Container for the parameters to the BatchGetQueryExecution operation. 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.

Class BatchGetQueryExecutionResponse

This is the response object from the BatchGetQueryExecution operation.

Class ColumnInfo

Information about the columns in a query execution result.

Class CreateNamedQueryRequest

Container for the parameters to the CreateNamedQuery operation. Creates a named query in the specified workgroup. Requires that you have access to the workgroup.

For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

Class CreateNamedQueryResponse

This is the response object from the CreateNamedQuery operation.

Class CreateWorkGroupRequest

Container for the parameters to the CreateWorkGroup operation. Creates a workgroup with the specified name.

Class CreateWorkGroupResponse

This is the response object from the CreateWorkGroup operation.

Class Datum

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

Class DeleteNamedQueryRequest

Container for the parameters to the DeleteNamedQuery operation. Deletes the named query if you have access to the workgroup in which the query was saved.

For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

Class DeleteNamedQueryResponse

This is the response object from the DeleteNamedQuery operation.

Class DeleteWorkGroupRequest

Container for the parameters to the DeleteWorkGroup operation. Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.

Class DeleteWorkGroupResponse

This is the response object from the DeleteWorkGroup operation.

Class EncryptionConfiguration

If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE-KMS or CSE-KMS) and key information.

Class GetNamedQueryRequest

Container for the parameters to the GetNamedQuery operation. Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.

Class GetNamedQueryResponse

This is the response object from the GetNamedQuery operation.

Class GetQueryExecutionRequest

Container for the parameters to the GetQueryExecution operation. 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.

Class GetQueryExecutionResponse

This is the response object from the GetQueryExecution operation.

Class GetQueryResultsRequest

Container for the parameters to the GetQueryResults operation. Streams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3. For more information, see Query Results 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.

IAM principals with permission to the Amazon S3 GetObject action for the query results location are able to retrieve query results from Amazon S3 even if permission to the GetQueryResults action is denied. To restrict user or role access, ensure that Amazon S3 permissions to the Athena query location are denied.

Class GetQueryResultsResponse

This is the response object from the GetQueryResults operation.

Class GetWorkGroupRequest

Container for the parameters to the GetWorkGroup operation. Returns information about the workgroup with the specified name.

Class GetWorkGroupResponse

This is the response object from the GetWorkGroup operation.

Class InternalServerException

Athena exception

Class InvalidRequestException

Athena exception

Class ListNamedQueriesRequest

Container for the parameters to the ListNamedQueries operation. Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the workgroup. If a workgroup is not specified, lists the saved queries for the primary workgroup.

For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

Class ListNamedQueriesResponse

This is the response object from the ListNamedQueries operation.

Class ListQueryExecutionsRequest

Container for the parameters to the ListQueryExecutions operation. Provides a list of available query execution IDs for the queries in the specified workgroup. If a workgroup is not specified, returns a list of query execution IDs for the primary workgroup. Requires you to have access to the workgroup in which the queries ran.

For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

Class ListQueryExecutionsResponse

This is the response object from the ListQueryExecutions operation.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Lists the tags associated with this workgroup.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class ListWorkGroupsRequest

Container for the parameters to the ListWorkGroups operation. Lists available workgroups for the account.

Class ListWorkGroupsResponse

This is the response object from the ListWorkGroups operation.

Class NamedQuery

A query, where QueryString is the list of SQL query statements that comprise the query.

Class QueryExecution

Information about a single instance of a query execution.

Class QueryExecutionContext

The database in which the query execution occurs.

Class QueryExecutionStatistics

The amount of data scanned during the query execution and the amount of time that it took to execute, and the type of statement that was run.

Class QueryExecutionStatus

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

Class ResourceNotFoundException

Athena exception

Class ResultConfiguration

The location in Amazon S3 where query 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 workgroup settings.

Class ResultConfigurationUpdates

The information about the updates in the query results, such as output location and encryption configuration for the query results.

Class ResultSet

The metadata and rows that comprise a query result set. The metadata describes the column structure and data types.

Class ResultSetMetadata

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

Class Row

The rows that comprise a query result table.

Class StartQueryExecutionRequest

Container for the parameters to the StartQueryExecution operation. Runs the SQL query statements contained in the Query. Requires you to have access to the workgroup in which the query ran.

For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

Class StartQueryExecutionResponse

This is the response object from the StartQueryExecution operation.

Class StopQueryExecutionRequest

Container for the parameters to the StopQueryExecution operation. Stops a query execution. Requires you to have access to the workgroup in which the query ran.

For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

Class StopQueryExecutionResponse

This is the response object from the StopQueryExecution operation.

Class Tag

A tag that you can add to a resource. A tag is a label that you assign to an AWS Athena resource (a workgroup). Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize workgroups in Athena, for example, by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups in your account. The maximum tag key length is 128 Unicode characters in UTF-8. The maximum tag value length is 256 Unicode characters in UTF-8. You 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.

Class TagResourceRequest

Container for the parameters to the TagResource operation. Adds one or more tags to the resource, such as a workgroup. A tag is a label that you assign to an AWS Athena resource (a workgroup). Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize resources (workgroups) in Athena, for example, by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups in your account. For best practices, see AWS Tagging Strategies. The key length is from 1 (minimum) to 128 (maximum) Unicode characters in UTF-8. The tag value length is from 0 (minimum) to 256 (maximum) Unicode characters in UTF-8. You 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, separate them by commas.

Class TagResourceResponse

This is the response object from the TagResource operation.

Class TooManyRequestsException

Athena exception

Class UnprocessedNamedQueryId

Information about a named query ID that could not be processed.

Class UnprocessedQueryExecutionId

Describes a query execution that failed to process.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Removes one or more tags from the workgroup resource. Takes as an input a list of TagKey Strings separated by commas, and removes their tags at the same time.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class UpdateWorkGroupRequest

Container for the parameters to the UpdateWorkGroup operation. Updates the workgroup with the specified name. The workgroup's name cannot be changed.

Class UpdateWorkGroupResponse

This is the response object from the UpdateWorkGroup operation.

Class WorkGroup

A workgroup, which contains a name, description, creation time, state, and other configuration, listed under WorkGroup$Configuration. Each workgroup enables you to isolate queries for you or your group of users from other queries in the same account, to configure the query results location and the encryption configuration (known as workgroup settings), to enable sending query metrics to Amazon CloudWatch, and to establish per-query data usage control limits for all queries in a workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

Class WorkGroupConfiguration

The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup and whether workgroup settings override query 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.

Class WorkGroupConfigurationUpdates

The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.

Class WorkGroupSummary

The summary information for the workgroup, which includes its name, state, description, and the date and time it was created.