athena

package
v0.1.0 Latest Latest
Warning

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

 Go to latest Published: Dec 21, 2017 License: Apache-2.0, Apache-2.0 Imports: 5 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 Amazon Athena with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

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

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

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

Index

Constants

View Source 
const (

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

Variables

This section is empty.

Functions

This section is empty.

Types

type Athena 

type Athena struct {
	*aws.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(config aws.Config) *Athena

New creates a new instance of the Athena client with a config. 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 config.
svc := athena.New(myConfig)

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

func (*Athena) BatchGetNamedQueryRequest 

func (c *Athena) BatchGetNamedQueryRequest(input *BatchGetNamedQueryInput) BatchGetNamedQueryRequest

BatchGetNamedQueryRequest returns a request value for making 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. 

// Example sending a request using the BatchGetNamedQueryRequest method.
req := client.BatchGetNamedQueryRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*Athena) BatchGetQueryExecutionRequest 

func (c *Athena) BatchGetQueryExecutionRequest(input *BatchGetQueryExecutionInput) BatchGetQueryExecutionRequest

BatchGetQueryExecutionRequest returns a request value for making 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. 

// Example sending a request using the BatchGetQueryExecutionRequest method.
req := client.BatchGetQueryExecutionRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*Athena) CreateNamedQueryRequest 

func (c *Athena) CreateNamedQueryRequest(input *CreateNamedQueryInput) CreateNamedQueryRequest

CreateNamedQueryRequest returns a request value for making 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. 

// Example sending a request using the CreateNamedQueryRequest method.
req := client.CreateNamedQueryRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*Athena) DeleteNamedQueryRequest 

func (c *Athena) DeleteNamedQueryRequest(input *DeleteNamedQueryInput) DeleteNamedQueryRequest

DeleteNamedQueryRequest returns a request value for making 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. 

// Example sending a request using the DeleteNamedQueryRequest method.
req := client.DeleteNamedQueryRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*Athena) GetNamedQueryRequest 

func (c *Athena) GetNamedQueryRequest(input *GetNamedQueryInput) GetNamedQueryRequest

GetNamedQueryRequest returns a request value for making API operation for Amazon Athena.

Returns information about a single query. 

// Example sending a request using the GetNamedQueryRequest method.
req := client.GetNamedQueryRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*Athena) GetQueryExecutionRequest 

func (c *Athena) GetQueryExecutionRequest(input *GetQueryExecutionInput) GetQueryExecutionRequest

GetQueryExecutionRequest returns a request value for making 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. 

// Example sending a request using the GetQueryExecutionRequest method.
req := client.GetQueryExecutionRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

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 ...aws.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) GetQueryResultsRequest

GetQueryResultsRequest returns a request value for making 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. 

// Example sending a request using the GetQueryResultsRequest method.
req := client.GetQueryResultsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

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 ...aws.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) ListNamedQueriesRequest

ListNamedQueriesRequest returns a request value for making 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. 

// Example sending a request using the ListNamedQueriesRequest method.
req := client.ListNamedQueriesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

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 ...aws.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) ListQueryExecutionsRequest

ListQueryExecutionsRequest returns a request value for making 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. 

// Example sending a request using the ListQueryExecutionsRequest method.
req := client.ListQueryExecutionsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*Athena) StartQueryExecutionRequest 

func (c *Athena) StartQueryExecutionRequest(input *StartQueryExecutionInput) StartQueryExecutionRequest

StartQueryExecutionRequest returns a request value for making 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. 

// Example sending a request using the StartQueryExecutionRequest method.
req := client.StartQueryExecutionRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*Athena) StopQueryExecutionRequest 

func (c *Athena) StopQueryExecutionRequest(input *StopQueryExecutionInput) StopQueryExecutionRequest

StopQueryExecutionRequest returns a request value for making 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. 

// Example sending a request using the StopQueryExecutionRequest method.
req := client.StopQueryExecutionRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

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

func (s BatchGetNamedQueryOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*BatchGetNamedQueryOutput) SetNamedQueries 

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

SetNamedQueries sets the NamedQueries field's value.

func (*BatchGetNamedQueryOutput) SetUnprocessedNamedQueryIds 

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

