athena

type BatchGetNamedQueryInput struct {
	// An array of query IDs.
	NamedQueryIds []*string
}

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
}

type BatchGetQueryExecutionInput struct {
	// An array of query execution IDs.
	QueryExecutionIds []*string
}

type BatchGetQueryExecutionOutput struct {
	// Information about the query executions that failed to run.
	UnprocessedQueryExecutionIds []*types.UnprocessedQueryExecutionId
	// Information about a query execution.
	QueryExecutions []*types.QueryExecution

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type CreateDataCatalogInput struct {
	// The name of the data catalog to create. The catalog name must be unique for the
	// AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or
	// hyphen characters.
	Name *string
	// The type of data catalog to create: LAMBDA for a federated catalog, GLUE for AWS
	// Glue Catalog, or HIVE for an external hive metastore.
	Type types.DataCatalogType
	// 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 has no parameters.
	Parameters map[string]*string
	// A list of comma separated tags to add to the data catalog that is created.
	Tags []*types.Tag
	// A description of the data catalog to be created.
	Description *string
}

type CreateDataCatalogOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateNamedQueryInput struct {
	// The name of the workgroup in which the named query is being created.
	WorkGroup *string
	// The query description.
	Description *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 AWS SDKs (for example the AWS SDK for
	// Java) auto-generate the token for users. If you are not using the AWS SDK or the
	// AWS CLI, you must provide this token or the action will fail.
	ClientRequestToken *string
	// The contents of the query with all query statements.
	QueryString *string
	// The database to which the query belongs.
	Database *string
	// The query name.
	Name *string
}

type CreateNamedQueryOutput struct {
	// The unique ID of the query.
	NamedQueryId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateWorkGroupInput struct {
	// A list of comma separated tags to add to the workgroup that is created.
	Tags []*types.Tag
	// The workgroup description.
	Description *string
	// The configuration for the workgroup, which includes the location in Amazon S3
	// where query 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 name.
	Name *string
}

type CreateWorkGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteDataCatalogInput struct {
	// The name of the data catalog to delete.
	Name *string
}

type DeleteDataCatalogOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteNamedQueryInput struct {
	// The unique ID of the query to delete.
	NamedQueryId *string
}

type DeleteNamedQueryOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteWorkGroupInput struct {
	// The option to delete the workgroup and its contents even if the workgroup
	// contains any named queries.
	RecursiveDeleteOption *bool
	// The unique name of the workgroup to delete.
	WorkGroup *string
}

type DeleteWorkGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

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

type GetDataCatalogInput struct {
	// The name of the data catalog to return.
	Name *string
}

type GetDataCatalogOutput struct {
	// The data catalog returned.
	DataCatalog *types.DataCatalog

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetDatabaseInput struct {
	// The name of the database to return.
	DatabaseName *string
	// The name of the data catalog that contains the database to return.
	CatalogName *string
}

type GetDatabaseOutput struct {
	// The database returned.
	Database *types.Database

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetNamedQueryInput struct {
	// The unique ID of the query. Use ListNamedQueries () to get query IDs.
	NamedQueryId *string
}

type GetNamedQueryOutput struct {
	// Information about the query.
	NamedQuery *types.NamedQuery

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetQueryExecutionInput struct {
	// The unique ID of the query execution.
	QueryExecutionId *string
}

type GetQueryExecutionOutput struct {
	// Information about the query execution.
	QueryExecution *types.QueryExecution

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetQueryResultsInput 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 unique ID of the query execution.
	QueryExecutionId *string
	// The maximum number of results (rows) to return in this request.
	MaxResults *int32
}

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 statement.
	UpdateCount *int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetTableMetadataInput struct {
	// The name of the data catalog that contains the database and table metadata to
	// return.
	CatalogName *string
	// The name of the table for which metadata is returned.
	TableName *string
	// The name of the database that contains the table metadata to return.
	DatabaseName *string
}

type GetTableMetadataOutput struct {
	// An object that contains table metadata.
	TableMetadata *types.TableMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetWorkGroupInput struct {
	// The name of the workgroup.
	WorkGroup *string
}

type GetWorkGroupOutput struct {
	// Information about the workgroup.
	WorkGroup *types.WorkGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

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

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

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
}

type ListDataCatalogsOutput 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 summary list of data catalogs.
	DataCatalogsSummary []*types.DataCatalogSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListDatabasesInput struct {
	// The name of the data catalog that contains the databases to return.
	CatalogName *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
	// Specifies the maximum number of results to return.
	MaxResults *int32
}

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
}

type ListNamedQueriesInput 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 maximum number of queries to return in this request.
	MaxResults *int32
	// 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
}

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
}

type ListQueryExecutionsInput 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 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
	// The maximum number of query executions to return in this request.
	MaxResults *int32
}

type ListQueryExecutionsOutput struct {
	// The unique IDs of each query execution as an array of strings.
	QueryExecutionIds []*string
	// A token to be used by the next request if this request is truncated.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListTableMetadataInput struct {
	// The name of the database for which table metadata should be returned.
	DatabaseName *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
	// Specifies the maximum number of results to return.
	MaxResults *int32
	// A regex filter that pattern-matches table names. If no expression is supplied,
	// metadata for all tables are listed.
	Expression *string
	// The name of the data catalog for which table metadata should be returned.
	CatalogName *string
}

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
}

type ListTagsForResourceInput struct {
	// The maximum number of results to be returned per request that lists the tags for
	// the resource.
	MaxResults *int32
	// Lists the tags for the resource with the specified ARN.
	ResourceARN *string
	// 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
}

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
}

type ListWorkGroupsInput 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 maximum number of workgroups to return in this request.
	MaxResults *int32
}

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
	// The list of workgroups, including their names, descriptions, creation times, and
	// states.
	WorkGroups []*types.WorkGroupSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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 credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

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

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

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

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

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer retry.Retryer

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

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

