athena

package
v1.99.1 Latest Latest
Warning

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

 Go to latest Published: Feb 10, 2020 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package athena provides the client and types for making API requests to 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 (http://docs.aws.amazon.com/athena/latest/ug/what-is.html) 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 (https://docs.aws.amazon.com/athena/latest/ug/connect-with-jdbc.html).

For code samples using the AWS SDK for Java, see Examples and Code Samples (https://docs.aws.amazon.com/athena/latest/ug/code-samples.html) in the Amazon Athena User Guide.

See https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18 for more information on this service.

See athena package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/athena/

Using the Client

To contact Amazon Athena with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Athena client Athena for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/athena/#New

Index

Constants

View Source 
const (
	// ColumnNullableNotNull is a ColumnNullable enum value
	ColumnNullableNotNull = "NOT_NULL"

	// ColumnNullableNullable is a ColumnNullable enum value
	ColumnNullableNullable = "NULLABLE"

	// ColumnNullableUnknown is a ColumnNullable enum value
	ColumnNullableUnknown = "UNKNOWN"
)
View Source 
const (
	// EncryptionOptionSseS3 is a EncryptionOption enum value
	EncryptionOptionSseS3 = "SSE_S3"

	// EncryptionOptionSseKms is a EncryptionOption enum value
	EncryptionOptionSseKms = "SSE_KMS"

	// EncryptionOptionCseKms is a EncryptionOption enum value
	EncryptionOptionCseKms = "CSE_KMS"
)
View Source 
const (
	// QueryExecutionStateQueued is a QueryExecutionState enum value
	QueryExecutionStateQueued = "QUEUED"

	// QueryExecutionStateRunning is a QueryExecutionState enum value
	QueryExecutionStateRunning = "RUNNING"

	// QueryExecutionStateSucceeded is a QueryExecutionState enum value
	QueryExecutionStateSucceeded = "SUCCEEDED"

	// QueryExecutionStateFailed is a QueryExecutionState enum value
	QueryExecutionStateFailed = "FAILED"

	// QueryExecutionStateCancelled is a QueryExecutionState enum value
	QueryExecutionStateCancelled = "CANCELLED"
)
View Source 
const (
	// StatementTypeDdl is a StatementType enum value
	StatementTypeDdl = "DDL"

	// StatementTypeDml is a StatementType enum value
	StatementTypeDml = "DML"

	// StatementTypeUtility is a StatementType enum value
	StatementTypeUtility = "UTILITY"
)
View Source 
const (
	// WorkGroupStateEnabled is a WorkGroupState enum value
	WorkGroupStateEnabled = "ENABLED"

	// WorkGroupStateDisabled is a WorkGroupState enum value
	WorkGroupStateDisabled = "DISABLED"
)
View Source 
const (

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// Indicates a platform issue, which may be due to a transient condition or
	// outage.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// Indicates that something is wrong with the input to the request. For example,
	// a required parameter may be missing or out of range.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// A resource, such as a workgroup, was not found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeTooManyRequestsException for service response error code
	// "TooManyRequestsException".
	//
	// Indicates that the request was throttled.
	ErrCodeTooManyRequestsException = "TooManyRequestsException"
)
View Source 
const (
	ServiceName = "athena"    // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "Athena"    // ServiceID is a unique identifer of a specific service.
)

Service information constants

View Source 
const (
	// ThrottleReasonConcurrentQueryLimitExceeded is a ThrottleReason enum value
	ThrottleReasonConcurrentQueryLimitExceeded = "CONCURRENT_QUERY_LIMIT_EXCEEDED"
)

The reason for the query throttling, for example, when it exceeds the concurrent query limit.

Variables

This section is empty.

Functions

This section is empty.

Types

type Athena 

type Athena struct {
	*client.Client
}

Athena provides the API operation methods for making requests to Amazon Athena. See this package's package overview docs for details on the service.

Athena methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *Athena

New creates a new instance of the Athena client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a Athena client from just a session.
svc := athena.New(mySession)

// Create a Athena client with additional configuration
svc := athena.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*Athena) BatchGetNamedQuery 

func (c *Athena) BatchGetNamedQuery(input *BatchGetNamedQueryInput) (*BatchGetNamedQueryOutput, error)

BatchGetNamedQuery API operation for Amazon Athena.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation BatchGetNamedQuery for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerException "InternalServerException" Indicates a platform issue, which may be due to a transient condition or outage.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/BatchGetNamedQuery

func (*Athena) BatchGetNamedQueryRequest 

func (c *Athena) BatchGetNamedQueryRequest(input *BatchGetNamedQueryInput) (req *request.Request, output *BatchGetNamedQueryOutput)

BatchGetNamedQueryRequest generates a "aws/request.Request" representing the client's request for the BatchGetNamedQuery operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchGetNamedQuery for more information on using the BatchGetNamedQuery API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the BatchGetNamedQueryRequest method.
req, resp := client.BatchGetNamedQueryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/BatchGetNamedQuery

func (*Athena) BatchGetNamedQueryWithContext 

func (c *Athena) BatchGetNamedQueryWithContext(ctx aws.Context, input *BatchGetNamedQueryInput, opts ...request.Option) (*BatchGetNamedQueryOutput, error)

BatchGetNamedQueryWithContext is the same as BatchGetNamedQuery with the addition of the ability to pass a context and additional request options.

See BatchGetNamedQuery for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) BatchGetQueryExecution 

func (c *Athena) BatchGetQueryExecution(input *BatchGetQueryExecutionInput) (*BatchGetQueryExecutionOutput, error)

BatchGetQueryExecution API operation for Amazon Athena.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation BatchGetQueryExecution for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerException "InternalServerException" Indicates a platform issue, which may be due to a transient condition or outage.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/BatchGetQueryExecution

func (*Athena) BatchGetQueryExecutionRequest 

func (c *Athena) BatchGetQueryExecutionRequest(input *BatchGetQueryExecutionInput) (req *request.Request, output *BatchGetQueryExecutionOutput)

BatchGetQueryExecutionRequest generates a "aws/request.Request" representing the client's request for the BatchGetQueryExecution operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchGetQueryExecution for more information on using the BatchGetQueryExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the BatchGetQueryExecutionRequest method.
req, resp := client.BatchGetQueryExecutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/BatchGetQueryExecution

func (*Athena) BatchGetQueryExecutionWithContext 

func (c *Athena) BatchGetQueryExecutionWithContext(ctx aws.Context, input *BatchGetQueryExecutionInput, opts ...request.Option) (*BatchGetQueryExecutionOutput, error)

BatchGetQueryExecutionWithContext is the same as BatchGetQueryExecution with the addition of the ability to pass a context and additional request options.

See BatchGetQueryExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) CreateNamedQuery 

func (c *Athena) CreateNamedQuery(input *CreateNamedQueryInput) (*CreateNamedQueryOutput, error)

CreateNamedQuery API operation for Amazon Athena.

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

For code samples using the AWS SDK for Java, see Examples and Code Samples (http://docs.aws.amazon.com/athena/latest/ug/code-samples.html) in the Amazon Athena User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation CreateNamedQuery for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerException "InternalServerException" Indicates a platform issue, which may be due to a transient condition or outage.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreateNamedQuery

func (*Athena) CreateNamedQueryRequest 

func (c *Athena) CreateNamedQueryRequest(input *CreateNamedQueryInput) (req *request.Request, output *CreateNamedQueryOutput)

CreateNamedQueryRequest generates a "aws/request.Request" representing the client's request for the CreateNamedQuery operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateNamedQuery for more information on using the CreateNamedQuery API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateNamedQueryRequest method.
req, resp := client.CreateNamedQueryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreateNamedQuery

func (*Athena) CreateNamedQueryWithContext 

func (c *Athena) CreateNamedQueryWithContext(ctx aws.Context, input *CreateNamedQueryInput, opts ...request.Option) (*CreateNamedQueryOutput, error)

CreateNamedQueryWithContext is the same as CreateNamedQuery with the addition of the ability to pass a context and additional request options.

See CreateNamedQuery for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) CreateWorkGroup added in v1.99.0 

func (c *Athena) CreateWorkGroup(input *CreateWorkGroupInput) (*CreateWorkGroupOutput, error)

CreateWorkGroup API operation for Amazon Athena.

Creates a workgroup with the specified name.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation CreateWorkGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerException "InternalServerException" Indicates a platform issue, which may be due to a transient condition or outage.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreateWorkGroup

func (*Athena) CreateWorkGroupRequest added in v1.99.0 

func (c *Athena) CreateWorkGroupRequest(input *CreateWorkGroupInput) (req *request.Request, output *CreateWorkGroupOutput)

CreateWorkGroupRequest generates a "aws/request.Request" representing the client's request for the CreateWorkGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateWorkGroup for more information on using the CreateWorkGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateWorkGroupRequest method.
req, resp := client.CreateWorkGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreateWorkGroup

func (*Athena) CreateWorkGroupWithContext added in v1.99.0 

func (c *Athena) CreateWorkGroupWithContext(ctx aws.Context, input *CreateWorkGroupInput, opts ...request.Option) (*CreateWorkGroupOutput, error)

CreateWorkGroupWithContext is the same as CreateWorkGroup with the addition of the ability to pass a context and additional request options.

See CreateWorkGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) DeleteNamedQuery 

func (c *Athena) DeleteNamedQuery(input *DeleteNamedQueryInput) (*DeleteNamedQueryOutput, error)

DeleteNamedQuery API operation for Amazon Athena.

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

For code samples using the AWS SDK for Java, see Examples and Code Samples (http://docs.aws.amazon.com/athena/latest/ug/code-samples.html) in the Amazon Athena User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation DeleteNamedQuery for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerException "InternalServerException" Indicates a platform issue, which may be due to a transient condition or outage.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/DeleteNamedQuery

func (*Athena) DeleteNamedQueryRequest 

func (c *Athena) DeleteNamedQueryRequest(input *DeleteNamedQueryInput) (req *request.Request, output *DeleteNamedQueryOutput)

DeleteNamedQueryRequest generates a "aws/request.Request" representing the client's request for the DeleteNamedQuery operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteNamedQuery for more information on using the DeleteNamedQuery API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteNamedQueryRequest method.
req, resp := client.DeleteNamedQueryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/DeleteNamedQuery

func (*Athena) DeleteNamedQueryWithContext 

func (c *Athena) DeleteNamedQueryWithContext(ctx aws.Context, input *DeleteNamedQueryInput, opts ...request.Option) (*DeleteNamedQueryOutput, error)

DeleteNamedQueryWithContext is the same as DeleteNamedQuery with the addition of the ability to pass a context and additional request options.

See DeleteNamedQuery for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) DeleteWorkGroup added in v1.99.0 

func (c *Athena) DeleteWorkGroup(input *DeleteWorkGroupInput) (*DeleteWorkGroupOutput, error)

DeleteWorkGroup API operation for Amazon Athena.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation DeleteWorkGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerException "InternalServerException" Indicates a platform issue, which may be due to a transient condition or outage.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/DeleteWorkGroup

func (*Athena) DeleteWorkGroupRequest added in v1.99.0 

func (c *Athena) DeleteWorkGroupRequest(input *DeleteWorkGroupInput) (req *request.Request, output *DeleteWorkGroupOutput)

DeleteWorkGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteWorkGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteWorkGroup for more information on using the DeleteWorkGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteWorkGroupRequest method.
req, resp := client.DeleteWorkGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/DeleteWorkGroup

func (*Athena) DeleteWorkGroupWithContext added in v1.99.0 

func (c *Athena) DeleteWorkGroupWithContext(ctx aws.Context, input *DeleteWorkGroupInput, opts ...request.Option) (*DeleteWorkGroupOutput, error)