SetUnprocessedNamedQueryIds sets the UnprocessedNamedQueryIds field's value.

func (BatchGetNamedQueryOutput) String 

func (s BatchGetNamedQueryOutput) String() string

String returns the string representation

type BatchGetNamedQueryRequest 

type BatchGetNamedQueryRequest struct {
	*aws.Request
	Input *BatchGetNamedQueryInput
}

BatchGetNamedQueryRequest is a API request type for the BatchGetNamedQuery API operation.

func (BatchGetNamedQueryRequest) Send 

func (r BatchGetNamedQueryRequest) Send() (*BatchGetNamedQueryOutput, error)

Send marshals and sends the BatchGetNamedQuery API request.

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 

func (s BatchGetQueryExecutionInput) String() string

String returns the string representation

func (*BatchGetQueryExecutionInput) Validate 

func (s *BatchGetQueryExecutionInput) Validate() error

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

type BatchGetQueryExecutionOutput 

type BatchGetQueryExecutionOutput struct {

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

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

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

func (s BatchGetQueryExecutionOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*BatchGetQueryExecutionOutput) SetQueryExecutions 

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

SetQueryExecutions sets the QueryExecutions field's value.

func (*BatchGetQueryExecutionOutput) SetUnprocessedQueryExecutionIds 

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

SetUnprocessedQueryExecutionIds sets the UnprocessedQueryExecutionIds field's value.

func (BatchGetQueryExecutionOutput) String 

func (s BatchGetQueryExecutionOutput) String() string

String returns the string representation

type BatchGetQueryExecutionRequest 

type BatchGetQueryExecutionRequest struct {
	*aws.Request
	Input *BatchGetQueryExecutionInput
}

BatchGetQueryExecutionRequest is a API request type for the BatchGetQueryExecution API operation.

func (BatchGetQueryExecutionRequest) Send 

func (r BatchGetQueryExecutionRequest) Send() (*BatchGetQueryExecutionOutput, error)

Send marshals and sends the BatchGetQueryExecution API request.

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

	// 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 ColumnNullable) *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 ColumnNullable 

type ColumnNullable string
const (
	ColumnNullableNotNull  ColumnNullable = "NOT_NULL"
	ColumnNullableNullable ColumnNullable = "NULLABLE"
	ColumnNullableUnknown  ColumnNullable = "UNKNOWN"
)

Enum values for ColumnNullable

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 

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

SetDatabase sets the Database field's value.

func (*CreateNamedQueryInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*CreateNamedQueryInput) SetName 

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

SetName sets the Name field's value.

func (*CreateNamedQueryInput) SetQueryString 

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

SetQueryString sets the QueryString field's value.

func (CreateNamedQueryInput) 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) SDKResponseMetadata 