type ResolveEndpointMiddlewareOptions interface {
	GetEndpointResolver() EndpointResolver
	GetEndpointOptions() ResolverOptions
}

type ResolverOptions = internalendpoints.Options

type StartQueryExecutionInput struct {
	// 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
	// The SQL query statements to be executed.
	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. If a
	// parameter has changed, for example, the QueryString, an error is returned. This
	// token is listed as not required because AWS SDKs (for example the AWS SDK for
	// Java) auto-generate the token for users. If you are not using the AWS SDK or the
	// AWS CLI, you must provide this token or the action will fail.
	ClientRequestToken *string
	// The name of the workgroup in which the query is being started.
	WorkGroup *string
}

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
}

type StopQueryExecutionInput struct {
	// The unique ID of the query execution to stop.
	QueryExecutionId *string
}

type StopQueryExecutionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type TagResourceInput struct {
	// A collection of one or more tags, separated by commas, to be added to an Athena
	// workgroup or data catalog resource.
	Tags []*types.Tag
	// Specifies the ARN of the Athena resource (workgroup or data catalog) to which
	// tags are to be added.
	ResourceARN *string
}

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UntagResourceInput struct {
	// A comma-separated list of one or more tag keys whose tags are to be removed from
	// the specified resource.
	TagKeys []*string
	// Specifies the ARN of the resource from which tags are to be removed.
	ResourceARN *string
}

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateDataCatalogInput struct {
	// Specifies the type of data catalog to update. Specify LAMBDA for a federated
	// catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore.
	Type types.DataCatalogType
	// The name of the data catalog to update. The catalog name must be unique for the
	// AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or
	// hyphen characters.
	Name *string
	// 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
	//
	//     * The GLUE type has no parameters.
	Parameters map[string]*string
}

type UpdateDataCatalogOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateWorkGroupInput struct {
	// The workgroup state that will be updated for the given workgroup.
	State types.WorkGroupState
	// The workgroup description.
	Description *string
	// The workgroup configuration that will be updated for the given workgroup.
	ConfigurationUpdates *types.WorkGroupConfigurationUpdates
	// The specified workgroup that will be updated.
	WorkGroup *string
}

type UpdateWorkGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}