athena

package
v1.37.5 Latest Latest
Warning

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

 Go to latest Published: Feb 4, 2021 License: Apache-2.0 Imports: 10 Imported by: 178

Documentation

Overview

Package athena provides the client and types for making API requests to Amazon Athena.

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

If you connect to Athena using the JDBC driver, use version 1.1.0 of the driver or later with the Amazon Athena API. Earlier version drivers do not support the API. For more information and to download the driver, see Accessing Amazon Athena with JDBC (https://docs.aws.amazon.com/athena/latest/ug/connect-with-jdbc.html).

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

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

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

Using the Client

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

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

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

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

Index

Constants

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

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

	// ColumnNullableUnknown is a ColumnNullable enum value
	ColumnNullableUnknown = "UNKNOWN"
)
View Source 
const (
	// DataCatalogTypeLambda is a DataCatalogType enum value
	DataCatalogTypeLambda = "LAMBDA"

	// DataCatalogTypeGlue is a DataCatalogType enum value
	DataCatalogTypeGlue = "GLUE"

	// DataCatalogTypeHive is a DataCatalogType enum value
	DataCatalogTypeHive = "HIVE"
)
View Source 
const (
	// EncryptionOptionSseS3 is a EncryptionOption enum value
	EncryptionOptionSseS3 = "SSE_S3"

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

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

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

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

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

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

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

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

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

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

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

	// ErrCodeMetadataException for service response error code
	// "MetadataException".
	//
	// An exception that Athena received when it called a custom metastore. Occurs
	// if the error is not caused by user input (InvalidRequestException) or from
	// the Athena platform (InternalServerException). For example, if a user-created
	// Lambda function is missing permissions, the Lambda 4XX exception is returned
	// in a MetadataException.
	ErrCodeMetadataException = "MetadataException"

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

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

Service information constants

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

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

Variables

This section is empty.

Functions

func ColumnNullable_Values added in v1.34.3 

func ColumnNullable_Values() []string

ColumnNullable_Values returns all elements of the ColumnNullable enum

func DataCatalogType_Values added in v1.34.3 

func DataCatalogType_Values() []string

DataCatalogType_Values returns all elements of the DataCatalogType enum

func EncryptionOption_Values added in v1.34.3 

func EncryptionOption_Values() []string

EncryptionOption_Values returns all elements of the EncryptionOption enum

func QueryExecutionState_Values added in v1.34.3 

func QueryExecutionState_Values() []string

QueryExecutionState_Values returns all elements of the QueryExecutionState enum

func StatementType_Values added in v1.34.3 

func StatementType_Values() []string

StatementType_Values returns all elements of the StatementType enum

func ThrottleReason_Values added in v1.34.3 

func ThrottleReason_Values() []string

ThrottleReason_Values returns all elements of the ThrottleReason enum

func WorkGroupState_Values added in v1.34.3 

func WorkGroupState_Values() []string

WorkGroupState_Values returns all elements of the WorkGroupState enum

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: 

mySession := session.Must(session.NewSession())

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

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

func (*Athena) BatchGetNamedQuery 

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

BatchGetNamedQuery API operation for Amazon Athena.

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

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

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

Returned Error Types:

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

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

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

func (*Athena) BatchGetNamedQueryRequest 

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

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

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

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

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

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

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

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

func (*Athena) BatchGetNamedQueryWithContext 

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

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

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

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

func (*Athena) BatchGetQueryExecution 

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

BatchGetQueryExecution API operation for Amazon Athena.

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

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

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

Returned Error Types:

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

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

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

func (*Athena) BatchGetQueryExecutionRequest 

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

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

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

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

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

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

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

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

func (*Athena) BatchGetQueryExecutionWithContext 

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

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

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

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

func (*Athena) CreateDataCatalog added in v1.31.8 

func (c *Athena) CreateDataCatalog(input *CreateDataCatalogInput) (*CreateDataCatalogOutput, error)

CreateDataCatalog API operation for Amazon Athena.

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

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

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

Returned Error Types:

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

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

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

func (*Athena) CreateDataCatalogRequest added in v1.31.8 

func (c *Athena) CreateDataCatalogRequest(input *CreateDataCatalogInput) (req *request.Request, output *CreateDataCatalogOutput)

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

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

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

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

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

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

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

func (*Athena) CreateDataCatalogWithContext added in v1.31.8 

func (c *Athena) CreateDataCatalogWithContext(ctx aws.Context, input *CreateDataCatalogInput, opts ...request.Option) (*CreateDataCatalogOutput, error)

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

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

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

func (*Athena) CreateNamedQuery 

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

CreateNamedQuery API operation for Amazon Athena.

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

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

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

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

Returned Error Types:

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

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

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

func (*Athena) CreateNamedQueryRequest 

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

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

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

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

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

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

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

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

func (*Athena) CreateNamedQueryWithContext 

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

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

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

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

func (*Athena) CreateWorkGroup added in v1.17.0 

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

CreateWorkGroup API operation for Amazon Athena.

Creates a workgroup with the specified name.

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

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

Returned Error Types:

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

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

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

func (*Athena) CreateWorkGroupRequest added in v1.17.0 

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

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

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

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

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

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

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

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

func (*Athena) CreateWorkGroupWithContext added in v1.17.0 

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

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

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

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

func (*Athena) DeleteDataCatalog added in v1.31.8 

func (c *Athena) DeleteDataCatalog(input *DeleteDataCatalogInput) (*DeleteDataCatalogOutput, error)

DeleteDataCatalog API operation for Amazon Athena.

Deletes a data catalog.

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 DeleteDataCatalog for usage and error information.

Returned Error Types:

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

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

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

func (*Athena) DeleteDataCatalogRequest added in v1.31.8 

func (c *Athena) DeleteDataCatalogRequest(input *DeleteDataCatalogInput) (req *request.Request, output *DeleteDataCatalogOutput)

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

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

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

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

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

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

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

func (*Athena) DeleteDataCatalogWithContext added in v1.31.8 

func (c *Athena) DeleteDataCatalogWithContext(ctx aws.Context, input *DeleteDataCatalogInput, opts ...request.Option) (*DeleteDataCatalogOutput, error)

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

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

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

func (*Athena) DeleteNamedQuery 

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

DeleteNamedQuery API operation for Amazon Athena.

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

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

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

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

Returned Error Types:

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

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

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

func (*Athena) DeleteNamedQueryRequest 

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

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

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

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

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

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

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

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

func (*Athena) DeleteNamedQueryWithContext 

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

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

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

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

func (*Athena) DeleteWorkGroup added in v1.17.0 

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

DeleteWorkGroup API operation for Amazon Athena.

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

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

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

Returned Error Types:

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

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

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

func (*Athena) DeleteWorkGroupRequest added in v1.17.0 

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

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

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

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

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

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

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

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

func (*Athena) DeleteWorkGroupWithContext added in v1.17.0 

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

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

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

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

func (*Athena) GetDataCatalog added in v1.31.8 

func (c *Athena) GetDataCatalog(input *GetDataCatalogInput) (*GetDataCatalogOutput, error)

GetDataCatalog API operation for Amazon Athena.

Returns the specified data catalog.

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 GetDataCatalog for usage and error information.

Returned Error Types:

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

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

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

func (*Athena) GetDataCatalogRequest added in v1.31.8 

func (c *Athena) GetDataCatalogRequest(input *GetDataCatalogInput) (req *request.Request, output *GetDataCatalogOutput)

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

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

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

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

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

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

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

func (*Athena) GetDataCatalogWithContext added in v1.31.8 

func (c *Athena) GetDataCatalogWithContext(ctx aws.Context, input *GetDataCatalogInput, opts ...request.Option) (*GetDataCatalogOutput, error)

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

See GetDataCatalog 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) GetDatabase added in v1.31.8 

func (c *Athena) GetDatabase(input *GetDatabaseInput) (*GetDatabaseOutput, error)

GetDatabase API operation for Amazon Athena.

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

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 GetDatabase for usage and error information.