DeleteWorkGroupWithContext is the same as DeleteWorkGroup with the addition of the ability to pass a context and additional request options.

See DeleteWorkGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) GetNamedQuery 

func (c *Athena) GetNamedQuery(input *GetNamedQueryInput) (*GetNamedQueryOutput, error)

GetNamedQuery API operation for Amazon Athena.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation GetNamedQuery for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerException "InternalServerException" Indicates a platform issue, which may be due to a transient condition or outage.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetNamedQuery

func (*Athena) GetNamedQueryRequest 

func (c *Athena) GetNamedQueryRequest(input *GetNamedQueryInput) (req *request.Request, output *GetNamedQueryOutput)

GetNamedQueryRequest generates a "aws/request.Request" representing the client's request for the GetNamedQuery operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetNamedQuery for more information on using the GetNamedQuery API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetNamedQueryRequest method.
req, resp := client.GetNamedQueryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetNamedQuery

func (*Athena) GetNamedQueryWithContext 

func (c *Athena) GetNamedQueryWithContext(ctx aws.Context, input *GetNamedQueryInput, opts ...request.Option) (*GetNamedQueryOutput, error)

GetNamedQueryWithContext is the same as GetNamedQuery with the addition of the ability to pass a context and additional request options.

See GetNamedQuery for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) GetQueryExecution 

func (c *Athena) GetQueryExecution(input *GetQueryExecutionInput) (*GetQueryExecutionOutput, error)

GetQueryExecution API operation for Amazon Athena.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation GetQueryExecution for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerException "InternalServerException" Indicates a platform issue, which may be due to a transient condition or outage.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetQueryExecution

func (*Athena) GetQueryExecutionRequest 

func (c *Athena) GetQueryExecutionRequest(input *GetQueryExecutionInput) (req *request.Request, output *GetQueryExecutionOutput)

GetQueryExecutionRequest generates a "aws/request.Request" representing the client's request for the GetQueryExecution operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetQueryExecution for more information on using the GetQueryExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetQueryExecutionRequest method.
req, resp := client.GetQueryExecutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetQueryExecution

func (*Athena) GetQueryExecutionWithContext 

func (c *Athena) GetQueryExecutionWithContext(ctx aws.Context, input *GetQueryExecutionInput, opts ...request.Option) (*GetQueryExecutionOutput, error)

GetQueryExecutionWithContext is the same as GetQueryExecution with the addition of the ability to pass a context and additional request options.

See GetQueryExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) GetQueryResults 

func (c *Athena) GetQueryResults(input *GetQueryResultsInput) (*GetQueryResultsOutput, error)

GetQueryResults API operation for Amazon Athena.

Returns the results of a single query execution specified by QueryExecutionId if you have access to the workgroup in which the query ran. This request does not execute the query but returns results. Use StartQueryExecution to run a query.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation GetQueryResults for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerException "InternalServerException" Indicates a platform issue, which may be due to a transient condition or outage.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetQueryResults

func (*Athena) GetQueryResultsPages 

func (c *Athena) GetQueryResultsPages(input *GetQueryResultsInput, fn func(*GetQueryResultsOutput, bool) bool) error

GetQueryResultsPages iterates over the pages of a GetQueryResults operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetQueryResults method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetQueryResults operation.
pageNum := 0
err := client.GetQueryResultsPages(params,
    func(page *athena.GetQueryResultsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Athena) GetQueryResultsPagesWithContext 

func (c *Athena) GetQueryResultsPagesWithContext(ctx aws.Context, input *GetQueryResultsInput, fn func(*GetQueryResultsOutput, bool) bool, opts ...request.Option) error

GetQueryResultsPagesWithContext same as GetQueryResultsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) GetQueryResultsRequest 

func (c *Athena) GetQueryResultsRequest(input *GetQueryResultsInput) (req *request.Request, output *GetQueryResultsOutput)

GetQueryResultsRequest generates a "aws/request.Request" representing the client's request for the GetQueryResults operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetQueryResults for more information on using the GetQueryResults API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetQueryResultsRequest method.
req, resp := client.GetQueryResultsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetQueryResults

func (*Athena) GetQueryResultsWithContext 

func (c *Athena) GetQueryResultsWithContext(ctx aws.Context, input *GetQueryResultsInput, opts ...request.Option) (*GetQueryResultsOutput, error)

GetQueryResultsWithContext is the same as GetQueryResults with the addition of the ability to pass a context and additional request options.

See GetQueryResults for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) GetWorkGroup added in v1.99.0 

func (c *Athena) GetWorkGroup(input *GetWorkGroupInput) (*GetWorkGroupOutput, error)

GetWorkGroup API operation for Amazon Athena.

Returns information about the workgroup with the specified name.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation GetWorkGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerException "InternalServerException" Indicates a platform issue, which may be due to a transient condition or outage.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetWorkGroup

func (*Athena) GetWorkGroupRequest added in v1.99.0 

func (c *Athena) GetWorkGroupRequest(input *GetWorkGroupInput) (req *request.Request, output *GetWorkGroupOutput)

GetWorkGroupRequest generates a "aws/request.Request" representing the client's request for the GetWorkGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetWorkGroup for more information on using the GetWorkGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetWorkGroupRequest method.
req, resp := client.GetWorkGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetWorkGroup

func (*Athena) GetWorkGroupWithContext added in v1.99.0 

func (c *Athena) GetWorkGroupWithContext(ctx aws.Context, input *GetWorkGroupInput, opts ...request.Option) (*GetWorkGroupOutput, error)

GetWorkGroupWithContext is the same as GetWorkGroup with the addition of the ability to pass a context and additional request options.

See GetWorkGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) ListNamedQueries 

func (c *Athena) ListNamedQueries(input *ListNamedQueriesInput) (*ListNamedQueriesOutput, error)

ListNamedQueries API operation for Amazon Athena.

Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the workgroup.

For code samples using the AWS SDK for Java, see Examples and Code Samples (http://docs.aws.amazon.com/athena/latest/ug/code-samples.html) in the Amazon Athena User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation ListNamedQueries for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerException "InternalServerException" Indicates a platform issue, which may be due to a transient condition or outage.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListNamedQueries

func (*Athena) ListNamedQueriesPages 

func (c *Athena) ListNamedQueriesPages(input *ListNamedQueriesInput, fn func(*ListNamedQueriesOutput, bool) bool) error

ListNamedQueriesPages iterates over the pages of a ListNamedQueries operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListNamedQueries method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListNamedQueries operation.
pageNum := 0
err := client.ListNamedQueriesPages(params,
    func(page *athena.ListNamedQueriesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Athena) ListNamedQueriesPagesWithContext 

func (c *Athena) ListNamedQueriesPagesWithContext(ctx aws.Context, input *ListNamedQueriesInput, fn func(*ListNamedQueriesOutput, bool) bool, opts ...request.Option) error

ListNamedQueriesPagesWithContext same as ListNamedQueriesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) ListNamedQueriesRequest 

func (c *Athena) ListNamedQueriesRequest(input *ListNamedQueriesInput) (req *request.Request, output *ListNamedQueriesOutput)

ListNamedQueriesRequest generates a "aws/request.Request" representing the client's request for the ListNamedQueries operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListNamedQueries for more information on using the ListNamedQueries API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListNamedQueriesRequest method.
req, resp := client.ListNamedQueriesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListNamedQueries

func (*Athena) ListNamedQueriesWithContext 

func (c *Athena) ListNamedQueriesWithContext(ctx aws.Context, input *ListNamedQueriesInput, opts ...request.Option) (*ListNamedQueriesOutput, error)

ListNamedQueriesWithContext is the same as ListNamedQueries with the addition of the ability to pass a context and additional request options.

See ListNamedQueries for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) ListQueryExecutions 

func (c *Athena) ListQueryExecutions(input *ListQueryExecutionsInput) (*ListQueryExecutionsOutput, error)

ListQueryExecutions API operation for Amazon Athena.

Provides a list of available query execution IDs for the queries in the specified workgroup. Requires you to have access to the workgroup in which the queries ran.

For code samples using the AWS SDK for Java, see Examples and Code Samples (http://docs.aws.amazon.com/athena/latest/ug/code-samples.html) in the Amazon Athena User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation ListQueryExecutions for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerException "InternalServerException" Indicates a platform issue, which may be due to a transient condition or outage.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListQueryExecutions

func (*Athena) ListQueryExecutionsPages 

func (c *Athena) ListQueryExecutionsPages(input *ListQueryExecutionsInput, fn func(*ListQueryExecutionsOutput, bool) bool) error

ListQueryExecutionsPages iterates over the pages of a ListQueryExecutions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListQueryExecutions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListQueryExecutions operation.
pageNum := 0
err := client.ListQueryExecutionsPages(params,
    func(page *athena.ListQueryExecutionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Athena) ListQueryExecutionsPagesWithContext 

func (c *Athena) ListQueryExecutionsPagesWithContext(ctx aws.Context, input *ListQueryExecutionsInput, fn func(*ListQueryExecutionsOutput, bool) bool, opts ...request.Option) error

ListQueryExecutionsPagesWithContext same as ListQueryExecutionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) ListQueryExecutionsRequest 

func (c *Athena) ListQueryExecutionsRequest(input *ListQueryExecutionsInput) (req *request.Request, output *ListQueryExecutionsOutput)

ListQueryExecutionsRequest generates a "aws/request.Request" representing the client's request for the ListQueryExecutions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListQueryExecutions for more information on using the ListQueryExecutions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListQueryExecutionsRequest method.
req, resp := client.ListQueryExecutionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListQueryExecutions

func (*Athena) ListQueryExecutionsWithContext 

func (c *Athena) ListQueryExecutionsWithContext(ctx aws.Context, input *ListQueryExecutionsInput, opts ...request.Option) (*ListQueryExecutionsOutput, error)

ListQueryExecutionsWithContext is the same as ListQueryExecutions with the addition of the ability to pass a context and additional request options.

See ListQueryExecutions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) ListTagsForResource added in v1.99.0 

func (c *Athena) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Athena.

Lists the tags associated with this workgroup.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation ListTagsForResource for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerException "InternalServerException" Indicates a platform issue, which may be due to a transient condition or outage.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" A resource, such as a workgroup, was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListTagsForResource

func (*Athena) ListTagsForResourceRequest added in v1.99.0 

func (c *Athena) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListTagsForResource

func (*Athena) ListTagsForResourceWithContext added in v1.99.0 

func (c *Athena) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) ListWorkGroups added in v1.99.0 

func (c *Athena) ListWorkGroups(input *ListWorkGroupsInput) (*ListWorkGroupsOutput, error)

ListWorkGroups API operation for Amazon Athena.

Lists available workgroups for the account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation ListWorkGroups for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerException "InternalServerException" Indicates a platform issue, which may be due to a transient condition or outage.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListWorkGroups

func (*Athena) ListWorkGroupsPages added in v1.99.0 

func (c *Athena) ListWorkGroupsPages(input *ListWorkGroupsInput, fn func(*ListWorkGroupsOutput, bool) bool) error

ListWorkGroupsPages iterates over the pages of a ListWorkGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListWorkGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListWorkGroups operation.
pageNum := 0
err := client.ListWorkGroupsPages(params,
    func(page *athena.ListWorkGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Athena) ListWorkGroupsPagesWithContext added in v1.99.0 

func (c *Athena) ListWorkGroupsPagesWithContext(ctx aws.Context, input *ListWorkGroupsInput, fn func(*ListWorkGroupsOutput, bool) bool, opts ...request.Option) error

ListWorkGroupsPagesWithContext same as ListWorkGroupsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) ListWorkGroupsRequest added in v1.99.0 

func (c *Athena) ListWorkGroupsRequest(input *ListWorkGroupsInput) (req *request.Request, output *ListWorkGroupsOutput)

