athena

package
v1.8.31-0...-26d4122 Latest Latest
Warning

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

Go to latest
Published: May 25, 2017 License: Apache-2.0 Imports: 7 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.

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.

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 use the client for Amazon Athena you will first need to create a new instance of it.

When creating a client for an AWS service you'll first need to have a Session already created. The Session provides configuration that can be shared between multiple service clients. Additional configuration can be applied to the Session and service's client when they are constructed. The aws package's Config type contains several fields such as Region for the AWS Region the client should make API requests too. The optional Config value can be provided as the variadic argument for Sessions and client creation.

Once the service's client is created you can use it to make API requests the AWS service. These clients are safe to use concurrently.

// Create a session to share configuration, and load external configuration.
sess := session.Must(session.NewSession())

// Create the service's client with the session.
svc := athena.New(sess)

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

See aws package's Config type for more information on configuration options. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

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

Once the client is created you can make an API request to the service. Each API method takes a input parameter, and returns the service response and an error.

The API method will document which error codes the service can be returned by the operation if the service models the API operation's errors. These errors will also be available as const strings prefixed with "ErrCode".

result, err := svc.BatchGetNamedQuery(params)
if err != nil {
    // Cast err to awserr.Error to handle specific error codes.
    aerr, ok := err.(awserr.Error)
    if ok && aerr.Code() == <error code to check for> {
        // Specific error code handling
    }
    return err
}

fmt.Println("BatchGetNamedQuery result:")
fmt.Println(result)

Using the Client with Context

The service's client also provides methods to make API requests with a Context value. This allows you to control the timeout, and cancellation of pending requests. These methods also take request Option as variadic parameter to apply additional configuration to the API request.

ctx := context.Background()

result, err := svc.BatchGetNamedQueryWithContext(ctx, params)

See the request package documentation for more information on using Context pattern with the SDK. https://docs.aws.amazon.com/sdk-for-go/api/aws/request/

Index