func (s CreateNamedQueryOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

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 CreateNamedQueryRequest 

type CreateNamedQueryRequest struct {
	*aws.Request
	Input *CreateNamedQueryInput
}

CreateNamedQueryRequest is a API request type for the CreateNamedQuery API operation.

func (CreateNamedQueryRequest) Send 

func (r CreateNamedQueryRequest) Send() (*CreateNamedQueryOutput, error)

Send marshals and sends the CreateNamedQuery API request.

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

func (s DeleteNamedQueryOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteNamedQueryOutput) String 

func (s DeleteNamedQueryOutput) String() string

String returns the string representation

type DeleteNamedQueryRequest 

type DeleteNamedQueryRequest struct {
	*aws.Request
	Input *DeleteNamedQueryInput
}

DeleteNamedQueryRequest is a API request type for the DeleteNamedQuery API operation.

func (DeleteNamedQueryRequest) Send 

func (r DeleteNamedQueryRequest) Send() (*DeleteNamedQueryOutput, error)

Send marshals and sends the DeleteNamedQuery API request.

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 EncryptionOption `type:"string" required:"true" enum:"true"`

	// 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 EncryptionOption) *EncryptionConfiguration

SetEncryptionOption sets the EncryptionOption field's value.

func (*EncryptionConfiguration) SetKmsKey 

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

SetKmsKey sets the KmsKey field's value.

func (EncryptionConfiguration) String 

func (s EncryptionConfiguration) String() string

String returns the string representation

func (*EncryptionConfiguration) Validate 

func (s *EncryptionConfiguration) Validate() error

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

type EncryptionOption 

type EncryptionOption string
const (
	EncryptionOptionSseS3  EncryptionOption = "SSE_S3"
	EncryptionOptionSseKms EncryptionOption = "SSE_KMS"
	EncryptionOptionCseKms EncryptionOption = "CSE_KMS"
)

Enum values for EncryptionOption

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

func (s GetNamedQueryOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

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 GetNamedQueryRequest 

type GetNamedQueryRequest struct {
	*aws.Request
	Input *GetNamedQueryInput
}

GetNamedQueryRequest is a API request type for the GetNamedQuery API operation.

func (GetNamedQueryRequest) Send 

func (r GetNamedQueryRequest) Send() (*GetNamedQueryOutput, error)

Send marshals and sends the GetNamedQuery API request.

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

func (s GetQueryExecutionOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetQueryExecutionOutput) SetQueryExecution 

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

SetQueryExecution sets the QueryExecution field's value.

func (GetQueryExecutionOutput) String 

func (s GetQueryExecutionOutput) String() string

String returns the string representation

type GetQueryExecutionRequest 

type GetQueryExecutionRequest struct {
	*aws.Request
	Input *GetQueryExecutionInput
}

GetQueryExecutionRequest is a API request type for the GetQueryExecution API operation.

func (GetQueryExecutionRequest) Send 

func (r GetQueryExecutionRequest) Send() (*GetQueryExecutionOutput, error)

Send marshals and sends the GetQueryExecution API request.

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

func (s GetQueryResultsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*GetQueryResultsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*GetQueryResultsOutput) SetResultSet 

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

SetResultSet sets the ResultSet field's value.

func (GetQueryResultsOutput) String 

func (s GetQueryResultsOutput) String() string

String returns the string representation

type GetQueryResultsRequest 

type GetQueryResultsRequest struct {
	*aws.Request
	Input *GetQueryResultsInput
}

GetQueryResultsRequest is a API request type for the GetQueryResults API operation.

func (GetQueryResultsRequest) Send 

func (r GetQueryResultsRequest) Send() (*GetQueryResultsOutput, error)

Send marshals and sends the GetQueryResults API request.

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 

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

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

func (s ListNamedQueriesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*ListNamedQueriesOutput) SetNamedQueryIds 

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

SetNamedQueryIds sets the NamedQueryIds field's value.

func (*ListNamedQueriesOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListNamedQueriesOutput) String 

func (s ListNamedQueriesOutput) String() string

String returns the string representation

type ListNamedQueriesRequest 

type ListNamedQueriesRequest struct {
	*aws.Request
	Input *ListNamedQueriesInput
}

ListNamedQueriesRequest is a API request type for the ListNamedQueries API operation.

func (ListNamedQueriesRequest) Send 

func (r ListNamedQueriesRequest) Send() (*ListNamedQueriesOutput, error)

Send marshals and sends the ListNamedQueries API request.

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 

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

SetMaxResults sets the MaxResults field's value.

func (*ListQueryExecutionsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListQueryExecutionsInput) 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) SDKResponseMetadata 

func (s ListQueryExecutionsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*ListQueryExecutionsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListQueryExecutionsOutput) SetQueryExecutionIds 

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

SetQueryExecutionIds sets the QueryExecutionIds field's value.

func (ListQueryExecutionsOutput) String 

func (s ListQueryExecutionsOutput) String() string

String returns the string representation

type ListQueryExecutionsRequest 

type ListQueryExecutionsRequest struct {
	*aws.Request
	Input *ListQueryExecutionsInput
}

ListQueryExecutionsRequest is a API request type for the ListQueryExecutions API operation.

func (ListQueryExecutionsRequest) Send 

func (r ListQueryExecutionsRequest) Send() (*ListQueryExecutionsOutput, error)

Send marshals and sends the ListQueryExecutions API request.

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 

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

SetStatistics sets the Statistics field's value.

func (*QueryExecution) SetStatus 

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

SetStatus sets the Status field's value.

func (QueryExecution) 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 

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

SetDatabase sets the Database field's value.

func (QueryExecutionContext) String 

func (s QueryExecutionContext) String() string

String returns the string representation

func (*QueryExecutionContext) Validate 

func (s *QueryExecutionContext) Validate() error

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

type QueryExecutionState 

type QueryExecutionState string
const (
	QueryExecutionStateQueued    QueryExecutionState = "QUEUED"
	QueryExecutionStateRunning   QueryExecutionState = "RUNNING"
	QueryExecutionStateSucceeded QueryExecutionState = "SUCCEEDED"
	QueryExecutionStateFailed    QueryExecutionState = "FAILED"
	QueryExecutionStateCancelled QueryExecutionState = "CANCELLED"
)

Enum values for QueryExecutionState

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

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

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

SetState sets the State field's value.

func (*QueryExecutionStatus) SetStateChangeReason 

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

SetStateChangeReason sets the StateChangeReason field's value.

func (*QueryExecutionStatus) SetSubmissionDateTime 

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

SetSubmissionDateTime sets the SubmissionDateTime field's value.

func (QueryExecutionStatus) String 

func (s QueryExecutionStatus) String() string

String returns the string representation

type ResultConfiguration 

type ResultConfiguration struct {

	// If query results are encrypted in 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 

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

SetQueryExecutionContext sets the QueryExecutionContext field's value.

func (*StartQueryExecutionInput) SetQueryString 

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

SetQueryString sets the QueryString field's value.

func (*StartQueryExecutionInput) SetResultConfiguration 

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

SetResultConfiguration sets the ResultConfiguration field's value.

func (StartQueryExecutionInput) 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) SDKResponseMetadata 

func (s StartQueryExecutionOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

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 StartQueryExecutionRequest 

type StartQueryExecutionRequest struct {
	*aws.Request
	Input *StartQueryExecutionInput
}

StartQueryExecutionRequest is a API request type for the StartQueryExecution API operation.

func (StartQueryExecutionRequest) Send 

func (r StartQueryExecutionRequest) Send() (*StartQueryExecutionOutput, error)

Send marshals and sends the StartQueryExecution API request.

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

func (s StopQueryExecutionOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (StopQueryExecutionOutput) String 

func (s StopQueryExecutionOutput) String() string

String returns the string representation

type StopQueryExecutionRequest 

type StopQueryExecutionRequest struct {
	*aws.Request
	Input *StopQueryExecutionInput
}

StopQueryExecutionRequest is a API request type for the StopQueryExecution API operation.

func (StopQueryExecutionRequest) Send 

func (r StopQueryExecutionRequest) Send() (*StopQueryExecutionOutput, error)

Send marshals and sends the StopQueryExecution API request.

type ThrottleReason 

type ThrottleReason string
const (
	ThrottleReasonConcurrentQueryLimitExceeded ThrottleReason = "CONCURRENT_QUERY_LIMIT_EXCEEDED"
)

Enum values for ThrottleReason

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 

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

SetErrorCode sets the ErrorCode field's value.

func (*UnprocessedNamedQueryId) SetErrorMessage 

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

SetErrorMessage sets the ErrorMessage field's value.

func (*UnprocessedNamedQueryId) SetNamedQueryId 

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

SetNamedQueryId sets the NamedQueryId field's value.

func (UnprocessedNamedQueryId) String 

func (s UnprocessedNamedQueryId) String() string

String returns the string representation

type UnprocessedQueryExecutionId 

type UnprocessedQueryExecutionId struct {

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

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

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

Describes a query execution that failed to process. 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 

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

SetErrorCode sets the ErrorCode field's value.

func (*UnprocessedQueryExecutionId) SetErrorMessage 

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

SetErrorMessage sets the ErrorMessage field's value.

func (*UnprocessedQueryExecutionId) SetQueryExecutionId 

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

SetQueryExecutionId sets the QueryExecutionId field's value.

func (UnprocessedQueryExecutionId) String 

func (s UnprocessedQueryExecutionId) String() string

String returns the string representation

Source Files

View all Source files

Directories

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

Jump to

Keyboard shortcuts

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