ListWorkGroupsRequest generates a "aws/request.Request" representing the client's request for the ListWorkGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListWorkGroups for more information on using the ListWorkGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListWorkGroupsRequest method.
req, resp := client.ListWorkGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListWorkGroups

func (*Athena) ListWorkGroupsWithContext added in v1.99.0 

func (c *Athena) ListWorkGroupsWithContext(ctx aws.Context, input *ListWorkGroupsInput, opts ...request.Option) (*ListWorkGroupsOutput, error)

ListWorkGroupsWithContext is the same as ListWorkGroups with the addition of the ability to pass a context and additional request options.

See ListWorkGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) StartQueryExecution 

func (c *Athena) StartQueryExecution(input *StartQueryExecutionInput) (*StartQueryExecutionOutput, error)

StartQueryExecution API operation for Amazon Athena.

Runs the SQL query statements contained in the Query. Requires you to have access to the workgroup in which the query ran.

For code samples using the AWS SDK for Java, see Examples and Code Samples (http://docs.aws.amazon.com/athena/latest/ug/code-samples.html) in the Amazon Athena User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation StartQueryExecution for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerException "InternalServerException" Indicates a platform issue, which may be due to a transient condition or outage.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" Indicates that the request was throttled.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StartQueryExecution

func (*Athena) StartQueryExecutionRequest 

func (c *Athena) StartQueryExecutionRequest(input *StartQueryExecutionInput) (req *request.Request, output *StartQueryExecutionOutput)

StartQueryExecutionRequest generates a "aws/request.Request" representing the client's request for the StartQueryExecution operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartQueryExecution for more information on using the StartQueryExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartQueryExecutionRequest method.
req, resp := client.StartQueryExecutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StartQueryExecution

func (*Athena) StartQueryExecutionWithContext 

func (c *Athena) StartQueryExecutionWithContext(ctx aws.Context, input *StartQueryExecutionInput, opts ...request.Option) (*StartQueryExecutionOutput, error)

StartQueryExecutionWithContext is the same as StartQueryExecution with the addition of the ability to pass a context and additional request options.

See StartQueryExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) StopQueryExecution 

func (c *Athena) StopQueryExecution(input *StopQueryExecutionInput) (*StopQueryExecutionOutput, error)

StopQueryExecution API operation for Amazon Athena.

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

For code samples using the AWS SDK for Java, see Examples and Code Samples (http://docs.aws.amazon.com/athena/latest/ug/code-samples.html) in the Amazon Athena User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation StopQueryExecution for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerException "InternalServerException" Indicates a platform issue, which may be due to a transient condition or outage.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StopQueryExecution

func (*Athena) StopQueryExecutionRequest 

func (c *Athena) StopQueryExecutionRequest(input *StopQueryExecutionInput) (req *request.Request, output *StopQueryExecutionOutput)

StopQueryExecutionRequest generates a "aws/request.Request" representing the client's request for the StopQueryExecution operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopQueryExecution for more information on using the StopQueryExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StopQueryExecutionRequest method.
req, resp := client.StopQueryExecutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StopQueryExecution

func (*Athena) StopQueryExecutionWithContext 

func (c *Athena) StopQueryExecutionWithContext(ctx aws.Context, input *StopQueryExecutionInput, opts ...request.Option) (*StopQueryExecutionOutput, error)

StopQueryExecutionWithContext is the same as StopQueryExecution with the addition of the ability to pass a context and additional request options.

See StopQueryExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) TagResource added in v1.99.0 

func (c *Athena) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Athena.

Adds one or more tags to the resource, such as a workgroup. A tag is a label that you assign to an AWS Athena resource (a workgroup). Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize resources (workgroups) in Athena, for example, by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups in your account. For best practices, see AWS Tagging Strategies (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/). The key length is from 1 (minimum) to 128 (maximum) Unicode characters in UTF-8. The tag value length is from 0 (minimum) to 256 (maximum) Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one, separate them by commas.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation TagResource for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerException "InternalServerException" Indicates a platform issue, which may be due to a transient condition or outage.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" A resource, such as a workgroup, was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/TagResource

func (*Athena) TagResourceRequest added in v1.99.0 

func (c *Athena) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/TagResource

func (*Athena) TagResourceWithContext added in v1.99.0 

func (c *Athena) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) UntagResource added in v1.99.0 

func (c *Athena) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Athena.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation UntagResource for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerException "InternalServerException" Indicates a platform issue, which may be due to a transient condition or outage.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" A resource, such as a workgroup, was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UntagResource

func (*Athena) UntagResourceRequest added in v1.99.0 

func (c *Athena) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UntagResource

func (*Athena) UntagResourceWithContext added in v1.99.0 

func (c *Athena) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) UpdateWorkGroup added in v1.99.0 

func (c *Athena) UpdateWorkGroup(input *UpdateWorkGroupInput) (*UpdateWorkGroupOutput, error)

UpdateWorkGroup API operation for Amazon Athena.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation UpdateWorkGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerException "InternalServerException" Indicates a platform issue, which may be due to a transient condition or outage.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateWorkGroup

func (*Athena) UpdateWorkGroupRequest added in v1.99.0 

func (c *Athena) UpdateWorkGroupRequest(input *UpdateWorkGroupInput) (req *request.Request, output *UpdateWorkGroupOutput)

UpdateWorkGroupRequest generates a "aws/request.Request" representing the client's request for the UpdateWorkGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateWorkGroup for more information on using the UpdateWorkGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateWorkGroupRequest method.
req, resp := client.UpdateWorkGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateWorkGroup

func (*Athena) UpdateWorkGroupWithContext added in v1.99.0 

func (c *Athena) UpdateWorkGroupWithContext(ctx aws.Context, input *UpdateWorkGroupInput, opts ...request.Option) (*UpdateWorkGroupOutput, error)

UpdateWorkGroupWithContext is the same as UpdateWorkGroup with the addition of the ability to pass a context and additional request options.

See UpdateWorkGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type BatchGetNamedQueryInput 

type BatchGetNamedQueryInput struct {

	// An array of query IDs.
	//
	// NamedQueryIds is a required field
	NamedQueryIds []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchGetNamedQueryInput) GoString 

func (s BatchGetNamedQueryInput) GoString() string

GoString returns the string representation

func (*BatchGetNamedQueryInput) SetNamedQueryIds 

func (s *BatchGetNamedQueryInput) SetNamedQueryIds(v []*string) *BatchGetNamedQueryInput

SetNamedQueryIds sets the NamedQueryIds field's value.

func (BatchGetNamedQueryInput) String 

func (s BatchGetNamedQueryInput) String() string

String returns the string representation

func (*BatchGetNamedQueryInput) Validate 

