athena

package module
v1.48.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 2, 2024 License: Apache-2.0 Imports: 45 Imported by: 87

Documentation

Overview

Package athena provides the API client, operations, and parameter types for Amazon Athena.

Amazon Athena is an interactive query service that lets you use standard SQL to analyze data directly in Amazon S3. You can point Athena at your data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay only for the queries you run. Athena scales automatically—executing queries in parallel—so results are fast, even with large datasets and complex queries. For more information, see What is Amazon Athena in the Amazon Athena User Guide.

If you connect to Athena using the JDBC driver, use version 1.1.0 of the driver or later with the Amazon Athena API. Earlier version drivers do not support the API. For more information and to download the driver, see Accessing Amazon Athena with JDBC.

Index

Constants

View Source 
const ServiceAPIVersion = "2017-05-18"
View Source 
const ServiceID = "Athena"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.31.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.34.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.34.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters added in v1.34.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.34.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type BatchGetNamedQueryInput 

type BatchGetNamedQueryInput struct {

	// An array of query IDs.
	//
	// This member is required.
	NamedQueryIds []string
	// contains filtered or unexported fields
}

Contains an array of named query IDs.

type BatchGetNamedQueryOutput 

type BatchGetNamedQueryOutput struct {

	// Information about the named query IDs submitted.
	NamedQueries []types.NamedQuery

	// Information about provided query IDs.
	UnprocessedNamedQueryIds []types.UnprocessedNamedQueryId

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchGetPreparedStatementInput added in v1.16.0 

type BatchGetPreparedStatementInput struct {

	// A list of prepared statement names to return.
	//
	// This member is required.
	PreparedStatementNames []string

	// The name of the workgroup to which the prepared statements belong.
	//
	// This member is required.
	WorkGroup *string
	// contains filtered or unexported fields
}

type BatchGetPreparedStatementOutput added in v1.16.0 

type BatchGetPreparedStatementOutput struct {

	// The list of prepared statements returned.
	PreparedStatements []types.PreparedStatement

	// A list of one or more prepared statements that were requested but could not be
	// returned.
	UnprocessedPreparedStatementNames []types.UnprocessedPreparedStatementName

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchGetQueryExecutionInput 

type BatchGetQueryExecutionInput struct {

	// An array of query execution IDs.
	//
	// This member is required.
	QueryExecutionIds []string
	// contains filtered or unexported fields
}

Contains an array of query execution IDs.

type BatchGetQueryExecutionOutput 

type BatchGetQueryExecutionOutput struct {

	// Information about a query execution.
	QueryExecutions []types.QueryExecution

	// Information about the query executions that failed to run.
	UnprocessedQueryExecutionIds []types.UnprocessedQueryExecutionId

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CancelCapacityReservationInput added in v1.26.0 

type CancelCapacityReservationInput struct {

	// The name of the capacity reservation to cancel.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type CancelCapacityReservationOutput added in v1.26.0 

type CancelCapacityReservationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Amazon Athena.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) BatchGetNamedQuery 

func (c *Client) BatchGetNamedQuery(ctx context.Context, params *BatchGetNamedQueryInput, optFns ...func(*Options)) (*BatchGetNamedQueryOutput, error)

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 ListNamedQueriesInputto 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 BatchGetQueryExecutionInputto get details about each unique query execution, and ListQueryExecutionsInputto get a list of query execution IDs.

func (*Client) BatchGetPreparedStatement added in v1.16.0 

func (c *Client) BatchGetPreparedStatement(ctx context.Context, params *BatchGetPreparedStatementInput, optFns ...func(*Options)) (*BatchGetPreparedStatementOutput, error)

Returns the details of a single prepared statement or a list of up to 256 prepared statements for the array of prepared statement names that you provide. Requires you to have access to the workgroup to which the prepared statements belong. If a prepared statement cannot be retrieved for the name specified, the statement is listed in UnprocessedPreparedStatementNames .

func (*Client) BatchGetQueryExecution 

func (c *Client) BatchGetQueryExecution(ctx context.Context, params *BatchGetQueryExecutionInput, optFns ...func(*Options)) (*BatchGetQueryExecutionOutput, error)

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 BatchGetNamedQueryInputto get details about named queries.

func (*Client) CancelCapacityReservation added in v1.26.0 

func (c *Client) CancelCapacityReservation(ctx context.Context, params *CancelCapacityReservationInput, optFns ...func(*Options)) (*CancelCapacityReservationOutput, error)

Cancels the capacity reservation with the specified name. Cancelled reservations remain in your account and will be deleted 45 days after cancellation. During the 45 days, you cannot re-purpose or reuse a reservation that has been cancelled, but you can refer to its tags and view it for historical reference.

func (*Client) CreateCapacityReservation added in v1.26.0 

func (c *Client) CreateCapacityReservation(ctx context.Context, params *CreateCapacityReservationInput, optFns ...func(*Options)) (*CreateCapacityReservationOutput, error)

Creates a capacity reservation with the specified name and number of requested data processing units.

func (*Client) CreateDataCatalog 

func (c *Client) CreateDataCatalog(ctx context.Context, params *CreateDataCatalogInput, optFns ...func(*Options)) (*CreateDataCatalogOutput, error)

Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same Amazon Web Services account.

func (*Client) CreateNamedQuery 

func (c *Client) CreateNamedQuery(ctx context.Context, params *CreateNamedQueryInput, optFns ...func(*Options)) (*CreateNamedQueryOutput, error)

Creates a named query in the specified workgroup. Requires that you have access to the workgroup.

func (*Client) CreateNotebook added in v1.20.0 

func (c *Client) CreateNotebook(ctx context.Context, params *CreateNotebookInput, optFns ...func(*Options)) (*CreateNotebookOutput, error)

Creates an empty ipynb file in the specified Apache Spark enabled workgroup. Throws an error if a file in the workgroup with the same name already exists.

func (*Client) CreatePreparedStatement added in v1.2.0 

func (c *Client) CreatePreparedStatement(ctx context.Context, params *CreatePreparedStatementInput, optFns ...func(*Options)) (*CreatePreparedStatementOutput, error)

Creates a prepared statement for use with SQL queries in Athena.

func (*Client) CreatePresignedNotebookUrl added in v1.20.0 

func (c *Client) CreatePresignedNotebookUrl(ctx context.Context, params *CreatePresignedNotebookUrlInput, optFns ...func(*Options)) (*CreatePresignedNotebookUrlOutput, error)

Gets an authentication token and the URL at which the notebook can be accessed. During programmatic access, CreatePresignedNotebookUrl must be called every 10 minutes to refresh the authentication token. For information about granting programmatic access, see Grant programmatic access.

func (*Client) CreateWorkGroup 

func (c *Client) CreateWorkGroup(ctx context.Context, params *CreateWorkGroupInput, optFns ...func(*Options)) (*CreateWorkGroupOutput, error)

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

func (*Client) DeleteCapacityReservation added in v1.29.0 

func (c *Client) DeleteCapacityReservation(ctx context.Context, params *DeleteCapacityReservationInput, optFns ...func(*Options)) (*DeleteCapacityReservationOutput, error)

Deletes a cancelled capacity reservation. A reservation must be cancelled before it can be deleted. A deleted reservation is immediately removed from your account and can no longer be referenced, including by its ARN. A deleted reservation cannot be called by GetCapacityReservation , and deleted reservations do not appear in the output of ListCapacityReservations .

func (*Client) DeleteDataCatalog 

func (c *Client) DeleteDataCatalog(ctx context.Context, params *DeleteDataCatalogInput, optFns ...func(*Options)) (*DeleteDataCatalogOutput, error)

Deletes a data catalog.

func (*Client) DeleteNamedQuery 

func (c *Client) DeleteNamedQuery(ctx context.Context, params *DeleteNamedQueryInput, optFns ...func(*Options)) (*DeleteNamedQueryOutput, error)

Deletes the named query if you have access to the workgroup in which the query was saved.

func (*Client) DeleteNotebook added in v1.20.0 

func (c *Client) DeleteNotebook(ctx context.Context, params *DeleteNotebookInput, optFns ...func(*Options)) (*DeleteNotebookOutput, error)

Deletes the specified notebook.

func (*Client) DeletePreparedStatement added in v1.2.0 

func (c *Client) DeletePreparedStatement(ctx context.Context, params *DeletePreparedStatementInput, optFns ...func(*Options)) (*DeletePreparedStatementOutput, error)

Deletes the prepared statement with the specified name from the specified workgroup.

func (*Client) DeleteWorkGroup 

func (c *Client) DeleteWorkGroup(ctx context.Context, params *DeleteWorkGroupInput, optFns ...func(*Options)) (*DeleteWorkGroupOutput, error)

Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.

func (*Client) ExportNotebook added in v1.20.0 

func (c *Client) ExportNotebook(ctx context.Context, params *ExportNotebookInput, optFns ...func(*Options)) (*ExportNotebookOutput, error)

Exports the specified notebook and its metadata.

func (*Client) GetCalculationExecution added in v1.20.0 

func (c *Client) GetCalculationExecution(ctx context.Context, params *GetCalculationExecutionInput, optFns ...func(*Options)) (*GetCalculationExecutionOutput, error)

Describes a previously submitted calculation execution.

func (*Client) GetCalculationExecutionCode added in v1.20.0 

func (c *Client) GetCalculationExecutionCode(ctx context.Context, params *GetCalculationExecutionCodeInput, optFns ...func(*Options)) (*GetCalculationExecutionCodeOutput, error)

Retrieves the unencrypted code that was executed for the calculation.

func (*Client) GetCalculationExecutionStatus added in v1.20.0 

func (c *Client) GetCalculationExecutionStatus(ctx context.Context, params *GetCalculationExecutionStatusInput, optFns ...func(*Options)) (*GetCalculationExecutionStatusOutput, error)

Gets the status of a current calculation.

func (*Client) GetCapacityAssignmentConfiguration added in v1.26.0 

func (c *Client) GetCapacityAssignmentConfiguration(ctx context.Context, params *GetCapacityAssignmentConfigurationInput, optFns ...func(*Options)) (*GetCapacityAssignmentConfigurationOutput, error)

Gets the capacity assignment configuration for a capacity reservation, if one exists.

func (*Client) GetCapacityReservation added in v1.26.0 

func (c *Client) GetCapacityReservation(ctx context.Context, params *GetCapacityReservationInput, optFns ...func(*Options)) (*GetCapacityReservationOutput, error)

Returns information about the capacity reservation with the specified name.

func (*Client) GetDataCatalog 

func (c *Client) GetDataCatalog(ctx context.Context, params *GetDataCatalogInput, optFns ...func(*Options)) (*GetDataCatalogOutput, error)

Returns the specified data catalog.

func (*Client) GetDatabase 

func (c *Client) GetDatabase(ctx context.Context, params *GetDatabaseInput, optFns ...func(*Options)) (*GetDatabaseOutput, error)

Returns a database object for the specified database and data catalog.

func (*Client) GetNamedQuery 

func (c *Client) GetNamedQuery(ctx context.Context, params *GetNamedQueryInput, optFns ...func(*Options)) (*GetNamedQueryOutput, error)

Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.

func (*Client) GetNotebookMetadata added in v1.20.0 

func (c *Client) GetNotebookMetadata(ctx context.Context, params *GetNotebookMetadataInput, optFns ...func(*Options)) (*GetNotebookMetadataOutput, error)

Retrieves notebook metadata for the specified notebook ID.

func (*Client) GetPreparedStatement added in v1.2.0 

func (c *Client) GetPreparedStatement(ctx context.Context, params *GetPreparedStatementInput, optFns ...func(*Options)) (*GetPreparedStatementOutput, error)

Retrieves the prepared statement with the specified name from the specified workgroup.

func (*Client) GetQueryExecution 

func (c *Client) GetQueryExecution(ctx context.Context, params *GetQueryExecutionInput, optFns ...func(*Options)) (*GetQueryExecutionOutput, error)

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.

func (*Client) GetQueryResults 

func (c *Client) GetQueryResults(ctx context.Context, params *GetQueryResultsInput, optFns ...func(*Options)) (*GetQueryResultsOutput, error)

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

func (*Client) GetQueryRuntimeStatistics added in v1.18.0 

func (c *Client) GetQueryRuntimeStatistics(ctx context.Context, params *GetQueryRuntimeStatisticsInput, optFns ...func(*Options)) (*GetQueryRuntimeStatisticsOutput, error)

Returns query execution runtime statistics related to a single execution of a query if you have access to the workgroup in which the query ran. Statistics from the Timeline section of the response object are available as soon as QueryExecutionStatus$State is in a SUCCEEDED or FAILED state. The remaining non-timeline statistics in the response (like stage-level input and output row count and data size) are updated asynchronously and may not be available immediately after a query completes. The non-timeline statistics are also not included when a query has row-level filters defined in Lake Formation.

func (*Client) GetSession added in v1.20.0 

func (c *Client) GetSession(ctx context.Context, params *GetSessionInput, optFns ...func(*Options)) (*GetSessionOutput, error)

Gets the full details of a previously created session, including the session status and configuration.

func (*Client) GetSessionStatus added in v1.20.0 

func (c *Client) GetSessionStatus(ctx context.Context, params *GetSessionStatusInput, optFns ...func(*Options)) (*GetSessionStatusOutput, error)

Gets the current status of a session.

func (*Client) GetTableMetadata 

func (c *Client) GetTableMetadata(ctx context.Context, params *GetTableMetadataInput, optFns ...func(*Options)) (*GetTableMetadataOutput, error)

Returns table metadata for the specified catalog, database, and table.

func (*Client) GetWorkGroup 

func (c *Client) GetWorkGroup(ctx context.Context, params *GetWorkGroupInput, optFns ...func(*Options)) (*GetWorkGroupOutput, error)

Returns information about the workgroup with the specified name.

func (*Client) ImportNotebook added in v1.20.0 

func (c *Client) ImportNotebook(ctx context.Context, params *ImportNotebookInput, optFns ...func(*Options)) (*ImportNotebookOutput, error)

Imports a single ipynb file to a Spark enabled workgroup. To import the notebook, the request must specify a value for either Payload or NoteBookS3LocationUri . If neither is specified or both are specified, an InvalidRequestException occurs. The maximum file size that can be imported is 10 megabytes. If an ipynb file with the same name already exists in the workgroup, throws an error.

func (*Client) ListApplicationDPUSizes added in v1.20.0 

func (c *Client) ListApplicationDPUSizes(ctx context.Context, params *ListApplicationDPUSizesInput, optFns ...func(*Options)) (*ListApplicationDPUSizesOutput, error)

Returns the supported DPU sizes for the supported application runtimes (for example, Athena notebook version 1 ).

func (*Client) ListCalculationExecutions added in v1.20.0 

func (c *Client) ListCalculationExecutions(ctx context.Context, params *ListCalculationExecutionsInput, optFns ...func(*Options)) (*ListCalculationExecutionsOutput, error)

Lists the calculations that have been submitted to a session in descending order. Newer calculations are listed first; older calculations are listed later.

func (*Client) ListCapacityReservations added in v1.26.0 

func (c *Client) ListCapacityReservations(ctx context.Context, params *ListCapacityReservationsInput, optFns ...func(*Options)) (*ListCapacityReservationsOutput, error)

Lists the capacity reservations for the current account.

func (*Client) ListDataCatalogs 

func (c *Client) ListDataCatalogs(ctx context.Context, params *ListDataCatalogsInput, optFns ...func(*Options)) (*ListDataCatalogsOutput, error)

Lists the data catalogs in the current Amazon Web Services account.

In the Athena console, data catalogs are listed as "data sources" on the Data sources page under the Data source name column.

func (*Client) ListDatabases 

func (c *Client) ListDatabases(ctx context.Context, params *ListDatabasesInput, optFns ...func(*Options)) (*ListDatabasesOutput, error)

Lists the databases in the specified data catalog.

func (*Client) ListEngineVersions added in v1.2.0 

func (c *Client) ListEngineVersions(ctx context.Context, params *ListEngineVersionsInput, optFns ...func(*Options)) (*ListEngineVersionsOutput, error)

Returns a list of engine versions that are available to choose from, including the Auto option.

func (*Client) ListExecutors added in v1.20.0 

func (c *Client) ListExecutors(ctx context.Context, params *ListExecutorsInput, optFns ...func(*Options)) (*ListExecutorsOutput, error)

Lists, in descending order, the executors that joined a session. Newer executors are listed first; older executors are listed later. The result can be optionally filtered by state.

func (*Client) ListNamedQueries 

func (c *Client) ListNamedQueries(ctx context.Context, params *ListNamedQueriesInput, optFns ...func(*Options)) (*ListNamedQueriesOutput, error)

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

func (*Client) ListNotebookMetadata added in v1.20.0 

func (c *Client) ListNotebookMetadata(ctx context.Context, params *ListNotebookMetadataInput, optFns ...func(*Options)) (*ListNotebookMetadataOutput, error)

Displays the notebook files for the specified workgroup in paginated format.

func (*Client) ListNotebookSessions added in v1.20.0 

func (c *Client) ListNotebookSessions(ctx context.Context, params *ListNotebookSessionsInput, optFns ...func(*Options)) (*ListNotebookSessionsOutput, error)

Lists, in descending order, the sessions that have been created in a notebook that are in an active state like CREATING , CREATED , IDLE or BUSY . Newer sessions are listed first; older sessions are listed later.

func (*Client) ListPreparedStatements added in v1.2.0 

func (c *Client) ListPreparedStatements(ctx context.Context, params *ListPreparedStatementsInput, optFns ...func(*Options)) (*ListPreparedStatementsOutput, error)

Lists the prepared statements in the specified workgroup.

func (*Client) ListQueryExecutions 

func (c *Client) ListQueryExecutions(ctx context.Context, params *ListQueryExecutionsInput, optFns ...func(*Options)) (*ListQueryExecutionsOutput, error)

Provides a list of available query execution IDs for the queries in the specified workgroup. Athena keeps a query history for 45 days. 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.

func (*Client) ListSessions added in v1.20.0 

func (c *Client) ListSessions(ctx context.Context, params *ListSessionsInput, optFns ...func(*Options)) (*ListSessionsOutput, error)

Lists the sessions in a workgroup that are in an active state like CREATING , CREATED , IDLE , or BUSY . Newer sessions are listed first; older sessions are listed later.

func (*Client) ListTableMetadata 

func (c *Client) ListTableMetadata(ctx context.Context, params *ListTableMetadataInput, optFns ...func(*Options)) (*ListTableMetadataOutput, error)

Lists the metadata for the tables in the specified data catalog database.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists the tags associated with an Athena resource.

func (*Client) ListWorkGroups 

func (c *Client) ListWorkGroups(ctx context.Context, params *ListWorkGroupsInput, optFns ...func(*Options)) (*ListWorkGroupsOutput, error)

Lists available workgroups for the account.

func (*Client) Options added in v1.36.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutCapacityAssignmentConfiguration added in v1.26.0 

func (c *Client) PutCapacityAssignmentConfiguration(ctx context.Context, params *PutCapacityAssignmentConfigurationInput, optFns ...func(*Options)) (*PutCapacityAssignmentConfigurationOutput, error)

Puts a new capacity assignment configuration for a specified capacity reservation. If a capacity assignment configuration already exists for the capacity reservation, replaces the existing capacity assignment configuration.

func (*Client) StartCalculationExecution added in v1.20.0 

func (c *Client) StartCalculationExecution(ctx context.Context, params *StartCalculationExecutionInput, optFns ...func(*Options)) (*StartCalculationExecutionOutput, error)

Submits calculations for execution within a session. You can supply the code to run as an inline code block within the request.

The request syntax requires the StartCalculationExecutionRequest$CodeBlock parameter or the CalculationConfiguration$CodeBlock parameter, but not both. Because CalculationConfiguration$CodeBlockis deprecated, use the StartCalculationExecutionRequest$CodeBlock parameter instead.

func (*Client) StartQueryExecution 

func (c *Client) StartQueryExecution(ctx context.Context, params *StartQueryExecutionInput, optFns ...func(*Options)) (*StartQueryExecutionOutput, error)

Runs the SQL query statements contained in the Query . Requires you to have access to the workgroup in which the query ran. Running queries against an external catalog requires GetDataCatalogpermission to the catalog. For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samplesin the Amazon Athena User Guide.

func (*Client) StartSession added in v1.20.0 

func (c *Client) StartSession(ctx context.Context, params *StartSessionInput, optFns ...func(*Options)) (*StartSessionOutput, error)

Creates a session for running calculations within a workgroup. The session is ready when it reaches an IDLE state.

func (*Client) StopCalculationExecution added in v1.20.0 

func (c *Client) StopCalculationExecution(ctx context.Context, params *StopCalculationExecutionInput, optFns ...func(*Options)) (*StopCalculationExecutionOutput, error)

Requests the cancellation of a calculation. A StopCalculationExecution call on a calculation that is already in a terminal state (for example, STOPPED , FAILED , or COMPLETED ) succeeds but has no effect.

Cancelling a calculation is done on a best effort basis. If a calculation cannot be cancelled, you can be charged for its completion. If you are concerned about being charged for a calculation that cannot be cancelled, consider terminating the session in which the calculation is running.

func (*Client) StopQueryExecution 

func (c *Client) StopQueryExecution(ctx context.Context, params *StopQueryExecutionInput, optFns ...func(*Options)) (*StopQueryExecutionOutput, error)

Stops a query execution. Requires you to have access to the workgroup in which the query ran.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds one or more tags to an Athena resource. A tag is a label that you assign to a resource. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena workgroups, data catalogs, or capacity reservations 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.

func (*Client) TerminateSession added in v1.20.0 

func (c *Client) TerminateSession(ctx context.Context, params *TerminateSessionInput, optFns ...func(*Options)) (*TerminateSessionOutput, error)

Terminates an active session. A TerminateSession call on a session that is already inactive (for example, in a FAILED , TERMINATED or TERMINATING state) succeeds but has no effect. Calculations running in the session when TerminateSession is called are forcefully stopped, but may display as FAILED instead of STOPPED .

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes one or more tags from an Athena resource.

func (*Client) UpdateCapacityReservation added in v1.26.0 

func (c *Client) UpdateCapacityReservation(ctx context.Context, params *UpdateCapacityReservationInput, optFns ...func(*Options)) (*UpdateCapacityReservationOutput, error)

Updates the number of requested data processing units for the capacity reservation with the specified name.

func (*Client) UpdateDataCatalog 

func (c *Client) UpdateDataCatalog(ctx context.Context, params *UpdateDataCatalogInput, optFns ...func(*Options)) (*UpdateDataCatalogOutput, error)

Updates the data catalog that has the specified name.

func (*Client) UpdateNamedQuery added in v1.14.0 

func (c *Client) UpdateNamedQuery(ctx context.Context, params *UpdateNamedQueryInput, optFns ...func(*Options)) (*UpdateNamedQueryOutput, error)

Updates a NamedQuery object. The database or workgroup cannot be updated.

func (*Client) UpdateNotebook added in v1.20.0 

func (c *Client) UpdateNotebook(ctx context.Context, params *UpdateNotebookInput, optFns ...func(*Options)) (*UpdateNotebookOutput, error)

Updates the contents of a Spark notebook.

func (*Client) UpdateNotebookMetadata added in v1.20.0 

func (c *Client) UpdateNotebookMetadata(ctx context.Context, params *UpdateNotebookMetadataInput, optFns ...func(*Options)) (*UpdateNotebookMetadataOutput, error)

Updates the metadata for a notebook.

func (*Client) UpdatePreparedStatement added in v1.2.0 

func (c *Client) UpdatePreparedStatement(ctx context.Context, params *UpdatePreparedStatementInput, optFns ...func(*Options)) (*UpdatePreparedStatementOutput, error)

Updates a prepared statement.

func (*Client) UpdateWorkGroup 

func (c *Client) UpdateWorkGroup(ctx context.Context, params *UpdateWorkGroupInput, optFns ...func(*Options)) (*UpdateWorkGroupOutput, error)

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

type CreateCapacityReservationInput added in v1.26.0 

type CreateCapacityReservationInput struct {

	// The name of the capacity reservation to create.
	//
	// This member is required.
	Name *string

	// The number of requested data processing units.
	//
	// This member is required.
	TargetDpus *int32

	// The tags for the capacity reservation.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateCapacityReservationOutput added in v1.26.0 

type CreateCapacityReservationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateDataCatalogInput 

type CreateDataCatalogInput struct {

	// The name of the data catalog to create. The catalog name must be unique for the
	// Amazon Web Services account and can use a maximum of 127 alphanumeric,
	// underscore, at sign, or hyphen characters. The remainder of the length
	// constraint of 256 is reserved for use by Athena.
	//
	// This member is required.
	Name *string

	// The type of data catalog to create: LAMBDA for a federated catalog, HIVE for an
	// external hive metastore, or GLUE for an Glue Data Catalog.
	//
	// This member is required.
	Type types.DataCatalogType

	// A description of the data catalog to be created.
	Description *string

	// Specifies the Lambda function or functions to use for creating the data
	// catalog. This is a mapping whose values depend on the catalog type.
	//
	//   - For the HIVE data catalog type, use the following syntax. The
	//   metadata-function parameter is required. The sdk-version parameter is optional
	//   and defaults to the currently supported version.
	//
	// metadata-function=lambda_arn, sdk-version=version_number
	//
	//   - For the LAMBDA data catalog type, use one of the following sets of required
	//   parameters, but not both.
	//
	//   - If you have one Lambda function that processes metadata and another for
	//   reading the actual data, use the following syntax. Both parameters are required.
	//
	// metadata-function=lambda_arn, record-function=lambda_arn
	//
	//   - If you have a composite Lambda function that processes both metadata and
	//   data, use the following syntax to specify your Lambda function.
	//
	// function=lambda_arn
	//
	//   - The GLUE type takes a catalog ID parameter and is required. The catalog_id
	//   is the account ID of the Amazon Web Services account to which the Glue Data
	//   Catalog belongs.
	//
	// catalog-id=catalog_id
	//
	//   - The GLUE data catalog type also applies to the default AwsDataCatalog that
	//   already exists in your account, of which you can have only one and cannot
	//   modify.
	Parameters map[string]string

	// A list of comma separated tags to add to the data catalog that is created.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateDataCatalogOutput 

type CreateDataCatalogOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateNamedQueryInput 

type CreateNamedQueryInput struct {

	// The database to which the query belongs.
	//
	// This member is required.
	Database *string

	// The query name.
	//
	// This member is required.
	Name *string

	// The contents of the query with all query statements.
	//
	// This member is required.
	QueryString *string

	// A unique case-sensitive string used to ensure the request to create the query
	// is idempotent (executes only once). If another CreateNamedQuery request is
	// received, the same response is returned and another query is not created. If a
	// parameter has changed, for example, the QueryString , an error is returned.
	//
	// This token is listed as not required because Amazon Web Services SDKs (for
	// example the Amazon Web Services SDK for Java) auto-generate the token for users.
	// If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI,
	// you must provide this token or the action will fail.
	ClientRequestToken *string

	// The query description.
	Description *string

	// The name of the workgroup in which the named query is being created.
	WorkGroup *string
	// contains filtered or unexported fields
}

type CreateNamedQueryOutput 

type CreateNamedQueryOutput struct {

	// The unique ID of the query.
	NamedQueryId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateNotebookInput added in v1.20.0 

type CreateNotebookInput struct {

	// The name of the ipynb file to be created in the Spark workgroup, without the
	// .ipynb extension.
	//
	// This member is required.
	Name *string

	// The name of the Spark enabled workgroup in which the notebook will be created.
	//
	// This member is required.
	WorkGroup *string

	// A unique case-sensitive string used to ensure the request to create the
	// notebook is idempotent (executes only once).
	//
	// This token is listed as not required because Amazon Web Services SDKs (for
	// example the Amazon Web Services SDK for Java) auto-generate the token for you.
	// If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI,
	// you must provide this token or the action will fail.
	ClientRequestToken *string
	// contains filtered or unexported fields
}

type CreateNotebookOutput added in v1.20.0 

type CreateNotebookOutput struct {

	// A unique identifier for the notebook.
	NotebookId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreatePreparedStatementInput added in v1.2.0 

type CreatePreparedStatementInput struct {

	// The query string for the prepared statement.
	//
	// This member is required.
	QueryStatement *string

	// The name of the prepared statement.
	//
	// This member is required.
	StatementName *string

	// The name of the workgroup to which the prepared statement belongs.
	//
	// This member is required.
	WorkGroup *string

	// The description of the prepared statement.
	Description *string
	// contains filtered or unexported fields
}

type CreatePreparedStatementOutput added in v1.2.0 

type CreatePreparedStatementOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreatePresignedNotebookUrlInput added in v1.20.0 

type CreatePresignedNotebookUrlInput struct {

	// The session ID.
	//
	// This member is required.
	SessionId *string
	// contains filtered or unexported fields
}

type CreatePresignedNotebookUrlOutput added in v1.20.0 

type CreatePresignedNotebookUrlOutput struct {

	// The authentication token for the notebook.
	//
	// This member is required.
	AuthToken *string

	// The UTC epoch time when the authentication token expires.
	//
	// This member is required.
	AuthTokenExpirationTime *int64

	// The URL of the notebook. The URL includes the authentication token and notebook
	// file name and points directly to the opened notebook.
	//
	// This member is required.
	NotebookUrl *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateWorkGroupInput 

type CreateWorkGroupInput struct {

	// The workgroup name.
	//
	// This member is required.
	Name *string

	// 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.
	Configuration *types.WorkGroupConfiguration

	// The workgroup description.
	Description *string

	// A list of comma separated tags to add to the workgroup that is created.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateWorkGroupOutput 

type CreateWorkGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteCapacityReservationInput added in v1.29.0 

type DeleteCapacityReservationInput struct {

	// The name of the capacity reservation to delete.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type DeleteCapacityReservationOutput added in v1.29.0 

type DeleteCapacityReservationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDataCatalogInput 

type DeleteDataCatalogInput struct {

	// The name of the data catalog to delete.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type DeleteDataCatalogOutput 

type DeleteDataCatalogOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteNamedQueryInput 

type DeleteNamedQueryInput struct {

	// The unique ID of the query to delete.
	//
	// This member is required.
	NamedQueryId *string
	// contains filtered or unexported fields
}

type DeleteNamedQueryOutput 

type DeleteNamedQueryOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteNotebookInput added in v1.20.0 

type DeleteNotebookInput struct {

	// The ID of the notebook to delete.
	//
	// This member is required.
	NotebookId *string
	// contains filtered or unexported fields
}

type DeleteNotebookOutput added in v1.20.0 

type DeleteNotebookOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeletePreparedStatementInput added in v1.2.0 

type DeletePreparedStatementInput struct {

	// The name of the prepared statement to delete.
	//
	// This member is required.
	StatementName *string

	// The workgroup to which the statement to be deleted belongs.
	//
	// This member is required.
	WorkGroup *string
	// contains filtered or unexported fields
}

type DeletePreparedStatementOutput added in v1.2.0 

type DeletePreparedStatementOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteWorkGroupInput 

type DeleteWorkGroupInput struct {

	// The unique name of the workgroup to delete.
	//
	// This member is required.
	WorkGroup *string

	// The option to delete the workgroup and its contents even if the workgroup
	// contains any named queries, query executions, or notebooks.
	RecursiveDeleteOption *bool
	// contains filtered or unexported fields
}

type DeleteWorkGroupOutput 

type DeleteWorkGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.31.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.31.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.31.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.31.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.31.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type ExportNotebookInput added in v1.20.0 

type ExportNotebookInput struct {

	// The ID of the notebook to export.
	//
	// This member is required.
	NotebookId *string
	// contains filtered or unexported fields
}

type ExportNotebookOutput added in v1.20.0 

type ExportNotebookOutput struct {

	// The notebook metadata, including notebook ID, notebook name, and workgroup name.
	NotebookMetadata *types.NotebookMetadata

	// The content of the exported notebook.
	Payload *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetCalculationExecutionCodeInput added in v1.20.0 

type GetCalculationExecutionCodeInput struct {

	// The calculation execution UUID.
	//
	// This member is required.
	CalculationExecutionId *string
	// contains filtered or unexported fields
}

type GetCalculationExecutionCodeOutput added in v1.20.0 

type GetCalculationExecutionCodeOutput struct {

	// The unencrypted code that was executed for the calculation.
	CodeBlock *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetCalculationExecutionInput added in v1.20.0 

type GetCalculationExecutionInput struct {

	// The calculation execution UUID.
	//
	// This member is required.
	CalculationExecutionId *string
	// contains filtered or unexported fields
}

type GetCalculationExecutionOutput added in v1.20.0 

type GetCalculationExecutionOutput struct {

	// The calculation execution UUID.
	CalculationExecutionId *string

	// The description of the calculation execution.
	Description *string

	// Contains result information. This field is populated only if the calculation is
	// completed.
	Result *types.CalculationResult

	// The session ID that the calculation ran in.
	SessionId *string

	// Contains information about the data processing unit (DPU) execution time and
	// progress. This field is populated only when statistics are available.
	Statistics *types.CalculationStatistics

	// Contains information about the status of the calculation.
	Status *types.CalculationStatus

	// The Amazon S3 location in which calculation results are stored.
	WorkingDirectory *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetCalculationExecutionStatusInput added in v1.20.0 

type GetCalculationExecutionStatusInput struct {

	// The calculation execution UUID.
	//
	// This member is required.
	CalculationExecutionId *string
	// contains filtered or unexported fields
}

type GetCalculationExecutionStatusOutput added in v1.20.0 

type GetCalculationExecutionStatusOutput struct {

	// Contains information about the DPU execution time and progress.
	Statistics *types.CalculationStatistics

	// Contains information about the calculation execution status.
	Status *types.CalculationStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetCapacityAssignmentConfigurationInput added in v1.26.0 

type GetCapacityAssignmentConfigurationInput struct {

	// The name of the capacity reservation to retrieve the capacity assignment
	// configuration for.
	//
	// This member is required.
	CapacityReservationName *string
	// contains filtered or unexported fields
}

type GetCapacityAssignmentConfigurationOutput added in v1.26.0 

type GetCapacityAssignmentConfigurationOutput struct {

	// The requested capacity assignment configuration for the specified capacity
	// reservation.
	//
	// This member is required.
	CapacityAssignmentConfiguration *types.CapacityAssignmentConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetCapacityReservationInput added in v1.26.0 

type GetCapacityReservationInput struct {

	// The name of the capacity reservation.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type GetCapacityReservationOutput added in v1.26.0 

type GetCapacityReservationOutput struct {

	// The requested capacity reservation structure.
	//
	// This member is required.
	CapacityReservation *types.CapacityReservation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetDataCatalogInput 

type GetDataCatalogInput struct {

	// The name of the data catalog to return.
	//
	// This member is required.
	Name *string

	// The name of the workgroup. Required if making an IAM Identity Center request.
	WorkGroup *string
	// contains filtered or unexported fields
}

type GetDataCatalogOutput 

type GetDataCatalogOutput struct {

	// The data catalog returned.
	DataCatalog *types.DataCatalog

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetDatabaseInput 

type GetDatabaseInput struct {

	// The name of the data catalog that contains the database to return.
	//
	// This member is required.
	CatalogName *string

	// The name of the database to return.
	//
	// This member is required.
	DatabaseName *string

	// The name of the workgroup for which the metadata is being fetched. Required if
	// requesting an IAM Identity Center enabled Glue Data Catalog.
	WorkGroup *string
	// contains filtered or unexported fields
}

type GetDatabaseOutput 

type GetDatabaseOutput struct {

	// The database returned.
	Database *types.Database

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetNamedQueryInput 

type GetNamedQueryInput struct {

	// The unique ID of the query. Use ListNamedQueries to get query IDs.
	//
	// This member is required.
	NamedQueryId *string
	// contains filtered or unexported fields
}

type GetNamedQueryOutput 

type GetNamedQueryOutput struct {

	// Information about the query.
	NamedQuery *types.NamedQuery

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetNotebookMetadataInput added in v1.20.0 

type GetNotebookMetadataInput struct {

	// The ID of the notebook whose metadata is to be retrieved.
	//
	// This member is required.
	NotebookId *string
	// contains filtered or unexported fields
}

type GetNotebookMetadataOutput added in v1.20.0 

type GetNotebookMetadataOutput struct {

	// The metadata that is returned for the specified notebook ID.
	NotebookMetadata *types.NotebookMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetPreparedStatementInput added in v1.2.0 

type GetPreparedStatementInput struct {

	// The name of the prepared statement to retrieve.
	//
	// This member is required.
	StatementName *string

	// The workgroup to which the statement to be retrieved belongs.
	//
	// This member is required.
	WorkGroup *string
	// contains filtered or unexported fields
}

type GetPreparedStatementOutput added in v1.2.0 

type GetPreparedStatementOutput struct {

	// The name of the prepared statement that was retrieved.
	PreparedStatement *types.PreparedStatement

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetQueryExecutionInput 

type GetQueryExecutionInput struct {

	// The unique ID of the query execution.
	//
	// This member is required.
	QueryExecutionId *string
	// contains filtered or unexported fields
}

type GetQueryExecutionOutput 

type GetQueryExecutionOutput struct {

	// Information about the query execution.
	QueryExecution *types.QueryExecution

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetQueryResultsAPIClient added in v0.30.0 

type GetQueryResultsAPIClient interface {
	GetQueryResults(context.Context, *GetQueryResultsInput, ...func(*Options)) (*GetQueryResultsOutput, error)
}

GetQueryResultsAPIClient is a client that implements the GetQueryResults operation.

type GetQueryResultsInput 

type GetQueryResultsInput struct {

	// The unique ID of the query execution.
	//
	// This member is required.
	QueryExecutionId *string

	// The maximum number of results (rows) to return in this request.
	MaxResults *int32

	// 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.
	NextToken *string
	// contains filtered or unexported fields
}

type GetQueryResultsOutput 

type GetQueryResultsOutput struct {

	// 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.
	NextToken *string

	// The results of the query execution.
	ResultSet *types.ResultSet

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetQueryResultsPaginator added in v0.30.0 

type GetQueryResultsPaginator struct {
	// contains filtered or unexported fields
}

GetQueryResultsPaginator is a paginator for GetQueryResults

func NewGetQueryResultsPaginator added in v0.30.0 

func NewGetQueryResultsPaginator(client GetQueryResultsAPIClient, params *GetQueryResultsInput, optFns ...func(*GetQueryResultsPaginatorOptions)) *GetQueryResultsPaginator

NewGetQueryResultsPaginator returns a new GetQueryResultsPaginator

func (*GetQueryResultsPaginator) HasMorePages added in v0.30.0 

func (p *GetQueryResultsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetQueryResultsPaginator) NextPage added in v0.30.0 

func (p *GetQueryResultsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetQueryResultsOutput, error)

NextPage retrieves the next GetQueryResults page.

type GetQueryResultsPaginatorOptions added in v0.30.0 

type GetQueryResultsPaginatorOptions struct {
	// The maximum number of results (rows) to return in this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetQueryResultsPaginatorOptions is the paginator options for GetQueryResults

type GetQueryRuntimeStatisticsInput added in v1.18.0 

type GetQueryRuntimeStatisticsInput struct {

	// The unique ID of the query execution.
	//
	// This member is required.
	QueryExecutionId *string
	// contains filtered or unexported fields
}

type GetQueryRuntimeStatisticsOutput added in v1.18.0 

type GetQueryRuntimeStatisticsOutput struct {

	// Runtime statistics about the query execution.
	QueryRuntimeStatistics *types.QueryRuntimeStatistics

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSessionInput added in v1.20.0 

type GetSessionInput struct {

	// The session ID.
	//
	// This member is required.
	SessionId *string
	// contains filtered or unexported fields
}

type GetSessionOutput added in v1.20.0 

type GetSessionOutput struct {

	// The session description.
	Description *string

	// Contains engine configuration information like DPU usage.
	EngineConfiguration *types.EngineConfiguration

	// The engine version used by the session (for example, PySpark engine version 3 ).
	// You can get a list of engine versions by calling ListEngineVersions.
	EngineVersion *string

	// The notebook version.
	NotebookVersion *string

	// Contains the workgroup configuration information used by the session.
	SessionConfiguration *types.SessionConfiguration

	// The session ID.
	SessionId *string

	// Contains the DPU execution time.
	Statistics *types.SessionStatistics

	// Contains information about the status of the session.
	Status *types.SessionStatus

	// The workgroup to which the session belongs.
	WorkGroup *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSessionStatusInput added in v1.20.0 

type GetSessionStatusInput struct {

	// The session ID.
	//
	// This member is required.
	SessionId *string
	// contains filtered or unexported fields
}

type GetSessionStatusOutput added in v1.20.0 

type GetSessionStatusOutput struct {

	// The session ID.
	SessionId *string

	// Contains information about the status of the session.
	Status *types.SessionStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTableMetadataInput 

type GetTableMetadataInput struct {

	// The name of the data catalog that contains the database and table metadata to
	// return.
	//
	// This member is required.
	CatalogName *string

	// The name of the database that contains the table metadata to return.
	//
	// This member is required.
	DatabaseName *string

	// The name of the table for which metadata is returned.
	//
	// This member is required.
	TableName *string

	// The name of the workgroup for which the metadata is being fetched. Required if
	// requesting an IAM Identity Center enabled Glue Data Catalog.
	WorkGroup *string
	// contains filtered or unexported fields
}

type GetTableMetadataOutput 

type GetTableMetadataOutput struct {

	// An object that contains table metadata.
	TableMetadata *types.TableMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetWorkGroupInput 

type GetWorkGroupInput struct {

	// The name of the workgroup.
	//
	// This member is required.
	WorkGroup *string
	// contains filtered or unexported fields
}

type GetWorkGroupOutput 

type GetWorkGroupOutput struct {

	// Information about the workgroup.
	WorkGroup *types.WorkGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ImportNotebookInput added in v1.20.0 

type ImportNotebookInput struct {

	// The name of the notebook to import.
	//
	// This member is required.
	Name *string

	// The notebook content type. Currently, the only valid type is IPYNB .
	//
	// This member is required.
	Type types.NotebookType

	// The name of the Spark enabled workgroup to import the notebook to.
	//
	// This member is required.
	WorkGroup *string

	// A unique case-sensitive string used to ensure the request to import the
	// notebook is idempotent (executes only once).
	//
	// This token is listed as not required because Amazon Web Services SDKs (for
	// example the Amazon Web Services SDK for Java) auto-generate the token for you.
	// If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI,
	// you must provide this token or the action will fail.
	ClientRequestToken *string

	// A URI that specifies the Amazon S3 location of a notebook file in ipynb format.
	NotebookS3LocationUri *string

	// The notebook content to be imported. The payload must be in ipynb format.
	Payload *string
	// contains filtered or unexported fields
}

type ImportNotebookOutput added in v1.20.0 

type ImportNotebookOutput struct {

	// The ID assigned to the imported notebook.
	NotebookId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListApplicationDPUSizesAPIClient added in v1.20.0 

type ListApplicationDPUSizesAPIClient interface {
	ListApplicationDPUSizes(context.Context, *ListApplicationDPUSizesInput, ...func(*Options)) (*ListApplicationDPUSizesOutput, error)
}

ListApplicationDPUSizesAPIClient is a client that implements the ListApplicationDPUSizes operation.

type ListApplicationDPUSizesInput added in v1.20.0 

type ListApplicationDPUSizesInput struct {

	// Specifies the maximum number of results to return.
	MaxResults *int32

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated.
	NextToken *string
	// contains filtered or unexported fields
}

type ListApplicationDPUSizesOutput added in v1.20.0 

type ListApplicationDPUSizesOutput struct {

	// A list of the supported DPU sizes that the application runtime supports.
	ApplicationDPUSizes []types.ApplicationDPUSizes

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListApplicationDPUSizesPaginator added in v1.20.0 

type ListApplicationDPUSizesPaginator struct {
	// contains filtered or unexported fields
}

ListApplicationDPUSizesPaginator is a paginator for ListApplicationDPUSizes

func NewListApplicationDPUSizesPaginator added in v1.20.0 

func NewListApplicationDPUSizesPaginator(client ListApplicationDPUSizesAPIClient, params *ListApplicationDPUSizesInput, optFns ...func(*ListApplicationDPUSizesPaginatorOptions)) *ListApplicationDPUSizesPaginator

NewListApplicationDPUSizesPaginator returns a new ListApplicationDPUSizesPaginator

func (*ListApplicationDPUSizesPaginator) HasMorePages added in v1.20.0 

func (p *ListApplicationDPUSizesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListApplicationDPUSizesPaginator) NextPage added in v1.20.0 

func (p *ListApplicationDPUSizesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListApplicationDPUSizesOutput, error)

NextPage retrieves the next ListApplicationDPUSizes page.

type ListApplicationDPUSizesPaginatorOptions added in v1.20.0 

type ListApplicationDPUSizesPaginatorOptions struct {
	// Specifies the maximum number of results to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListApplicationDPUSizesPaginatorOptions is the paginator options for ListApplicationDPUSizes

type ListCalculationExecutionsAPIClient added in v1.20.0 

type ListCalculationExecutionsAPIClient interface {
	ListCalculationExecutions(context.Context, *ListCalculationExecutionsInput, ...func(*Options)) (*ListCalculationExecutionsOutput, error)
}

ListCalculationExecutionsAPIClient is a client that implements the ListCalculationExecutions operation.

type ListCalculationExecutionsInput added in v1.20.0 

type ListCalculationExecutionsInput struct {

	// The session ID.
	//
	// This member is required.
	SessionId *string

	// The maximum number of calculation executions to return.
	MaxResults *int32

	// 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.
	NextToken *string

	// A filter for a specific calculation execution state. A description of each
	// state follows.
	//
	// CREATING - The calculation is in the process of being created.
	//
	// CREATED - The calculation has been created and is ready to run.
	//
	// QUEUED - The calculation has been queued for processing.
	//
	// RUNNING - The calculation is running.
	//
	// CANCELING - A request to cancel the calculation has been received and the
	// system is working to stop it.
	//
	// CANCELED - The calculation is no longer running as the result of a cancel
	// request.
	//
	// COMPLETED - The calculation has completed without error.
	//
	// FAILED - The calculation failed and is no longer running.
	StateFilter types.CalculationExecutionState
	// contains filtered or unexported fields
}

type ListCalculationExecutionsOutput added in v1.20.0 

type ListCalculationExecutionsOutput struct {

	// A list of CalculationSummary objects.
	Calculations []types.CalculationSummary

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCalculationExecutionsPaginator added in v1.20.0 

type ListCalculationExecutionsPaginator struct {
	// contains filtered or unexported fields
}

ListCalculationExecutionsPaginator is a paginator for ListCalculationExecutions

func NewListCalculationExecutionsPaginator added in v1.20.0 

func NewListCalculationExecutionsPaginator(client ListCalculationExecutionsAPIClient, params *ListCalculationExecutionsInput, optFns ...func(*ListCalculationExecutionsPaginatorOptions)) *ListCalculationExecutionsPaginator

NewListCalculationExecutionsPaginator returns a new ListCalculationExecutionsPaginator

func (*ListCalculationExecutionsPaginator) HasMorePages added in v1.20.0 

func (p *ListCalculationExecutionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCalculationExecutionsPaginator) NextPage added in v1.20.0 

func (p *ListCalculationExecutionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCalculationExecutionsOutput, error)

NextPage retrieves the next ListCalculationExecutions page.

type ListCalculationExecutionsPaginatorOptions added in v1.20.0 

type ListCalculationExecutionsPaginatorOptions struct {
	// The maximum number of calculation executions to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCalculationExecutionsPaginatorOptions is the paginator options for ListCalculationExecutions

type ListCapacityReservationsAPIClient added in v1.26.0 

type ListCapacityReservationsAPIClient interface {
	ListCapacityReservations(context.Context, *ListCapacityReservationsInput, ...func(*Options)) (*ListCapacityReservationsOutput, error)
}

ListCapacityReservationsAPIClient is a client that implements the ListCapacityReservations operation.

type ListCapacityReservationsInput added in v1.26.0 

type ListCapacityReservationsInput struct {

	// Specifies the maximum number of results to return.
	MaxResults *int32

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCapacityReservationsOutput added in v1.26.0 

type ListCapacityReservationsOutput struct {

	// The capacity reservations for the current account.
	//
	// This member is required.
	CapacityReservations []types.CapacityReservation

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCapacityReservationsPaginator added in v1.26.0 

type ListCapacityReservationsPaginator struct {
	// contains filtered or unexported fields
}

ListCapacityReservationsPaginator is a paginator for ListCapacityReservations

func NewListCapacityReservationsPaginator added in v1.26.0 

func NewListCapacityReservationsPaginator(client ListCapacityReservationsAPIClient, params *ListCapacityReservationsInput, optFns ...func(*ListCapacityReservationsPaginatorOptions)) *ListCapacityReservationsPaginator

NewListCapacityReservationsPaginator returns a new ListCapacityReservationsPaginator

func (*ListCapacityReservationsPaginator) HasMorePages added in v1.26.0 

func (p *ListCapacityReservationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCapacityReservationsPaginator) NextPage added in v1.26.0 

func (p *ListCapacityReservationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCapacityReservationsOutput, error)

NextPage retrieves the next ListCapacityReservations page.

type ListCapacityReservationsPaginatorOptions added in v1.26.0 

type ListCapacityReservationsPaginatorOptions struct {
	// Specifies the maximum number of results to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCapacityReservationsPaginatorOptions is the paginator options for ListCapacityReservations

type ListDataCatalogsAPIClient added in v0.30.0 

type ListDataCatalogsAPIClient interface {
	ListDataCatalogs(context.Context, *ListDataCatalogsInput, ...func(*Options)) (*ListDataCatalogsOutput, error)
}

ListDataCatalogsAPIClient is a client that implements the ListDataCatalogs operation.

type ListDataCatalogsInput 

type ListDataCatalogsInput struct {

	// Specifies the maximum number of data catalogs to return.
	MaxResults *int32

	// 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.
	NextToken *string

	// The name of the workgroup. Required if making an IAM Identity Center request.
	WorkGroup *string
	// contains filtered or unexported fields
}

type ListDataCatalogsOutput 

type ListDataCatalogsOutput struct {

	// A summary list of data catalogs.
	DataCatalogsSummary []types.DataCatalogSummary

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDataCatalogsPaginator added in v0.30.0 

type ListDataCatalogsPaginator struct {
	// contains filtered or unexported fields
}

ListDataCatalogsPaginator is a paginator for ListDataCatalogs

func NewListDataCatalogsPaginator added in v0.30.0 

func NewListDataCatalogsPaginator(client ListDataCatalogsAPIClient, params *ListDataCatalogsInput, optFns ...func(*ListDataCatalogsPaginatorOptions)) *ListDataCatalogsPaginator

NewListDataCatalogsPaginator returns a new ListDataCatalogsPaginator

func (*ListDataCatalogsPaginator) HasMorePages added in v0.30.0 

func (p *ListDataCatalogsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDataCatalogsPaginator) NextPage added in v0.30.0 

func (p *ListDataCatalogsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDataCatalogsOutput, error)

NextPage retrieves the next ListDataCatalogs page.

type ListDataCatalogsPaginatorOptions added in v0.30.0 

type ListDataCatalogsPaginatorOptions struct {
	// Specifies the maximum number of data catalogs to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDataCatalogsPaginatorOptions is the paginator options for ListDataCatalogs

type ListDatabasesAPIClient added in v0.30.0 

type ListDatabasesAPIClient interface {
	ListDatabases(context.Context, *ListDatabasesInput, ...func(*Options)) (*ListDatabasesOutput, error)
}

ListDatabasesAPIClient is a client that implements the ListDatabases operation.

type ListDatabasesInput 

type ListDatabasesInput struct {

	// The name of the data catalog that contains the databases to return.
	//
	// This member is required.
	CatalogName *string

	// Specifies the maximum number of results to return.
	MaxResults *int32

	// 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.
	NextToken *string

	// The name of the workgroup for which the metadata is being fetched. Required if
	// requesting an IAM Identity Center enabled Glue Data Catalog.
	WorkGroup *string
	// contains filtered or unexported fields
}

type ListDatabasesOutput 

type ListDatabasesOutput struct {

	// A list of databases from a data catalog.
	DatabaseList []types.Database

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDatabasesPaginator added in v0.30.0 

type ListDatabasesPaginator struct {
	// contains filtered or unexported fields
}

ListDatabasesPaginator is a paginator for ListDatabases

func NewListDatabasesPaginator added in v0.30.0 

func NewListDatabasesPaginator(client ListDatabasesAPIClient, params *ListDatabasesInput, optFns ...func(*ListDatabasesPaginatorOptions)) *ListDatabasesPaginator

NewListDatabasesPaginator returns a new ListDatabasesPaginator

func (*ListDatabasesPaginator) HasMorePages added in v0.30.0 

func (p *ListDatabasesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDatabasesPaginator) NextPage added in v0.30.0 

func (p *ListDatabasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDatabasesOutput, error)

NextPage retrieves the next ListDatabases page.

type ListDatabasesPaginatorOptions added in v0.30.0 

type ListDatabasesPaginatorOptions struct {
	// Specifies the maximum number of results to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDatabasesPaginatorOptions is the paginator options for ListDatabases

type ListEngineVersionsAPIClient added in v1.18.0 

type ListEngineVersionsAPIClient interface {
	ListEngineVersions(context.Context, *ListEngineVersionsInput, ...func(*Options)) (*ListEngineVersionsOutput, error)
}

ListEngineVersionsAPIClient is a client that implements the ListEngineVersions operation.

type ListEngineVersionsInput added in v1.2.0 

type ListEngineVersionsInput struct {

	// The maximum number of engine versions to return in this request.
	MaxResults *int32

	// 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.
	NextToken *string
	// contains filtered or unexported fields
}

type ListEngineVersionsOutput added in v1.2.0 

type ListEngineVersionsOutput struct {

	// A list of engine versions that are available to choose from.
	EngineVersions []types.EngineVersion

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListEngineVersionsPaginator added in v1.18.0 

type ListEngineVersionsPaginator struct {
	// contains filtered or unexported fields
}

ListEngineVersionsPaginator is a paginator for ListEngineVersions

func NewListEngineVersionsPaginator added in v1.18.0 

func NewListEngineVersionsPaginator(client ListEngineVersionsAPIClient, params *ListEngineVersionsInput, optFns ...func(*ListEngineVersionsPaginatorOptions)) *ListEngineVersionsPaginator

NewListEngineVersionsPaginator returns a new ListEngineVersionsPaginator

func (*ListEngineVersionsPaginator) HasMorePages added in v1.18.0 

func (p *ListEngineVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEngineVersionsPaginator) NextPage added in v1.18.0 

func (p *ListEngineVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEngineVersionsOutput, error)

NextPage retrieves the next ListEngineVersions page.

type ListEngineVersionsPaginatorOptions added in v1.18.0 

type ListEngineVersionsPaginatorOptions struct {
	// The maximum number of engine versions to return in this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListEngineVersionsPaginatorOptions is the paginator options for ListEngineVersions

type ListExecutorsAPIClient added in v1.20.0 

type ListExecutorsAPIClient interface {
	ListExecutors(context.Context, *ListExecutorsInput, ...func(*Options)) (*ListExecutorsOutput, error)
}

ListExecutorsAPIClient is a client that implements the ListExecutors operation.

type ListExecutorsInput added in v1.20.0 

type ListExecutorsInput struct {

	// The session ID.
	//
	// This member is required.
	SessionId *string

	// A filter for a specific executor state. A description of each state follows.
	//
	// CREATING - The executor is being started, including acquiring resources.
	//
	// CREATED - The executor has been started.
	//
	// REGISTERED - The executor has been registered.
	//
	// TERMINATING - The executor is in the process of shutting down.
	//
	// TERMINATED - The executor is no longer running.
	//
	// FAILED - Due to a failure, the executor is no longer running.
	ExecutorStateFilter types.ExecutorState

	// The maximum number of executors to return.
	MaxResults *int32

	// 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.
	NextToken *string
	// contains filtered or unexported fields
}

type ListExecutorsOutput added in v1.20.0 

type ListExecutorsOutput struct {

	// The session ID.
	//
	// This member is required.
	SessionId *string

	// Contains summary information about the executor.
	ExecutorsSummary []types.ExecutorsSummary

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListExecutorsPaginator added in v1.20.0 

type ListExecutorsPaginator struct {
	// contains filtered or unexported fields
}

ListExecutorsPaginator is a paginator for ListExecutors

func NewListExecutorsPaginator added in v1.20.0 

func NewListExecutorsPaginator(client ListExecutorsAPIClient, params *ListExecutorsInput, optFns ...func(*ListExecutorsPaginatorOptions)) *ListExecutorsPaginator

NewListExecutorsPaginator returns a new ListExecutorsPaginator

func (*ListExecutorsPaginator) HasMorePages added in v1.20.0 

func (p *ListExecutorsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListExecutorsPaginator) NextPage added in v1.20.0 

func (p *ListExecutorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListExecutorsOutput, error)

NextPage retrieves the next ListExecutors page.

type ListExecutorsPaginatorOptions added in v1.20.0 

type ListExecutorsPaginatorOptions struct {
	// The maximum number of executors to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListExecutorsPaginatorOptions is the paginator options for ListExecutors

type ListNamedQueriesAPIClient added in v0.30.0 

type ListNamedQueriesAPIClient interface {
	ListNamedQueries(context.Context, *ListNamedQueriesInput, ...func(*Options)) (*ListNamedQueriesOutput, error)
}

ListNamedQueriesAPIClient is a client that implements the ListNamedQueries operation.

type ListNamedQueriesInput 

type ListNamedQueriesInput struct {

	// The maximum number of queries to return in this request.
	MaxResults *int32

	// 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.
	NextToken *string

	// The name of the workgroup from which the named queries are being returned. If a
	// workgroup is not specified, the saved queries for the primary workgroup are
	// returned.
	WorkGroup *string
	// contains filtered or unexported fields
}

type ListNamedQueriesOutput 

type ListNamedQueriesOutput struct {

	// The list of unique query IDs.
	NamedQueryIds []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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListNamedQueriesPaginator added in v0.30.0 

type ListNamedQueriesPaginator struct {
	// contains filtered or unexported fields
}

ListNamedQueriesPaginator is a paginator for ListNamedQueries

func NewListNamedQueriesPaginator added in v0.30.0 

func NewListNamedQueriesPaginator(client ListNamedQueriesAPIClient, params *ListNamedQueriesInput, optFns ...func(*ListNamedQueriesPaginatorOptions)) *ListNamedQueriesPaginator

NewListNamedQueriesPaginator returns a new ListNamedQueriesPaginator

func (*ListNamedQueriesPaginator) HasMorePages added in v0.30.0 

func (p *ListNamedQueriesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListNamedQueriesPaginator) NextPage added in v0.30.0 

func (p *ListNamedQueriesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListNamedQueriesOutput, error)

NextPage retrieves the next ListNamedQueries page.

type ListNamedQueriesPaginatorOptions added in v0.30.0 

type ListNamedQueriesPaginatorOptions struct {
	// The maximum number of queries to return in this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListNamedQueriesPaginatorOptions is the paginator options for ListNamedQueries

type ListNotebookMetadataInput added in v1.20.0 

type ListNotebookMetadataInput struct {

	// The name of the Spark enabled workgroup to retrieve notebook metadata for.
	//
	// This member is required.
	WorkGroup *string

	// Search filter string.
	Filters *types.FilterDefinition

	// Specifies the maximum number of results to return.
	MaxResults *int32

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated.
	NextToken *string
	// contains filtered or unexported fields
}

type ListNotebookMetadataOutput added in v1.20.0 

type ListNotebookMetadataOutput struct {

	// 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.
	NextToken *string

	// The list of notebook metadata for the specified workgroup.
	NotebookMetadataList []types.NotebookMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListNotebookSessionsInput added in v1.20.0 

type ListNotebookSessionsInput struct {

	// The ID of the notebook to list sessions for.
	//
	// This member is required.
	NotebookId *string

	// The maximum number of notebook sessions to return.
	MaxResults *int32

	// 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.
	NextToken *string
	// contains filtered or unexported fields
}

type ListNotebookSessionsOutput added in v1.20.0 

type ListNotebookSessionsOutput struct {

	// A list of the sessions belonging to the notebook.
	//
	// This member is required.
	NotebookSessionsList []types.NotebookSessionSummary

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPreparedStatementsAPIClient added in v1.2.0 

type ListPreparedStatementsAPIClient interface {
	ListPreparedStatements(context.Context, *ListPreparedStatementsInput, ...func(*Options)) (*ListPreparedStatementsOutput, error)
}

ListPreparedStatementsAPIClient is a client that implements the ListPreparedStatements operation.

type ListPreparedStatementsInput added in v1.2.0 

type ListPreparedStatementsInput struct {

	// The workgroup to list the prepared statements for.
	//
	// This member is required.
	WorkGroup *string

	// The maximum number of results to return in this request.
	MaxResults *int32

	// 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.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPreparedStatementsOutput added in v1.2.0 

type ListPreparedStatementsOutput struct {

	// 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.
	NextToken *string

	// The list of prepared statements for the workgroup.
	PreparedStatements []types.PreparedStatementSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPreparedStatementsPaginator added in v1.2.0 

type ListPreparedStatementsPaginator struct {
	// contains filtered or unexported fields
}

ListPreparedStatementsPaginator is a paginator for ListPreparedStatements

func NewListPreparedStatementsPaginator added in v1.2.0 

func NewListPreparedStatementsPaginator(client ListPreparedStatementsAPIClient, params *ListPreparedStatementsInput, optFns ...func(*ListPreparedStatementsPaginatorOptions)) *ListPreparedStatementsPaginator

NewListPreparedStatementsPaginator returns a new ListPreparedStatementsPaginator

func (*ListPreparedStatementsPaginator) HasMorePages added in v1.2.0 

func (p *ListPreparedStatementsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPreparedStatementsPaginator) NextPage added in v1.2.0 

func (p *ListPreparedStatementsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPreparedStatementsOutput, error)

NextPage retrieves the next ListPreparedStatements page.

type ListPreparedStatementsPaginatorOptions added in v1.2.0 

type ListPreparedStatementsPaginatorOptions struct {
	// The maximum number of results to return in this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPreparedStatementsPaginatorOptions is the paginator options for ListPreparedStatements

type ListQueryExecutionsAPIClient added in v0.30.0 

type ListQueryExecutionsAPIClient interface {
	ListQueryExecutions(context.Context, *ListQueryExecutionsInput, ...func(*Options)) (*ListQueryExecutionsOutput, error)
}

ListQueryExecutionsAPIClient is a client that implements the ListQueryExecutions operation.

type ListQueryExecutionsInput 

type ListQueryExecutionsInput struct {

	// The maximum number of query executions to return in this request.
	MaxResults *int32

	// 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.
	NextToken *string

	// The name of the workgroup from which queries are being returned. If a workgroup
	// is not specified, a list of available query execution IDs for the queries in the
	// primary workgroup is returned.
	WorkGroup *string
	// contains filtered or unexported fields
}

type ListQueryExecutionsOutput 

type ListQueryExecutionsOutput struct {

	// A token to be used by the next request if this request is truncated.
	NextToken *string

	// The unique IDs of each query execution as an array of strings.
	QueryExecutionIds []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListQueryExecutionsPaginator added in v0.30.0 

type ListQueryExecutionsPaginator struct {
	// contains filtered or unexported fields
}

ListQueryExecutionsPaginator is a paginator for ListQueryExecutions

func NewListQueryExecutionsPaginator added in v0.30.0 

func NewListQueryExecutionsPaginator(client ListQueryExecutionsAPIClient, params *ListQueryExecutionsInput, optFns ...func(*ListQueryExecutionsPaginatorOptions)) *ListQueryExecutionsPaginator

NewListQueryExecutionsPaginator returns a new ListQueryExecutionsPaginator

func (*ListQueryExecutionsPaginator) HasMorePages added in v0.30.0 

func (p *ListQueryExecutionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListQueryExecutionsPaginator) NextPage added in v0.30.0 

func (p *ListQueryExecutionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListQueryExecutionsOutput, error)

NextPage retrieves the next ListQueryExecutions page.

type ListQueryExecutionsPaginatorOptions added in v0.30.0 

type ListQueryExecutionsPaginatorOptions struct {
	// The maximum number of query executions to return in this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListQueryExecutionsPaginatorOptions is the paginator options for ListQueryExecutions

type ListSessionsAPIClient added in v1.20.0 

type ListSessionsAPIClient interface {
	ListSessions(context.Context, *ListSessionsInput, ...func(*Options)) (*ListSessionsOutput, error)
}

ListSessionsAPIClient is a client that implements the ListSessions operation.

type ListSessionsInput added in v1.20.0 

type ListSessionsInput struct {

	// The workgroup to which the session belongs.
	//
	// This member is required.
	WorkGroup *string

	// The maximum number of sessions to return.
	MaxResults *int32

	// 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.
	NextToken *string

	// A filter for a specific session state. A description of each state follows.
	//
	// CREATING - The session is being started, including acquiring resources.
	//
	// CREATED - The session has been started.
	//
	// IDLE - The session is able to accept a calculation.
	//
	// BUSY - The session is processing another task and is unable to accept a
	// calculation.
	//
	// TERMINATING - The session is in the process of shutting down.
	//
	// TERMINATED - The session and its resources are no longer running.
	//
	// DEGRADED - The session has no healthy coordinators.
	//
	// FAILED - Due to a failure, the session and its resources are no longer running.
	StateFilter types.SessionState
	// contains filtered or unexported fields
}

type ListSessionsOutput added in v1.20.0 

type ListSessionsOutput struct {

	// 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.
	NextToken *string

	// A list of sessions.
	Sessions []types.SessionSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSessionsPaginator added in v1.20.0 

type ListSessionsPaginator struct {
	// contains filtered or unexported fields
}

ListSessionsPaginator is a paginator for ListSessions

func NewListSessionsPaginator added in v1.20.0 

func NewListSessionsPaginator(client ListSessionsAPIClient, params *ListSessionsInput, optFns ...func(*ListSessionsPaginatorOptions)) *ListSessionsPaginator

NewListSessionsPaginator returns a new ListSessionsPaginator

func (*ListSessionsPaginator) HasMorePages added in v1.20.0 

func (p *ListSessionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSessionsPaginator) NextPage added in v1.20.0 

func (p *ListSessionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSessionsOutput, error)

NextPage retrieves the next ListSessions page.

type ListSessionsPaginatorOptions added in v1.20.0 

type ListSessionsPaginatorOptions struct {
	// The maximum number of sessions to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSessionsPaginatorOptions is the paginator options for ListSessions

type ListTableMetadataAPIClient added in v0.30.0 

type ListTableMetadataAPIClient interface {
	ListTableMetadata(context.Context, *ListTableMetadataInput, ...func(*Options)) (*ListTableMetadataOutput, error)
}

ListTableMetadataAPIClient is a client that implements the ListTableMetadata operation.

type ListTableMetadataInput 

type ListTableMetadataInput struct {

	// The name of the data catalog for which table metadata should be returned.
	//
	// This member is required.
	CatalogName *string

	// The name of the database for which table metadata should be returned.
	//
	// This member is required.
	DatabaseName *string

	// A regex filter that pattern-matches table names. If no expression is supplied,
	// metadata for all tables are listed.
	Expression *string

	// Specifies the maximum number of results to return.
	MaxResults *int32

	// 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.
	NextToken *string

	// The name of the workgroup for which the metadata is being fetched. Required if
	// requesting an IAM Identity Center enabled Glue Data Catalog.
	WorkGroup *string
	// contains filtered or unexported fields
}

type ListTableMetadataOutput 

type ListTableMetadataOutput struct {

	// 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.
	NextToken *string

	// A list of table metadata.
	TableMetadataList []types.TableMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTableMetadataPaginator added in v0.30.0 

type ListTableMetadataPaginator struct {
	// contains filtered or unexported fields
}

ListTableMetadataPaginator is a paginator for ListTableMetadata

func NewListTableMetadataPaginator added in v0.30.0 

func NewListTableMetadataPaginator(client ListTableMetadataAPIClient, params *ListTableMetadataInput, optFns ...func(*ListTableMetadataPaginatorOptions)) *ListTableMetadataPaginator

NewListTableMetadataPaginator returns a new ListTableMetadataPaginator

func (*ListTableMetadataPaginator) HasMorePages added in v0.30.0 

func (p *ListTableMetadataPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTableMetadataPaginator) NextPage added in v0.30.0 

func (p *ListTableMetadataPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTableMetadataOutput, error)

NextPage retrieves the next ListTableMetadata page.

type ListTableMetadataPaginatorOptions added in v0.30.0 

type ListTableMetadataPaginatorOptions struct {
	// Specifies the maximum number of results to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTableMetadataPaginatorOptions is the paginator options for ListTableMetadata

type ListTagsForResourceAPIClient added in v0.30.0 

type ListTagsForResourceAPIClient interface {
	ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error)
}

ListTagsForResourceAPIClient is a client that implements the ListTagsForResource operation.

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// Lists the tags for the resource with the specified ARN.
	//
	// This member is required.
	ResourceARN *string

	// The maximum number of results to be returned per request that lists the tags
	// for the resource.
	MaxResults *int32

	// The token for the next set of results, or null if there are no additional
	// results for this request, where the request lists the tags for the resource with
	// the specified ARN.
	NextToken *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// A token to be used by the next request if this request is truncated.
	NextToken *string

	// The list of tags associated with the specified resource.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTagsForResourcePaginator added in v0.30.0 

type ListTagsForResourcePaginator struct {
	// contains filtered or unexported fields
}

ListTagsForResourcePaginator is a paginator for ListTagsForResource

func NewListTagsForResourcePaginator added in v0.30.0 

func NewListTagsForResourcePaginator(client ListTagsForResourceAPIClient, params *ListTagsForResourceInput, optFns ...func(*ListTagsForResourcePaginatorOptions)) *ListTagsForResourcePaginator

NewListTagsForResourcePaginator returns a new ListTagsForResourcePaginator

func (*ListTagsForResourcePaginator) HasMorePages added in v0.30.0 

func (p *ListTagsForResourcePaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTagsForResourcePaginator) NextPage added in v0.30.0 

func (p *ListTagsForResourcePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

NextPage retrieves the next ListTagsForResource page.

type ListTagsForResourcePaginatorOptions added in v0.30.0 

type ListTagsForResourcePaginatorOptions struct {
	// The maximum number of results to be returned per request that lists the tags
	// for the resource.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTagsForResourcePaginatorOptions is the paginator options for ListTagsForResource

type ListWorkGroupsAPIClient added in v0.30.0 

type ListWorkGroupsAPIClient interface {
	ListWorkGroups(context.Context, *ListWorkGroupsInput, ...func(*Options)) (*ListWorkGroupsOutput, error)
}

ListWorkGroupsAPIClient is a client that implements the ListWorkGroups operation.

type ListWorkGroupsInput 

type ListWorkGroupsInput struct {

	// The maximum number of workgroups to return in this request.
	MaxResults *int32

	// 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.
	NextToken *string
	// contains filtered or unexported fields
}

type ListWorkGroupsOutput 

type ListWorkGroupsOutput struct {

	// 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.
	NextToken *string

	// A list of WorkGroupSummary objects that include the names, descriptions, creation times, and
	// states for each workgroup.
	WorkGroups []types.WorkGroupSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListWorkGroupsPaginator added in v0.30.0 

type ListWorkGroupsPaginator struct {
	// contains filtered or unexported fields
}

ListWorkGroupsPaginator is a paginator for ListWorkGroups

func NewListWorkGroupsPaginator added in v0.30.0 

func NewListWorkGroupsPaginator(client ListWorkGroupsAPIClient, params *ListWorkGroupsInput, optFns ...func(*ListWorkGroupsPaginatorOptions)) *ListWorkGroupsPaginator

NewListWorkGroupsPaginator returns a new ListWorkGroupsPaginator

func (*ListWorkGroupsPaginator) HasMorePages added in v0.30.0 

func (p *ListWorkGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWorkGroupsPaginator) NextPage added in v0.30.0 

func (p *ListWorkGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWorkGroupsOutput, error)

NextPage retrieves the next ListWorkGroups page.

type ListWorkGroupsPaginatorOptions added in v0.30.0 

type ListWorkGroupsPaginatorOptions struct {
	// The maximum number of workgroups to return in this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListWorkGroupsPaginatorOptions is the paginator options for ListWorkGroups

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.34.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutCapacityAssignmentConfigurationInput added in v1.26.0 

type PutCapacityAssignmentConfigurationInput struct {

	// The list of assignments for the capacity assignment configuration.
	//
	// This member is required.
	CapacityAssignments []types.CapacityAssignment

	// The name of the capacity reservation to put a capacity assignment configuration
	// for.
	//
	// This member is required.
	CapacityReservationName *string
	// contains filtered or unexported fields
}

type PutCapacityAssignmentConfigurationOutput added in v1.26.0 

type PutCapacityAssignmentConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type StartCalculationExecutionInput added in v1.20.0 

type StartCalculationExecutionInput struct {

	// The session ID.
	//
	// This member is required.
	SessionId *string

	// Contains configuration information for the calculation.
	//
	// Deprecated: Kepler Post GA Tasks : https://sim.amazon.com/issues/ATHENA-39828
	CalculationConfiguration *types.CalculationConfiguration

	// A unique case-sensitive string used to ensure the request to create the
	// calculation is idempotent (executes only once). If another
	// StartCalculationExecutionRequest is received, the same response is returned and
	// another calculation is not created. If a parameter has changed, an error is
	// returned.
	//
	// This token is listed as not required because Amazon Web Services SDKs (for
	// example the Amazon Web Services SDK for Java) auto-generate the token for users.
	// If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI,
	// you must provide this token or the action will fail.
	ClientRequestToken *string

	// A string that contains the code of the calculation. Use this parameter instead
	// of CalculationConfiguration$CodeBlock, which is deprecated.
	CodeBlock *string

	// A description of the calculation.
	Description *string
	// contains filtered or unexported fields
}

type StartCalculationExecutionOutput added in v1.20.0 

type StartCalculationExecutionOutput struct {

	// The calculation execution UUID.
	CalculationExecutionId *string

	// CREATING - The calculation is in the process of being created.
	//
	// CREATED - The calculation has been created and is ready to run.
	//
	// QUEUED - The calculation has been queued for processing.
	//
	// RUNNING - The calculation is running.
	//
	// CANCELING - A request to cancel the calculation has been received and the
	// system is working to stop it.
	//
	// CANCELED - The calculation is no longer running as the result of a cancel
	// request.
	//
	// COMPLETED - The calculation has completed without error.
	//
	// FAILED - The calculation failed and is no longer running.
	State types.CalculationExecutionState

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartQueryExecutionInput 

type StartQueryExecutionInput struct {

	// The SQL query statements to be executed.
	//
	// This member is required.
	QueryString *string

	// A unique case-sensitive string used to ensure the request to create the query
	// is idempotent (executes only once). If another StartQueryExecution request is
	// received, the same response is returned and another query is not created. An
	// error is returned if a parameter, such as QueryString , has changed. A call to
	// StartQueryExecution that uses a previous client request token returns the same
	// QueryExecutionId even if the requester doesn't have permission on the tables
	// specified in QueryString .
	//
	// This token is listed as not required because Amazon Web Services SDKs (for
	// example the Amazon Web Services SDK for Java) auto-generate the token for users.
	// If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI,
	// you must provide this token or the action will fail.
	ClientRequestToken *string

	// 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.
	ExecutionParameters []string

	// The database within which the query executes.
	QueryExecutionContext *types.QueryExecutionContext

	// Specifies information about where and how to save the results of the query
	// execution. If the query runs in a workgroup, then workgroup's settings may
	// override query settings. This affects the query results location. The workgroup
	// settings override is specified in EnforceWorkGroupConfiguration (true/false) in
	// the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
	ResultConfiguration *types.ResultConfiguration

	// Specifies the query result reuse behavior for the query.
	ResultReuseConfiguration *types.ResultReuseConfiguration

	// The name of the workgroup in which the query is being started.
	WorkGroup *string
	// contains filtered or unexported fields
}

type StartQueryExecutionOutput 

type StartQueryExecutionOutput struct {

	// The unique ID of the query that ran as a result of this request.
	QueryExecutionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartSessionInput added in v1.20.0 

type StartSessionInput struct {

	// Contains engine data processing unit (DPU) configuration settings and parameter
	// mappings.
	//
	// This member is required.
	EngineConfiguration *types.EngineConfiguration

	// The workgroup to which the session belongs.
	//
	// This member is required.
	WorkGroup *string

	// A unique case-sensitive string used to ensure the request to create the session
	// is idempotent (executes only once). If another StartSessionRequest is received,
	// the same response is returned and another session is not created. If a parameter
	// has changed, an error is returned.
	//
	// This token is listed as not required because Amazon Web Services SDKs (for
	// example the Amazon Web Services SDK for Java) auto-generate the token for users.
	// If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI,
	// you must provide this token or the action will fail.
	ClientRequestToken *string

	// The session description.
	Description *string

	// The notebook version. This value is supplied automatically for notebook
	// sessions in the Athena console and is not required for programmatic session
	// access. The only valid notebook version is Athena notebook version 1 . If you
	// specify a value for NotebookVersion , you must also specify a value for
	// NotebookId . See EngineConfiguration$AdditionalConfigs.
	NotebookVersion *string

	// The idle timeout in minutes for the session.
	SessionIdleTimeoutInMinutes *int32
	// contains filtered or unexported fields
}

type StartSessionOutput added in v1.20.0 

type StartSessionOutput struct {

	// The session ID.
	SessionId *string

	// The state of the session. A description of each state follows.
	//
	// CREATING - The session is being started, including acquiring resources.
	//
	// CREATED - The session has been started.
	//
	// IDLE - The session is able to accept a calculation.
	//
	// BUSY - The session is processing another task and is unable to accept a
	// calculation.
	//
	// TERMINATING - The session is in the process of shutting down.
	//
	// TERMINATED - The session and its resources are no longer running.
	//
	// DEGRADED - The session has no healthy coordinators.
	//
	// FAILED - Due to a failure, the session and its resources are no longer running.
	State types.SessionState

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopCalculationExecutionInput added in v1.20.0 

type StopCalculationExecutionInput struct {

	// The calculation execution UUID.
	//
	// This member is required.
	CalculationExecutionId *string
	// contains filtered or unexported fields
}

type StopCalculationExecutionOutput added in v1.20.0 

type StopCalculationExecutionOutput struct {

	// CREATING - The calculation is in the process of being created.
	//
	// CREATED - The calculation has been created and is ready to run.
	//
	// QUEUED - The calculation has been queued for processing.
	//
	// RUNNING - The calculation is running.
	//
	// CANCELING - A request to cancel the calculation has been received and the
	// system is working to stop it.
	//
	// CANCELED - The calculation is no longer running as the result of a cancel
	// request.
	//
	// COMPLETED - The calculation has completed without error.
	//
	// FAILED - The calculation failed and is no longer running.
	State types.CalculationExecutionState

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopQueryExecutionInput 

type StopQueryExecutionInput struct {

	// The unique ID of the query execution to stop.
	//
	// This member is required.
	QueryExecutionId *string
	// contains filtered or unexported fields
}

type StopQueryExecutionOutput 

type StopQueryExecutionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput 

type TagResourceInput struct {

	// Specifies the ARN of the Athena resource to which tags are to be added.
	//
	// This member is required.
	ResourceARN *string

	// A collection of one or more tags, separated by commas, to be added to an Athena
	// resource.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TerminateSessionInput added in v1.20.0 

type TerminateSessionInput struct {

	// The session ID.
	//
	// This member is required.
	SessionId *string
	// contains filtered or unexported fields
}

type TerminateSessionOutput added in v1.20.0 

type TerminateSessionOutput struct {

	// The state of the session. A description of each state follows.
	//
	// CREATING - The session is being started, including acquiring resources.
	//
	// CREATED - The session has been started.
	//
	// IDLE - The session is able to accept a calculation.
	//
	// BUSY - The session is processing another task and is unable to accept a
	// calculation.
	//
	// TERMINATING - The session is in the process of shutting down.
	//
	// TERMINATED - The session and its resources are no longer running.
	//
	// DEGRADED - The session has no healthy coordinators.
	//
	// FAILED - Due to a failure, the session and its resources are no longer running.
	State types.SessionState

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// Specifies the ARN of the resource from which tags are to be removed.
	//
	// This member is required.
	ResourceARN *string

	// A comma-separated list of one or more tag keys whose tags are to be removed
	// from the specified resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateCapacityReservationInput added in v1.26.0 

type UpdateCapacityReservationInput struct {

	// The name of the capacity reservation.
	//
	// This member is required.
	Name *string

	// The new number of requested data processing units.
	//
	// This member is required.
	TargetDpus *int32
	// contains filtered or unexported fields
}

type UpdateCapacityReservationOutput added in v1.26.0 

type UpdateCapacityReservationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateDataCatalogInput 

type UpdateDataCatalogInput struct {

	// The name of the data catalog to update. The catalog name must be unique for the
	// Amazon Web Services account and can use a maximum of 127 alphanumeric,
	// underscore, at sign, or hyphen characters. The remainder of the length
	// constraint of 256 is reserved for use by Athena.
	//
	// This member is required.
	Name *string

	// Specifies the type of data catalog to update. Specify LAMBDA for a federated
	// catalog, HIVE for an external hive metastore, or GLUE for an Glue Data Catalog.
	//
	// This member is required.
	Type types.DataCatalogType

	// New or modified text that describes the data catalog.
	Description *string

	// Specifies the Lambda function or functions to use for updating the data
	// catalog. This is a mapping whose values depend on the catalog type.
	//
	//   - For the HIVE data catalog type, use the following syntax. The
	//   metadata-function parameter is required. The sdk-version parameter is optional
	//   and defaults to the currently supported version.
	//
	// metadata-function=lambda_arn, sdk-version=version_number
	//
	//   - For the LAMBDA data catalog type, use one of the following sets of required
	//   parameters, but not both.
	//
	//   - If you have one Lambda function that processes metadata and another for
	//   reading the actual data, use the following syntax. Both parameters are required.
	//
	// metadata-function=lambda_arn, record-function=lambda_arn
	//
	//   - If you have a composite Lambda function that processes both metadata and
	//   data, use the following syntax to specify your Lambda function.
	//
	// function=lambda_arn
	Parameters map[string]string
	// contains filtered or unexported fields
}

type UpdateDataCatalogOutput 

type UpdateDataCatalogOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateNamedQueryInput added in v1.14.0 

type UpdateNamedQueryInput struct {

	// The name of the query.
	//
	// This member is required.
	Name *string

	// The unique identifier (UUID) of the query.
	//
	// This member is required.
	NamedQueryId *string

	// The contents of the query with all query statements.
	//
	// This member is required.
	QueryString *string

	// The query description.
	Description *string
	// contains filtered or unexported fields
}

type UpdateNamedQueryOutput added in v1.14.0 

type UpdateNamedQueryOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateNotebookInput added in v1.20.0 

type UpdateNotebookInput struct {

	// The ID of the notebook to update.
	//
	// This member is required.
	NotebookId *string

	// The updated content for the notebook.
	//
	// This member is required.
	Payload *string

	// The notebook content type. Currently, the only valid type is IPYNB .
	//
	// This member is required.
	Type types.NotebookType

	// A unique case-sensitive string used to ensure the request to create the
	// notebook is idempotent (executes only once).
	//
	// This token is listed as not required because Amazon Web Services SDKs (for
	// example the Amazon Web Services SDK for Java) auto-generate the token for you.
	// If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI,
	// you must provide this token or the action will fail.
	ClientRequestToken *string

	// The active notebook session ID. Required if the notebook has an active session.
	SessionId *string
	// contains filtered or unexported fields
}

type UpdateNotebookMetadataInput added in v1.20.0 

type UpdateNotebookMetadataInput struct {

	// The name to update the notebook to.
	//
	// This member is required.
	Name *string

	// The ID of the notebook to update the metadata for.
	//
	// This member is required.
	NotebookId *string

	// A unique case-sensitive string used to ensure the request to create the
	// notebook is idempotent (executes only once).
	//
	// This token is listed as not required because Amazon Web Services SDKs (for
	// example the Amazon Web Services SDK for Java) auto-generate the token for you.
	// If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI,
	// you must provide this token or the action will fail.
	ClientRequestToken *string
	// contains filtered or unexported fields
}

type UpdateNotebookMetadataOutput added in v1.20.0 

type UpdateNotebookMetadataOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateNotebookOutput added in v1.20.0 

type UpdateNotebookOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdatePreparedStatementInput added in v1.2.0 

type UpdatePreparedStatementInput struct {

	// The query string for the prepared statement.
	//
	// This member is required.
	QueryStatement *string

	// The name of the prepared statement.
	//
	// This member is required.
	StatementName *string

	// The workgroup for the prepared statement.
	//
	// This member is required.
	WorkGroup *string

	// The description of the prepared statement.
	Description *string
	// contains filtered or unexported fields
}

type UpdatePreparedStatementOutput added in v1.2.0 

type UpdatePreparedStatementOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateWorkGroupInput 

type UpdateWorkGroupInput struct {

	// The specified workgroup that will be updated.
	//
	// This member is required.
	WorkGroup *string

	// Contains configuration updates for an Athena SQL workgroup.
	ConfigurationUpdates *types.WorkGroupConfigurationUpdates

	// The workgroup description.
	Description *string

	// The workgroup state that will be updated for the given workgroup.
	State types.WorkGroupState
	// contains filtered or unexported fields
}

type UpdateWorkGroupOutput 

type UpdateWorkGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.