Returned Error Types:

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

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

  • MetadataException An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform (InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.

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

func (*Athena) GetDatabaseRequest added in v1.31.8 

func (c *Athena) GetDatabaseRequest(input *GetDatabaseInput) (req *request.Request, output *GetDatabaseOutput)

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

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

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

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

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

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

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

func (*Athena) GetDatabaseWithContext added in v1.31.8 

func (c *Athena) GetDatabaseWithContext(ctx aws.Context, input *GetDatabaseInput, opts ...request.Option) (*GetDatabaseOutput, error)

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

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

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

func (*Athena) GetNamedQuery 

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

GetNamedQuery API operation for Amazon Athena.

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

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

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

Returned Error Types:

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

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

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

func (*Athena) GetNamedQueryRequest 

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

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

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

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

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

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

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

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

func (*Athena) GetNamedQueryWithContext 

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

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

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

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

func (*Athena) GetQueryExecution 

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

GetQueryExecution API operation for Amazon Athena.

Returns information about a single execution of a query if you have access to the workgroup in which the query ran. Each time a query executes, information about the query execution is saved with a unique ID.

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

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

Returned Error Types:

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

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

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

func (*Athena) GetQueryExecutionRequest 

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

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

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

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

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

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

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

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

func (*Athena) GetQueryExecutionWithContext 

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

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

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

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

func (*Athena) GetQueryResults 

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

GetQueryResults API operation for Amazon Athena.

Streams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3. For more information, see Query Results (https://docs.aws.amazon.com/athena/latest/ug/querying.html) in the Amazon Athena User Guide. This request does not execute the query but returns results. Use StartQueryExecution to run a query.

To stream query results successfully, the IAM principal with permission to call GetQueryResults also must have permissions to the Amazon S3 GetObject action for the Athena query results location.

IAM principals with permission to the Amazon S3 GetObject action for the query results location are able to retrieve query results from Amazon S3 even if permission to the GetQueryResults action is denied. To restrict user or role access, ensure that Amazon S3 permissions to the Athena query location are denied.

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 Types:

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

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

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

func (*Athena) GetQueryResultsPages 

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

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

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

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

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

func (*Athena) GetQueryResultsPagesWithContext 

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

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

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

func (*Athena) GetQueryResultsRequest 

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

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

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

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

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

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

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

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

func (*Athena) GetQueryResultsWithContext 

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

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

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

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

func (*Athena) GetTableMetadata added in v1.31.8 

func (c *Athena) GetTableMetadata(input *GetTableMetadataInput) (*GetTableMetadataOutput, error)

GetTableMetadata API operation for Amazon Athena.

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

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 GetTableMetadata for usage and error information.

Returned Error Types:

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

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

  • MetadataException An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform (InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.

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

func (*Athena) GetTableMetadataRequest added in v1.31.8 

func (c *Athena) GetTableMetadataRequest(input *GetTableMetadataInput) (req *request.Request, output *GetTableMetadataOutput)

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

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

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

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

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

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

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

func (*Athena) GetTableMetadataWithContext added in v1.31.8 

func (c *Athena) GetTableMetadataWithContext(ctx aws.Context, input *GetTableMetadataInput, opts ...request.Option) (*GetTableMetadataOutput, error)

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

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

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

func (*Athena) GetWorkGroup added in v1.17.0 

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

GetWorkGroup API operation for Amazon Athena.

Returns information about the workgroup with the specified name.

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

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

Returned Error Types:

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

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

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

func (*Athena) GetWorkGroupRequest added in v1.17.0 

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

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

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

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

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

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

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

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

func (*Athena) GetWorkGroupWithContext added in v1.17.0 

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

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

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

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

func (*Athena) ListDataCatalogs added in v1.31.8 

func (c *Athena) ListDataCatalogs(input *ListDataCatalogsInput) (*ListDataCatalogsOutput, error)

ListDataCatalogs API operation for Amazon Athena.

Lists the data catalogs in the current AWS account.

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

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

Returned Error Types:

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

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

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

func (*Athena) ListDataCatalogsPages added in v1.31.8 

func (c *Athena) ListDataCatalogsPages(input *ListDataCatalogsInput, fn func(*ListDataCatalogsOutput, bool) bool) error

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

See ListDataCatalogs 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 ListDataCatalogs operation.
pageNum := 0
err := client.ListDataCatalogsPages(params,
    func(page *athena.ListDataCatalogsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Athena) ListDataCatalogsPagesWithContext added in v1.31.8 

func (c *Athena) ListDataCatalogsPagesWithContext(ctx aws.Context, input *ListDataCatalogsInput, fn func(*ListDataCatalogsOutput, bool) bool, opts ...request.Option) error

ListDataCatalogsPagesWithContext same as ListDataCatalogsPages 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) ListDataCatalogsRequest added in v1.31.8 

func (c *Athena) ListDataCatalogsRequest(input *ListDataCatalogsInput) (req *request.Request, output *ListDataCatalogsOutput)

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

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

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

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

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

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

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

func (*Athena) ListDataCatalogsWithContext added in v1.31.8 

func (c *Athena) ListDataCatalogsWithContext(ctx aws.Context, input *ListDataCatalogsInput, opts ...request.Option) (*ListDataCatalogsOutput, error)

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

See ListDataCatalogs 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) ListDatabases added in v1.31.8 

func (c *Athena) ListDatabases(input *ListDatabasesInput) (*ListDatabasesOutput, error)

ListDatabases API operation for Amazon Athena.

Lists the databases in the specified data catalog.

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 ListDatabases for usage and error information.

Returned Error Types:

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

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

  • MetadataException An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform (InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.

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

func (*Athena) ListDatabasesPages added in v1.31.8 

func (c *Athena) ListDatabasesPages(input *ListDatabasesInput, fn func(*ListDatabasesOutput, bool) bool) error

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

See ListDatabases 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 ListDatabases operation.
pageNum := 0
err := client.ListDatabasesPages(params,
    func(page *athena.ListDatabasesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Athena) ListDatabasesPagesWithContext added in v1.31.8 

func (c *Athena) ListDatabasesPagesWithContext(ctx aws.Context, input *ListDatabasesInput, fn func(*ListDatabasesOutput, bool) bool, opts ...request.Option) error

ListDatabasesPagesWithContext same as ListDatabasesPages 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) ListDatabasesRequest added in v1.31.8 

func (c *Athena) ListDatabasesRequest(input *ListDatabasesInput) (req *request.Request, output *ListDatabasesOutput)

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

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

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

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

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

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

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

func (*Athena) ListDatabasesWithContext added in v1.31.8 

func (c *Athena) ListDatabasesWithContext(ctx aws.Context, input *ListDatabasesInput, opts ...request.Option) (*ListDatabasesOutput, error)

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

See ListDatabases 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) ListEngineVersions added in v1.37.4 

func (c *Athena) ListEngineVersions(input *ListEngineVersionsInput) (*ListEngineVersionsOutput, error)

ListEngineVersions API operation for Amazon Athena.

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

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 ListEngineVersions for usage and error information.

Returned Error Types:

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

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

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

func (*Athena) ListEngineVersionsRequest added in v1.37.4 

func (c *Athena) ListEngineVersionsRequest(input *ListEngineVersionsInput) (req *request.Request, output *ListEngineVersionsOutput)

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

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

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

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

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

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

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

func (*Athena) ListEngineVersionsWithContext added in v1.37.4 

func (c *Athena) ListEngineVersionsWithContext(ctx aws.Context, input *ListEngineVersionsInput, opts ...request.Option) (*ListEngineVersionsOutput, error)

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

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

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

func (*Athena) ListNamedQueries 

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

ListNamedQueries API operation for Amazon Athena.

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

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

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

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

Returned Error Types:

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

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

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

func (*Athena) ListNamedQueriesPages 

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

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

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

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

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

func (*Athena) ListNamedQueriesPagesWithContext 

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

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

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

func (*Athena) ListNamedQueriesRequest 

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

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

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

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

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

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

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

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

func (*Athena) ListNamedQueriesWithContext 

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

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

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

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

func (*Athena) ListQueryExecutions 

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

ListQueryExecutions API operation for Amazon Athena.

Provides a list of available query execution IDs for the queries in the specified workgroup. If a workgroup is not specified, returns a list of query execution IDs for the primary workgroup. Requires you to have access to the workgroup in which the queries ran.

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 Types:

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

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

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

func (*Athena) ListQueryExecutionsPages 

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

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

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

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

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

func (*Athena) ListQueryExecutionsPagesWithContext 

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

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

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

func (*Athena) ListQueryExecutionsRequest 

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

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

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

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

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

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

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

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

func (*Athena) ListQueryExecutionsWithContext 

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

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

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

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

func (*Athena) ListTableMetadata added in v1.31.8 

func (c *Athena) ListTableMetadata(input *ListTableMetadataInput) (*ListTableMetadataOutput, error)

ListTableMetadata API operation for Amazon Athena.

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

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 ListTableMetadata for usage and error information.

Returned Error Types:

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

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

  • MetadataException An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform (InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.

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

func (*Athena) ListTableMetadataPages added in v1.31.8 

func (c *Athena) ListTableMetadataPages(input *ListTableMetadataInput, fn func(*ListTableMetadataOutput, bool) bool) error

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

See ListTableMetadata 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 ListTableMetadata operation.
pageNum := 0
err := client.ListTableMetadataPages(params,
    func(page *athena.ListTableMetadataOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Athena) ListTableMetadataPagesWithContext added in v1.31.8 

func (c *Athena) ListTableMetadataPagesWithContext(ctx aws.Context, input *ListTableMetadataInput, fn func(*ListTableMetadataOutput, bool) bool, opts ...request.Option) error

ListTableMetadataPagesWithContext same as ListTableMetadataPages 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) ListTableMetadataRequest added in v1.31.8 

func (c *Athena) ListTableMetadataRequest(input *ListTableMetadataInput) (req *request.Request, output *ListTableMetadataOutput)

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

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

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

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

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

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

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

func (*Athena) ListTableMetadataWithContext added in v1.31.8 

func (c *Athena) ListTableMetadataWithContext(ctx aws.Context, input *ListTableMetadataInput, opts ...request.Option) (*ListTableMetadataOutput, error)

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

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

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

func (*Athena) ListTagsForResource added in v1.17.4 

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

ListTagsForResource API operation for Amazon Athena.

Lists the tags associated with an Athena workgroup or data catalog resource.

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

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

Returned Error Types:

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

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

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

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

func (*Athena) ListTagsForResourcePages added in v1.31.8 

func (c *Athena) ListTagsForResourcePages(input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool) error

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

See ListTagsForResource 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 ListTagsForResource operation.
pageNum := 0
err := client.ListTagsForResourcePages(params,
    func(page *athena.ListTagsForResourceOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Athena) ListTagsForResourcePagesWithContext added in v1.31.8 

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

ListTagsForResourcePagesWithContext same as ListTagsForResourcePages 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) ListTagsForResourceRequest added in v1.17.4 

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

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

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

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

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

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

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

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

func (*Athena) ListTagsForResourceWithContext added in v1.17.4 

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

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

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

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

func (*Athena) ListWorkGroups added in v1.17.0 

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

ListWorkGroups API operation for Amazon Athena.

Lists available workgroups for the account.

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

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

Returned Error Types:

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

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

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

func (*Athena) ListWorkGroupsPages added in v1.17.0 

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

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

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

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

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

func (*Athena) ListWorkGroupsPagesWithContext added in v1.17.0 

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

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

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

func (*Athena) ListWorkGroupsRequest added in v1.17.0 

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

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

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

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

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

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

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

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

func (*Athena) ListWorkGroupsWithContext added in v1.17.0 

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

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

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

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

func (*Athena) StartQueryExecution 

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

StartQueryExecution API operation for Amazon Athena.

Runs the SQL query statements contained in the Query. Requires you to have access to the workgroup in which the query ran. Running queries against an external catalog requires GetDataCatalog permission to the catalog. 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 Types:

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

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

  • TooManyRequestsException Indicates that the request was throttled.

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

func (*Athena) StartQueryExecutionRequest 

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

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

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

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

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

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

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

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

func (*Athena) StartQueryExecutionWithContext 

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

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

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

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

func (*Athena) StopQueryExecution 

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

StopQueryExecution API operation for Amazon Athena.

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

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

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

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

Returned Error Types:

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

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

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

func (*Athena) StopQueryExecutionRequest 

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

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

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

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

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

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

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

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

func (*Athena) StopQueryExecutionWithContext 

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

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

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

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

func (*Athena) TagResource added in v1.17.4 

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

TagResource API operation for Amazon Athena.

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

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

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

Returned Error Types:

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

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

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

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

func (*Athena) TagResourceRequest added in v1.17.4 

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

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

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

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

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

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

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

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

func (*Athena) TagResourceWithContext added in v1.17.4 

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

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

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

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

func (*Athena) UntagResource added in v1.17.4 

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

UntagResource API operation for Amazon Athena.

Removes one or more tags from a data catalog or workgroup resource.

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

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

Returned Error Types:

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

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

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

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

func (*Athena) UntagResourceRequest added in v1.17.4 

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

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

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

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

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

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

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

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

func (*Athena) UntagResourceWithContext added in v1.17.4 

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

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

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

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

func (*Athena) UpdateDataCatalog added in v1.31.8 

func (c *Athena) UpdateDataCatalog(input *UpdateDataCatalogInput) (*UpdateDataCatalogOutput, error)

UpdateDataCatalog API operation for Amazon Athena.

Updates the data catalog that has the specified name.

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

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

Returned Error Types:

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

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

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

func (*Athena) UpdateDataCatalogRequest added in v1.31.8 

func (c *Athena) UpdateDataCatalogRequest(input *UpdateDataCatalogInput) (req *request.Request, output *UpdateDataCatalogOutput)

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

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

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

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

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

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

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

func (*Athena) UpdateDataCatalogWithContext added in v1.31.8 

func (c *Athena) UpdateDataCatalogWithContext(ctx aws.Context, input *UpdateDataCatalogInput, opts ...request.Option) (*UpdateDataCatalogOutput, error)

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

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

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

func (*Athena) UpdateWorkGroup added in v1.17.0 

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

UpdateWorkGroup API operation for Amazon Athena.

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

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

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

Returned Error Types:

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

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

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

func (*Athena) UpdateWorkGroupRequest added in v1.17.0 

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

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

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

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

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

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

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

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

func (*Athena) UpdateWorkGroupWithContext added in v1.17.0 

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

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

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

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

type BatchGetNamedQueryInput 

type BatchGetNamedQueryInput struct {

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

func (BatchGetNamedQueryInput) GoString 

func (s BatchGetNamedQueryInput) GoString() string

GoString returns the string representation

func (*BatchGetNamedQueryInput) SetNamedQueryIds 

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

SetNamedQueryIds sets the NamedQueryIds field's value.

func (BatchGetNamedQueryInput) String 

func (s BatchGetNamedQueryInput) String() string

String returns the string representation

func (*BatchGetNamedQueryInput) Validate 

func (s *BatchGetNamedQueryInput) Validate() error

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

type BatchGetNamedQueryOutput 

type BatchGetNamedQueryOutput struct {

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

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

func (BatchGetNamedQueryOutput) GoString 

func (s BatchGetNamedQueryOutput) GoString() string

GoString returns the string representation

func (*BatchGetNamedQueryOutput) SetNamedQueries 

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

SetNamedQueries sets the NamedQueries field's value.

func (*BatchGetNamedQueryOutput) SetUnprocessedNamedQueryIds 

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

SetUnprocessedNamedQueryIds sets the UnprocessedNamedQueryIds field's value.

func (BatchGetNamedQueryOutput) String 

func (s BatchGetNamedQueryOutput) String() string

String returns the string representation

type BatchGetQueryExecutionInput 

type BatchGetQueryExecutionInput struct {

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

func (BatchGetQueryExecutionInput) GoString 

func (s BatchGetQueryExecutionInput) GoString() string

GoString returns the string representation

func (*BatchGetQueryExecutionInput) SetQueryExecutionIds 

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

SetQueryExecutionIds sets the QueryExecutionIds field's value.

func (BatchGetQueryExecutionInput) String 

func (s BatchGetQueryExecutionInput) String() string

String returns the string representation

func (*BatchGetQueryExecutionInput) Validate 

func (s *BatchGetQueryExecutionInput) Validate() error

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

type BatchGetQueryExecutionOutput 

type BatchGetQueryExecutionOutput struct {

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

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

func (BatchGetQueryExecutionOutput) GoString 

func (s BatchGetQueryExecutionOutput) GoString() string

GoString returns the string representation

func (*BatchGetQueryExecutionOutput) SetQueryExecutions 

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

SetQueryExecutions sets the QueryExecutions field's value.

func (*BatchGetQueryExecutionOutput) SetUnprocessedQueryExecutionIds 

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

SetUnprocessedQueryExecutionIds sets the UnprocessedQueryExecutionIds field's value.

func (BatchGetQueryExecutionOutput) String 

func (s BatchGetQueryExecutionOutput) String() string

String returns the string representation

type Column added in v1.31.8 

type Column struct {

	// Optional information about the column.
	Comment *string `type:"string"`

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

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

Contains metadata for a column in a table.

func (Column) GoString added in v1.31.8 

func (s Column) GoString() string

GoString returns the string representation

func (*Column) SetComment added in v1.31.8 

func (s *Column) SetComment(v string) *Column

SetComment sets the Comment field's value.

func (*Column) SetName added in v1.31.8 

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

SetName sets the Name field's value.

func (*Column) SetType added in v1.31.8 

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

SetType sets the Type field's value.

func (Column) String added in v1.31.8 

func (s Column) String() string

String returns the string representation

type ColumnInfo 

type ColumnInfo struct {

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

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

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

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

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

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

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

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

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

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

Information about the columns in a query execution result.

func (ColumnInfo) GoString 

func (s ColumnInfo) GoString() string

GoString returns the string representation

func (*ColumnInfo) SetCaseSensitive 

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

SetCaseSensitive sets the CaseSensitive field's value.

func (*ColumnInfo) SetCatalogName 

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

SetCatalogName sets the CatalogName field's value.

func (*ColumnInfo) SetLabel 

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

SetLabel sets the Label field's value.

func (*ColumnInfo) SetName 

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

SetName sets the Name field's value.

func (*ColumnInfo) SetNullable 

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

SetNullable sets the Nullable field's value.

func (*ColumnInfo) SetPrecision 

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

SetPrecision sets the Precision field's value.

func (*ColumnInfo) SetScale 

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

SetScale sets the Scale field's value.

func (*ColumnInfo) SetSchemaName 

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

SetSchemaName sets the SchemaName field's value.

func (*ColumnInfo) SetTableName 

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

SetTableName sets the TableName field's value.

func (*ColumnInfo) SetType 

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

SetType sets the Type field's value.

func (ColumnInfo) String 

func (s ColumnInfo) String() string

String returns the string representation

type CreateDataCatalogInput added in v1.31.8 

type CreateDataCatalogInput struct {

	// A description of the data catalog to be created.
	Description *string `min:"1" type:"string"`

	// The name of the data catalog to create. The catalog name must be unique for
	// the AWS account and can use a maximum of 128 alphanumeric, underscore, at
	// sign, or hyphen characters.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

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

	// A list of comma separated tags to add to the data catalog that is created.
	Tags []*Tag `type:"list"`

	// The type of data catalog to create: LAMBDA for a federated catalog or HIVE
	// for an external hive metastore.
	//
	// Do not use the GLUE type. This refers to the AwsDataCatalog that already
	// exists in your account, of which you can have only one. Specifying the GLUE
	// type will result in an INVALID_INPUT error.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"DataCatalogType"`
	// contains filtered or unexported fields
}

func (CreateDataCatalogInput) GoString added in v1.31.8 

func (s CreateDataCatalogInput) GoString() string

GoString returns the string representation

func (*CreateDataCatalogInput) SetDescription added in v1.31.8 

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

SetDescription sets the Description field's value.

func (*CreateDataCatalogInput) SetName added in v1.31.8 

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

SetName sets the Name field's value.

func (*CreateDataCatalogInput) SetParameters added in v1.31.8 

func (s *CreateDataCatalogInput) SetParameters(v map[string]*string) *CreateDataCatalogInput

SetParameters sets the Parameters field's value.

func (*CreateDataCatalogInput) SetTags added in v1.31.8 

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

SetTags sets the Tags field's value.

func (*CreateDataCatalogInput) SetType added in v1.31.8 

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

SetType sets the Type field's value.

func (CreateDataCatalogInput) String added in v1.31.8 

func (s CreateDataCatalogInput) String() string

String returns the string representation

func (*CreateDataCatalogInput) Validate added in v1.31.8 

func (s *CreateDataCatalogInput) Validate() error

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

type CreateDataCatalogOutput added in v1.31.8 

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

func (CreateDataCatalogOutput) GoString added in v1.31.8 

func (s CreateDataCatalogOutput) GoString() string

GoString returns the string representation

func (CreateDataCatalogOutput) String added in v1.31.8 

func (s CreateDataCatalogOutput) String() string

String returns the string representation

type CreateNamedQueryInput 

type CreateNamedQueryInput struct {

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

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

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

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

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

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

func (CreateNamedQueryInput) GoString 

func (s CreateNamedQueryInput) GoString() string

GoString returns the string representation

func (*CreateNamedQueryInput) SetClientRequestToken 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateNamedQueryInput) SetDatabase 

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

SetDatabase sets the Database field's value.

func (*CreateNamedQueryInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*CreateNamedQueryInput) SetName 

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

SetName sets the Name field's value.

func (*CreateNamedQueryInput) SetQueryString 

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

SetQueryString sets the QueryString field's value.

func (*CreateNamedQueryInput) SetWorkGroup added in v1.17.0 

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

SetWorkGroup sets the WorkGroup field's value.

func (CreateNamedQueryInput) String 

func (s CreateNamedQueryInput) String() string

String returns the string representation

func (*CreateNamedQueryInput) Validate 

func (s *CreateNamedQueryInput) Validate() error

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

type CreateNamedQueryOutput 

type CreateNamedQueryOutput struct {

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

func (CreateNamedQueryOutput) GoString 

func (s CreateNamedQueryOutput) GoString() string

GoString returns the string representation

func (*CreateNamedQueryOutput) SetNamedQueryId 

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

SetNamedQueryId sets the NamedQueryId field's value.

func (CreateNamedQueryOutput) String 

func (s CreateNamedQueryOutput) String() string

String returns the string representation

type CreateWorkGroupInput added in v1.17.0 

type CreateWorkGroupInput struct {

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

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

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

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

func (CreateWorkGroupInput) GoString added in v1.17.0 

func (s CreateWorkGroupInput) GoString() string

GoString returns the string representation

func (*CreateWorkGroupInput) SetConfiguration added in v1.17.0 

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

SetConfiguration sets the Configuration field's value.

func (*CreateWorkGroupInput) SetDescription added in v1.17.0 

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

SetDescription sets the Description field's value.

func (*CreateWorkGroupInput) SetName added in v1.17.0 

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

SetName sets the Name field's value.

func (*CreateWorkGroupInput) SetTags added in v1.17.4 

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

SetTags sets the Tags field's value.

func (CreateWorkGroupInput) String added in v1.17.0 

func (s CreateWorkGroupInput) String() string

String returns the string representation

func (*CreateWorkGroupInput) Validate added in v1.17.0 

func (s *CreateWorkGroupInput) Validate() error

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

type CreateWorkGroupOutput added in v1.17.0 

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

func (CreateWorkGroupOutput) GoString added in v1.17.0 

func (s CreateWorkGroupOutput) GoString() string

GoString returns the string representation

func (CreateWorkGroupOutput) String added in v1.17.0 

func (s CreateWorkGroupOutput) String() string

String returns the string representation

type DataCatalog added in v1.31.8 

type DataCatalog struct {

	// An optional description of the data catalog.
	Description *string `min:"1" type:"string"`

	// The name of the data catalog. The catalog name must be unique for the AWS
	// account and can use a maximum of 128 alphanumeric, underscore, at sign, or
	// hyphen characters.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

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

	// The type of data catalog: LAMBDA for a federated catalog or HIVE for an external
	// hive metastore. GLUE refers to the AwsDataCatalog that already exists in
	// your account, of which you can have only one.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"DataCatalogType"`
	// contains filtered or unexported fields
}

Contains information about a data catalog in an AWS account.

func (DataCatalog) GoString added in v1.31.8 

func (s DataCatalog) GoString() string

GoString returns the string representation

func (*DataCatalog) SetDescription added in v1.31.8 

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

SetDescription sets the Description field's value.

func (*DataCatalog) SetName added in v1.31.8 

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

SetName sets the Name field's value.

func (*DataCatalog) SetParameters added in v1.31.8 

func (s *DataCatalog) SetParameters(v map[string]*string) *DataCatalog

SetParameters sets the Parameters field's value.

func (*DataCatalog) SetType added in v1.31.8 

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

SetType sets the Type field's value.

func (DataCatalog) String added in v1.31.8 

func (s DataCatalog) String() string

String returns the string representation

type DataCatalogSummary added in v1.31.8 

type DataCatalogSummary struct {

	// The name of the data catalog.
	CatalogName *string `min:"1" type:"string"`

	// The data catalog type.
	Type *string `type:"string" enum:"DataCatalogType"`
	// contains filtered or unexported fields
}

The summary information for the data catalog, which includes its name and type.

func (DataCatalogSummary) GoString added in v1.31.8 

func (s DataCatalogSummary) GoString() string

GoString returns the string representation

func (*DataCatalogSummary) SetCatalogName added in v1.31.8 

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

SetCatalogName sets the CatalogName field's value.

func (*DataCatalogSummary) SetType added in v1.31.8 

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

SetType sets the Type field's value.

func (DataCatalogSummary) String added in v1.31.8 

func (s DataCatalogSummary) String() string

String returns the string representation

type Database added in v1.31.8 

type Database struct {

	// An optional description of the database.
	Description *string `min:"1" type:"string"`

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

	// A set of custom key/value pairs.
	Parameters map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

Contains metadata information for a database in a data catalog.

func (Database) GoString added in v1.31.8 

func (s Database) GoString() string

GoString returns the string representation

func (*Database) SetDescription added in v1.31.8 

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

SetDescription sets the Description field's value.

func (*Database) SetName added in v1.31.8 

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

SetName sets the Name field's value.

func (*Database) SetParameters added in v1.31.8 

func (s *Database) SetParameters(v map[string]*string) *Database

SetParameters sets the Parameters field's value.

func (Database) String added in v1.31.8 

func (s Database) String() string

String returns the string representation

type Datum 

type Datum struct {

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

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

func (Datum) GoString 

func (s Datum) GoString() string

GoString returns the string representation

func (*Datum) SetVarCharValue 

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

SetVarCharValue sets the VarCharValue field's value.

func (Datum) String 

func (s Datum) String() string

String returns the string representation

type DeleteDataCatalogInput added in v1.31.8 

type DeleteDataCatalogInput struct {

	// The name of the data catalog to delete.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDataCatalogInput) GoString added in v1.31.8 

func (s DeleteDataCatalogInput) GoString() string

GoString returns the string representation

func (*DeleteDataCatalogInput) SetName added in v1.31.8 

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

SetName sets the Name field's value.

func (DeleteDataCatalogInput) String added in v1.31.8 

func (s DeleteDataCatalogInput) String() string

String returns the string representation

func (*DeleteDataCatalogInput) Validate added in v1.31.8 

func (s *DeleteDataCatalogInput) Validate() error

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

type DeleteDataCatalogOutput added in v1.31.8 

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

func (DeleteDataCatalogOutput) GoString added in v1.31.8 

func (s DeleteDataCatalogOutput) GoString() string

GoString returns the string representation

func (DeleteDataCatalogOutput) String added in v1.31.8 

func (s DeleteDataCatalogOutput) String() string

String returns the string representation

type DeleteNamedQueryInput 

type DeleteNamedQueryInput struct {

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

func (DeleteNamedQueryInput) GoString 

func (s DeleteNamedQueryInput) GoString() string

GoString returns the string representation

func (*DeleteNamedQueryInput) SetNamedQueryId 

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

SetNamedQueryId sets the NamedQueryId field's value.

func (DeleteNamedQueryInput) String 

func (s DeleteNamedQueryInput) String() string

String returns the string representation

type DeleteNamedQueryOutput 

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

func (DeleteNamedQueryOutput) GoString 

func (s DeleteNamedQueryOutput) GoString() string

GoString returns the string representation

func (DeleteNamedQueryOutput) String 

func (s DeleteNamedQueryOutput) String() string

String returns the string representation

type DeleteWorkGroupInput added in v1.17.0 

type DeleteWorkGroupInput struct {

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

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

func (DeleteWorkGroupInput) GoString added in v1.17.0 

func (s DeleteWorkGroupInput) GoString() string

GoString returns the string representation

func (*DeleteWorkGroupInput) SetRecursiveDeleteOption added in v1.17.0 

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

SetRecursiveDeleteOption sets the RecursiveDeleteOption field's value.

func (*DeleteWorkGroupInput) SetWorkGroup added in v1.17.0 

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

SetWorkGroup sets the WorkGroup field's value.

func (DeleteWorkGroupInput) String added in v1.17.0 

func (s DeleteWorkGroupInput) String() string

String returns the string representation

func (*DeleteWorkGroupInput) Validate added in v1.17.0 

func (s *DeleteWorkGroupInput) Validate() error

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

type DeleteWorkGroupOutput added in v1.17.0 

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

func (DeleteWorkGroupOutput) GoString added in v1.17.0 

func (s DeleteWorkGroupOutput) GoString() string

GoString returns the string representation

func (DeleteWorkGroupOutput) String added in v1.17.0 

func (s DeleteWorkGroupOutput) String() string

String returns the string representation

type EncryptionConfiguration 

type EncryptionConfiguration struct {

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

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

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

func (EncryptionConfiguration) GoString 

func (s EncryptionConfiguration) GoString() string

GoString returns the string representation

func (*EncryptionConfiguration) SetEncryptionOption 

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

SetEncryptionOption sets the EncryptionOption field's value.

func (*EncryptionConfiguration) SetKmsKey 

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

SetKmsKey sets the KmsKey field's value.

func (EncryptionConfiguration) String 

func (s EncryptionConfiguration) String() string

String returns the string representation

func (*EncryptionConfiguration) Validate 

func (s *EncryptionConfiguration) Validate() error

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

type EngineVersion added in v1.37.4 

type EngineVersion struct {

	// Read only. The engine version on which the query runs. If the user requests
	// a valid engine version other than Auto, the effective engine version is the
	// same as the engine version that the user requested. If the user requests
	// Auto, the effective engine version is chosen by Athena. When a request to
	// update the engine version is made by a CreateWorkGroup or UpdateWorkGroup
	// operation, the EffectiveEngineVersion field is ignored.
	EffectiveEngineVersion *string `min:"1" type:"string"`

	// The engine version requested by the user. Possible values are determined
	// by the output of ListEngineVersions, including Auto. The default is Auto.
	SelectedEngineVersion *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The Athena engine version for running queries.

func (EngineVersion) GoString added in v1.37.4 

func (s EngineVersion) GoString() string

GoString returns the string representation

func (*EngineVersion) SetEffectiveEngineVersion added in v1.37.4 

func (s *EngineVersion) SetEffectiveEngineVersion(v string) *EngineVersion

SetEffectiveEngineVersion sets the EffectiveEngineVersion field's value.

func (*EngineVersion) SetSelectedEngineVersion added in v1.37.4 

func (s *EngineVersion) SetSelectedEngineVersion(v string) *EngineVersion

SetSelectedEngineVersion sets the SelectedEngineVersion field's value.

func (EngineVersion) String added in v1.37.4 

func (s EngineVersion) String() string

String returns the string representation

func (*EngineVersion) Validate added in v1.37.4 

func (s *EngineVersion) Validate() error

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

type GetDataCatalogInput added in v1.31.8 

type GetDataCatalogInput struct {

	// The name of the data catalog to return.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDataCatalogInput) GoString added in v1.31.8 

func (s GetDataCatalogInput) GoString() string

GoString returns the string representation

func (*GetDataCatalogInput) SetName added in v1.31.8 

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

SetName sets the Name field's value.

func (GetDataCatalogInput) String added in v1.31.8 

func (s GetDataCatalogInput) String() string

String returns the string representation

func (*GetDataCatalogInput) Validate added in v1.31.8 

func (s *GetDataCatalogInput) Validate() error

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

type GetDataCatalogOutput added in v1.31.8 

type GetDataCatalogOutput struct {

	// The data catalog returned.
	DataCatalog *DataCatalog `type:"structure"`
	// contains filtered or unexported fields
}

func (GetDataCatalogOutput) GoString added in v1.31.8 

func (s GetDataCatalogOutput) GoString() string

GoString returns the string representation

func (*GetDataCatalogOutput) SetDataCatalog added in v1.31.8 

func (s *GetDataCatalogOutput) SetDataCatalog(v *DataCatalog) *GetDataCatalogOutput

SetDataCatalog sets the DataCatalog field's value.

func (GetDataCatalogOutput) String added in v1.31.8 

func (s GetDataCatalogOutput) String() string

String returns the string representation

type GetDatabaseInput added in v1.31.8 

type GetDatabaseInput struct {

	// The name of the data catalog that contains the database to return.
	//
	// CatalogName is a required field
	CatalogName *string `min:"1" type:"string" required:"true"`

	// The name of the database to return.
	//
	// DatabaseName is a required field
	DatabaseName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDatabaseInput) GoString added in v1.31.8 

func (s GetDatabaseInput) GoString() string

GoString returns the string representation

func (*GetDatabaseInput) SetCatalogName added in v1.31.8 

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

SetCatalogName sets the CatalogName field's value.

func (*GetDatabaseInput) SetDatabaseName added in v1.31.8 

func (s *GetDatabaseInput) SetDatabaseName(v string) *GetDatabaseInput

SetDatabaseName sets the DatabaseName field's value.

func (GetDatabaseInput) String added in v1.31.8 

func (s GetDatabaseInput) String() string

String returns the string representation

func (*GetDatabaseInput) Validate added in v1.31.8 

func (s *GetDatabaseInput) Validate() error

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

type GetDatabaseOutput added in v1.31.8 

type GetDatabaseOutput struct {

	// The database returned.
	Database *Database `type:"structure"`
	// contains filtered or unexported fields
}

func (GetDatabaseOutput) GoString added in v1.31.8 

func (s GetDatabaseOutput) GoString() string

GoString returns the string representation

func (*GetDatabaseOutput) SetDatabase added in v1.31.8 

func (s *GetDatabaseOutput) SetDatabase(v *Database) *GetDatabaseOutput

SetDatabase sets the Database field's value.

func (GetDatabaseOutput) String added in v1.31.8 

func (s GetDatabaseOutput) String() string

String returns the string representation

type GetNamedQueryInput 

type GetNamedQueryInput struct {

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

func (GetNamedQueryInput) GoString 

func (s GetNamedQueryInput) GoString() string

GoString returns the string representation

func (*GetNamedQueryInput) SetNamedQueryId 

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

SetNamedQueryId sets the NamedQueryId field's value.

func (GetNamedQueryInput) String 

func (s GetNamedQueryInput) String() string

String returns the string representation

func (*GetNamedQueryInput) Validate 

func (s *GetNamedQueryInput) Validate() error

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

type GetNamedQueryOutput 

type GetNamedQueryOutput struct {

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

func (GetNamedQueryOutput) GoString 

func (s GetNamedQueryOutput) GoString() string

GoString returns the string representation

func (*GetNamedQueryOutput) SetNamedQuery 

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

SetNamedQuery sets the NamedQuery field's value.

func (GetNamedQueryOutput) String 

func (s GetNamedQueryOutput) String() string

String returns the string representation

type GetQueryExecutionInput 

type GetQueryExecutionInput struct {

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

func (GetQueryExecutionInput) GoString 

func (s GetQueryExecutionInput) GoString() string

GoString returns the string representation

func (*GetQueryExecutionInput) SetQueryExecutionId 

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

SetQueryExecutionId sets the QueryExecutionId field's value.

func (GetQueryExecutionInput) String 

func (s GetQueryExecutionInput) String() string

String returns the string representation

func (*GetQueryExecutionInput) Validate 

func (s *GetQueryExecutionInput) Validate() error

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

type GetQueryExecutionOutput 

type GetQueryExecutionOutput struct {

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

func (GetQueryExecutionOutput) GoString 

func (s GetQueryExecutionOutput) GoString() string

GoString returns the string representation

func (*GetQueryExecutionOutput) SetQueryExecution 

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

SetQueryExecution sets the QueryExecution field's value.

func (GetQueryExecutionOutput) String 

func (s GetQueryExecutionOutput) String() string

String returns the string representation

type GetQueryResultsInput 

type GetQueryResultsInput struct {

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

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`

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

func (GetQueryResultsInput) GoString 

func (s GetQueryResultsInput) GoString() string

GoString returns the string representation

func (*GetQueryResultsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*GetQueryResultsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*GetQueryResultsInput) SetQueryExecutionId 

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

SetQueryExecutionId sets the QueryExecutionId field's value.

func (GetQueryResultsInput) String 

func (s GetQueryResultsInput) String() string

String returns the string representation

func (*GetQueryResultsInput) Validate 

func (s *GetQueryResultsInput) Validate() error

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

type GetQueryResultsOutput 

type GetQueryResultsOutput struct {

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`

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

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

func (GetQueryResultsOutput) GoString 

func (s GetQueryResultsOutput) GoString() string

GoString returns the string representation

func (*GetQueryResultsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*GetQueryResultsOutput) SetResultSet 

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

SetResultSet sets the ResultSet field's value.

func (*GetQueryResultsOutput) SetUpdateCount added in v1.15.53 

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

SetUpdateCount sets the UpdateCount field's value.

func (GetQueryResultsOutput) String 

func (s GetQueryResultsOutput) String() string

String returns the string representation

type GetTableMetadataInput added in v1.31.8 

type GetTableMetadataInput struct {

	// The name of the data catalog that contains the database and table metadata
	// to return.
	//
	// CatalogName is a required field
	CatalogName *string `min:"1" type:"string" required:"true"`

	// The name of the database that contains the table metadata to return.
	//
	// DatabaseName is a required field
	DatabaseName *string `min:"1" type:"string" required:"true"`

	// The name of the table for which metadata is returned.
	//
	// TableName is a required field
	TableName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetTableMetadataInput) GoString added in v1.31.8 

func (s GetTableMetadataInput) GoString() string

GoString returns the string representation

func (*GetTableMetadataInput) SetCatalogName added in v1.31.8 

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

SetCatalogName sets the CatalogName field's value.

func (*GetTableMetadataInput) SetDatabaseName added in v1.31.8 

func (s *GetTableMetadataInput) SetDatabaseName(v string) *GetTableMetadataInput

SetDatabaseName sets the DatabaseName field's value.

func (*GetTableMetadataInput) SetTableName added in v1.31.8 

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

SetTableName sets the TableName field's value.

func (GetTableMetadataInput) String added in v1.31.8 

func (s GetTableMetadataInput) String() string

String returns the string representation

func (*GetTableMetadataInput) Validate added in v1.31.8 

func (s *GetTableMetadataInput) Validate() error

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

type GetTableMetadataOutput added in v1.31.8 

type GetTableMetadataOutput struct {

	// An object that contains table metadata.
	TableMetadata *TableMetadata `type:"structure"`
	// contains filtered or unexported fields
}

func (GetTableMetadataOutput) GoString added in v1.31.8 

func (s GetTableMetadataOutput) GoString() string

GoString returns the string representation

func (*GetTableMetadataOutput) SetTableMetadata added in v1.31.8 

func (s *GetTableMetadataOutput) SetTableMetadata(v *TableMetadata) *GetTableMetadataOutput

SetTableMetadata sets the TableMetadata field's value.

func (GetTableMetadataOutput) String added in v1.31.8 

func (s GetTableMetadataOutput) String() string

String returns the string representation

type GetWorkGroupInput added in v1.17.0 

type GetWorkGroupInput struct {

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

func (GetWorkGroupInput) GoString added in v1.17.0 

func (s GetWorkGroupInput) GoString() string

GoString returns the string representation

func (*GetWorkGroupInput) SetWorkGroup added in v1.17.0 

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

SetWorkGroup sets the WorkGroup field's value.

func (GetWorkGroupInput) String added in v1.17.0 

func (s GetWorkGroupInput) String() string

String returns the string representation

func (*GetWorkGroupInput) Validate added in v1.17.0 

func (s *GetWorkGroupInput) Validate() error

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

type GetWorkGroupOutput added in v1.17.0 

type GetWorkGroupOutput struct {

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

func (GetWorkGroupOutput) GoString added in v1.17.0 

func (s GetWorkGroupOutput) GoString() string

GoString returns the string representation

func (*GetWorkGroupOutput) SetWorkGroup added in v1.17.0 

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

SetWorkGroup sets the WorkGroup field's value.

func (GetWorkGroupOutput) String added in v1.17.0 

func (s GetWorkGroupOutput) String() string

String returns the string representation

type InternalServerException added in v1.28.0 

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Indicates a platform issue, which may be due to a transient condition or outage.

func (*InternalServerException) Code added in v1.28.0 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error added in v1.28.0 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString added in v1.28.0 

func (s InternalServerException) GoString() string

GoString returns the string representation

func (*InternalServerException) Message added in v1.28.0 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr added in v1.28.0 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID added in v1.28.0 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode added in v1.28.0 

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String added in v1.28.0 

func (s InternalServerException) String() string

String returns the string representation

type InvalidRequestException added in v1.28.0 

type InvalidRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code returned when the query execution failed to process, or when
	// the processing request for the named query failed.
	AthenaErrorCode *string `min:"1" type:"string"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InvalidRequestException) Code added in v1.28.0 

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error added in v1.28.0 

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString added in v1.28.0 

func (s InvalidRequestException) GoString() string

GoString returns the string representation

func (*InvalidRequestException) Message added in v1.28.0 

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr added in v1.28.0 

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID added in v1.28.0 

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode added in v1.28.0 

func (s *InvalidRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidRequestException) String added in v1.28.0 

func (s InvalidRequestException) String() string

String returns the string representation

type ListDataCatalogsInput added in v1.31.8 

type ListDataCatalogsInput struct {

	// Specifies the maximum number of data catalogs to return.
	MaxResults *int64 `min:"2" type:"integer"`

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDataCatalogsInput) GoString added in v1.31.8 

func (s ListDataCatalogsInput) GoString() string

GoString returns the string representation

func (*ListDataCatalogsInput) SetMaxResults added in v1.31.8 

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

SetMaxResults sets the MaxResults field's value.

func (*ListDataCatalogsInput) SetNextToken added in v1.31.8 

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

SetNextToken sets the NextToken field's value.

func (ListDataCatalogsInput) String added in v1.31.8 

func (s ListDataCatalogsInput) String() string

String returns the string representation

func (*ListDataCatalogsInput) Validate added in v1.31.8 

func (s *ListDataCatalogsInput) Validate() error

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

type ListDataCatalogsOutput added in v1.31.8 

type ListDataCatalogsOutput struct {

	// A summary list of data catalogs.
	DataCatalogsSummary []*DataCatalogSummary `type:"list"`

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDataCatalogsOutput) GoString added in v1.31.8 

func (s ListDataCatalogsOutput) GoString() string

GoString returns the string representation

func (*ListDataCatalogsOutput) SetDataCatalogsSummary added in v1.31.8 

func (s *ListDataCatalogsOutput) SetDataCatalogsSummary(v []*DataCatalogSummary) *ListDataCatalogsOutput

SetDataCatalogsSummary sets the DataCatalogsSummary field's value.

func (*ListDataCatalogsOutput) SetNextToken added in v1.31.8 

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

SetNextToken sets the NextToken field's value.

func (ListDataCatalogsOutput) String added in v1.31.8 

func (s ListDataCatalogsOutput) String() string

String returns the string representation

type ListDatabasesInput added in v1.31.8 

type ListDatabasesInput struct {

	// The name of the data catalog that contains the databases to return.
	//
	// CatalogName is a required field
	CatalogName *string `min:"1" type:"string" required:"true"`

	// Specifies the maximum number of results to return.
	MaxResults *int64 `min:"1" type:"integer"`

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDatabasesInput) GoString added in v1.31.8 

func (s ListDatabasesInput) GoString() string

GoString returns the string representation

func (*ListDatabasesInput) SetCatalogName added in v1.31.8 

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

SetCatalogName sets the CatalogName field's value.

func (*ListDatabasesInput) SetMaxResults added in v1.31.8 

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

SetMaxResults sets the MaxResults field's value.

func (*ListDatabasesInput) SetNextToken added in v1.31.8 

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

SetNextToken sets the NextToken field's value.

func (ListDatabasesInput) String added in v1.31.8 

func (s ListDatabasesInput) String() string

String returns the string representation

func (*ListDatabasesInput) Validate added in v1.31.8 

func (s *ListDatabasesInput) Validate() error

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

type ListDatabasesOutput added in v1.31.8 

type ListDatabasesOutput struct {

	// A list of databases from a data catalog.
	DatabaseList []*Database `type:"list"`

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDatabasesOutput) GoString added in v1.31.8 

func (s ListDatabasesOutput) GoString() string

GoString returns the string representation

func (*ListDatabasesOutput) SetDatabaseList added in v1.31.8 

func (s *ListDatabasesOutput) SetDatabaseList(v []*Database) *ListDatabasesOutput

SetDatabaseList sets the DatabaseList field's value.

func (*ListDatabasesOutput) SetNextToken added in v1.31.8 

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

SetNextToken sets the NextToken field's value.

func (ListDatabasesOutput) String added in v1.31.8 

func (s ListDatabasesOutput) String() string

String returns the string representation

type ListEngineVersionsInput added in v1.37.4 

type ListEngineVersionsInput struct {

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

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEngineVersionsInput) GoString added in v1.37.4 

func (s ListEngineVersionsInput) GoString() string

GoString returns the string representation

func (*ListEngineVersionsInput) SetMaxResults added in v1.37.4 

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

SetMaxResults sets the MaxResults field's value.

func (*ListEngineVersionsInput) SetNextToken added in v1.37.4 

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

SetNextToken sets the NextToken field's value.

func (ListEngineVersionsInput) String added in v1.37.4 

func (s ListEngineVersionsInput) String() string

String returns the string representation

func (*ListEngineVersionsInput) Validate added in v1.37.4 

func (s *ListEngineVersionsInput) Validate() error

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

type ListEngineVersionsOutput added in v1.37.4 

type ListEngineVersionsOutput struct {

	// A list of engine versions that are available to choose from.
	EngineVersions []*EngineVersion `type:"list"`

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEngineVersionsOutput) GoString added in v1.37.4 

func (s ListEngineVersionsOutput) GoString() string

GoString returns the string representation

func (*ListEngineVersionsOutput) SetEngineVersions added in v1.37.4 

func (s *ListEngineVersionsOutput) SetEngineVersions(v []*EngineVersion) *ListEngineVersionsOutput

SetEngineVersions sets the EngineVersions field's value.

func (*ListEngineVersionsOutput) SetNextToken added in v1.37.4 

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

SetNextToken sets the NextToken field's value.

func (ListEngineVersionsOutput) String added in v1.37.4 

func (s ListEngineVersionsOutput) 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"`

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`

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

func (ListNamedQueriesInput) GoString 

func (s ListNamedQueriesInput) GoString() string

GoString returns the string representation

func (*ListNamedQueriesInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListNamedQueriesInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListNamedQueriesInput) SetWorkGroup added in v1.17.0 

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

SetWorkGroup sets the WorkGroup field's value.

func (ListNamedQueriesInput) String 

func (s ListNamedQueriesInput) String() string

String returns the string representation

func (*ListNamedQueriesInput) Validate added in v1.17.0 

func (s *ListNamedQueriesInput) Validate() error

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

type ListNamedQueriesOutput 

type ListNamedQueriesOutput struct {

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

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListNamedQueriesOutput) GoString 

func (s ListNamedQueriesOutput) GoString() string

GoString returns the string representation

func (*ListNamedQueriesOutput) SetNamedQueryIds 

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

SetNamedQueryIds sets the NamedQueryIds field's value.

func (*ListNamedQueriesOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListNamedQueriesOutput) String 

func (s ListNamedQueriesOutput) String() string

String returns the string representation

type ListQueryExecutionsInput 

type ListQueryExecutionsInput struct {

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

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`

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

func (ListQueryExecutionsInput) GoString 

func (s ListQueryExecutionsInput) GoString() string

GoString returns the string representation

func (*ListQueryExecutionsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListQueryExecutionsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListQueryExecutionsInput) SetWorkGroup added in v1.17.0 

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

SetWorkGroup sets the WorkGroup field's value.

func (ListQueryExecutionsInput) String 

func (s ListQueryExecutionsInput) String() string

String returns the string representation

func (*ListQueryExecutionsInput) Validate added in v1.17.0 

func (s *ListQueryExecutionsInput) Validate() error

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

type ListQueryExecutionsOutput 

type ListQueryExecutionsOutput struct {

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

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

func (ListQueryExecutionsOutput) GoString 

func (s ListQueryExecutionsOutput) GoString() string

GoString returns the string representation

func (*ListQueryExecutionsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListQueryExecutionsOutput) SetQueryExecutionIds 

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

SetQueryExecutionIds sets the QueryExecutionIds field's value.

func (ListQueryExecutionsOutput) String 

func (s ListQueryExecutionsOutput) String() string

String returns the string representation

type ListTableMetadataInput added in v1.31.8 

type ListTableMetadataInput struct {

	// The name of the data catalog for which table metadata should be returned.
	//
	// CatalogName is a required field
	CatalogName *string `min:"1" type:"string" required:"true"`

	// The name of the database for which table metadata should be returned.
	//
	// DatabaseName is a required field
	DatabaseName *string `min:"1" type:"string" required:"true"`

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

	// Specifies the maximum number of results to return.
	MaxResults *int64 `min:"1" type:"integer"`

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListTableMetadataInput) GoString added in v1.31.8 

func (s ListTableMetadataInput) GoString() string

GoString returns the string representation

func (*ListTableMetadataInput) SetCatalogName added in v1.31.8 

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

SetCatalogName sets the CatalogName field's value.

func (*ListTableMetadataInput) SetDatabaseName added in v1.31.8 

func (s *ListTableMetadataInput) SetDatabaseName(v string) *ListTableMetadataInput

SetDatabaseName sets the DatabaseName field's value.

func (*ListTableMetadataInput) SetExpression added in v1.31.8 

func (s *ListTableMetadataInput) SetExpression(v string) *ListTableMetadataInput

SetExpression sets the Expression field's value.

func (*ListTableMetadataInput) SetMaxResults added in v1.31.8 

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

SetMaxResults sets the MaxResults field's value.

func (*ListTableMetadataInput) SetNextToken added in v1.31.8 

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

SetNextToken sets the NextToken field's value.

func (ListTableMetadataInput) String added in v1.31.8 

func (s ListTableMetadataInput) String() string

String returns the string representation

func (*ListTableMetadataInput) Validate added in v1.31.8 

func (s *ListTableMetadataInput) Validate() error

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

type ListTableMetadataOutput added in v1.31.8 

type ListTableMetadataOutput struct {

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`

	// A list of table metadata.
	TableMetadataList []*TableMetadata `type:"list"`
	// contains filtered or unexported fields
}

func (ListTableMetadataOutput) GoString added in v1.31.8 

func (s ListTableMetadataOutput) GoString() string

GoString returns the string representation

func (*ListTableMetadataOutput) SetNextToken added in v1.31.8 

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

SetNextToken sets the NextToken field's value.

func (*ListTableMetadataOutput) SetTableMetadataList added in v1.31.8 

func (s *ListTableMetadataOutput) SetTableMetadataList(v []*TableMetadata) *ListTableMetadataOutput

SetTableMetadataList sets the TableMetadataList field's value.

func (ListTableMetadataOutput) String added in v1.31.8 

func (s ListTableMetadataOutput) String() string

String returns the string representation

type ListTagsForResourceInput added in v1.17.4 

type ListTagsForResourceInput struct {

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

	// The token for the next set of results, or null if there are no additional
	// results for this request, where the request lists the tags for the resource
	// with the specified ARN.
	NextToken *string `min:"1" type:"string"`

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

func (ListTagsForResourceInput) GoString added in v1.17.4 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetMaxResults added in v1.17.4 

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

SetMaxResults sets the MaxResults field's value.

func (*ListTagsForResourceInput) SetNextToken added in v1.17.4 

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

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceInput) SetResourceARN added in v1.17.4 

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

SetResourceARN sets the ResourceARN field's value.

func (ListTagsForResourceInput) String added in v1.17.4 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v1.17.4 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v1.17.4 

type ListTagsForResourceOutput struct {

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

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

func (ListTagsForResourceOutput) GoString added in v1.17.4 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetNextToken added in v1.17.4 

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

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceOutput) SetTags added in v1.17.4 

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

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.17.4 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListWorkGroupsInput added in v1.17.0 

type ListWorkGroupsInput struct {

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

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListWorkGroupsInput) GoString added in v1.17.0 

func (s ListWorkGroupsInput) GoString() string

GoString returns the string representation

func (*ListWorkGroupsInput) SetMaxResults added in v1.17.0 

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

SetMaxResults sets the MaxResults field's value.

func (*ListWorkGroupsInput) SetNextToken added in v1.17.0 

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

SetNextToken sets the NextToken field's value.

func (ListWorkGroupsInput) String added in v1.17.0 

func (s ListWorkGroupsInput) String() string

String returns the string representation

func (*ListWorkGroupsInput) Validate added in v1.17.0 

func (s *ListWorkGroupsInput) Validate() error

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

type ListWorkGroupsOutput added in v1.17.0 

type ListWorkGroupsOutput struct {

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`

	// A list of WorkGroupSummary objects that include the names, descriptions,
	// creation times, and states for each workgroup.
	WorkGroups []*WorkGroupSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListWorkGroupsOutput) GoString added in v1.17.0 

func (s ListWorkGroupsOutput) GoString() string

GoString returns the string representation

func (*ListWorkGroupsOutput) SetNextToken added in v1.17.0 

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

SetNextToken sets the NextToken field's value.

func (*ListWorkGroupsOutput) SetWorkGroups added in v1.17.0 

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

SetWorkGroups sets the WorkGroups field's value.

func (ListWorkGroupsOutput) String added in v1.17.0 

func (s ListWorkGroupsOutput) String() string

String returns the string representation

type MetadataException added in v1.31.8 

type MetadataException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform (InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.

func (*MetadataException) Code added in v1.31.8 

func (s *MetadataException) Code() string

Code returns the exception type name.

func (*MetadataException) Error added in v1.31.8 

func (s *MetadataException) Error() string

func (MetadataException) GoString added in v1.31.8 

func (s MetadataException) GoString() string

GoString returns the string representation

func (*MetadataException) Message added in v1.31.8 

func (s *MetadataException) Message() string

Message returns the exception's message.

func (*MetadataException) OrigErr added in v1.31.8 

func (s *MetadataException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MetadataException) RequestID added in v1.31.8 

func (s *MetadataException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MetadataException) StatusCode added in v1.31.8 

func (s *MetadataException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (MetadataException) String added in v1.31.8 

func (s MetadataException) String() string

String returns the string representation

type NamedQuery 

type NamedQuery struct {

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

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

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

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

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

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

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

func (NamedQuery) GoString 

func (s NamedQuery) GoString() string

GoString returns the string representation

func (*NamedQuery) SetDatabase 

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

SetDatabase sets the Database field's value.

func (*NamedQuery) SetDescription 

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

SetDescription sets the Description field's value.

func (*NamedQuery) SetName 

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

SetName sets the Name field's value.

func (*NamedQuery) SetNamedQueryId 

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

SetNamedQueryId sets the NamedQueryId field's value.

func (*NamedQuery) SetQueryString 

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

SetQueryString sets the QueryString field's value.

func (*NamedQuery) SetWorkGroup added in v1.17.0 

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

SetWorkGroup sets the WorkGroup field's value.

func (NamedQuery) String 

func (s NamedQuery) String() string

String returns the string representation

type QueryExecution 

type QueryExecution struct {

	// The engine version that executed the query.
	EngineVersion *EngineVersion `type:"structure"`

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

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

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

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

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

	// Query execution statistics, such as the amount of data scanned, the amount
	// of time that the query took to process, and the type of statement that was
	// run.
	Statistics *QueryExecutionStatistics `type:"structure"`

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

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

Information about a single instance of a query execution.

func (QueryExecution) GoString 

func (s QueryExecution) GoString() string

GoString returns the string representation

func (*QueryExecution) SetEngineVersion added in v1.37.4 

func (s *QueryExecution) SetEngineVersion(v *EngineVersion) *QueryExecution

SetEngineVersion sets the EngineVersion field's value.

func (*QueryExecution) SetQuery 

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

SetQuery sets the Query field's value.

func (*QueryExecution) SetQueryExecutionContext 

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

SetQueryExecutionContext sets the QueryExecutionContext field's value.

func (*QueryExecution) SetQueryExecutionId 

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

SetQueryExecutionId sets the QueryExecutionId field's value.

func (*QueryExecution) SetResultConfiguration 

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

SetResultConfiguration sets the ResultConfiguration field's value.

func (*QueryExecution) SetStatementType added in v1.15.53 

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

SetStatementType sets the StatementType field's value.

func (*QueryExecution) SetStatistics 

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

SetStatistics sets the Statistics field's value.

func (*QueryExecution) SetStatus 

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

SetStatus sets the Status field's value.

func (*QueryExecution) SetWorkGroup added in v1.17.0 

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

SetWorkGroup sets the WorkGroup field's value.

func (QueryExecution) String 

func (s QueryExecution) String() string

String returns the string representation

type QueryExecutionContext 

type QueryExecutionContext struct {

	// The name of the data catalog used in the query execution.
	Catalog *string `min:"1" type:"string"`

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

The database and data catalog context in which the query execution occurs.

func (QueryExecutionContext) GoString 

func (s QueryExecutionContext) GoString() string

GoString returns the string representation

func (*QueryExecutionContext) SetCatalog added in v1.31.8 

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

SetCatalog sets the Catalog field's value.

func (*QueryExecutionContext) SetDatabase 

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

SetDatabase sets the Database field's value.

func (QueryExecutionContext) String 

func (s QueryExecutionContext) String() string

String returns the string representation

func (*QueryExecutionContext) Validate 

func (s *QueryExecutionContext) Validate() error

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

type QueryExecutionStatistics 

type QueryExecutionStatistics struct {

	// The location and file name of a data manifest file. The manifest file is
	// saved to the Athena query results location in Amazon S3. The manifest file
	// tracks files that the query wrote to Amazon S3. If the query fails, the manifest
	// file also tracks files that the query intended to write. The manifest is
	// useful for identifying orphaned files resulting from a failed query. For
	// more information, see Working with Query Results, Output Files, and Query
	// History (https://docs.aws.amazon.com/athena/latest/ug/querying.html) in the
	// Amazon Athena User Guide.
	DataManifestLocation *string `type:"string"`

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

	// The number of milliseconds that Athena took to plan the query processing
	// flow. This includes the time spent retrieving table partitions from the data
	// source. Note that because the query engine performs the query planning, query
	// planning time is a subset of engine processing time.
	QueryPlanningTimeInMillis *int64 `type:"long"`

	// The number of milliseconds that the query was in your query queue waiting
	// for resources. Note that if transient errors occur, Athena might automatically
	// add the query back to the queue.
	QueryQueueTimeInMillis *int64 `type:"long"`

	// The number of milliseconds that Athena took to finalize and publish the query
	// results after the query engine finished running the query.
	ServiceProcessingTimeInMillis *int64 `type:"long"`

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

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

func (QueryExecutionStatistics) GoString 

func (s QueryExecutionStatistics) GoString() string

GoString returns the string representation

func (*QueryExecutionStatistics) SetDataManifestLocation added in v1.24.0 

func (s *QueryExecutionStatistics) SetDataManifestLocation(v string) *QueryExecutionStatistics

SetDataManifestLocation sets the DataManifestLocation field's value.

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) SetQueryPlanningTimeInMillis added in v1.25.42 

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

SetQueryPlanningTimeInMillis sets the QueryPlanningTimeInMillis field's value.

func (*QueryExecutionStatistics) SetQueryQueueTimeInMillis added in v1.25.42 

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

SetQueryQueueTimeInMillis sets the QueryQueueTimeInMillis field's value.

func (*QueryExecutionStatistics) SetServiceProcessingTimeInMillis added in v1.25.42 

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

SetServiceProcessingTimeInMillis sets the ServiceProcessingTimeInMillis field's value.

func (*QueryExecutionStatistics) SetTotalExecutionTimeInMillis added in v1.25.42 

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

SetTotalExecutionTimeInMillis sets the TotalExecutionTimeInMillis field's value.

func (QueryExecutionStatistics) String 

func (s QueryExecutionStatistics) String() string

String returns the string representation

type QueryExecutionStatus 

type QueryExecutionStatus struct {

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

	// The state of query execution. QUEUED indicates that the query has been submitted
	// to the service, and Athena will execute the query as soon as resources are
	// available. RUNNING indicates that the query is in execution phase. SUCCEEDED
	// indicates that the query completed without errors. FAILED indicates that
	// the query experienced an error and did not complete processing. CANCELLED
	// indicates that a user input interrupted query execution.
	//
	// Athena automatically retries your queries in cases of certain transient errors.
	// As a result, you may see the query state transition from RUNNING or FAILED
	// to QUEUED.
	State *string `type:"string" enum:"QueryExecutionState"`

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

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

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

func (QueryExecutionStatus) GoString 

func (s QueryExecutionStatus) GoString() string

GoString returns the string representation

func (*QueryExecutionStatus) SetCompletionDateTime 

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

SetCompletionDateTime sets the CompletionDateTime field's value.

func (*QueryExecutionStatus) SetState 

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

SetState sets the State field's value.

func (*QueryExecutionStatus) SetStateChangeReason 

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

SetStateChangeReason sets the StateChangeReason field's value.

func (*QueryExecutionStatus) SetSubmissionDateTime 

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

SetSubmissionDateTime sets the SubmissionDateTime field's value.

func (QueryExecutionStatus) String 

func (s QueryExecutionStatus) String() string

String returns the string representation

type ResourceNotFoundException added in v1.28.0 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`

	ResourceName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A resource, such as a workgroup, was not found.

func (*ResourceNotFoundException) Code added in v1.28.0 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message added in v1.28.0 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.0 

func (s ResourceNotFoundException) String() string

String returns the string representation

type ResultConfiguration 

type ResultConfiguration struct {

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

	// The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/.
	// To run the query, you must specify the query results location using one of
	// the ways: either for individual queries using either this setting (client-side),
	// or in the workgroup, using WorkGroupConfiguration. If none of them is set,
	// Athena issues an error that no output location is provided. For more information,
	// see Query Results (https://docs.aws.amazon.com/athena/latest/ug/querying.html).
	// If workgroup settings override client-side settings, then the query uses
	// the settings specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
	OutputLocation *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (ResultConfiguration) GoString 

func (s ResultConfiguration) GoString() string

GoString returns the string representation

func (*ResultConfiguration) SetEncryptionConfiguration 

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

SetEncryptionConfiguration sets the EncryptionConfiguration field's value.

func (*ResultConfiguration) SetOutputLocation 

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

SetOutputLocation sets the OutputLocation field's value.

func (ResultConfiguration) String 

func (s ResultConfiguration) String() string

String returns the string representation

func (*ResultConfiguration) Validate 

func (s *ResultConfiguration) Validate() error

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

type ResultConfigurationUpdates added in v1.17.0 

type ResultConfigurationUpdates struct {

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

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

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

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

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

func (ResultConfigurationUpdates) GoString added in v1.17.0 

func (s ResultConfigurationUpdates) GoString() string

GoString returns the string representation

func (*ResultConfigurationUpdates) SetEncryptionConfiguration added in v1.17.0 

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

SetEncryptionConfiguration sets the EncryptionConfiguration field's value.

func (*ResultConfigurationUpdates) SetOutputLocation added in v1.17.0 

func (s *ResultConfigurationUpdates) SetOutputLocation(v string) *ResultConfigurationUpdates

SetOutputLocation sets the OutputLocation field's value.

func (*ResultConfigurationUpdates) SetRemoveEncryptionConfiguration added in v1.17.0 

func (s *ResultConfigurationUpdates) SetRemoveEncryptionConfiguration(v bool) *ResultConfigurationUpdates

SetRemoveEncryptionConfiguration sets the RemoveEncryptionConfiguration field's value.

func (*ResultConfigurationUpdates) SetRemoveOutputLocation added in v1.17.0 

func (s *ResultConfigurationUpdates) SetRemoveOutputLocation(v bool) *ResultConfigurationUpdates

SetRemoveOutputLocation sets the RemoveOutputLocation field's value.

func (ResultConfigurationUpdates) String added in v1.17.0 

func (s ResultConfigurationUpdates) String() string

String returns the string representation

func (*ResultConfigurationUpdates) Validate added in v1.17.0 

func (s *ResultConfigurationUpdates) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResultSet 

type ResultSet struct {

	// The metadata that describes the column structure and data types of a table
	// of query results.
	ResultSetMetadata *ResultSetMetadata `type:"structure"`

	// The rows in the table.
	Rows []*Row `type:"list"`
	// contains filtered or unexported fields
}

The metadata and rows that comprise a query result set. The metadata describes the column structure and data types. To return a ResultSet object, use GetQueryResults.

func (ResultSet) GoString 

func (s ResultSet) GoString() string

GoString returns the string representation

func (*ResultSet) SetResultSetMetadata 

func (s *ResultSet) SetResultSetMetadata(v *ResultSetMetadata) *ResultSet

SetResultSetMetadata sets the ResultSetMetadata field's value.

func (*ResultSet) SetRows 

func (s *ResultSet) SetRows(v []*Row) *ResultSet

SetRows sets the Rows field's value.

func (ResultSet) String 

func (s ResultSet) String() string

String returns the string representation

type ResultSetMetadata 

type ResultSetMetadata struct {

	// Information about the columns returned in a query result metadata.
	ColumnInfo []*ColumnInfo `type:"list"`
	// contains filtered or unexported fields
}

The metadata that describes the column structure and data types of a table of query results. To return a ResultSetMetadata object, use GetQueryResults.

func (ResultSetMetadata) GoString 

func (s ResultSetMetadata) GoString() string

GoString returns the string representation

func (*ResultSetMetadata) SetColumnInfo 

func (s *ResultSetMetadata) SetColumnInfo(v []*ColumnInfo) *ResultSetMetadata

SetColumnInfo sets the ColumnInfo field's value.

func (ResultSetMetadata) String 

func (s ResultSetMetadata) String() string

String returns the string representation

type Row 

type Row struct {

	// The data that populates a row in a query result table.
	Data []*Datum `type:"list"`
	// contains filtered or unexported fields
}

The rows that comprise a query result table.

func (Row) GoString 

func (s Row) GoString() string

GoString returns the string representation

func (*Row) SetData 

func (s *Row) SetData(v []*Datum) *Row

SetData sets the Data field's value.

func (Row) String 

func (s Row) String() string

String returns the string representation

type StartQueryExecutionInput 

type StartQueryExecutionInput struct {

	// A unique case-sensitive string used to ensure the request to create the query
	// is idempotent (executes only once). If another StartQueryExecution request
	// is received, the same response is returned and another query is not created.
	// If a parameter has changed, for example, the QueryString, an error is returned.
	//
	// This token is listed as not required because AWS SDKs (for example the AWS
	// SDK for Java) auto-generate the token for users. If you are not using the
	// AWS SDK or the AWS CLI, you must provide this token or the action will fail.
	ClientRequestToken *string `min:"32" type:"string" idempotencyToken:"true"`

	// The database within which the query executes.
	QueryExecutionContext *QueryExecutionContext `type:"structure"`

	// The SQL query statements to be executed.
	//
	// QueryString is a required field
	QueryString *string `min:"1" type:"string" required:"true"`

	// Specifies information about where and how to save the results of the query
	// execution. If the query runs in a workgroup, then workgroup's settings may
	// override query settings. This affects the query results location. The workgroup
	// settings override is specified in EnforceWorkGroupConfiguration (true/false)
	// in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
	ResultConfiguration *ResultConfiguration `type:"structure"`

	// The name of the workgroup in which the query is being started.
	WorkGroup *string `type:"string"`
	// contains filtered or unexported fields
}

func (StartQueryExecutionInput) GoString 

func (s StartQueryExecutionInput) GoString() string

GoString returns the string representation

func (*StartQueryExecutionInput) SetClientRequestToken 

func (s *StartQueryExecutionInput) SetClientRequestToken(v string) *StartQueryExecutionInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartQueryExecutionInput) SetQueryExecutionContext 

func (s *StartQueryExecutionInput) SetQueryExecutionContext(v *QueryExecutionContext) *StartQueryExecutionInput

SetQueryExecutionContext sets the QueryExecutionContext field's value.

func (*StartQueryExecutionInput) SetQueryString 

func (s *StartQueryExecutionInput) SetQueryString(v string) *StartQueryExecutionInput

SetQueryString sets the QueryString field's value.

func (*StartQueryExecutionInput) SetResultConfiguration 

func (s *StartQueryExecutionInput) SetResultConfiguration(v *ResultConfiguration) *StartQueryExecutionInput

SetResultConfiguration sets the ResultConfiguration field's value.

func (*StartQueryExecutionInput) SetWorkGroup added in v1.17.0 

func (s *StartQueryExecutionInput) SetWorkGroup(v string) *StartQueryExecutionInput

SetWorkGroup sets the WorkGroup field's value.

func (StartQueryExecutionInput) String 

func (s StartQueryExecutionInput) String() string

String returns the string representation

func (*StartQueryExecutionInput) Validate 

func (s *StartQueryExecutionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartQueryExecutionOutput 

type StartQueryExecutionOutput struct {

	// The unique ID of the query that ran as a result of this request.
	QueryExecutionId *string `type:"string"`
	// contains filtered or unexported fields
}

func (StartQueryExecutionOutput) GoString 

func (s StartQueryExecutionOutput) GoString() string

GoString returns the string representation

func (*StartQueryExecutionOutput) SetQueryExecutionId 

func (s *StartQueryExecutionOutput) SetQueryExecutionId(v string) *StartQueryExecutionOutput

SetQueryExecutionId sets the QueryExecutionId field's value.

func (StartQueryExecutionOutput) String 

func (s StartQueryExecutionOutput) String() string

String returns the string representation

type StopQueryExecutionInput 

type StopQueryExecutionInput struct {

	// The unique ID of the query execution to stop.
	QueryExecutionId *string `type:"string" idempotencyToken:"true"`
	// contains filtered or unexported fields
}

func (StopQueryExecutionInput) GoString 

func (s StopQueryExecutionInput) GoString() string

GoString returns the string representation

func (*StopQueryExecutionInput) SetQueryExecutionId 

func (s *StopQueryExecutionInput) SetQueryExecutionId(v string) *StopQueryExecutionInput

SetQueryExecutionId sets the QueryExecutionId field's value.

func (StopQueryExecutionInput) String 

func (s StopQueryExecutionInput) String() string

String returns the string representation

type StopQueryExecutionOutput 

type StopQueryExecutionOutput struct {
	// contains filtered or unexported fields
}

func (StopQueryExecutionOutput) GoString 

func (s StopQueryExecutionOutput) GoString() string

GoString returns the string representation

func (StopQueryExecutionOutput) String 

func (s StopQueryExecutionOutput) String() string

String returns the string representation

type TableMetadata added in v1.31.8 

type TableMetadata struct {

	// A list of the columns in the table.
	Columns []*Column `type:"list"`

	// The time that the table was created.
	CreateTime *time.Time `type:"timestamp"`

	// The last time the table was accessed.
	LastAccessTime *time.Time `type:"timestamp"`

	// The name of the table.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// A set of custom key/value pairs for table properties.
	Parameters map[string]*string `type:"map"`

	// A list of the partition keys in the table.
	PartitionKeys []*Column `type:"list"`

	// The type of table. In Athena, only EXTERNAL_TABLE is supported.
	TableType *string `type:"string"`
	// contains filtered or unexported fields
}

Contains metadata for a table.

func (TableMetadata) GoString added in v1.31.8 

func (s TableMetadata) GoString() string

GoString returns the string representation

func (*TableMetadata) SetColumns added in v1.31.8 

func (s *TableMetadata) SetColumns(v []*Column) *TableMetadata

SetColumns sets the Columns field's value.

func (*TableMetadata) SetCreateTime added in v1.31.8 

func (s *TableMetadata) SetCreateTime(v time.Time) *TableMetadata

SetCreateTime sets the CreateTime field's value.

func (*TableMetadata) SetLastAccessTime added in v1.31.8 

func (s *TableMetadata) SetLastAccessTime(v time.Time) *TableMetadata

SetLastAccessTime sets the LastAccessTime field's value.

func (*TableMetadata) SetName added in v1.31.8 

func (s *TableMetadata) SetName(v string) *TableMetadata

SetName sets the Name field's value.

func (*TableMetadata) SetParameters added in v1.31.8 

func (s *TableMetadata) SetParameters(v map[string]*string) *TableMetadata

SetParameters sets the Parameters field's value.

func (*TableMetadata) SetPartitionKeys added in v1.31.8 

func (s *TableMetadata) SetPartitionKeys(v []*Column) *TableMetadata

SetPartitionKeys sets the PartitionKeys field's value.

func (*TableMetadata) SetTableType added in v1.31.8 

func (s *TableMetadata) SetTableType(v string) *TableMetadata

SetTableType sets the TableType field's value.

func (TableMetadata) String added in v1.31.8 

func (s TableMetadata) String() string

String returns the string representation

type Tag added in v1.17.4 

type Tag struct {

	// A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8.
	// You can use letters and numbers representable in UTF-8, and the following
	// characters: + - = . _ : / @. Tag keys are case-sensitive and must be unique
	// per resource.
	Key *string `min:"1" type:"string"`

	// A tag value. The tag value length is from 0 to 256 Unicode characters in
	// UTF-8. You can use letters and numbers representable in UTF-8, and the following
	// characters: + - = . _ : / @. Tag values are case-sensitive.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A label that you assign to a resource. In Athena, a resource can be a workgroup or data catalog. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena workgroups or data catalogs by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups or data catalogs in your account. For best practices, see Tagging Best Practices (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/). Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas.

func (Tag) GoString added in v1.17.4 

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey added in v1.17.4 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.17.4 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v1.17.4 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate added in v1.17.4 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput added in v1.17.4 

type TagResourceInput struct {

	// Specifies the ARN of the Athena resource (workgroup or data catalog) to which
	// tags are to be added.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// A collection of one or more tags, separated by commas, to be added to an
	// Athena workgroup or data catalog resource.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.17.4 

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetResourceARN added in v1.17.4 

func (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetTags added in v1.17.4 

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.17.4 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v1.17.4 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v1.17.4 

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString added in v1.17.4 

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) String added in v1.17.4 

func (s TagResourceOutput) String() string

String returns the string representation

type TooManyRequestsException added in v1.28.0 

type TooManyRequestsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`

	// The reason for the query throttling, for example, when it exceeds the concurrent
	// query limit.
	Reason *string `type:"string" enum:"ThrottleReason"`
	// contains filtered or unexported fields
}

Indicates that the request was throttled.

func (*TooManyRequestsException) Code added in v1.28.0 

func (s *TooManyRequestsException) Code() string

Code returns the exception type name.

func (*TooManyRequestsException) Error added in v1.28.0 

func (s *TooManyRequestsException) Error() string

func (TooManyRequestsException) GoString added in v1.28.0 

func (s TooManyRequestsException) GoString() string

GoString returns the string representation

func (*TooManyRequestsException) Message added in v1.28.0 

func (s *TooManyRequestsException) Message() string

Message returns the exception's message.

func (*TooManyRequestsException) OrigErr added in v1.28.0 

func (s *TooManyRequestsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyRequestsException) RequestID added in v1.28.0 

func (s *TooManyRequestsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyRequestsException) StatusCode added in v1.28.0 

func (s *TooManyRequestsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TooManyRequestsException) String added in v1.28.0 

func (s TooManyRequestsException) String() string

String returns the string representation

type UnprocessedNamedQueryId 

type UnprocessedNamedQueryId struct {

	// The error code returned when the processing request for the named query failed,
	// if applicable.
	ErrorCode *string `min:"1" type:"string"`

	// The error message returned when the processing request for the named query
	// failed, if applicable.
	ErrorMessage *string `type:"string"`

	// The unique identifier of the named query.
	NamedQueryId *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a named query ID that could not be processed.

func (UnprocessedNamedQueryId) GoString 

func (s UnprocessedNamedQueryId) GoString() string

GoString returns the string representation

func (*UnprocessedNamedQueryId) SetErrorCode 

func (s *UnprocessedNamedQueryId) SetErrorCode(v string) *UnprocessedNamedQueryId

SetErrorCode sets the ErrorCode field's value.

func (*UnprocessedNamedQueryId) SetErrorMessage 

func (s *UnprocessedNamedQueryId) SetErrorMessage(v string) *UnprocessedNamedQueryId

SetErrorMessage sets the ErrorMessage field's value.

func (*UnprocessedNamedQueryId) SetNamedQueryId 

func (s *UnprocessedNamedQueryId) SetNamedQueryId(v string) *UnprocessedNamedQueryId

SetNamedQueryId sets the NamedQueryId field's value.

func (UnprocessedNamedQueryId) String 

func (s UnprocessedNamedQueryId) String() string

String returns the string representation

type UnprocessedQueryExecutionId 

type UnprocessedQueryExecutionId struct {

	// The error code returned when the query execution failed to process, if applicable.
	ErrorCode *string `min:"1" type:"string"`

	// The error message returned when the query execution failed to process, if
	// applicable.
	ErrorMessage *string `type:"string"`

	// The unique identifier of the query execution.
	QueryExecutionId *string `type:"string"`
	// contains filtered or unexported fields
}

Describes a query execution that failed to process.

func (UnprocessedQueryExecutionId) GoString 

func (s UnprocessedQueryExecutionId) GoString() string

GoString returns the string representation

func (*UnprocessedQueryExecutionId) SetErrorCode 

func (s *UnprocessedQueryExecutionId) SetErrorCode(v string) *UnprocessedQueryExecutionId

SetErrorCode sets the ErrorCode field's value.

func (*UnprocessedQueryExecutionId) SetErrorMessage 

func (s *UnprocessedQueryExecutionId) SetErrorMessage(v string) *UnprocessedQueryExecutionId

SetErrorMessage sets the ErrorMessage field's value.

func (*UnprocessedQueryExecutionId) SetQueryExecutionId 

func (s *UnprocessedQueryExecutionId) SetQueryExecutionId(v string) *UnprocessedQueryExecutionId

SetQueryExecutionId sets the QueryExecutionId field's value.

func (UnprocessedQueryExecutionId) String 

func (s UnprocessedQueryExecutionId) String() string

String returns the string representation

type UntagResourceInput added in v1.17.4 

type UntagResourceInput struct {

	// Specifies the ARN of the resource from which tags are to be removed.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// A comma-separated list of one or more tag keys whose tags are to be removed
	// from the specified resource.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.17.4 

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetResourceARN added in v1.17.4 

func (s *UntagResourceInput) SetResourceARN(v string) *UntagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*UntagResourceInput) SetTagKeys added in v1.17.4 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.17.4 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v1.17.4 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v1.17.4 

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString added in v1.17.4 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) String added in v1.17.4 

func (s UntagResourceOutput) String() string

String returns the string representation

type UpdateDataCatalogInput added in v1.31.8 

type UpdateDataCatalogInput struct {

	// New or modified text that describes the data catalog.
	Description *string `min:"1" type:"string"`

	// The name of the data catalog to update. The catalog name must be unique for
	// the AWS account and can use a maximum of 128 alphanumeric, underscore, at
	// sign, or hyphen characters.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// Specifies the Lambda function or functions to use for updating the data catalog.
	// This is a mapping whose values depend on the catalog type.
	//
	//    * For the HIVE data catalog type, use the following syntax. The metadata-function
	//    parameter is required. The sdk-version parameter is optional and defaults
	//    to the currently supported version. metadata-function=lambda_arn, sdk-version=version_number
	//
	//    * For the LAMBDA data catalog type, use one of the following sets of required
	//    parameters, but not both. If you have one Lambda function that processes
	//    metadata and another for reading the actual data, use the following syntax.
	//    Both parameters are required. metadata-function=lambda_arn, record-function=lambda_arn
	//    If you have a composite Lambda function that processes both metadata and
	//    data, use the following syntax to specify your Lambda function. function=lambda_arn
	Parameters map[string]*string `type:"map"`

	// Specifies the type of data catalog to update. Specify LAMBDA for a federated
	// catalog or HIVE for an external hive metastore.
	//
	// Do not use the GLUE type. This refers to the AwsDataCatalog that already
	// exists in your account, of which you can have only one. Specifying the GLUE
	// type will result in an INVALID_INPUT error.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"DataCatalogType"`
	// contains filtered or unexported fields
}

func (UpdateDataCatalogInput) GoString added in v1.31.8 

func (s UpdateDataCatalogInput) GoString() string

GoString returns the string representation

func (*UpdateDataCatalogInput) SetDescription added in v1.31.8 

func (s *UpdateDataCatalogInput) SetDescription(v string) *UpdateDataCatalogInput

SetDescription sets the Description field's value.

func (*UpdateDataCatalogInput) SetName added in v1.31.8 

func (s *UpdateDataCatalogInput) SetName(v string) *UpdateDataCatalogInput

SetName sets the Name field's value.

func (*UpdateDataCatalogInput) SetParameters added in v1.31.8 

func (s *UpdateDataCatalogInput) SetParameters(v map[string]*string) *UpdateDataCatalogInput

SetParameters sets the Parameters field's value.

func (*UpdateDataCatalogInput) SetType added in v1.31.8 

func (s *UpdateDataCatalogInput) SetType(v string) *UpdateDataCatalogInput

SetType sets the Type field's value.

func (UpdateDataCatalogInput) String added in v1.31.8 

func (s UpdateDataCatalogInput) String() string

String returns the string representation

func (*UpdateDataCatalogInput) Validate added in v1.31.8 

func (s *UpdateDataCatalogInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateDataCatalogOutput added in v1.31.8 

type UpdateDataCatalogOutput struct {
	// contains filtered or unexported fields
}

func (UpdateDataCatalogOutput) GoString added in v1.31.8 

func (s UpdateDataCatalogOutput) GoString() string

GoString returns the string representation

func (UpdateDataCatalogOutput) String added in v1.31.8 

func (s UpdateDataCatalogOutput) String() string

String returns the string representation

type UpdateWorkGroupInput added in v1.17.0 

type UpdateWorkGroupInput struct {

	// The workgroup configuration that will be updated for the given workgroup.
	ConfigurationUpdates *WorkGroupConfigurationUpdates `type:"structure"`

	// The workgroup description.
	Description *string `type:"string"`

	// The workgroup state that will be updated for the given workgroup.
	State *string `type:"string" enum:"WorkGroupState"`

	// The specified workgroup that will be updated.
	//
	// WorkGroup is a required field
	WorkGroup *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateWorkGroupInput) GoString added in v1.17.0 

func (s UpdateWorkGroupInput) GoString() string

GoString returns the string representation

func (*UpdateWorkGroupInput) SetConfigurationUpdates added in v1.17.0 

func (s *UpdateWorkGroupInput) SetConfigurationUpdates(v *WorkGroupConfigurationUpdates) *UpdateWorkGroupInput

SetConfigurationUpdates sets the ConfigurationUpdates field's value.

func (*UpdateWorkGroupInput) SetDescription added in v1.17.0 

func (s *UpdateWorkGroupInput) SetDescription(v string) *UpdateWorkGroupInput

SetDescription sets the Description field's value.

func (*UpdateWorkGroupInput) SetState added in v1.17.0 

func (s *UpdateWorkGroupInput) SetState(v string) *UpdateWorkGroupInput

SetState sets the State field's value.

func (*UpdateWorkGroupInput) SetWorkGroup added in v1.17.0 

func (s *UpdateWorkGroupInput) SetWorkGroup(v string) *UpdateWorkGroupInput

SetWorkGroup sets the WorkGroup field's value.

func (UpdateWorkGroupInput) String added in v1.17.0 

func (s UpdateWorkGroupInput) String() string

String returns the string representation

func (*UpdateWorkGroupInput) Validate added in v1.17.0 

func (s *UpdateWorkGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateWorkGroupOutput added in v1.17.0 

type UpdateWorkGroupOutput struct {
	// contains filtered or unexported fields
}

func (UpdateWorkGroupOutput) GoString added in v1.17.0 

func (s UpdateWorkGroupOutput) GoString() string

GoString returns the string representation

func (UpdateWorkGroupOutput) String added in v1.17.0 

func (s UpdateWorkGroupOutput) String() string

String returns the string representation

type WorkGroup added in v1.17.0 

type WorkGroup struct {

	// The configuration of the workgroup, which includes the location in Amazon
	// S3 where query results are stored, the encryption configuration, if any,
	// used for query results; whether the Amazon CloudWatch Metrics are enabled
	// for the workgroup; whether workgroup settings override client-side settings;
	// and the data usage limits for the amount of data scanned per query or per
	// workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration
	// (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
	Configuration *WorkGroupConfiguration `type:"structure"`

	// The date and time the workgroup was created.
	CreationTime *time.Time `type:"timestamp"`

	// The workgroup description.
	Description *string `type:"string"`

	// The workgroup name.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The state of the workgroup: ENABLED or DISABLED.
	State *string `type:"string" enum:"WorkGroupState"`
	// contains filtered or unexported fields
}

A workgroup, which contains a name, description, creation time, state, and other configuration, listed under WorkGroup$Configuration. Each workgroup enables you to isolate queries for you or your group of users from other queries in the same account, to configure the query results location and the encryption configuration (known as workgroup settings), to enable sending query metrics to Amazon CloudWatch, and to establish per-query data usage control limits for all queries in a workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

func (WorkGroup) GoString added in v1.17.0 

func (s WorkGroup) GoString() string

GoString returns the string representation

func (*WorkGroup) SetConfiguration added in v1.17.0 

func (s *WorkGroup) SetConfiguration(v *WorkGroupConfiguration) *WorkGroup

SetConfiguration sets the Configuration field's value.

func (*WorkGroup) SetCreationTime added in v1.17.0 

func (s *WorkGroup) SetCreationTime(v time.Time) *WorkGroup

SetCreationTime sets the CreationTime field's value.

func (*WorkGroup) SetDescription added in v1.17.0 

func (s *WorkGroup) SetDescription(v string) *WorkGroup

SetDescription sets the Description field's value.

func (*WorkGroup) SetName added in v1.17.0 

func (s *WorkGroup) SetName(v string) *WorkGroup

SetName sets the Name field's value.

func (*WorkGroup) SetState added in v1.17.0 

func (s *WorkGroup) SetState(v string) *WorkGroup

SetState sets the State field's value.

func (WorkGroup) String added in v1.17.0 

func (s WorkGroup) String() string

String returns the string representation

type WorkGroupConfiguration added in v1.17.0 

type WorkGroupConfiguration struct {

	// The upper data usage limit (cutoff) for the amount of bytes a single query
	// in a workgroup is allowed to scan.
	BytesScannedCutoffPerQuery *int64 `min:"1e+07" type:"long"`

	// If set to "true", the settings for the workgroup override client-side settings.
	// If set to "false", client-side settings are used. For more information, see
	// Workgroup Settings Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html).
	EnforceWorkGroupConfiguration *bool `type:"boolean"`

	// The engine version that all queries running on the workgroup use. Queries
	// on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine
	// regardless of this setting.
	EngineVersion *EngineVersion `type:"structure"`

	// Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
	PublishCloudWatchMetricsEnabled *bool `type:"boolean"`

	// If set to true, allows members assigned to a workgroup to reference Amazon
	// S3 Requester Pays buckets in queries. If set to false, workgroup members
	// cannot query data from Requester Pays buckets, and queries that retrieve
	// data from Requester Pays buckets cause an error. The default is false. For
	// more information about Requester Pays buckets, see Requester Pays Buckets
	// (https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html)
	// in the Amazon Simple Storage Service Developer Guide.
	RequesterPaysEnabled *bool `type:"boolean"`

	// The configuration for the workgroup, which includes the location in Amazon
	// S3 where query results are stored and the encryption option, if any, used
	// for query results. To run the query, you must specify the query results location
	// using one of the ways: either in the workgroup using this setting, or for
	// individual queries (client-side), using ResultConfiguration$OutputLocation.
	// If none of them is set, Athena issues an error that no output location is
	// provided. For more information, see Query Results (https://docs.aws.amazon.com/athena/latest/ug/querying.html).
	ResultConfiguration *ResultConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup and whether workgroup settings override query settings, and the data usage limits for the amount of data scanned per query or per workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

func (WorkGroupConfiguration) GoString added in v1.17.0 

func (s WorkGroupConfiguration) GoString() string

GoString returns the string representation

func (*WorkGroupConfiguration) SetBytesScannedCutoffPerQuery added in v1.17.0 

func (s *WorkGroupConfiguration) SetBytesScannedCutoffPerQuery(v int64) *WorkGroupConfiguration

SetBytesScannedCutoffPerQuery sets the BytesScannedCutoffPerQuery field's value.

func (*WorkGroupConfiguration) SetEnforceWorkGroupConfiguration added in v1.17.0 

func (s *WorkGroupConfiguration) SetEnforceWorkGroupConfiguration(v bool) *WorkGroupConfiguration

SetEnforceWorkGroupConfiguration sets the EnforceWorkGroupConfiguration field's value.

func (*WorkGroupConfiguration) SetEngineVersion added in v1.37.4 

func (s *WorkGroupConfiguration) SetEngineVersion(v *EngineVersion) *WorkGroupConfiguration

SetEngineVersion sets the EngineVersion field's value.

func (*WorkGroupConfiguration) SetPublishCloudWatchMetricsEnabled added in v1.17.0 

func (s *WorkGroupConfiguration) SetPublishCloudWatchMetricsEnabled(v bool) *WorkGroupConfiguration

SetPublishCloudWatchMetricsEnabled sets the PublishCloudWatchMetricsEnabled field's value.

func (*WorkGroupConfiguration) SetRequesterPaysEnabled added in v1.23.2 

func (s *WorkGroupConfiguration) SetRequesterPaysEnabled(v bool) *WorkGroupConfiguration

SetRequesterPaysEnabled sets the RequesterPaysEnabled field's value.

func (*WorkGroupConfiguration) SetResultConfiguration added in v1.17.0 

func (s *WorkGroupConfiguration) SetResultConfiguration(v *ResultConfiguration) *WorkGroupConfiguration

SetResultConfiguration sets the ResultConfiguration field's value.

func (WorkGroupConfiguration) String added in v1.17.0 

func (s WorkGroupConfiguration) String() string

String returns the string representation

func (*WorkGroupConfiguration) Validate added in v1.17.0 

func (s *WorkGroupConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type WorkGroupConfigurationUpdates added in v1.17.0 

type WorkGroupConfigurationUpdates struct {

	// The upper limit (cutoff) for the amount of bytes a single query in a workgroup
	// is allowed to scan.
	BytesScannedCutoffPerQuery *int64 `min:"1e+07" type:"long"`

	// If set to "true", the settings for the workgroup override client-side settings.
	// If set to "false" client-side settings are used. For more information, see
	// Workgroup Settings Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html).
	EnforceWorkGroupConfiguration *bool `type:"boolean"`

	// The engine version requested when a workgroup is updated. After the update,
	// all queries on the workgroup run on the requested engine version. If no value
	// was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality
	// workgroup run on the preview engine regardless of this setting.
	EngineVersion *EngineVersion `type:"structure"`

	// Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
	PublishCloudWatchMetricsEnabled *bool `type:"boolean"`

	// Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery
	RemoveBytesScannedCutoffPerQuery *bool `type:"boolean"`

	// If set to true, allows members assigned to a workgroup to specify Amazon
	// S3 Requester Pays buckets in queries. If set to false, workgroup members
	// cannot query data from Requester Pays buckets, and queries that retrieve
	// data from Requester Pays buckets cause an error. The default is false. For
	// more information about Requester Pays buckets, see Requester Pays Buckets
	// (https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html)
	// in the Amazon Simple Storage Service Developer Guide.
	RequesterPaysEnabled *bool `type:"boolean"`

	// The result configuration information about the queries in this workgroup
	// that will be updated. Includes the updated results location and an updated
	// option for encrypting query results.
	ResultConfigurationUpdates *ResultConfigurationUpdates `type:"structure"`
	// contains filtered or unexported fields
}

The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.

func (WorkGroupConfigurationUpdates) GoString added in v1.17.0 

func (s WorkGroupConfigurationUpdates) GoString() string

GoString returns the string representation

func (*WorkGroupConfigurationUpdates) SetBytesScannedCutoffPerQuery added in v1.17.0 

func (s *WorkGroupConfigurationUpdates) SetBytesScannedCutoffPerQuery(v int64) *WorkGroupConfigurationUpdates

SetBytesScannedCutoffPerQuery sets the BytesScannedCutoffPerQuery field's value.

func (*WorkGroupConfigurationUpdates) SetEnforceWorkGroupConfiguration added in v1.17.0 

func (s *WorkGroupConfigurationUpdates) SetEnforceWorkGroupConfiguration(v bool) *WorkGroupConfigurationUpdates

SetEnforceWorkGroupConfiguration sets the EnforceWorkGroupConfiguration field's value.

func (*WorkGroupConfigurationUpdates) SetEngineVersion added in v1.37.4 

func (s *WorkGroupConfigurationUpdates) SetEngineVersion(v *EngineVersion) *WorkGroupConfigurationUpdates

SetEngineVersion sets the EngineVersion field's value.

func (*WorkGroupConfigurationUpdates) SetPublishCloudWatchMetricsEnabled added in v1.17.0 

func (s *WorkGroupConfigurationUpdates) SetPublishCloudWatchMetricsEnabled(v bool) *WorkGroupConfigurationUpdates

SetPublishCloudWatchMetricsEnabled sets the PublishCloudWatchMetricsEnabled field's value.

func (*WorkGroupConfigurationUpdates) SetRemoveBytesScannedCutoffPerQuery added in v1.17.0 

func (s *WorkGroupConfigurationUpdates) SetRemoveBytesScannedCutoffPerQuery(v bool) *WorkGroupConfigurationUpdates

SetRemoveBytesScannedCutoffPerQuery sets the RemoveBytesScannedCutoffPerQuery field's value.

func (*WorkGroupConfigurationUpdates) SetRequesterPaysEnabled added in v1.23.2 

func (s *WorkGroupConfigurationUpdates) SetRequesterPaysEnabled(v bool) *WorkGroupConfigurationUpdates

SetRequesterPaysEnabled sets the RequesterPaysEnabled field's value.

func (*WorkGroupConfigurationUpdates) SetResultConfigurationUpdates added in v1.17.0 

func (s *WorkGroupConfigurationUpdates) SetResultConfigurationUpdates(v *ResultConfigurationUpdates) *WorkGroupConfigurationUpdates

SetResultConfigurationUpdates sets the ResultConfigurationUpdates field's value.

func (WorkGroupConfigurationUpdates) String added in v1.17.0 

func (s WorkGroupConfigurationUpdates) String() string

String returns the string representation

func (*WorkGroupConfigurationUpdates) Validate added in v1.17.0 

func (s *WorkGroupConfigurationUpdates) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type WorkGroupSummary added in v1.17.0 

type WorkGroupSummary struct {

	// The workgroup creation date and time.
	CreationTime *time.Time `type:"timestamp"`

	// The workgroup description.
	Description *string `type:"string"`

	// The engine version setting for all queries on the workgroup. Queries on the
	// AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless
	// of this setting.
	EngineVersion *EngineVersion `type:"structure"`

	// The name of the workgroup.
	Name *string `type:"string"`

	// The state of the workgroup.
	State *string `type:"string" enum:"WorkGroupState"`
	// contains filtered or unexported fields
}

The summary information for the workgroup, which includes its name, state, description, and the date and time it was created.

func (WorkGroupSummary) GoString added in v1.17.0 

func (s WorkGroupSummary) GoString() string

GoString returns the string representation

func (*WorkGroupSummary) SetCreationTime added in v1.17.0 

func (s *WorkGroupSummary) SetCreationTime(v time.Time) *WorkGroupSummary

SetCreationTime sets the CreationTime field's value.

func (*WorkGroupSummary) SetDescription added in v1.17.0 

func (s *WorkGroupSummary) SetDescription(v string) *WorkGroupSummary

SetDescription sets the Description field's value.

func (*WorkGroupSummary) SetEngineVersion added in v1.37.4 

func (s *WorkGroupSummary) SetEngineVersion(v *EngineVersion) *WorkGroupSummary

SetEngineVersion sets the EngineVersion field's value.

func (*WorkGroupSummary) SetName added in v1.17.0 

func (s *WorkGroupSummary) SetName(v string) *WorkGroupSummary

SetName sets the Name field's value.

func (*WorkGroupSummary) SetState added in v1.17.0 

func (s *WorkGroupSummary) SetState(v string) *WorkGroupSummary

SetState sets the State field's value.

func (WorkGroupSummary) String added in v1.17.0 

func (s WorkGroupSummary) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package athenaiface provides an interface to enable mocking the Amazon Athena service client for testing your code.
 Package athenaiface provides an interface to enable mocking the Amazon Athena service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.