func (s *BatchGetNamedQueryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchGetNamedQueryOutput 

type BatchGetNamedQueryOutput struct {

	// Information about the named query IDs submitted.
	NamedQueries []*NamedQuery `type:"list"`

	// Information about provided query IDs.
	UnprocessedNamedQueryIds []*UnprocessedNamedQueryId `type:"list"`
	// contains filtered or unexported fields
}

func (BatchGetNamedQueryOutput) GoString 

func (s BatchGetNamedQueryOutput) GoString() string

GoString returns the string representation

func (*BatchGetNamedQueryOutput) SetNamedQueries 

func (s *BatchGetNamedQueryOutput) SetNamedQueries(v []*NamedQuery) *BatchGetNamedQueryOutput

SetNamedQueries sets the NamedQueries field's value.

func (*BatchGetNamedQueryOutput) SetUnprocessedNamedQueryIds 

func (s *BatchGetNamedQueryOutput) SetUnprocessedNamedQueryIds(v []*UnprocessedNamedQueryId) *BatchGetNamedQueryOutput

SetUnprocessedNamedQueryIds sets the UnprocessedNamedQueryIds field's value.

func (BatchGetNamedQueryOutput) String 

func (s BatchGetNamedQueryOutput) String() string

String returns the string representation

type BatchGetQueryExecutionInput 

type BatchGetQueryExecutionInput struct {

	// An array of query execution IDs.
	//
	// QueryExecutionIds is a required field
	QueryExecutionIds []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchGetQueryExecutionInput) GoString 

func (s BatchGetQueryExecutionInput) GoString() string

GoString returns the string representation

func (*BatchGetQueryExecutionInput) SetQueryExecutionIds 

func (s *BatchGetQueryExecutionInput) SetQueryExecutionIds(v []*string) *BatchGetQueryExecutionInput

SetQueryExecutionIds sets the QueryExecutionIds field's value.

func (BatchGetQueryExecutionInput) String 

func (s BatchGetQueryExecutionInput) String() string

String returns the string representation

func (*BatchGetQueryExecutionInput) Validate 

func (s *BatchGetQueryExecutionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchGetQueryExecutionOutput 

type BatchGetQueryExecutionOutput struct {

	// Information about a query execution.
	QueryExecutions []*QueryExecution `type:"list"`

	// Information about the query executions that failed to run.
	UnprocessedQueryExecutionIds []*UnprocessedQueryExecutionId `type:"list"`
	// contains filtered or unexported fields
}

func (BatchGetQueryExecutionOutput) GoString 

func (s BatchGetQueryExecutionOutput) GoString() string

GoString returns the string representation

func (*BatchGetQueryExecutionOutput) SetQueryExecutions 

func (s *BatchGetQueryExecutionOutput) SetQueryExecutions(v []*QueryExecution) *BatchGetQueryExecutionOutput

SetQueryExecutions sets the QueryExecutions field's value.

func (*BatchGetQueryExecutionOutput) SetUnprocessedQueryExecutionIds 

func (s *BatchGetQueryExecutionOutput) SetUnprocessedQueryExecutionIds(v []*UnprocessedQueryExecutionId) *BatchGetQueryExecutionOutput

SetUnprocessedQueryExecutionIds sets the UnprocessedQueryExecutionIds field's value.

func (BatchGetQueryExecutionOutput) String 

func (s BatchGetQueryExecutionOutput) String() string

String returns the string representation

type ColumnInfo 

type ColumnInfo struct {

	// Indicates whether values in the column are case-sensitive.
	CaseSensitive *bool `type:"boolean"`

	// The catalog to which the query results belong.
	CatalogName *string `type:"string"`

	// A column label.
	Label *string `type:"string"`

	// The name of the column.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// Indicates the column's nullable status.
	Nullable *string `type:"string" enum:"ColumnNullable"`

	// For DECIMAL data types, specifies the total number of digits, up to 38. For
	// performance reasons, we recommend up to 18 digits.
	Precision *int64 `type:"integer"`

	// For DECIMAL data types, specifies the total number of digits in the fractional
	// part of the value. Defaults to 0.
	Scale *int64 `type:"integer"`

	// The schema name (database name) to which the query results belong.
	SchemaName *string `type:"string"`

	// The table name for the query results.
	TableName *string `type:"string"`

	// The data type of the column.
	//
	// Type is a required field
	Type *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information about the columns in a query execution result.

func (ColumnInfo) GoString 

func (s ColumnInfo) GoString() string

GoString returns the string representation

func (*ColumnInfo) SetCaseSensitive 

func (s *ColumnInfo) SetCaseSensitive(v bool) *ColumnInfo

SetCaseSensitive sets the CaseSensitive field's value.

func (*ColumnInfo) SetCatalogName 

func (s *ColumnInfo) SetCatalogName(v string) *ColumnInfo

SetCatalogName sets the CatalogName field's value.

func (*ColumnInfo) SetLabel 

func (s *ColumnInfo) SetLabel(v string) *ColumnInfo

SetLabel sets the Label field's value.

func (*ColumnInfo) SetName 

func (s *ColumnInfo) SetName(v string) *ColumnInfo

SetName sets the Name field's value.

func (*ColumnInfo) SetNullable 

func (s *ColumnInfo) SetNullable(v string) *ColumnInfo

SetNullable sets the Nullable field's value.

func (*ColumnInfo) SetPrecision 

func (s *ColumnInfo) SetPrecision(v int64) *ColumnInfo

SetPrecision sets the Precision field's value.

func (*ColumnInfo) SetScale 

func (s *ColumnInfo) SetScale(v int64) *ColumnInfo

SetScale sets the Scale field's value.

func (*ColumnInfo) SetSchemaName 

func (s *ColumnInfo) SetSchemaName(v string) *ColumnInfo

SetSchemaName sets the SchemaName field's value.

func (*ColumnInfo) SetTableName 

func (s *ColumnInfo) SetTableName(v string) *ColumnInfo

SetTableName sets the TableName field's value.

func (*ColumnInfo) SetType 

func (s *ColumnInfo) SetType(v string) *ColumnInfo

SetType sets the Type field's value.

func (ColumnInfo) String 

func (s ColumnInfo) String() string

String returns the string representation

type CreateNamedQueryInput 

type CreateNamedQueryInput struct {

	// 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 `min:"32" type:"string" idempotencyToken:"true"`

	// The database to which the query belongs.
	//
	// Database is a required field
	Database *string `min:"1" type:"string" required:"true"`

	// The query description.
	Description *string `min:"1" type:"string"`

	// The query name.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The contents of the query with all query statements.
	//
	// QueryString is a required field
	QueryString *string `min:"1" type:"string" required:"true"`

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

func (CreateNamedQueryInput) GoString 

func (s CreateNamedQueryInput) GoString() string

GoString returns the string representation

func (*CreateNamedQueryInput) SetClientRequestToken 

func (s *CreateNamedQueryInput) SetClientRequestToken(v string) *CreateNamedQueryInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateNamedQueryInput) SetDatabase 

func (s *CreateNamedQueryInput) SetDatabase(v string) *CreateNamedQueryInput

SetDatabase sets the Database field's value.

func (*CreateNamedQueryInput) SetDescription 

func (s *CreateNamedQueryInput) SetDescription(v string) *CreateNamedQueryInput

SetDescription sets the Description field's value.

func (*CreateNamedQueryInput) SetName 

func (s *CreateNamedQueryInput) SetName(v string) *CreateNamedQueryInput

SetName sets the Name field's value.

func (*CreateNamedQueryInput) SetQueryString 

func (s *CreateNamedQueryInput) SetQueryString(v string) *CreateNamedQueryInput

SetQueryString sets the QueryString field's value.

func (*CreateNamedQueryInput) SetWorkGroup added in v1.99.0 

func (s *CreateNamedQueryInput) SetWorkGroup(v string) *CreateNamedQueryInput

SetWorkGroup sets the WorkGroup field's value.

func (CreateNamedQueryInput) String 

func (s CreateNamedQueryInput) String() string

String returns the string representation

func (*CreateNamedQueryInput) Validate 

func (s *CreateNamedQueryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateNamedQueryOutput 

type CreateNamedQueryOutput struct {

	// The unique ID of the query.
	NamedQueryId *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateNamedQueryOutput) GoString 

func (s CreateNamedQueryOutput) GoString() string

GoString returns the string representation

func (*CreateNamedQueryOutput) SetNamedQueryId 

func (s *CreateNamedQueryOutput) SetNamedQueryId(v string) *CreateNamedQueryOutput

SetNamedQueryId sets the NamedQueryId field's value.

func (CreateNamedQueryOutput) String 

func (s CreateNamedQueryOutput) String() string

String returns the string representation

type CreateWorkGroupInput added in v1.99.0 

type CreateWorkGroupInput struct {

	// 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 *WorkGroupConfiguration `type:"structure"`

	// The workgroup description.
	Description *string `type:"string"`

	// The workgroup name.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// One or more tags, separated by commas, that you want to attach to the workgroup
	// as you create it.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateWorkGroupInput) GoString added in v1.99.0 

func (s CreateWorkGroupInput) GoString() string

GoString returns the string representation

func (*CreateWorkGroupInput) SetConfiguration added in v1.99.0 

func (s *CreateWorkGroupInput) SetConfiguration(v *WorkGroupConfiguration) *CreateWorkGroupInput

SetConfiguration sets the Configuration field's value.

func (*CreateWorkGroupInput) SetDescription added in v1.99.0 

func (s *CreateWorkGroupInput) SetDescription(v string) *CreateWorkGroupInput

SetDescription sets the Description field's value.

func (*CreateWorkGroupInput) SetName added in v1.99.0 

func (s *CreateWorkGroupInput) SetName(v string) *CreateWorkGroupInput

SetName sets the Name field's value.

func (*CreateWorkGroupInput) SetTags added in v1.99.0 

func (s *CreateWorkGroupInput) SetTags(v []*Tag) *CreateWorkGroupInput

SetTags sets the Tags field's value.

func (CreateWorkGroupInput) String added in v1.99.0 

func (s CreateWorkGroupInput) String() string

String returns the string representation

func (*CreateWorkGroupInput) Validate added in v1.99.0 

func (s *CreateWorkGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateWorkGroupOutput added in v1.99.0 

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

func (CreateWorkGroupOutput) GoString added in v1.99.0 

func (s CreateWorkGroupOutput) GoString() string

GoString returns the string representation

func (CreateWorkGroupOutput) String added in v1.99.0 

func (s CreateWorkGroupOutput) String() string

String returns the string representation

type Datum 

type Datum struct {

	// The value of the datum.
	VarCharValue *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (Datum) GoString 

func (s Datum) GoString() string

GoString returns the string representation

func (*Datum) SetVarCharValue 

func (s *Datum) SetVarCharValue(v string) *Datum

SetVarCharValue sets the VarCharValue field's value.

func (Datum) String 

func (s Datum) String() string

String returns the string representation

type DeleteNamedQueryInput 

type DeleteNamedQueryInput struct {

	// The unique ID of the query to delete.
	NamedQueryId *string `type:"string" idempotencyToken:"true"`
	// contains filtered or unexported fields
}

func (DeleteNamedQueryInput) GoString 

func (s DeleteNamedQueryInput) GoString() string

GoString returns the string representation

func (*DeleteNamedQueryInput) SetNamedQueryId 

func (s *DeleteNamedQueryInput) SetNamedQueryId(v string) *DeleteNamedQueryInput

SetNamedQueryId sets the NamedQueryId field's value.

func (DeleteNamedQueryInput) String 

func (s DeleteNamedQueryInput) String() string

String returns the string representation

type DeleteNamedQueryOutput 

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

func (DeleteNamedQueryOutput) GoString 

func (s DeleteNamedQueryOutput) GoString() string

GoString returns the string representation

func (DeleteNamedQueryOutput) String 

func (s DeleteNamedQueryOutput) String() string

String returns the string representation

type DeleteWorkGroupInput added in v1.99.0 

type DeleteWorkGroupInput struct {

	// The option to delete the workgroup and its contents even if the workgroup
	// contains any named queries.
	RecursiveDeleteOption *bool `type:"boolean"`

	// The unique name of the workgroup to delete.
	//
	// WorkGroup is a required field
	WorkGroup *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteWorkGroupInput) GoString added in v1.99.0 

func (s DeleteWorkGroupInput) GoString() string

GoString returns the string representation

func (*DeleteWorkGroupInput) SetRecursiveDeleteOption added in v1.99.0 

func (s *DeleteWorkGroupInput) SetRecursiveDeleteOption(v bool) *DeleteWorkGroupInput

SetRecursiveDeleteOption sets the RecursiveDeleteOption field's value.

func (*DeleteWorkGroupInput) SetWorkGroup added in v1.99.0 

func (s *DeleteWorkGroupInput) SetWorkGroup(v string) *DeleteWorkGroupInput

SetWorkGroup sets the WorkGroup field's value.

func (DeleteWorkGroupInput) String added in v1.99.0 

func (s DeleteWorkGroupInput) String() string

String returns the string representation

func (*DeleteWorkGroupInput) Validate added in v1.99.0 

func (s *DeleteWorkGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteWorkGroupOutput added in v1.99.0 

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

func (DeleteWorkGroupOutput) GoString added in v1.99.0 

func (s DeleteWorkGroupOutput) GoString() string

GoString returns the string representation

func (DeleteWorkGroupOutput) String added in v1.99.0 

func (s DeleteWorkGroupOutput) String() string

String returns the string representation

type EncryptionConfiguration 

type EncryptionConfiguration struct {

	// Indicates whether Amazon S3 server-side encryption with Amazon S3-managed
	// keys (SSE-S3), server-side encryption with KMS-managed keys (SSE-KMS), or
	// client-side encryption with KMS-managed keys (CSE-KMS) is used.
	//
	// If a query runs in a workgroup and the workgroup overrides client-side settings,
	// then the workgroup's setting for encryption is used. It specifies whether
	// query results must be encrypted, for all queries that run in this workgroup.
	//
	// EncryptionOption is a required field
	EncryptionOption *string `type:"string" required:"true" enum:"EncryptionOption"`

	// For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID.
	KmsKey *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (EncryptionConfiguration) GoString 

func (s EncryptionConfiguration) GoString() string

GoString returns the string representation

func (*EncryptionConfiguration) SetEncryptionOption 

func (s *EncryptionConfiguration) SetEncryptionOption(v string) *EncryptionConfiguration

SetEncryptionOption sets the EncryptionOption field's value.

func (*EncryptionConfiguration) SetKmsKey 

func (s *EncryptionConfiguration) SetKmsKey(v string) *EncryptionConfiguration

SetKmsKey sets the KmsKey field's value.

func (EncryptionConfiguration) String 

func (s EncryptionConfiguration) String() string

String returns the string representation

func (*EncryptionConfiguration) Validate 

func (s *EncryptionConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetNamedQueryInput 

type GetNamedQueryInput struct {

	// The unique ID of the query. Use ListNamedQueries to get query IDs.
	//
	// NamedQueryId is a required field
	NamedQueryId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetNamedQueryInput) GoString 

func (s GetNamedQueryInput) GoString() string

GoString returns the string representation

func (*GetNamedQueryInput) SetNamedQueryId 

func (s *GetNamedQueryInput) SetNamedQueryId(v string) *GetNamedQueryInput

SetNamedQueryId sets the NamedQueryId field's value.

func (GetNamedQueryInput) String 

func (s GetNamedQueryInput) String() string

String returns the string representation

func (*GetNamedQueryInput) Validate 

func (s *GetNamedQueryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetNamedQueryOutput 

type GetNamedQueryOutput struct {

	// Information about the query.
	NamedQuery *NamedQuery `type:"structure"`
	// contains filtered or unexported fields
}

func (GetNamedQueryOutput) GoString 

func (s GetNamedQueryOutput) GoString() string

GoString returns the string representation

func (*GetNamedQueryOutput) SetNamedQuery 

func (s *GetNamedQueryOutput) SetNamedQuery(v *NamedQuery) *GetNamedQueryOutput

SetNamedQuery sets the NamedQuery field's value.

func (GetNamedQueryOutput) String 

func (s GetNamedQueryOutput) String() string

String returns the string representation

type GetQueryExecutionInput 

type GetQueryExecutionInput struct {

	// The unique ID of the query execution.
	//
	// QueryExecutionId is a required field
	QueryExecutionId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetQueryExecutionInput) GoString 

func (s GetQueryExecutionInput) GoString() string

GoString returns the string representation

func (*GetQueryExecutionInput) SetQueryExecutionId 

func (s *GetQueryExecutionInput) SetQueryExecutionId(v string) *GetQueryExecutionInput

SetQueryExecutionId sets the QueryExecutionId field's value.

func (GetQueryExecutionInput) String 

func (s GetQueryExecutionInput) String() string

String returns the string representation

func (*GetQueryExecutionInput) Validate 

func (s *GetQueryExecutionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetQueryExecutionOutput 

type GetQueryExecutionOutput struct {

	// Information about the query execution.
	QueryExecution *QueryExecution `type:"structure"`
	// contains filtered or unexported fields
}

func (GetQueryExecutionOutput) GoString 

func (s GetQueryExecutionOutput) GoString() string

GoString returns the string representation

func (*GetQueryExecutionOutput) SetQueryExecution 

func (s *GetQueryExecutionOutput) SetQueryExecution(v *QueryExecution) *GetQueryExecutionOutput

SetQueryExecution sets the QueryExecution field's value.

func (GetQueryExecutionOutput) String 

func (s GetQueryExecutionOutput) String() string

String returns the string representation

type GetQueryResultsInput 

type GetQueryResultsInput struct {

	// The maximum number of results (rows) to return in this request.
	MaxResults *int64 `type:"integer"`

	// The token that specifies where to start pagination if a previous request
	// was truncated.
	NextToken *string `min:"1" type:"string"`

	// The unique ID of the query execution.
	//
	// QueryExecutionId is a required field
	QueryExecutionId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetQueryResultsInput) GoString 

func (s GetQueryResultsInput) GoString() string

GoString returns the string representation

func (*GetQueryResultsInput) SetMaxResults 

func (s *GetQueryResultsInput) SetMaxResults(v int64) *GetQueryResultsInput

SetMaxResults sets the MaxResults field's value.

func (*GetQueryResultsInput) SetNextToken 

func (s *GetQueryResultsInput) SetNextToken(v string) *GetQueryResultsInput

SetNextToken sets the NextToken field's value.

func (*GetQueryResultsInput) SetQueryExecutionId 

func (s *GetQueryResultsInput) SetQueryExecutionId(v string) *GetQueryResultsInput

SetQueryExecutionId sets the QueryExecutionId field's value.

func (GetQueryResultsInput) String 

func (s GetQueryResultsInput) String() string

String returns the string representation

func (*GetQueryResultsInput) Validate 

func (s *GetQueryResultsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetQueryResultsOutput 

type GetQueryResultsOutput struct {

	// A token to be used by the next request if this request is truncated.
	NextToken *string `min:"1" type:"string"`

	// The results of the query execution.
	ResultSet *ResultSet `type:"structure"`

	// The number of rows inserted with a CREATE TABLE AS SELECT statement.
	UpdateCount *int64 `type:"long"`
	// contains filtered or unexported fields
}

func (GetQueryResultsOutput) GoString 

func (s GetQueryResultsOutput) GoString() string

GoString returns the string representation

func (*GetQueryResultsOutput) SetNextToken 

func (s *GetQueryResultsOutput) SetNextToken(v string) *GetQueryResultsOutput

SetNextToken sets the NextToken field's value.

func (*GetQueryResultsOutput) SetResultSet 

func (s *GetQueryResultsOutput) SetResultSet(v *ResultSet) *GetQueryResultsOutput

SetResultSet sets the ResultSet field's value.

func (*GetQueryResultsOutput) SetUpdateCount added in v1.99.0 

func (s *GetQueryResultsOutput) SetUpdateCount(v int64) *GetQueryResultsOutput

SetUpdateCount sets the UpdateCount field's value.

func (GetQueryResultsOutput) String 

func (s GetQueryResultsOutput) String() string

String returns the string representation

type GetWorkGroupInput added in v1.99.0 

type GetWorkGroupInput struct {

	// The name of the workgroup.
	//
	// WorkGroup is a required field
	WorkGroup *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetWorkGroupInput) GoString added in v1.99.0 

func (s GetWorkGroupInput) GoString() string

GoString returns the string representation

func (*GetWorkGroupInput) SetWorkGroup added in v1.99.0 

func (s *GetWorkGroupInput) SetWorkGroup(v string) *GetWorkGroupInput

SetWorkGroup sets the WorkGroup field's value.

func (GetWorkGroupInput) String added in v1.99.0 

func (s GetWorkGroupInput) String() string

String returns the string representation

func (*GetWorkGroupInput) Validate added in v1.99.0 

func (s *GetWorkGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetWorkGroupOutput added in v1.99.0 

type GetWorkGroupOutput struct {

	// Information about the workgroup.
	WorkGroup *WorkGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (GetWorkGroupOutput) GoString added in v1.99.0 

func (s GetWorkGroupOutput) GoString() string

GoString returns the string representation

func (*GetWorkGroupOutput) SetWorkGroup added in v1.99.0 

func (s *GetWorkGroupOutput) SetWorkGroup(v *WorkGroup) *GetWorkGroupOutput

SetWorkGroup sets the WorkGroup field's value.

func (GetWorkGroupOutput) String added in v1.99.0 

func (s GetWorkGroupOutput) String() string

String returns the string representation

type ListNamedQueriesInput 

type ListNamedQueriesInput struct {

	// The maximum number of queries to return in this request.
	MaxResults *int64 `type:"integer"`

	// The token that specifies where to start pagination if a previous request
	// was truncated.
	NextToken *string `min:"1" type:"string"`

	// The name of the workgroup from which the named queries are being returned.
	WorkGroup *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListNamedQueriesInput) GoString 

func (s ListNamedQueriesInput) GoString() string

GoString returns the string representation

func (*ListNamedQueriesInput) SetMaxResults 

func (s *ListNamedQueriesInput) SetMaxResults(v int64) *ListNamedQueriesInput

SetMaxResults sets the MaxResults field's value.

func (*ListNamedQueriesInput) SetNextToken 

func (s *ListNamedQueriesInput) SetNextToken(v string) *ListNamedQueriesInput

SetNextToken sets the NextToken field's value.

func (*ListNamedQueriesInput) SetWorkGroup added in v1.99.0 

func (s *ListNamedQueriesInput) SetWorkGroup(v string) *ListNamedQueriesInput

SetWorkGroup sets the WorkGroup field's value.

func (ListNamedQueriesInput) String 

func (s ListNamedQueriesInput) String() string

String returns the string representation

func (*ListNamedQueriesInput) Validate added in v1.99.0 

func (s *ListNamedQueriesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListNamedQueriesOutput 

type ListNamedQueriesOutput struct {

	// The list of unique query IDs.
	NamedQueryIds []*string `min:"1" type:"list"`

	// A token to be used by the next request if this request is truncated.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListNamedQueriesOutput) GoString 

func (s ListNamedQueriesOutput) GoString() string

GoString returns the string representation

func (*ListNamedQueriesOutput) SetNamedQueryIds 

func (s *ListNamedQueriesOutput) SetNamedQueryIds(v []*string) *ListNamedQueriesOutput

SetNamedQueryIds sets the NamedQueryIds field's value.

func (*ListNamedQueriesOutput) SetNextToken 

func (s *ListNamedQueriesOutput) SetNextToken(v string) *ListNamedQueriesOutput

SetNextToken sets the NextToken field's value.

func (ListNamedQueriesOutput) String 

func (s ListNamedQueriesOutput) String() string

String returns the string representation

type ListQueryExecutionsInput 

type ListQueryExecutionsInput struct {

	// The maximum number of query executions to return in this request.
	MaxResults *int64 `type:"integer"`

	// The token that specifies where to start pagination if a previous request
	// was truncated.
	NextToken *string `min:"1" type:"string"`

	// The name of the workgroup from which queries are being returned.
	WorkGroup *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListQueryExecutionsInput) GoString 

func (s ListQueryExecutionsInput) GoString() string

GoString returns the string representation

func (*ListQueryExecutionsInput) SetMaxResults 

func (s *ListQueryExecutionsInput) SetMaxResults(v int64) *ListQueryExecutionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListQueryExecutionsInput) SetNextToken 

func (s *ListQueryExecutionsInput) SetNextToken(v string) *ListQueryExecutionsInput

SetNextToken sets the NextToken field's value.

func (*ListQueryExecutionsInput) SetWorkGroup added in v1.99.0 

func (s *ListQueryExecutionsInput) SetWorkGroup(v string) *ListQueryExecutionsInput

SetWorkGroup sets the WorkGroup field's value.

func (ListQueryExecutionsInput) String 

func (s ListQueryExecutionsInput) String() string

String returns the string representation

func (*ListQueryExecutionsInput) Validate added in v1.99.0 

func (s *ListQueryExecutionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListQueryExecutionsOutput 

type ListQueryExecutionsOutput struct {

	// A token to be used by the next request if this request is truncated.
	NextToken *string `min:"1" type:"string"`

	// The unique IDs of each query execution as an array of strings.
	QueryExecutionIds []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (ListQueryExecutionsOutput) GoString 

func (s ListQueryExecutionsOutput) GoString() string

GoString returns the string representation

func (*ListQueryExecutionsOutput) SetNextToken 

func (s *ListQueryExecutionsOutput) SetNextToken(v string) *ListQueryExecutionsOutput

SetNextToken sets the NextToken field's value.

func (*ListQueryExecutionsOutput) SetQueryExecutionIds 

func (s *ListQueryExecutionsOutput) SetQueryExecutionIds(v []*string) *ListQueryExecutionsOutput

SetQueryExecutionIds sets the QueryExecutionIds field's value.

func (ListQueryExecutionsOutput) String 

func (s ListQueryExecutionsOutput) String() string

String returns the string representation

type ListTagsForResourceInput added in v1.99.0 

type ListTagsForResourceInput struct {

	// The maximum number of results to be returned per request that lists the tags
	// for the workgroup resource.
	MaxResults *int64 `min:"75" type:"integer"`

	// 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 workgroup
	// resource with the specified ARN.
	NextToken *string `min:"1" type:"string"`

	// Lists the tags for the workgroup resource with the specified ARN.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.99.0 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetMaxResults added in v1.99.0 

func (s *ListTagsForResourceInput) SetMaxResults(v int64) *ListTagsForResourceInput

SetMaxResults sets the MaxResults field's value.

func (*ListTagsForResourceInput) SetNextToken added in v1.99.0 

func (s *ListTagsForResourceInput) SetNextToken(v string) *ListTagsForResourceInput

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceInput) SetResourceARN added in v1.99.0 

func (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResourceInput

SetResourceARN sets the ResourceARN field's value.

func (ListTagsForResourceInput) String added in v1.99.0 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v1.99.0 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v1.99.0 

type ListTagsForResourceOutput struct {

	// A token to be used by the next request if this request is truncated.
	NextToken *string `min:"1" type:"string"`

	// The list of tags associated with this workgroup.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.99.0 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetNextToken added in v1.99.0 

func (s *ListTagsForResourceOutput) SetNextToken(v string) *ListTagsForResourceOutput

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceOutput) SetTags added in v1.99.0 

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.99.0 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListWorkGroupsInput added in v1.99.0 

type ListWorkGroupsInput struct {

	// The maximum number of workgroups to return in this request.
	MaxResults *int64 `min:"1" type:"integer"`

	// A token to be used by the next request if this request is truncated.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListWorkGroupsInput) GoString added in v1.99.0 

func (s ListWorkGroupsInput) GoString() string

GoString returns the string representation

func (*ListWorkGroupsInput) SetMaxResults added in v1.99.0 

func (s *ListWorkGroupsInput) SetMaxResults(v int64) *ListWorkGroupsInput

SetMaxResults sets the MaxResults field's value.

func (*ListWorkGroupsInput) SetNextToken added in v1.99.0 

func (s *ListWorkGroupsInput) SetNextToken(v string) *ListWorkGroupsInput

SetNextToken sets the NextToken field's value.

func (ListWorkGroupsInput) String added in v1.99.0 

func (s ListWorkGroupsInput) String() string

String returns the string representation

func (*ListWorkGroupsInput) Validate added in v1.99.0 

func (s *ListWorkGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListWorkGroupsOutput added in v1.99.0 

type ListWorkGroupsOutput struct {

	// A token to be used by the next request if this request is truncated.
	NextToken *string `min:"1" type:"string"`

	// The list of workgroups, including their names, descriptions, creation times,
	// and states.
	WorkGroups []*WorkGroupSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListWorkGroupsOutput) GoString added in v1.99.0 

func (s ListWorkGroupsOutput) GoString() string

GoString returns the string representation

func (*ListWorkGroupsOutput) SetNextToken added in v1.99.0 

func (s *ListWorkGroupsOutput) SetNextToken(v string) *ListWorkGroupsOutput

SetNextToken sets the NextToken field's value.

func (*ListWorkGroupsOutput) SetWorkGroups added in v1.99.0 

func (s *ListWorkGroupsOutput) SetWorkGroups(v []*WorkGroupSummary) *ListWorkGroupsOutput

SetWorkGroups sets the WorkGroups field's value.

func (ListWorkGroupsOutput) String added in v1.99.0 

func (s ListWorkGroupsOutput) String() string

String returns the string representation

type NamedQuery 

type NamedQuery struct {

	// The database to which the query belongs.
	//
	// Database is a required field
	Database *string `min:"1" type:"string" required:"true"`

	// The query description.
	Description *string `min:"1" type:"string"`

	// The query name.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The unique identifier of the query.
	NamedQueryId *string `type:"string"`

	// The SQL query statements that comprise the query.
	//
	// QueryString is a required field
	QueryString *string `min:"1" type:"string" required:"true"`

	// The name of the workgroup that contains the named query.
	WorkGroup *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (NamedQuery) GoString 

func (s NamedQuery) GoString() string

GoString returns the string representation

func (*NamedQuery) SetDatabase 

func (s *NamedQuery) SetDatabase(v string) *NamedQuery

SetDatabase sets the Database field's value.

func (*NamedQuery) SetDescription 

func (s *NamedQuery) SetDescription(v string) *NamedQuery

SetDescription sets the Description field's value.

func (*NamedQuery) SetName 

func (s *NamedQuery) SetName(v string) *NamedQuery

SetName sets the Name field's value.

func (*NamedQuery) SetNamedQueryId 

func (s *NamedQuery) SetNamedQueryId(v string) *NamedQuery

SetNamedQueryId sets the NamedQueryId field's value.

func (*NamedQuery) SetQueryString 

func (s *NamedQuery) SetQueryString(v string) *NamedQuery

SetQueryString sets the QueryString field's value.

func (*NamedQuery) SetWorkGroup added in v1.99.0 

func (s *NamedQuery) SetWorkGroup(v string) *NamedQuery

SetWorkGroup sets the WorkGroup field's value.

func (NamedQuery) String 

func (s NamedQuery) String() string

String returns the string representation

type QueryExecution 

type QueryExecution struct {

	// The SQL query statements which the query execution ran.
	Query *string `min:"1" type:"string"`

	// The database in which the query execution occurred.
	QueryExecutionContext *QueryExecutionContext `type:"structure"`

	// The unique identifier for each query execution.
	QueryExecutionId *string `type:"string"`

	// The location in Amazon S3 where query results were stored and the encryption
	// option, if any, used for query results. These are known as "client-side settings".
	// If workgroup settings override client-side settings, then the query uses
	// the location for the query results and the encryption configuration that
	// are specified for the workgroup.
	ResultConfiguration *ResultConfiguration `type:"structure"`

	// The type of query statement that was run. DDL indicates DDL query statements.
	// DML indicates DML (Data Manipulation Language) query statements, such as
	// CREATE TABLE AS SELECT. UTILITY indicates query statements other than DDL
	// and DML, such as SHOW CREATE TABLE, or DESCRIBE <table>.
	StatementType *string `type:"string" enum:"StatementType"`

	// The amount of data scanned during the query execution and the amount of time
	// that it took to execute, and the type of statement that was run.
	Statistics *QueryExecutionStatistics `type:"structure"`

	// The completion date, current state, submission time, and state change reason
	// (if applicable) for the query execution.
	Status *QueryExecutionStatus `type:"structure"`

	// The name of the workgroup in which the query ran.
	WorkGroup *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a single instance of a query execution.

func (QueryExecution) GoString 

func (s QueryExecution) GoString() string

GoString returns the string representation

func (*QueryExecution) SetQuery 

func (s *QueryExecution) SetQuery(v string) *QueryExecution

SetQuery sets the Query field's value.

func (*QueryExecution) SetQueryExecutionContext 

func (s *QueryExecution) SetQueryExecutionContext(v *QueryExecutionContext) *QueryExecution

SetQueryExecutionContext sets the QueryExecutionContext field's value.

func (*QueryExecution) SetQueryExecutionId 

func (s *QueryExecution) SetQueryExecutionId(v string) *QueryExecution

SetQueryExecutionId sets the QueryExecutionId field's value.

func (*QueryExecution) SetResultConfiguration 

func (s *QueryExecution) SetResultConfiguration(v *ResultConfiguration) *QueryExecution

SetResultConfiguration sets the ResultConfiguration field's value.

func (*QueryExecution) SetStatementType added in v1.99.0 

func (s *QueryExecution) SetStatementType(v string) *QueryExecution

SetStatementType sets the StatementType field's value.

func (*QueryExecution) SetStatistics 

func (s *QueryExecution) SetStatistics(v *QueryExecutionStatistics) *QueryExecution

SetStatistics sets the Statistics field's value.

func (*QueryExecution) SetStatus 

func (s *QueryExecution) SetStatus(v *QueryExecutionStatus) *QueryExecution

SetStatus sets the Status field's value.

func (*QueryExecution) SetWorkGroup added in v1.99.0 

func (s *QueryExecution) SetWorkGroup(v string) *QueryExecution

SetWorkGroup sets the WorkGroup field's value.

func (QueryExecution) String 

func (s QueryExecution) String() string

String returns the string representation

type QueryExecutionContext 

type QueryExecutionContext struct {

	// The name of the database.
	Database *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The database in which the query execution occurs.

func (QueryExecutionContext) GoString 

func (s QueryExecutionContext) GoString() string

GoString returns the string representation

func (*QueryExecutionContext) SetDatabase 

func (s *QueryExecutionContext) SetDatabase(v string) *QueryExecutionContext

SetDatabase sets the Database field's value.

func (QueryExecutionContext) String 

func (s QueryExecutionContext) String() string

String returns the string representation

func (*QueryExecutionContext) Validate 

func (s *QueryExecutionContext) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type QueryExecutionStatistics 

type QueryExecutionStatistics struct {

	// The number of bytes in the data that was queried.
	DataScannedInBytes *int64 `type:"long"`

	// The number of milliseconds that the query took to execute.
	EngineExecutionTimeInMillis *int64 `type:"long"`
	// contains filtered or unexported fields
}

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

func (QueryExecutionStatistics) GoString 

func (s QueryExecutionStatistics) GoString() string

GoString returns the string representation

func (*QueryExecutionStatistics) SetDataScannedInBytes 

func (s *QueryExecutionStatistics) SetDataScannedInBytes(v int64) *QueryExecutionStatistics

SetDataScannedInBytes sets the DataScannedInBytes field's value.

func (*QueryExecutionStatistics) SetEngineExecutionTimeInMillis 

func (s *QueryExecutionStatistics) SetEngineExecutionTimeInMillis(v int64) *QueryExecutionStatistics

SetEngineExecutionTimeInMillis sets the EngineExecutionTimeInMillis field's value.

func (QueryExecutionStatistics) String 

func (s QueryExecutionStatistics) String() string

String returns the string representation

type QueryExecutionStatus 

type QueryExecutionStatus struct {

	// The date and time that the query completed.
	CompletionDateTime *time.Time `type:"timestamp"`

	// The state of query execution. QUEUED state is listed but is not used by Athena
	// and is reserved for future use. RUNNING indicates that the query has been
	// submitted to the service, and Athena will execute the query as soon as resources
	// are available. SUCCEEDED indicates that the query completed without errors.
	// FAILED indicates that the query experienced an error and did not complete
	// processing. CANCELLED indicates that a user input interrupted query execution.
	State *string `type:"string" enum:"QueryExecutionState"`

	// Further detail about the status of the query.
	StateChangeReason *string `type:"string"`

	// The date and time that the query was submitted.
	SubmissionDateTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

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

func (QueryExecutionStatus) GoString 

func (s QueryExecutionStatus) GoString() string

GoString returns the string representation

func (*QueryExecutionStatus) SetCompletionDateTime 

func (s *QueryExecutionStatus) SetCompletionDateTime(v time.Time) *QueryExecutionStatus

SetCompletionDateTime sets the CompletionDateTime field's value.

func (*QueryExecutionStatus) SetState 

func (s *QueryExecutionStatus) SetState(v string) *QueryExecutionStatus

SetState sets the State field's value.

func (*QueryExecutionStatus) SetStateChangeReason 

func (s *QueryExecutionStatus) SetStateChangeReason(v string) *QueryExecutionStatus

SetStateChangeReason sets the StateChangeReason field's value.

func (*QueryExecutionStatus) SetSubmissionDateTime 

func (s *QueryExecutionStatus) SetSubmissionDateTime(v time.Time) *QueryExecutionStatus

SetSubmissionDateTime sets the SubmissionDateTime field's value.

func (QueryExecutionStatus) String 

func (s QueryExecutionStatus) String() string

String returns the string representation

type ResultConfiguration 

type ResultConfiguration struct {

	// If query results are encrypted in Amazon S3, indicates the encryption option
	// used (for example, SSE-KMS or CSE-KMS) and key information. This is a client-side
	// setting. If workgroup settings override client-side settings, then the query
	// uses the encryption configuration that is specified for the workgroup, and
	// also uses the location for storing query results specified in the workgroup.
	// See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings
	// Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html).
	EncryptionConfiguration *EncryptionConfiguration `type:"structure"`

	// The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/.
	// For more information, see Queries and Query Result Files. (https://docs.aws.amazon.com/athena/latest/ug/querying.html)
	// If workgroup settings override client-side settings, then the query uses
	// the location for the query results and the encryption configuration that
	// are specified for the workgroup. The "workgroup settings override" is specified
	// in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration.
	// See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
	OutputLocation *string `type:"string"`
	// contains filtered or unexported fields
}

The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup.

func (ResultConfiguration) GoString 

func (s ResultConfiguration) GoString() string

GoString returns the string representation

func (*ResultConfiguration) SetEncryptionConfiguration 

func (s *ResultConfiguration) SetEncryptionConfiguration(v *EncryptionConfiguration) *ResultConfiguration

SetEncryptionConfiguration sets the EncryptionConfiguration field's value.

func (*ResultConfiguration) SetOutputLocation 

func (s *ResultConfiguration) SetOutputLocation(v string) *ResultConfiguration

SetOutputLocation sets the OutputLocation field's value.

func (ResultConfiguration) String 

func (s ResultConfiguration) String() string

String returns the string representation

func (*ResultConfiguration) Validate 

func (s *ResultConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResultConfigurationUpdates added in v1.99.0 

type ResultConfigurationUpdates struct {

	// The encryption configuration for the query results.
	EncryptionConfiguration *EncryptionConfiguration `type:"structure"`

	// The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/.
	// For more information, see Queries and Query Result Files. (https://docs.aws.amazon.com/athena/latest/ug/querying.html)
	// If workgroup settings override client-side settings, then the query uses
	// the location for the query results and the encryption configuration that
	// are specified for the workgroup. The "workgroup settings override" is specified
	// in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration.
	// See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
	OutputLocation *string `type:"string"`

	// If set to "true", indicates that the previously-specified encryption configuration
	// (also known as the client-side setting) for queries in this workgroup should
	// be ignored and set to null. If set to "false" or not set, and a value is
	// present in the EncryptionConfiguration in ResultConfigurationUpdates (the
	// client-side setting), the EncryptionConfiguration in the workgroup's ResultConfiguration
	// will be updated with the new value. For more information, see Workgroup Settings
	// Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html).
	RemoveEncryptionConfiguration *bool `type:"boolean"`

	// If set to "true", indicates that the previously-specified query results location
	// (also known as a client-side setting) for queries in this workgroup should
	// be ignored and set to null. If set to "false" or not set, and a value is
	// present in the OutputLocation in ResultConfigurationUpdates (the client-side
	// setting), the OutputLocation in the workgroup's ResultConfiguration will
	// be updated with the new value. For more information, see Workgroup Settings
	// Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html).
	RemoveOutputLocation *bool `type:"boolean"`
	// contains filtered or unexported fields
}

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

func (ResultConfigurationUpdates) GoString added in v1.99.0 

func (s ResultConfigurationUpdates) GoString() string

GoString returns the string representation

func (*ResultConfigurationUpdates) SetEncryptionConfiguration added in v1.99.0 

func (s *ResultConfigurationUpdates) SetEncryptionConfiguration(v *EncryptionConfiguration) *ResultConfigurationUpdates

SetEncryptionConfiguration sets the EncryptionConfiguration field's value.

func (*ResultConfigurationUpdates) SetOutputLocation added in v1.99.0 

func (s *ResultConfigurationUpdates) SetOutputLocation(v string) *ResultConfigurationUpdates

SetOutputLocation sets the OutputLocation field's value.

func (*ResultConfigurationUpdates) SetRemoveEncryptionConfiguration added in v1.99.0 

func (s *ResultConfigurationUpdates) SetRemoveEncryptionConfiguration(v bool) *ResultConfigurationUpdates

SetRemoveEncryptionConfiguration sets the RemoveEncryptionConfiguration field's value.

func (*ResultConfigurationUpdates) SetRemoveOutputLocation added in v1.99.0 

func (s *ResultConfigurationUpdates) SetRemoveOutputLocation(v bool) *ResultConfigurationUpdates

SetRemoveOutputLocation sets the RemoveOutputLocation field's value.

func (ResultConfigurationUpdates) String added in v1.99.0 

func (s ResultConfigurationUpdates) String() string

String returns the string representation

func (*ResultConfigurationUpdates) Validate added in v1.99.0 

func (s *ResultConfigurationUpdates) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResultSet 

type ResultSet struct {

	// The metadata that describes the column structure and data types of a table
	// of query results.
	ResultSetMetadata *ResultSetMetadata `type:"structure"`

	// The rows in the table.
	Rows []*Row `type:"list"`
	// contains filtered or unexported fields
}

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

func (ResultSet) GoString 

func (s ResultSet) GoString() string

GoString returns the string representation

func (*ResultSet) SetResultSetMetadata 

func (s *ResultSet) SetResultSetMetadata(v *ResultSetMetadata) *ResultSet

SetResultSetMetadata sets the ResultSetMetadata field's value.

func (*ResultSet) SetRows 

func (s *ResultSet) SetRows(v []*Row) *ResultSet

SetRows sets the Rows field's value.

func (ResultSet) String 

func (s ResultSet) String() string

String returns the string representation

type ResultSetMetadata 

type ResultSetMetadata struct {

	// Information about the columns returned in a query result metadata.
	ColumnInfo []*ColumnInfo `type:"list"`
	// contains filtered or unexported fields
}

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

func (ResultSetMetadata) GoString 

func (s ResultSetMetadata) GoString() string

GoString returns the string representation

func (*ResultSetMetadata) SetColumnInfo 

func (s *ResultSetMetadata) SetColumnInfo(v []*ColumnInfo) *ResultSetMetadata

SetColumnInfo sets the ColumnInfo field's value.

func (ResultSetMetadata) String 

func (s ResultSetMetadata) String() string

String returns the string representation

type Row 

type Row struct {

	// The data that populates a row in a query result table.
	Data []*Datum `type:"list"`
	// contains filtered or unexported fields
}

The rows that comprise a query result table.

func (Row) GoString 

func (s Row) GoString() string

GoString returns the string representation

func (*Row) SetData 

func (s *Row) SetData(v []*Datum) *Row

SetData sets the Data field's value.

func (Row) String 

func (s Row) String() string

String returns the string representation

type StartQueryExecutionInput 

type StartQueryExecutionInput struct {

	// 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 `min:"32" type:"string" idempotencyToken:"true"`

	// The database within which the query executes.
	QueryExecutionContext *QueryExecutionContext `type:"structure"`

	// The SQL query statements to be executed.
	//
	// QueryString is a required field
	QueryString *string `min:"1" type:"string" required:"true"`

	// 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 *ResultConfiguration `type:"structure"`

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

func (StartQueryExecutionInput) GoString 

func (s StartQueryExecutionInput) GoString() string

GoString returns the string representation

func (*StartQueryExecutionInput) SetClientRequestToken 

func (s *StartQueryExecutionInput) SetClientRequestToken(v string) *StartQueryExecutionInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartQueryExecutionInput) SetQueryExecutionContext 

func (s *StartQueryExecutionInput) SetQueryExecutionContext(v *QueryExecutionContext) *StartQueryExecutionInput

SetQueryExecutionContext sets the QueryExecutionContext field's value.

func (*StartQueryExecutionInput) SetQueryString 

func (s *StartQueryExecutionInput) SetQueryString(v string) *StartQueryExecutionInput

SetQueryString sets the QueryString field's value.

func (*StartQueryExecutionInput) SetResultConfiguration 

func (s *StartQueryExecutionInput) SetResultConfiguration(v *ResultConfiguration) *StartQueryExecutionInput

SetResultConfiguration sets the ResultConfiguration field's value.

func (*StartQueryExecutionInput) SetWorkGroup added in v1.99.0 

func (s *StartQueryExecutionInput) SetWorkGroup(v string) *StartQueryExecutionInput

SetWorkGroup sets the WorkGroup field's value.

func (StartQueryExecutionInput) String 

func (s StartQueryExecutionInput) String() string

String returns the string representation

func (*StartQueryExecutionInput) Validate 

func (s *StartQueryExecutionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartQueryExecutionOutput 

type StartQueryExecutionOutput struct {

	// The unique ID of the query that ran as a result of this request.
	QueryExecutionId *string `type:"string"`
	// contains filtered or unexported fields
}

func (StartQueryExecutionOutput) GoString 

func (s StartQueryExecutionOutput) GoString() string

GoString returns the string representation

func (*StartQueryExecutionOutput) SetQueryExecutionId 

func (s *StartQueryExecutionOutput) SetQueryExecutionId(v string) *StartQueryExecutionOutput

SetQueryExecutionId sets the QueryExecutionId field's value.

func (StartQueryExecutionOutput) String 

func (s StartQueryExecutionOutput) String() string

String returns the string representation

type StopQueryExecutionInput 

type StopQueryExecutionInput struct {

	// The unique ID of the query execution to stop.
	QueryExecutionId *string `type:"string" idempotencyToken:"true"`
	// contains filtered or unexported fields
}

func (StopQueryExecutionInput) GoString 

func (s StopQueryExecutionInput) GoString() string

GoString returns the string representation

func (*StopQueryExecutionInput) SetQueryExecutionId 

func (s *StopQueryExecutionInput) SetQueryExecutionId(v string) *StopQueryExecutionInput

SetQueryExecutionId sets the QueryExecutionId field's value.

func (StopQueryExecutionInput) String 

func (s StopQueryExecutionInput) String() string

String returns the string representation

type StopQueryExecutionOutput 

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

func (StopQueryExecutionOutput) GoString 

func (s StopQueryExecutionOutput) GoString() string

GoString returns the string representation

func (StopQueryExecutionOutput) String 

func (s StopQueryExecutionOutput) String() string

String returns the string representation

type Tag added in v1.99.0 

type Tag struct {

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

	// A tag value. The tag value length is from 0 to 256 Unicode characters in
	// UTF-8. You can use letters and numbers representable in UTF-8, and the following
	// characters: + - = . _ : / @. Tag values are case-sensitive.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A tag that you can add to a resource. A tag is a label that you assign to an AWS Athena resource (a workgroup). Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize workgroups in Athena, for example, by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups in your account. The maximum tag key length is 128 Unicode characters in UTF-8. The maximum tag value length is 256 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource.

func (Tag) GoString added in v1.99.0 

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey added in v1.99.0 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.99.0 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v1.99.0 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate added in v1.99.0 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput added in v1.99.0 

type TagResourceInput struct {

	// Requests that one or more tags are added to the resource (such as a workgroup)
	// for the specified ARN.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// One or more tags, separated by commas, to be added to the resource, such
	// as a workgroup.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.99.0 

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetResourceARN added in v1.99.0 

func (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetTags added in v1.99.0 

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.99.0 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v1.99.0 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v1.99.0 

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

func (TagResourceOutput) GoString added in v1.99.0 

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) String added in v1.99.0 

func (s TagResourceOutput) String() string

String returns the string representation

type UnprocessedNamedQueryId 

type UnprocessedNamedQueryId struct {

	// The error code returned when the processing request for the named query failed,
	// if applicable.
	ErrorCode *string `min:"1" type:"string"`

	// The error message returned when the processing request for the named query
	// failed, if applicable.
	ErrorMessage *string `type:"string"`

	// The unique identifier of the named query.
	NamedQueryId *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (UnprocessedNamedQueryId) GoString 

func (s UnprocessedNamedQueryId) GoString() string

GoString returns the string representation

func (*UnprocessedNamedQueryId) SetErrorCode 

func (s *UnprocessedNamedQueryId) SetErrorCode(v string) *UnprocessedNamedQueryId

SetErrorCode sets the ErrorCode field's value.

func (*UnprocessedNamedQueryId) SetErrorMessage 

func (s *UnprocessedNamedQueryId) SetErrorMessage(v string) *UnprocessedNamedQueryId

SetErrorMessage sets the ErrorMessage field's value.

func (*UnprocessedNamedQueryId) SetNamedQueryId 

func (s *UnprocessedNamedQueryId) SetNamedQueryId(v string) *UnprocessedNamedQueryId

SetNamedQueryId sets the NamedQueryId field's value.

func (UnprocessedNamedQueryId) String 

func (s UnprocessedNamedQueryId) String() string

String returns the string representation

type UnprocessedQueryExecutionId 

type UnprocessedQueryExecutionId struct {

	// The error code returned when the query execution failed to process, if applicable.
	ErrorCode *string `min:"1" type:"string"`

	// The error message returned when the query execution failed to process, if
	// applicable.
	ErrorMessage *string `type:"string"`

	// The unique identifier of the query execution.
	QueryExecutionId *string `type:"string"`
	// contains filtered or unexported fields
}

Describes a query execution that failed to process.

func (UnprocessedQueryExecutionId) GoString 

func (s UnprocessedQueryExecutionId) GoString() string

GoString returns the string representation

func (*UnprocessedQueryExecutionId) SetErrorCode 

func (s *UnprocessedQueryExecutionId) SetErrorCode(v string) *UnprocessedQueryExecutionId

SetErrorCode sets the ErrorCode field's value.

func (*UnprocessedQueryExecutionId) SetErrorMessage 

func (s *UnprocessedQueryExecutionId) SetErrorMessage(v string) *UnprocessedQueryExecutionId

SetErrorMessage sets the ErrorMessage field's value.

func (*UnprocessedQueryExecutionId) SetQueryExecutionId 

func (s *UnprocessedQueryExecutionId) SetQueryExecutionId(v string) *UnprocessedQueryExecutionId

SetQueryExecutionId sets the QueryExecutionId field's value.

func (UnprocessedQueryExecutionId) String 

func (s UnprocessedQueryExecutionId) String() string

String returns the string representation

type UntagResourceInput added in v1.99.0 

type UntagResourceInput struct {

	// Removes one or more tags from the workgroup resource for the specified ARN.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// Removes the tags associated with one or more tag keys from the workgroup
	// resource.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.99.0 

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetResourceARN added in v1.99.0 

func (s *UntagResourceInput) SetResourceARN(v string) *UntagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*UntagResourceInput) SetTagKeys added in v1.99.0 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.99.0 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v1.99.0 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v1.99.0 

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

func (UntagResourceOutput) GoString added in v1.99.0 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) String added in v1.99.0 

func (s UntagResourceOutput) String() string

String returns the string representation

type UpdateWorkGroupInput added in v1.99.0 

type UpdateWorkGroupInput struct {

	// The workgroup configuration that will be updated for the given workgroup.
	ConfigurationUpdates *WorkGroupConfigurationUpdates `type:"structure"`

	// The workgroup description.
	Description *string `type:"string"`

	// The workgroup state that will be updated for the given workgroup.
	State *string `type:"string" enum:"WorkGroupState"`

	// The specified workgroup that will be updated.
	//
	// WorkGroup is a required field
	WorkGroup *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateWorkGroupInput) GoString added in v1.99.0 

func (s UpdateWorkGroupInput) GoString() string

GoString returns the string representation

func (*UpdateWorkGroupInput) SetConfigurationUpdates added in v1.99.0 

func (s *UpdateWorkGroupInput) SetConfigurationUpdates(v *WorkGroupConfigurationUpdates) *UpdateWorkGroupInput

SetConfigurationUpdates sets the ConfigurationUpdates field's value.

func (*UpdateWorkGroupInput) SetDescription added in v1.99.0 

func (s *UpdateWorkGroupInput) SetDescription(v string) *UpdateWorkGroupInput

SetDescription sets the Description field's value.

func (*UpdateWorkGroupInput) SetState added in v1.99.0 

func (s *UpdateWorkGroupInput) SetState(v string) *UpdateWorkGroupInput

SetState sets the State field's value.

func (*UpdateWorkGroupInput) SetWorkGroup added in v1.99.0 

func (s *UpdateWorkGroupInput) SetWorkGroup(v string) *UpdateWorkGroupInput

SetWorkGroup sets the WorkGroup field's value.

func (UpdateWorkGroupInput) String added in v1.99.0 

func (s UpdateWorkGroupInput) String() string

String returns the string representation

func (*UpdateWorkGroupInput) Validate added in v1.99.0 

func (s *UpdateWorkGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateWorkGroupOutput added in v1.99.0 

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

func (UpdateWorkGroupOutput) GoString added in v1.99.0 

func (s UpdateWorkGroupOutput) GoString() string

GoString returns the string representation

func (UpdateWorkGroupOutput) String added in v1.99.0 

func (s UpdateWorkGroupOutput) String() string

String returns the string representation

type WorkGroup added in v1.99.0 

type WorkGroup struct {

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

	// The date and time the workgroup was created.
	CreationTime *time.Time `type:"timestamp"`

	// The workgroup description.
	Description *string `type:"string"`

	// The workgroup name.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The state of the workgroup: ENABLED or DISABLED.
	State *string `type:"string" enum:"WorkGroupState"`
	// contains filtered or unexported fields
}

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

func (WorkGroup) GoString added in v1.99.0 

func (s WorkGroup) GoString() string

GoString returns the string representation

func (*WorkGroup) SetConfiguration added in v1.99.0 

func (s *WorkGroup) SetConfiguration(v *WorkGroupConfiguration) *WorkGroup

SetConfiguration sets the Configuration field's value.

func (*WorkGroup) SetCreationTime added in v1.99.0 

func (s *WorkGroup) SetCreationTime(v time.Time) *WorkGroup

SetCreationTime sets the CreationTime field's value.

func (*WorkGroup) SetDescription added in v1.99.0 

func (s *WorkGroup) SetDescription(v string) *WorkGroup

SetDescription sets the Description field's value.

func (*WorkGroup) SetName added in v1.99.0 

func (s *WorkGroup) SetName(v string) *WorkGroup

SetName sets the Name field's value.

func (*WorkGroup) SetState added in v1.99.0 

func (s *WorkGroup) SetState(v string) *WorkGroup

SetState sets the State field's value.

func (WorkGroup) String added in v1.99.0 

func (s WorkGroup) String() string

String returns the string representation

type WorkGroupConfiguration added in v1.99.0 

type WorkGroupConfiguration struct {

	// The upper data usage limit (cutoff) for the amount of bytes a single query
	// in a workgroup is allowed to scan.
	BytesScannedCutoffPerQuery *int64 `min:"1e+07" type:"long"`

	// If set to "true", the settings for the workgroup override client-side settings.
	// If set to "false", client-side settings are used. For more information, see
	// Workgroup Settings Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html).
	EnforceWorkGroupConfiguration *bool `type:"boolean"`

	// Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
	PublishCloudWatchMetricsEnabled *bool `type:"boolean"`

	// The configuration for the workgroup, which includes the location in Amazon
	// S3 where query results are stored and the encryption option, if any, used
	// for query results.
	ResultConfiguration *ResultConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

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

func (WorkGroupConfiguration) GoString added in v1.99.0 

func (s WorkGroupConfiguration) GoString() string

GoString returns the string representation

func (*WorkGroupConfiguration) SetBytesScannedCutoffPerQuery added in v1.99.0 

func (s *WorkGroupConfiguration) SetBytesScannedCutoffPerQuery(v int64) *WorkGroupConfiguration

SetBytesScannedCutoffPerQuery sets the BytesScannedCutoffPerQuery field's value.

func (*WorkGroupConfiguration) SetEnforceWorkGroupConfiguration added in v1.99.0 

func (s *WorkGroupConfiguration) SetEnforceWorkGroupConfiguration(v bool) *WorkGroupConfiguration

SetEnforceWorkGroupConfiguration sets the EnforceWorkGroupConfiguration field's value.

func (*WorkGroupConfiguration) SetPublishCloudWatchMetricsEnabled added in v1.99.0 

func (s *WorkGroupConfiguration) SetPublishCloudWatchMetricsEnabled(v bool) *WorkGroupConfiguration

SetPublishCloudWatchMetricsEnabled sets the PublishCloudWatchMetricsEnabled field's value.

func (*WorkGroupConfiguration) SetResultConfiguration added in v1.99.0 

func (s *WorkGroupConfiguration) SetResultConfiguration(v *ResultConfiguration) *WorkGroupConfiguration

SetResultConfiguration sets the ResultConfiguration field's value.

func (WorkGroupConfiguration) String added in v1.99.0 

func (s WorkGroupConfiguration) String() string

String returns the string representation

func (*WorkGroupConfiguration) Validate added in v1.99.0 

func (s *WorkGroupConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type WorkGroupConfigurationUpdates added in v1.99.0 

type WorkGroupConfigurationUpdates struct {

	// The upper limit (cutoff) for the amount of bytes a single query in a workgroup
	// is allowed to scan.
	BytesScannedCutoffPerQuery *int64 `min:"1e+07" type:"long"`

	// If set to "true", the settings for the workgroup override client-side settings.
	// If set to "false" client-side settings are used. For more information, see
	// Workgroup Settings Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html).
	EnforceWorkGroupConfiguration *bool `type:"boolean"`

	// Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
	PublishCloudWatchMetricsEnabled *bool `type:"boolean"`

	// Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery
	RemoveBytesScannedCutoffPerQuery *bool `type:"boolean"`

	// The result configuration information about the queries in this workgroup
	// that will be updated. Includes the updated results location and an updated
	// option for encrypting query results.
	ResultConfigurationUpdates *ResultConfigurationUpdates `type:"structure"`
	// contains filtered or unexported fields
}

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

func (WorkGroupConfigurationUpdates) GoString added in v1.99.0 

func (s WorkGroupConfigurationUpdates) GoString() string

GoString returns the string representation

func (*WorkGroupConfigurationUpdates) SetBytesScannedCutoffPerQuery added in v1.99.0 

func (s *WorkGroupConfigurationUpdates) SetBytesScannedCutoffPerQuery(v int64) *WorkGroupConfigurationUpdates

SetBytesScannedCutoffPerQuery sets the BytesScannedCutoffPerQuery field's value.

func (*WorkGroupConfigurationUpdates) SetEnforceWorkGroupConfiguration added in v1.99.0 

func (s *WorkGroupConfigurationUpdates) SetEnforceWorkGroupConfiguration(v bool) *WorkGroupConfigurationUpdates

SetEnforceWorkGroupConfiguration sets the EnforceWorkGroupConfiguration field's value.

func (*WorkGroupConfigurationUpdates) SetPublishCloudWatchMetricsEnabled added in v1.99.0 

func (s *WorkGroupConfigurationUpdates) SetPublishCloudWatchMetricsEnabled(v bool) *WorkGroupConfigurationUpdates

SetPublishCloudWatchMetricsEnabled sets the PublishCloudWatchMetricsEnabled field's value.

func (*WorkGroupConfigurationUpdates) SetRemoveBytesScannedCutoffPerQuery added in v1.99.0 

func (s *WorkGroupConfigurationUpdates) SetRemoveBytesScannedCutoffPerQuery(v bool) *WorkGroupConfigurationUpdates

SetRemoveBytesScannedCutoffPerQuery sets the RemoveBytesScannedCutoffPerQuery field's value.

func (*WorkGroupConfigurationUpdates) SetResultConfigurationUpdates added in v1.99.0 

func (s *WorkGroupConfigurationUpdates) SetResultConfigurationUpdates(v *ResultConfigurationUpdates) *WorkGroupConfigurationUpdates

SetResultConfigurationUpdates sets the ResultConfigurationUpdates field's value.

func (WorkGroupConfigurationUpdates) String added in v1.99.0 

func (s WorkGroupConfigurationUpdates) String() string

String returns the string representation

func (*WorkGroupConfigurationUpdates) Validate added in v1.99.0 

func (s *WorkGroupConfigurationUpdates) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type WorkGroupSummary added in v1.99.0 

type WorkGroupSummary struct {

	// The workgroup creation date and time.
	CreationTime *time.Time `type:"timestamp"`

	// The workgroup description.
	Description *string `type:"string"`

	// The name of the workgroup.
	Name *string `type:"string"`

	// The state of the workgroup.
	State *string `type:"string" enum:"WorkGroupState"`
	// contains filtered or unexported fields
}

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

func (WorkGroupSummary) GoString added in v1.99.0 

func (s WorkGroupSummary) GoString() string

GoString returns the string representation

func (*WorkGroupSummary) SetCreationTime added in v1.99.0 

func (s *WorkGroupSummary) SetCreationTime(v time.Time) *WorkGroupSummary

SetCreationTime sets the CreationTime field's value.

func (*WorkGroupSummary) SetDescription added in v1.99.0 

func (s *WorkGroupSummary) SetDescription(v string) *WorkGroupSummary

SetDescription sets the Description field's value.

func (*WorkGroupSummary) SetName added in v1.99.0 

func (s *WorkGroupSummary) SetName(v string) *WorkGroupSummary

SetName sets the Name field's value.

func (*WorkGroupSummary) SetState added in v1.99.0 

func (s *WorkGroupSummary) SetState(v string) *WorkGroupSummary

SetState sets the State field's value.

func (WorkGroupSummary) String added in v1.99.0 

func (s WorkGroupSummary) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package athenaiface provides an interface to enable mocking the Amazon Athena service client for testing your code.
 Package athenaiface provides an interface to enable mocking the Amazon Athena service client for testing your code.

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.