Examples

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 (

	// 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"

	// ErrCodeTooManyRequestsException for service response error code
	// "TooManyRequestsException".
	//
	// Indicates that the request was throttled.
	ErrCodeTooManyRequestsException = "TooManyRequestsException"
)
View Source
const (
	ServiceName = "athena"    // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

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

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. Use ListNamedQueries to get the list of named query IDs. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under UnprocessedNamedQueryId. Named queries are different from executed queries. Use BatchGetQueryExecution to get details about each unique query execution, and ListQueryExecutions 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.

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

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/athena"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := athena.New(sess)

	params := &athena.BatchGetNamedQueryInput{
		NamedQueryIds: []*string{ // Required
			aws.String("NamedQueryId"), // Required
			// More values...
		},
	}
	resp, err := svc.BatchGetNamedQuery(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

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 can be used to capture response data after the request's "Send" method is called.

See BatchGetNamedQuery for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the BatchGetNamedQuery method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see 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. To get a list of query execution IDs, use ListQueryExecutions. Query executions are different from named (saved) queries. Use BatchGetNamedQuery 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.

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

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/athena"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := athena.New(sess)

	params := &athena.BatchGetQueryExecutionInput{
		QueryExecutionIds: []*string{ // Required
			aws.String("QueryExecutionId"), // Required
			// More values...
		},
	}
	resp, err := svc.BatchGetQueryExecution(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

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 can be used to capture response data after the request's "Send" method is called.

See BatchGetQueryExecution for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the BatchGetQueryExecution method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see 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.

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.

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

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/athena"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := athena.New(sess)

	params := &athena.CreateNamedQueryInput{
		Database:           aws.String("DatabaseString"), // Required
		Name:               aws.String("NameString"),     // Required
		QueryString:        aws.String("QueryString"),    // Required
		ClientRequestToken: aws.String("IdempotencyToken"),
		Description:        aws.String("DescriptionString"),
	}
	resp, err := svc.CreateNamedQuery(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

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 can be used to capture response data after the request's "Send" method is called.

See CreateNamedQuery for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateNamedQuery method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see 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) DeleteNamedQuery

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

DeleteNamedQuery API operation for Amazon Athena.

Deletes a named query.

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.

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

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/athena"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := athena.New(sess)

	params := &athena.DeleteNamedQueryInput{
		NamedQueryId: aws.String("NamedQueryId"), // Required
	}
	resp, err := svc.DeleteNamedQuery(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

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 can be used to capture response data after the request's "Send" method is called.

See DeleteNamedQuery for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteNamedQuery method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see 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) GetNamedQuery

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

GetNamedQuery API operation for Amazon Athena.

Returns information about a single 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 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.

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

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/athena"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := athena.New(sess)

	params := &athena.GetNamedQueryInput{
		NamedQueryId: aws.String("NamedQueryId"), // Required
	}
	resp, err := svc.GetNamedQuery(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

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 can be used to capture response data after the request's "Send" method is called.

See GetNamedQuery for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetNamedQuery method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see 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. 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.

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

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/athena"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := athena.New(sess)

	params := &athena.GetQueryExecutionInput{
		QueryExecutionId: aws.String("QueryExecutionId"), // Required
	}
	resp, err := svc.GetQueryExecution(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

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 can be used to capture response data after the request's "Send" method is called.

See GetQueryExecution for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetQueryExecution method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see 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. 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.

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

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/athena"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := athena.New(sess)

	params := &athena.GetQueryResultsInput{
		QueryExecutionId: aws.String("QueryExecutionId"), // Required
		MaxResults:       aws.Int64(1),
		NextToken:        aws.String("Token"),
	}
	resp, err := svc.GetQueryResults(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

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 *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 can be used to capture response data after the request's "Send" method is called.

See GetQueryResults for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetQueryResults method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see 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) ListNamedQueries

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

ListNamedQueries API operation for Amazon Athena.

Provides a list of all available query IDs.

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.

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

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/athena"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := athena.New(sess)

	params := &athena.ListNamedQueriesInput{
		MaxResults: aws.Int64(1),
		NextToken:  aws.String("Token"),
	}
	resp, err := svc.ListNamedQueries(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

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 *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 can be used to capture response data after the request's "Send" method is called.

See ListNamedQueries for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListNamedQueries method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see 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 all available query execution IDs.

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.

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

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/athena"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := athena.New(sess)

	params := &athena.ListQueryExecutionsInput{
		MaxResults: aws.Int64(1),
		NextToken:  aws.String("Token"),
	}
	resp, err := svc.ListQueryExecutions(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

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 *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 can be used to capture response data after the request's "Send" method is called.

See ListQueryExecutions for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListQueryExecutions method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see 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) StartQueryExecution

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

StartQueryExecution API operation for Amazon Athena.

Runs (executes) the SQL query statements contained in the Query string.

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.

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

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/athena"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := athena.New(sess)

	params := &athena.StartQueryExecutionInput{
		QueryString: aws.String("QueryString"), // Required
		ResultConfiguration: &athena.ResultConfiguration{ // Required
			OutputLocation: aws.String("String"), // Required
			EncryptionConfiguration: &athena.EncryptionConfiguration{
				EncryptionOption: aws.String("EncryptionOption"), // Required
				KmsKey:           aws.String("String"),
			},
		},
		ClientRequestToken: aws.String("IdempotencyToken"),
		QueryExecutionContext: &athena.QueryExecutionContext{
			Database: aws.String("DatabaseString"),
		},
	}
	resp, err := svc.StartQueryExecution(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

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 can be used to capture response data after the request's "Send" method is called.

See StartQueryExecution for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the StartQueryExecution method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see 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.

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.

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

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/athena"
)

func main() {
	sess := session.Must(session.NewSession())

	svc := athena.New(sess)

	params := &athena.StopQueryExecutionInput{
		QueryExecutionId: aws.String("QueryExecutionId"), // Required
	}
	resp, err := svc.StopQueryExecution(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

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 can be used to capture response data after the request's "Send" method is called.

See StopQueryExecution for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the StopQueryExecution method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see 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.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/BatchGetNamedQueryInput

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/BatchGetNamedQueryOutput

func (BatchGetNamedQueryOutput) GoString

func (s BatchGetNamedQueryOutput) GoString() string

GoString returns the string representation

func (*BatchGetNamedQueryOutput) SetNamedQueries

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/BatchGetQueryExecutionInput

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/BatchGetQueryExecutionOutput

func (BatchGetQueryExecutionOutput) GoString

func (s BatchGetQueryExecutionOutput) GoString() string

GoString returns the string representation

func (*BatchGetQueryExecutionOutput) SetQueryExecutions

SetQueryExecutions sets the QueryExecutions field's value.

func (*BatchGetQueryExecutionOutput) SetUnprocessedQueryExecutionIds

SetUnprocessedQueryExecutionIds sets the UnprocessedQueryExecutionIds field's value.

func (BatchGetQueryExecutionOutput) 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ColumnInfo

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"`

	// A brief explanation of the query.
	Description *string `min:"1" type:"string"`

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

	// The text of the query itself. In other words, all query statements.
	//
	// QueryString is a required field
	QueryString *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreateNamedQueryInput

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

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

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) 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreateNamedQueryOutput

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 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). Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/Datum

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 is a required field
	NamedQueryId *string `type:"string" required:"true" idempotencyToken:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/DeleteNamedQueryInput

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

func (*DeleteNamedQueryInput) Validate

func (s *DeleteNamedQueryInput) Validate() error

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

type DeleteNamedQueryOutput

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/DeleteNamedQueryOutput

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 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.
	//
	// 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 Amazon S3 encryption option used. Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/EncryptionConfiguration

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetNamedQueryInput

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetNamedQueryOutput

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetQueryExecutionInput

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetQueryExecutionOutput

func (GetQueryExecutionOutput) GoString

func (s GetQueryExecutionOutput) GoString() string

GoString returns the string representation

func (*GetQueryExecutionOutput) SetQueryExecution

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 `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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetQueryResultsInput

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 `type:"string"`

	// The results of the query execution.
	ResultSet *ResultSet `type:"structure"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetQueryResultsOutput

func (GetQueryResultsOutput) GoString

func (s GetQueryResultsOutput) GoString() string

GoString returns the string representation

func (*GetQueryResultsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*GetQueryResultsOutput) SetResultSet

SetResultSet sets the ResultSet field's value.

func (GetQueryResultsOutput) String

func (s GetQueryResultsOutput) 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 `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListNamedQueriesInput

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

SetNextToken sets the NextToken field's value.

func (ListNamedQueriesInput) String

func (s ListNamedQueriesInput) String() string

String returns the string representation

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 `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListNamedQueriesOutput

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

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 `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListQueryExecutionsInput

func (ListQueryExecutionsInput) GoString

func (s ListQueryExecutionsInput) GoString() string

GoString returns the string representation

func (*ListQueryExecutionsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListQueryExecutionsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListQueryExecutionsInput) String

func (s ListQueryExecutionsInput) String() string

String returns the string representation

type ListQueryExecutionsOutput

type ListQueryExecutionsOutput struct {

	// A token to be used by the next request if this request is truncated.
	NextToken *string `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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListQueryExecutionsOutput

func (ListQueryExecutionsOutput) GoString

func (s ListQueryExecutionsOutput) GoString() string

GoString returns the string representation

func (*ListQueryExecutionsOutput) SetNextToken

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 NamedQuery

type NamedQuery struct {

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

	// A brief description of the query.
	Description *string `min:"1" type:"string"`

	// The plain-language name of the query.
	//
	// 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"`
	// contains filtered or unexported fields
}

A query, where QueryString is the SQL query statements that comprise the query. Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/NamedQuery

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

	// The amount of data scanned during the query execution and the amount of time
	// that it took to execute.
	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"`
	// contains filtered or unexported fields
}

Information about a single instance of a query execution. Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/QueryExecution

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) SetStatistics

SetStatistics sets the Statistics field's value.

func (*QueryExecution) SetStatus

SetStatus sets the Status 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/QueryExecutionContext

func (QueryExecutionContext) GoString

func (s QueryExecutionContext) GoString() string

GoString returns the string representation

func (*QueryExecutionContext) SetDatabase

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/QueryExecutionStatistics

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" timestampFormat:"unix"`

	// The state of query execution. SUBMITTED indicates that the query is queued
	// for execution. RUNNING indicates that the query is scanning data and returning
	// results. SUCCEEDED indicates that the query completed without error. FAILED
	// indicates that the query experienced an error and did not complete processing.
	// CANCELLED indicates that 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" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

The completion date, current state, submission time, and state change reason (if applicable) for the query execution. Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/QueryExecutionStatus

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

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 S3, indicates the S3 encryption option
	// used (for example, SSE-KMS or CSE-KMS and key information.
	EncryptionConfiguration *EncryptionConfiguration `type:"structure"`

	// The location in S3 where query results are stored.
	//
	// OutputLocation is a required field
	OutputLocation *string `type:"string" required:"true"`
	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ResultConfiguration

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 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ResultSet

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 in a query execution result.
	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. Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ResultSetMetadata

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/Row

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.
	//
	// ResultConfiguration is a required field
	ResultConfiguration *ResultConfiguration `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StartQueryExecutionInput

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

SetQueryExecutionContext sets the QueryExecutionContext field's value.

func (*StartQueryExecutionInput) SetQueryString

SetQueryString sets the QueryString field's value.

func (*StartQueryExecutionInput) SetResultConfiguration

SetResultConfiguration sets the ResultConfiguration 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StartQueryExecutionOutput

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 is a required field
	QueryExecutionId *string `type:"string" required:"true" idempotencyToken:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StopQueryExecutionInput

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

func (*StopQueryExecutionInput) Validate

func (s *StopQueryExecutionInput) Validate() error

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

type StopQueryExecutionOutput

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StopQueryExecutionOutput

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 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UnprocessedNamedQueryId

func (UnprocessedNamedQueryId) GoString

func (s UnprocessedNamedQueryId) GoString() string

GoString returns the string representation

func (*UnprocessedNamedQueryId) SetErrorCode

SetErrorCode sets the ErrorCode field's value.

func (*UnprocessedNamedQueryId) SetErrorMessage

SetErrorMessage sets the ErrorMessage field's value.

func (*UnprocessedNamedQueryId) SetNamedQueryId

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UnprocessedQueryExecutionId

func (UnprocessedQueryExecutionId) GoString

func (s UnprocessedQueryExecutionId) GoString() string

GoString returns the string representation

func (*UnprocessedQueryExecutionId) SetErrorCode

SetErrorCode sets the ErrorCode field's value.

func (*UnprocessedQueryExecutionId) SetErrorMessage

SetErrorMessage sets the ErrorMessage field's value.

func (*UnprocessedQueryExecutionId) SetQueryExecutionId

SetQueryExecutionId sets the QueryExecutionId field's value.

func (UnprocessedQueryExecutionId) String

String returns the string representation

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