package athena
import "github.com/aws/aws-sdk-go-v2/service/athena"
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 use 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 for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/athena/#New
Index ¶
- Constants
- type BatchGetNamedQueryInput
- type BatchGetNamedQueryOutput
- type BatchGetNamedQueryRequest
- type BatchGetNamedQueryResponse
- type BatchGetQueryExecutionInput
- func (s BatchGetQueryExecutionInput) String() string
- func (s *BatchGetQueryExecutionInput) Validate() error
- type BatchGetQueryExecutionOutput
- type BatchGetQueryExecutionRequest
- type BatchGetQueryExecutionResponse
- type Client
- func New(config aws.Config) *Client
- func (c *Client) BatchGetNamedQueryRequest(input *BatchGetNamedQueryInput) BatchGetNamedQueryRequest
- func (c *Client) BatchGetQueryExecutionRequest(input *BatchGetQueryExecutionInput) BatchGetQueryExecutionRequest
- func (c *Client) CreateDataCatalogRequest(input *CreateDataCatalogInput) CreateDataCatalogRequest
- func (c *Client) CreateNamedQueryRequest(input *CreateNamedQueryInput) CreateNamedQueryRequest
- func (c *Client) CreateWorkGroupRequest(input *CreateWorkGroupInput) CreateWorkGroupRequest
- func (c *Client) DeleteDataCatalogRequest(input *DeleteDataCatalogInput) DeleteDataCatalogRequest
- func (c *Client) DeleteNamedQueryRequest(input *DeleteNamedQueryInput) DeleteNamedQueryRequest
- func (c *Client) DeleteWorkGroupRequest(input *DeleteWorkGroupInput) DeleteWorkGroupRequest
- func (c *Client) GetDataCatalogRequest(input *GetDataCatalogInput) GetDataCatalogRequest
- func (c *Client) GetDatabaseRequest(input *GetDatabaseInput) GetDatabaseRequest
- func (c *Client) GetNamedQueryRequest(input *GetNamedQueryInput) GetNamedQueryRequest
- func (c *Client) GetQueryExecutionRequest(input *GetQueryExecutionInput) GetQueryExecutionRequest
- func (c *Client) GetQueryResultsRequest(input *GetQueryResultsInput) GetQueryResultsRequest
- func (c *Client) GetTableMetadataRequest(input *GetTableMetadataInput) GetTableMetadataRequest
- func (c *Client) GetWorkGroupRequest(input *GetWorkGroupInput) GetWorkGroupRequest
- func (c *Client) ListDataCatalogsRequest(input *ListDataCatalogsInput) ListDataCatalogsRequest
- func (c *Client) ListDatabasesRequest(input *ListDatabasesInput) ListDatabasesRequest
- func (c *Client) ListNamedQueriesRequest(input *ListNamedQueriesInput) ListNamedQueriesRequest
- func (c *Client) ListQueryExecutionsRequest(input *ListQueryExecutionsInput) ListQueryExecutionsRequest
- func (c *Client) ListTableMetadataRequest(input *ListTableMetadataInput) ListTableMetadataRequest
- func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest
- func (c *Client) ListWorkGroupsRequest(input *ListWorkGroupsInput) ListWorkGroupsRequest
- func (c *Client) StartQueryExecutionRequest(input *StartQueryExecutionInput) StartQueryExecutionRequest
- func (c *Client) StopQueryExecutionRequest(input *StopQueryExecutionInput) StopQueryExecutionRequest
- func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest
- func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest
- func (c *Client) UpdateDataCatalogRequest(input *UpdateDataCatalogInput) UpdateDataCatalogRequest
- func (c *Client) UpdateWorkGroupRequest(input *UpdateWorkGroupInput) UpdateWorkGroupRequest
- type Column
- type ColumnInfo
- type ColumnNullable
- func (enum ColumnNullable) MarshalValue() (string, error)
- func (enum ColumnNullable) MarshalValueBuf(b []byte) ([]byte, error)
- type CreateDataCatalogInput
- type CreateDataCatalogOutput
- type CreateDataCatalogRequest
- type CreateDataCatalogResponse
- type CreateNamedQueryInput
- type CreateNamedQueryOutput
- type CreateNamedQueryRequest
- type CreateNamedQueryResponse
- type CreateWorkGroupInput
- type CreateWorkGroupOutput
- type CreateWorkGroupRequest
- type CreateWorkGroupResponse
- type DataCatalog
- type DataCatalogSummary
- type DataCatalogType
- func (enum DataCatalogType) MarshalValue() (string, error)
- func (enum DataCatalogType) MarshalValueBuf(b []byte) ([]byte, error)
- type Database
- type Datum
- type DeleteDataCatalogInput
- type DeleteDataCatalogOutput
- type DeleteDataCatalogRequest
- type DeleteDataCatalogResponse
- type DeleteNamedQueryInput
- type DeleteNamedQueryOutput
- type DeleteNamedQueryRequest
- type DeleteNamedQueryResponse
- type DeleteWorkGroupInput
- type DeleteWorkGroupOutput
- type DeleteWorkGroupRequest
- type DeleteWorkGroupResponse
- type EncryptionConfiguration
- type EncryptionOption
- func (enum EncryptionOption) MarshalValue() (string, error)
- func (enum EncryptionOption) MarshalValueBuf(b []byte) ([]byte, error)
- type GetDataCatalogInput
- type GetDataCatalogOutput
- type GetDataCatalogRequest
- type GetDataCatalogResponse
- type GetDatabaseInput
- type GetDatabaseOutput
- type GetDatabaseRequest
- type GetDatabaseResponse
- type GetNamedQueryInput
- type GetNamedQueryOutput
- type GetNamedQueryRequest
- type GetNamedQueryResponse
- type GetQueryExecutionInput
- type GetQueryExecutionOutput
- type GetQueryExecutionRequest
- type GetQueryExecutionResponse
- type GetQueryResultsInput
- type GetQueryResultsOutput
- type GetQueryResultsPaginator
- func NewGetQueryResultsPaginator(req GetQueryResultsRequest) GetQueryResultsPaginator
- func (p *GetQueryResultsPaginator) CurrentPage() *GetQueryResultsOutput
- type GetQueryResultsRequest
- type GetQueryResultsResponse
- type GetTableMetadataInput
- type GetTableMetadataOutput
- type GetTableMetadataRequest
- type GetTableMetadataResponse
- type GetWorkGroupInput
- type GetWorkGroupOutput
- type GetWorkGroupRequest
- type GetWorkGroupResponse
- type ListDataCatalogsInput
- type ListDataCatalogsOutput
- type ListDataCatalogsPaginator
- func NewListDataCatalogsPaginator(req ListDataCatalogsRequest) ListDataCatalogsPaginator
- func (p *ListDataCatalogsPaginator) CurrentPage() *ListDataCatalogsOutput
- type ListDataCatalogsRequest
- type ListDataCatalogsResponse
- type ListDatabasesInput
- type ListDatabasesOutput
- type ListDatabasesPaginator
- func NewListDatabasesPaginator(req ListDatabasesRequest) ListDatabasesPaginator
- func (p *ListDatabasesPaginator) CurrentPage() *ListDatabasesOutput
- type ListDatabasesRequest
- type ListDatabasesResponse
- type ListNamedQueriesInput
- type ListNamedQueriesOutput
- type ListNamedQueriesPaginator
- func NewListNamedQueriesPaginator(req ListNamedQueriesRequest) ListNamedQueriesPaginator
- func (p *ListNamedQueriesPaginator) CurrentPage() *ListNamedQueriesOutput
- type ListNamedQueriesRequest
- type ListNamedQueriesResponse
- type ListQueryExecutionsInput
- func (s ListQueryExecutionsInput) String() string
- func (s *ListQueryExecutionsInput) Validate() error
- type ListQueryExecutionsOutput
- type ListQueryExecutionsPaginator
- func NewListQueryExecutionsPaginator(req ListQueryExecutionsRequest) ListQueryExecutionsPaginator
- func (p *ListQueryExecutionsPaginator) CurrentPage() *ListQueryExecutionsOutput
- type ListQueryExecutionsRequest
- type ListQueryExecutionsResponse
- type ListTableMetadataInput
- type ListTableMetadataOutput
- type ListTableMetadataPaginator
- func NewListTableMetadataPaginator(req ListTableMetadataRequest) ListTableMetadataPaginator
- func (p *ListTableMetadataPaginator) CurrentPage() *ListTableMetadataOutput
- type ListTableMetadataRequest
- type ListTableMetadataResponse
- type ListTagsForResourceInput
- func (s ListTagsForResourceInput) String() string
- func (s *ListTagsForResourceInput) Validate() error
- type ListTagsForResourceOutput
- type ListTagsForResourcePaginator
- func NewListTagsForResourcePaginator(req ListTagsForResourceRequest) ListTagsForResourcePaginator
- func (p *ListTagsForResourcePaginator) CurrentPage() *ListTagsForResourceOutput
- type ListTagsForResourceRequest
- type ListTagsForResourceResponse
- type ListWorkGroupsInput
- type ListWorkGroupsOutput
- type ListWorkGroupsPaginator
- func NewListWorkGroupsPaginator(req ListWorkGroupsRequest) ListWorkGroupsPaginator
- func (p *ListWorkGroupsPaginator) CurrentPage() *ListWorkGroupsOutput
- type ListWorkGroupsRequest
- type ListWorkGroupsResponse
- type NamedQuery
- type QueryExecution
- type QueryExecutionContext
- type QueryExecutionState
- func (enum QueryExecutionState) MarshalValue() (string, error)
- func (enum QueryExecutionState) MarshalValueBuf(b []byte) ([]byte, error)
- type QueryExecutionStatistics
- type QueryExecutionStatus
- type ResultConfiguration
- type ResultConfigurationUpdates
- func (s ResultConfigurationUpdates) String() string
- func (s *ResultConfigurationUpdates) Validate() error
- type ResultSet
- type ResultSetMetadata
- type Row
- type StartQueryExecutionInput
- func (s StartQueryExecutionInput) String() string
- func (s *StartQueryExecutionInput) Validate() error
- type StartQueryExecutionOutput
- type StartQueryExecutionRequest
- type StartQueryExecutionResponse
- type StatementType
- func (enum StatementType) MarshalValue() (string, error)
- func (enum StatementType) MarshalValueBuf(b []byte) ([]byte, error)
- type StopQueryExecutionInput
- type StopQueryExecutionOutput
- type StopQueryExecutionRequest
- type StopQueryExecutionResponse
- type TableMetadata
- type Tag
- type TagResourceInput
- type TagResourceOutput
- type TagResourceRequest
- type TagResourceResponse
- type ThrottleReason
- func (enum ThrottleReason) MarshalValue() (string, error)
- func (enum ThrottleReason) MarshalValueBuf(b []byte) ([]byte, error)
- type UnprocessedNamedQueryId
- type UnprocessedQueryExecutionId
- type UntagResourceInput
- type UntagResourceOutput
- type UntagResourceRequest
- type UntagResourceResponse
- type UpdateDataCatalogInput
- type UpdateDataCatalogOutput
- type UpdateDataCatalogRequest
- type UpdateDataCatalogResponse
- type UpdateWorkGroupInput
- type UpdateWorkGroupOutput
- type UpdateWorkGroupRequest
- type UpdateWorkGroupResponse
- type WorkGroup
- type WorkGroupConfiguration
- type WorkGroupConfigurationUpdates
- func (s WorkGroupConfigurationUpdates) String() string
- func (s *WorkGroupConfigurationUpdates) Validate() error
- type WorkGroupState
- func (enum WorkGroupState) MarshalValue() (string, error)
- func (enum WorkGroupState) MarshalValueBuf(b []byte) ([]byte, error)
- type WorkGroupSummary
Constants ¶
const ( ServiceName = "Amazon Athena" // Service's name ServiceID = "Athena" // Service's identifier EndpointsID = "athena" // Service's Endpoint identifier )
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" )
Types ¶
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) 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) String ¶
func (s BatchGetNamedQueryOutput) String() string
String returns the string representation
type BatchGetNamedQueryRequest ¶
type BatchGetNamedQueryRequest struct { *aws.Request Input *BatchGetNamedQueryInput Copy func(*BatchGetNamedQueryInput) BatchGetNamedQueryRequest }
BatchGetNamedQueryRequest is the request type for the BatchGetNamedQuery API operation.
func (BatchGetNamedQueryRequest) Send ¶
func (r BatchGetNamedQueryRequest) Send(ctx context.Context) (*BatchGetNamedQueryResponse, error)
Send marshals and sends the BatchGetNamedQuery API request.
type BatchGetNamedQueryResponse ¶
type BatchGetNamedQueryResponse struct { *BatchGetNamedQueryOutput // contains filtered or unexported fields }
BatchGetNamedQueryResponse is the response type for the BatchGetNamedQuery API operation.
func (*BatchGetNamedQueryResponse) SDKResponseMetdata ¶
func (r *BatchGetNamedQueryResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the BatchGetNamedQuery request.
type BatchGetQueryExecutionInput ¶
type BatchGetQueryExecutionInput struct { // An array of query execution IDs. // // QueryExecutionIds is a required field QueryExecutionIds []string `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
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) String ¶
func (s BatchGetQueryExecutionOutput) String() string
String returns the string representation
type BatchGetQueryExecutionRequest ¶
type BatchGetQueryExecutionRequest struct { *aws.Request Input *BatchGetQueryExecutionInput Copy func(*BatchGetQueryExecutionInput) BatchGetQueryExecutionRequest }
BatchGetQueryExecutionRequest is the request type for the BatchGetQueryExecution API operation.
func (BatchGetQueryExecutionRequest) Send ¶
func (r BatchGetQueryExecutionRequest) Send(ctx context.Context) (*BatchGetQueryExecutionResponse, error)
Send marshals and sends the BatchGetQueryExecution API request.
type BatchGetQueryExecutionResponse ¶
type BatchGetQueryExecutionResponse struct { *BatchGetQueryExecutionOutput // contains filtered or unexported fields }
BatchGetQueryExecutionResponse is the response type for the BatchGetQueryExecution API operation.
func (*BatchGetQueryExecutionResponse) SDKResponseMetdata ¶
func (r *BatchGetQueryExecutionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the BatchGetQueryExecution request.
type Client ¶
Client provides the API operation methods for making requests to Amazon Athena. See this package's package overview docs for details on the service.
The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
New creates a new instance of the client from the provided Config.
Example:
// Create a client from just a config. svc := athena.New(myConfig)
func (*Client) BatchGetNamedQueryRequest ¶
func (c *Client) BatchGetNamedQueryRequest(input *BatchGetNamedQueryInput) BatchGetNamedQueryRequest
BatchGetNamedQueryRequest returns a request value for making API operation for Amazon Athena.
Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings. 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.
// Example sending a request using BatchGetNamedQueryRequest. req := client.BatchGetNamedQueryRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/BatchGetNamedQuery
func (*Client) BatchGetQueryExecutionRequest ¶
func (c *Client) BatchGetQueryExecutionRequest(input *BatchGetQueryExecutionInput) BatchGetQueryExecutionRequest
BatchGetQueryExecutionRequest returns a request value for making API operation for Amazon Athena.
Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. 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.
// Example sending a request using BatchGetQueryExecutionRequest. req := client.BatchGetQueryExecutionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/BatchGetQueryExecution
func (*Client) CreateDataCatalogRequest ¶
func (c *Client) CreateDataCatalogRequest(input *CreateDataCatalogInput) CreateDataCatalogRequest
CreateDataCatalogRequest returns a request value for making 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.
// Example sending a request using CreateDataCatalogRequest. req := client.CreateDataCatalogRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreateDataCatalog
func (*Client) CreateNamedQueryRequest ¶
func (c *Client) CreateNamedQueryRequest(input *CreateNamedQueryInput) CreateNamedQueryRequest
CreateNamedQueryRequest returns a request value for making 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.
// Example sending a request using CreateNamedQueryRequest. req := client.CreateNamedQueryRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreateNamedQuery
func (*Client) CreateWorkGroupRequest ¶
func (c *Client) CreateWorkGroupRequest(input *CreateWorkGroupInput) CreateWorkGroupRequest
CreateWorkGroupRequest returns a request value for making API operation for Amazon Athena.
Creates a workgroup with the specified name.
// Example sending a request using CreateWorkGroupRequest. req := client.CreateWorkGroupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreateWorkGroup
func (*Client) DeleteDataCatalogRequest ¶
func (c *Client) DeleteDataCatalogRequest(input *DeleteDataCatalogInput) DeleteDataCatalogRequest
DeleteDataCatalogRequest returns a request value for making API operation for Amazon Athena.
Deletes a data catalog.
// Example sending a request using DeleteDataCatalogRequest. req := client.DeleteDataCatalogRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/DeleteDataCatalog
func (*Client) DeleteNamedQueryRequest ¶
func (c *Client) DeleteNamedQueryRequest(input *DeleteNamedQueryInput) DeleteNamedQueryRequest
DeleteNamedQueryRequest returns a request value for making 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.
// Example sending a request using DeleteNamedQueryRequest. req := client.DeleteNamedQueryRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/DeleteNamedQuery
func (*Client) DeleteWorkGroupRequest ¶
func (c *Client) DeleteWorkGroupRequest(input *DeleteWorkGroupInput) DeleteWorkGroupRequest
DeleteWorkGroupRequest returns a request value for making API operation for Amazon Athena.
Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.
// Example sending a request using DeleteWorkGroupRequest. req := client.DeleteWorkGroupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/DeleteWorkGroup
func (*Client) GetDataCatalogRequest ¶
func (c *Client) GetDataCatalogRequest(input *GetDataCatalogInput) GetDataCatalogRequest
GetDataCatalogRequest returns a request value for making API operation for Amazon Athena.
Returns the specified data catalog.
// Example sending a request using GetDataCatalogRequest. req := client.GetDataCatalogRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetDataCatalog
func (*Client) GetDatabaseRequest ¶
func (c *Client) GetDatabaseRequest(input *GetDatabaseInput) GetDatabaseRequest
GetDatabaseRequest returns a request value for making API operation for Amazon Athena.
Returns a database object for the specfied database and data catalog.
// Example sending a request using GetDatabaseRequest. req := client.GetDatabaseRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetDatabase
func (*Client) GetNamedQueryRequest ¶
func (c *Client) GetNamedQueryRequest(input *GetNamedQueryInput) GetNamedQueryRequest
GetNamedQueryRequest returns a request value for making 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.
// Example sending a request using GetNamedQueryRequest. req := client.GetNamedQueryRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetNamedQuery
func (*Client) GetQueryExecutionRequest ¶
func (c *Client) GetQueryExecutionRequest(input *GetQueryExecutionInput) GetQueryExecutionRequest
GetQueryExecutionRequest returns a request value for making API operation for Amazon Athena.
Returns information about a single execution of a query 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.
// Example sending a request using GetQueryExecutionRequest. req := client.GetQueryExecutionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetQueryExecution
func (*Client) GetQueryResultsRequest ¶
func (c *Client) GetQueryResultsRequest(input *GetQueryResultsInput) GetQueryResultsRequest
GetQueryResultsRequest returns a request value for making 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.
// Example sending a request using GetQueryResultsRequest. req := client.GetQueryResultsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetQueryResults
func (*Client) GetTableMetadataRequest ¶
func (c *Client) GetTableMetadataRequest(input *GetTableMetadataInput) GetTableMetadataRequest
GetTableMetadataRequest returns a request value for making API operation for Amazon Athena.
Returns table metadata for the specified catalog, database, and table.
// Example sending a request using GetTableMetadataRequest. req := client.GetTableMetadataRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetTableMetadata
func (*Client) GetWorkGroupRequest ¶
func (c *Client) GetWorkGroupRequest(input *GetWorkGroupInput) GetWorkGroupRequest
GetWorkGroupRequest returns a request value for making API operation for Amazon Athena.
Returns information about the workgroup with the specified name.
// Example sending a request using GetWorkGroupRequest. req := client.GetWorkGroupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetWorkGroup
func (*Client) ListDataCatalogsRequest ¶
func (c *Client) ListDataCatalogsRequest(input *ListDataCatalogsInput) ListDataCatalogsRequest
ListDataCatalogsRequest returns a request value for making API operation for Amazon Athena.
Lists the data catalogs in the current AWS account.
// Example sending a request using ListDataCatalogsRequest. req := client.ListDataCatalogsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListDataCatalogs
func (*Client) ListDatabasesRequest ¶
func (c *Client) ListDatabasesRequest(input *ListDatabasesInput) ListDatabasesRequest
ListDatabasesRequest returns a request value for making API operation for Amazon Athena.
Lists the databases in the specified data catalog.
// Example sending a request using ListDatabasesRequest. req := client.ListDatabasesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListDatabases
func (*Client) ListNamedQueriesRequest ¶
func (c *Client) ListNamedQueriesRequest(input *ListNamedQueriesInput) ListNamedQueriesRequest
ListNamedQueriesRequest returns a request value for making 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.
// Example sending a request using ListNamedQueriesRequest. req := client.ListNamedQueriesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListNamedQueries
func (*Client) ListQueryExecutionsRequest ¶
func (c *Client) ListQueryExecutionsRequest(input *ListQueryExecutionsInput) ListQueryExecutionsRequest
ListQueryExecutionsRequest returns a request value for making 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.
// Example sending a request using ListQueryExecutionsRequest. req := client.ListQueryExecutionsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListQueryExecutions
func (*Client) ListTableMetadataRequest ¶
func (c *Client) ListTableMetadataRequest(input *ListTableMetadataInput) ListTableMetadataRequest
ListTableMetadataRequest returns a request value for making API operation for Amazon Athena.
Lists the metadata for the tables in the specified data catalog database.
// Example sending a request using ListTableMetadataRequest. req := client.ListTableMetadataRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListTableMetadata
func (*Client) ListTagsForResourceRequest ¶
func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest
ListTagsForResourceRequest returns a request value for making API operation for Amazon Athena.
Lists the tags associated with an Athena workgroup or data catalog resource.
// Example sending a request using ListTagsForResourceRequest. req := client.ListTagsForResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListTagsForResource
func (*Client) ListWorkGroupsRequest ¶
func (c *Client) ListWorkGroupsRequest(input *ListWorkGroupsInput) ListWorkGroupsRequest
ListWorkGroupsRequest returns a request value for making API operation for Amazon Athena.
Lists available workgroups for the account.
// Example sending a request using ListWorkGroupsRequest. req := client.ListWorkGroupsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListWorkGroups
func (*Client) StartQueryExecutionRequest ¶
func (c *Client) StartQueryExecutionRequest(input *StartQueryExecutionInput) StartQueryExecutionRequest
StartQueryExecutionRequest returns a request value for making 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.
// Example sending a request using StartQueryExecutionRequest. req := client.StartQueryExecutionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StartQueryExecution
func (*Client) StopQueryExecutionRequest ¶
func (c *Client) StopQueryExecutionRequest(input *StopQueryExecutionInput) StopQueryExecutionRequest
StopQueryExecutionRequest returns a request value for making 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.
// Example sending a request using StopQueryExecutionRequest. req := client.StopQueryExecutionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StopQueryExecution
func (*Client) TagResourceRequest ¶
func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest
TagResourceRequest returns a request value for making 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.
// Example sending a request using TagResourceRequest. req := client.TagResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/TagResource
func (*Client) UntagResourceRequest ¶
func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest
UntagResourceRequest returns a request value for making API operation for Amazon Athena.
Removes one or more tags from a data catalog or workgroup resource.
// Example sending a request using UntagResourceRequest. req := client.UntagResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UntagResource
func (*Client) UpdateDataCatalogRequest ¶
func (c *Client) UpdateDataCatalogRequest(input *UpdateDataCatalogInput) UpdateDataCatalogRequest
UpdateDataCatalogRequest returns a request value for making API operation for Amazon Athena.
Updates the data catalog that has the specified name.
// Example sending a request using UpdateDataCatalogRequest. req := client.UpdateDataCatalogRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateDataCatalog
func (*Client) UpdateWorkGroupRequest ¶
func (c *Client) UpdateWorkGroupRequest(input *UpdateWorkGroupInput) UpdateWorkGroupRequest
UpdateWorkGroupRequest returns a request value for making API operation for Amazon Athena.
Updates the workgroup with the specified name. The workgroup's name cannot be changed.
// Example sending a request using UpdateWorkGroupRequest. req := client.UpdateWorkGroupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateWorkGroup
type Column ¶
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) 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 ColumnNullable `type:"string" enum:"true"` // For DECIMAL data types, specifies the total number of digits, up to 38. For // performance reasons, we recommend up to 18 digits. Precision *int64 `type:"integer"` // For DECIMAL data types, specifies the total number of digits in the fractional // part of the value. Defaults to 0. Scale *int64 `type:"integer"` // The schema name (database name) to which the query results belong. SchemaName *string `type:"string"` // The table name for the query results. TableName *string `type:"string"` // The data type of the column. // // Type is a required field Type *string `type:"string" required:"true"` // contains filtered or unexported fields }
Information about the columns in a query execution result.
func (ColumnInfo) String ¶
func (s ColumnInfo) String() string
String returns the string representation
type ColumnNullable ¶
type ColumnNullable string
const ( ColumnNullableNotNull ColumnNullable = "NOT_NULL" ColumnNullableNullable ColumnNullable = "NULLABLE" ColumnNullableUnknown ColumnNullable = "UNKNOWN" )
Enum values for ColumnNullable
func (ColumnNullable) MarshalValue ¶
func (enum ColumnNullable) MarshalValue() (string, error)
func (ColumnNullable) MarshalValueBuf ¶
func (enum ColumnNullable) MarshalValueBuf(b []byte) ([]byte, error)
type CreateDataCatalogInput ¶
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 // // * The GLUE type has no parameters. 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, GLUE // for AWS Glue Catalog, or HIVE for an external hive metastore. // // Type is a required field Type DataCatalogType `type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
func (CreateDataCatalogInput) String ¶
func (s CreateDataCatalogInput) String() string
String returns the string representation
func (*CreateDataCatalogInput) Validate ¶
func (s *CreateDataCatalogInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateDataCatalogOutput ¶
type CreateDataCatalogOutput struct {
// contains filtered or unexported fields
}
func (CreateDataCatalogOutput) String ¶
func (s CreateDataCatalogOutput) String() string
String returns the string representation
type CreateDataCatalogRequest ¶
type CreateDataCatalogRequest struct { *aws.Request Input *CreateDataCatalogInput Copy func(*CreateDataCatalogInput) CreateDataCatalogRequest }
CreateDataCatalogRequest is the request type for the CreateDataCatalog API operation.
func (CreateDataCatalogRequest) Send ¶
func (r CreateDataCatalogRequest) Send(ctx context.Context) (*CreateDataCatalogResponse, error)
Send marshals and sends the CreateDataCatalog API request.
type CreateDataCatalogResponse ¶
type CreateDataCatalogResponse struct { *CreateDataCatalogOutput // contains filtered or unexported fields }
CreateDataCatalogResponse is the response type for the CreateDataCatalog API operation.
func (*CreateDataCatalogResponse) SDKResponseMetdata ¶
func (r *CreateDataCatalogResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateDataCatalog request.
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) 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) String ¶
func (s CreateNamedQueryOutput) String() string
String returns the string representation
type CreateNamedQueryRequest ¶
type CreateNamedQueryRequest struct { *aws.Request Input *CreateNamedQueryInput Copy func(*CreateNamedQueryInput) CreateNamedQueryRequest }
CreateNamedQueryRequest is the request type for the CreateNamedQuery API operation.
func (CreateNamedQueryRequest) Send ¶
func (r CreateNamedQueryRequest) Send(ctx context.Context) (*CreateNamedQueryResponse, error)
Send marshals and sends the CreateNamedQuery API request.
type CreateNamedQueryResponse ¶
type CreateNamedQueryResponse struct { *CreateNamedQueryOutput // contains filtered or unexported fields }
CreateNamedQueryResponse is the response type for the CreateNamedQuery API operation.
func (*CreateNamedQueryResponse) SDKResponseMetdata ¶
func (r *CreateNamedQueryResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateNamedQuery request.
type CreateWorkGroupInput ¶
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) String ¶
func (s CreateWorkGroupInput) String() string
String returns the string representation
func (*CreateWorkGroupInput) Validate ¶
func (s *CreateWorkGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateWorkGroupOutput ¶
type CreateWorkGroupOutput struct {
// contains filtered or unexported fields
}
func (CreateWorkGroupOutput) String ¶
func (s CreateWorkGroupOutput) String() string
String returns the string representation
type CreateWorkGroupRequest ¶
type CreateWorkGroupRequest struct { *aws.Request Input *CreateWorkGroupInput Copy func(*CreateWorkGroupInput) CreateWorkGroupRequest }
CreateWorkGroupRequest is the request type for the CreateWorkGroup API operation.
func (CreateWorkGroupRequest) Send ¶
func (r CreateWorkGroupRequest) Send(ctx context.Context) (*CreateWorkGroupResponse, error)
Send marshals and sends the CreateWorkGroup API request.
type CreateWorkGroupResponse ¶
type CreateWorkGroupResponse struct { *CreateWorkGroupOutput // contains filtered or unexported fields }
CreateWorkGroupResponse is the response type for the CreateWorkGroup API operation.
func (*CreateWorkGroupResponse) SDKResponseMetdata ¶
func (r *CreateWorkGroupResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateWorkGroup request.
type DataCatalog ¶
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 // // * The GLUE type has no parameters. Parameters map[string]string `type:"map"` // The type of data catalog: LAMBDA for a federated catalog, GLUE for AWS Glue // Catalog, or HIVE for an external hive metastore. // // Type is a required field Type DataCatalogType `type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Contains information about a data catalog in an AWS account.
func (DataCatalog) String ¶
func (s DataCatalog) String() string
String returns the string representation
type DataCatalogSummary ¶
type DataCatalogSummary struct { // The name of the data catalog. CatalogName *string `min:"1" type:"string"` // The data catalog type. Type DataCatalogType `type:"string" enum:"true"` // contains filtered or unexported fields }
The summary information for the data catalog, which includes its name and type.
func (DataCatalogSummary) String ¶
func (s DataCatalogSummary) String() string
String returns the string representation
type DataCatalogType ¶
type DataCatalogType string
const ( DataCatalogTypeLambda DataCatalogType = "LAMBDA" DataCatalogTypeGlue DataCatalogType = "GLUE" DataCatalogTypeHive DataCatalogType = "HIVE" )
Enum values for DataCatalogType
func (DataCatalogType) MarshalValue ¶
func (enum DataCatalogType) MarshalValue() (string, error)
func (DataCatalogType) MarshalValueBuf ¶
func (enum DataCatalogType) MarshalValueBuf(b []byte) ([]byte, error)
type Database ¶
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) 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) String ¶
String returns the string representation
type DeleteDataCatalogInput ¶
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) String ¶
func (s DeleteDataCatalogInput) String() string
String returns the string representation
func (*DeleteDataCatalogInput) Validate ¶
func (s *DeleteDataCatalogInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteDataCatalogOutput ¶
type DeleteDataCatalogOutput struct {
// contains filtered or unexported fields
}
func (DeleteDataCatalogOutput) String ¶
func (s DeleteDataCatalogOutput) String() string
String returns the string representation
type DeleteDataCatalogRequest ¶
type DeleteDataCatalogRequest struct { *aws.Request Input *DeleteDataCatalogInput Copy func(*DeleteDataCatalogInput) DeleteDataCatalogRequest }
DeleteDataCatalogRequest is the request type for the DeleteDataCatalog API operation.
func (DeleteDataCatalogRequest) Send ¶
func (r DeleteDataCatalogRequest) Send(ctx context.Context) (*DeleteDataCatalogResponse, error)
Send marshals and sends the DeleteDataCatalog API request.
type DeleteDataCatalogResponse ¶
type DeleteDataCatalogResponse struct { *DeleteDataCatalogOutput // contains filtered or unexported fields }
DeleteDataCatalogResponse is the response type for the DeleteDataCatalog API operation.
func (*DeleteDataCatalogResponse) SDKResponseMetdata ¶
func (r *DeleteDataCatalogResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteDataCatalog request.
type DeleteNamedQueryInput ¶
type DeleteNamedQueryInput struct { // The unique ID of the query to delete. // // NamedQueryId is a required field NamedQueryId *string `type:"string" required:"true" idempotencyToken:"true"` // contains filtered or unexported fields }
func (DeleteNamedQueryInput) String ¶
func (s DeleteNamedQueryInput) String() string
String returns the string representation
func (*DeleteNamedQueryInput) Validate ¶
func (s *DeleteNamedQueryInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteNamedQueryOutput ¶
type DeleteNamedQueryOutput struct {
// contains filtered or unexported fields
}
func (DeleteNamedQueryOutput) String ¶
func (s DeleteNamedQueryOutput) String() string
String returns the string representation
type DeleteNamedQueryRequest ¶
type DeleteNamedQueryRequest struct { *aws.Request Input *DeleteNamedQueryInput Copy func(*DeleteNamedQueryInput) DeleteNamedQueryRequest }
DeleteNamedQueryRequest is the request type for the DeleteNamedQuery API operation.
func (DeleteNamedQueryRequest) Send ¶
func (r DeleteNamedQueryRequest) Send(ctx context.Context) (*DeleteNamedQueryResponse, error)
Send marshals and sends the DeleteNamedQuery API request.
type DeleteNamedQueryResponse ¶
type DeleteNamedQueryResponse struct { *DeleteNamedQueryOutput // contains filtered or unexported fields }
DeleteNamedQueryResponse is the response type for the DeleteNamedQuery API operation.
func (*DeleteNamedQueryResponse) SDKResponseMetdata ¶
func (r *DeleteNamedQueryResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteNamedQuery request.
type DeleteWorkGroupInput ¶
type DeleteWorkGroupInput struct { // The option to delete the workgroup and its contents even if the workgroup // contains any named queries. RecursiveDeleteOption *bool `type:"boolean"` // The unique name of the workgroup to delete. // // WorkGroup is a required field WorkGroup *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteWorkGroupInput) String ¶
func (s DeleteWorkGroupInput) String() string
String returns the string representation
func (*DeleteWorkGroupInput) Validate ¶
func (s *DeleteWorkGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteWorkGroupOutput ¶
type DeleteWorkGroupOutput struct {
// contains filtered or unexported fields
}
func (DeleteWorkGroupOutput) String ¶
func (s DeleteWorkGroupOutput) String() string
String returns the string representation
type DeleteWorkGroupRequest ¶
type DeleteWorkGroupRequest struct { *aws.Request Input *DeleteWorkGroupInput Copy func(*DeleteWorkGroupInput) DeleteWorkGroupRequest }
DeleteWorkGroupRequest is the request type for the DeleteWorkGroup API operation.
func (DeleteWorkGroupRequest) Send ¶
func (r DeleteWorkGroupRequest) Send(ctx context.Context) (*DeleteWorkGroupResponse, error)
Send marshals and sends the DeleteWorkGroup API request.
type DeleteWorkGroupResponse ¶
type DeleteWorkGroupResponse struct { *DeleteWorkGroupOutput // contains filtered or unexported fields }
DeleteWorkGroupResponse is the response type for the DeleteWorkGroup API operation.
func (*DeleteWorkGroupResponse) SDKResponseMetdata ¶
func (r *DeleteWorkGroupResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteWorkGroup request.
type EncryptionConfiguration ¶
type EncryptionConfiguration struct { // Indicates whether Amazon S3 server-side encryption with Amazon S3-managed // keys (SSE-S3), server-side encryption with KMS-managed keys (SSE-KMS), or // client-side encryption with KMS-managed keys (CSE-KMS) is used. // // 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 EncryptionOption `type:"string" required:"true" enum:"true"` // For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID. KmsKey *string `type:"string"` // contains filtered or unexported fields }
If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE-KMS or CSE-KMS) and key information.
func (EncryptionConfiguration) String ¶
func (s EncryptionConfiguration) String() string
String returns the string representation
func (*EncryptionConfiguration) Validate ¶
func (s *EncryptionConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type EncryptionOption ¶
type EncryptionOption string
const ( EncryptionOptionSseS3 EncryptionOption = "SSE_S3" EncryptionOptionSseKms EncryptionOption = "SSE_KMS" EncryptionOptionCseKms EncryptionOption = "CSE_KMS" )
Enum values for EncryptionOption
func (EncryptionOption) MarshalValue ¶
func (enum EncryptionOption) MarshalValue() (string, error)
func (EncryptionOption) MarshalValueBuf ¶
func (enum EncryptionOption) MarshalValueBuf(b []byte) ([]byte, error)
type GetDataCatalogInput ¶
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) String ¶
func (s GetDataCatalogInput) String() string
String returns the string representation
func (*GetDataCatalogInput) Validate ¶
func (s *GetDataCatalogInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDataCatalogOutput ¶
type GetDataCatalogOutput struct { // The data catalog returned. DataCatalog *DataCatalog `type:"structure"` // contains filtered or unexported fields }
func (GetDataCatalogOutput) String ¶
func (s GetDataCatalogOutput) String() string
String returns the string representation
type GetDataCatalogRequest ¶
type GetDataCatalogRequest struct { *aws.Request Input *GetDataCatalogInput Copy func(*GetDataCatalogInput) GetDataCatalogRequest }
GetDataCatalogRequest is the request type for the GetDataCatalog API operation.
func (GetDataCatalogRequest) Send ¶
func (r GetDataCatalogRequest) Send(ctx context.Context) (*GetDataCatalogResponse, error)
Send marshals and sends the GetDataCatalog API request.
type GetDataCatalogResponse ¶
type GetDataCatalogResponse struct { *GetDataCatalogOutput // contains filtered or unexported fields }
GetDataCatalogResponse is the response type for the GetDataCatalog API operation.
func (*GetDataCatalogResponse) SDKResponseMetdata ¶
func (r *GetDataCatalogResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetDataCatalog request.
type GetDatabaseInput ¶
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) String ¶
func (s GetDatabaseInput) String() string
String returns the string representation
func (*GetDatabaseInput) Validate ¶
func (s *GetDatabaseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDatabaseOutput ¶
type GetDatabaseOutput struct { // The database returned. Database *Database `type:"structure"` // contains filtered or unexported fields }
func (GetDatabaseOutput) String ¶
func (s GetDatabaseOutput) String() string
String returns the string representation
type GetDatabaseRequest ¶
type GetDatabaseRequest struct { *aws.Request Input *GetDatabaseInput Copy func(*GetDatabaseInput) GetDatabaseRequest }
GetDatabaseRequest is the request type for the GetDatabase API operation.
func (GetDatabaseRequest) Send ¶
func (r GetDatabaseRequest) Send(ctx context.Context) (*GetDatabaseResponse, error)
Send marshals and sends the GetDatabase API request.
type GetDatabaseResponse ¶
type GetDatabaseResponse struct { *GetDatabaseOutput // contains filtered or unexported fields }
GetDatabaseResponse is the response type for the GetDatabase API operation.
func (*GetDatabaseResponse) SDKResponseMetdata ¶
func (r *GetDatabaseResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetDatabase request.
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) 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) String ¶
func (s GetNamedQueryOutput) String() string
String returns the string representation
type GetNamedQueryRequest ¶
type GetNamedQueryRequest struct { *aws.Request Input *GetNamedQueryInput Copy func(*GetNamedQueryInput) GetNamedQueryRequest }
GetNamedQueryRequest is the request type for the GetNamedQuery API operation.
func (GetNamedQueryRequest) Send ¶
func (r GetNamedQueryRequest) Send(ctx context.Context) (*GetNamedQueryResponse, error)
Send marshals and sends the GetNamedQuery API request.
type GetNamedQueryResponse ¶
type GetNamedQueryResponse struct { *GetNamedQueryOutput // contains filtered or unexported fields }
GetNamedQueryResponse is the response type for the GetNamedQuery API operation.
func (*GetNamedQueryResponse) SDKResponseMetdata ¶
func (r *GetNamedQueryResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetNamedQuery request.
type GetQueryExecutionInput ¶
type GetQueryExecutionInput struct { // The unique ID of the query execution. // // QueryExecutionId is a required field QueryExecutionId *string `type:"string" required:"true"` // contains filtered or unexported fields }
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) String ¶
func (s GetQueryExecutionOutput) String() string
String returns the string representation
type GetQueryExecutionRequest ¶
type GetQueryExecutionRequest struct { *aws.Request Input *GetQueryExecutionInput Copy func(*GetQueryExecutionInput) GetQueryExecutionRequest }
GetQueryExecutionRequest is the request type for the GetQueryExecution API operation.
func (GetQueryExecutionRequest) Send ¶
func (r GetQueryExecutionRequest) Send(ctx context.Context) (*GetQueryExecutionResponse, error)
Send marshals and sends the GetQueryExecution API request.
type GetQueryExecutionResponse ¶
type GetQueryExecutionResponse struct { *GetQueryExecutionOutput // contains filtered or unexported fields }
GetQueryExecutionResponse is the response type for the GetQueryExecution API operation.
func (*GetQueryExecutionResponse) SDKResponseMetdata ¶
func (r *GetQueryExecutionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetQueryExecution request.
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) 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) String ¶
func (s GetQueryResultsOutput) String() string
String returns the string representation
type GetQueryResultsPaginator ¶
GetQueryResultsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewGetQueryResultsPaginator ¶
func NewGetQueryResultsPaginator(req GetQueryResultsRequest) GetQueryResultsPaginator
NewGetQueryResultsRequestPaginator returns a paginator for GetQueryResults. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.GetQueryResultsRequest(input) p := athena.NewGetQueryResultsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*GetQueryResultsPaginator) CurrentPage ¶
func (p *GetQueryResultsPaginator) CurrentPage() *GetQueryResultsOutput
type GetQueryResultsRequest ¶
type GetQueryResultsRequest struct { *aws.Request Input *GetQueryResultsInput Copy func(*GetQueryResultsInput) GetQueryResultsRequest }
GetQueryResultsRequest is the request type for the GetQueryResults API operation.
func (GetQueryResultsRequest) Send ¶
func (r GetQueryResultsRequest) Send(ctx context.Context) (*GetQueryResultsResponse, error)
Send marshals and sends the GetQueryResults API request.
type GetQueryResultsResponse ¶
type GetQueryResultsResponse struct { *GetQueryResultsOutput // contains filtered or unexported fields }
GetQueryResultsResponse is the response type for the GetQueryResults API operation.
func (*GetQueryResultsResponse) SDKResponseMetdata ¶
func (r *GetQueryResultsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetQueryResults request.
type GetTableMetadataInput ¶
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) String ¶
func (s GetTableMetadataInput) String() string
String returns the string representation
func (*GetTableMetadataInput) Validate ¶
func (s *GetTableMetadataInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetTableMetadataOutput ¶
type GetTableMetadataOutput struct { // An object that contains table metadata. TableMetadata *TableMetadata `type:"structure"` // contains filtered or unexported fields }
func (GetTableMetadataOutput) String ¶
func (s GetTableMetadataOutput) String() string
String returns the string representation
type GetTableMetadataRequest ¶
type GetTableMetadataRequest struct { *aws.Request Input *GetTableMetadataInput Copy func(*GetTableMetadataInput) GetTableMetadataRequest }
GetTableMetadataRequest is the request type for the GetTableMetadata API operation.
func (GetTableMetadataRequest) Send ¶
func (r GetTableMetadataRequest) Send(ctx context.Context) (*GetTableMetadataResponse, error)
Send marshals and sends the GetTableMetadata API request.
type GetTableMetadataResponse ¶
type GetTableMetadataResponse struct { *GetTableMetadataOutput // contains filtered or unexported fields }
GetTableMetadataResponse is the response type for the GetTableMetadata API operation.
func (*GetTableMetadataResponse) SDKResponseMetdata ¶
func (r *GetTableMetadataResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetTableMetadata request.
type GetWorkGroupInput ¶
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) String ¶
func (s GetWorkGroupInput) String() string
String returns the string representation
func (*GetWorkGroupInput) Validate ¶
func (s *GetWorkGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetWorkGroupOutput ¶
type GetWorkGroupOutput struct { // Information about the workgroup. WorkGroup *WorkGroup `type:"structure"` // contains filtered or unexported fields }
func (GetWorkGroupOutput) String ¶
func (s GetWorkGroupOutput) String() string
String returns the string representation
type GetWorkGroupRequest ¶
type GetWorkGroupRequest struct { *aws.Request Input *GetWorkGroupInput Copy func(*GetWorkGroupInput) GetWorkGroupRequest }
GetWorkGroupRequest is the request type for the GetWorkGroup API operation.
func (GetWorkGroupRequest) Send ¶
func (r GetWorkGroupRequest) Send(ctx context.Context) (*GetWorkGroupResponse, error)
Send marshals and sends the GetWorkGroup API request.
type GetWorkGroupResponse ¶
type GetWorkGroupResponse struct { *GetWorkGroupOutput // contains filtered or unexported fields }
GetWorkGroupResponse is the response type for the GetWorkGroup API operation.
func (*GetWorkGroupResponse) SDKResponseMetdata ¶
func (r *GetWorkGroupResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetWorkGroup request.
type ListDataCatalogsInput ¶
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) String ¶
func (s ListDataCatalogsInput) String() string
String returns the string representation
func (*ListDataCatalogsInput) Validate ¶
func (s *ListDataCatalogsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListDataCatalogsOutput ¶
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) String ¶
func (s ListDataCatalogsOutput) String() string
String returns the string representation
type ListDataCatalogsPaginator ¶
ListDataCatalogsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListDataCatalogsPaginator ¶
func NewListDataCatalogsPaginator(req ListDataCatalogsRequest) ListDataCatalogsPaginator
NewListDataCatalogsRequestPaginator returns a paginator for ListDataCatalogs. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListDataCatalogsRequest(input) p := athena.NewListDataCatalogsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListDataCatalogsPaginator) CurrentPage ¶
func (p *ListDataCatalogsPaginator) CurrentPage() *ListDataCatalogsOutput
type ListDataCatalogsRequest ¶
type ListDataCatalogsRequest struct { *aws.Request Input *ListDataCatalogsInput Copy func(*ListDataCatalogsInput) ListDataCatalogsRequest }
ListDataCatalogsRequest is the request type for the ListDataCatalogs API operation.
func (ListDataCatalogsRequest) Send ¶
func (r ListDataCatalogsRequest) Send(ctx context.Context) (*ListDataCatalogsResponse, error)
Send marshals and sends the ListDataCatalogs API request.
type ListDataCatalogsResponse ¶
type ListDataCatalogsResponse struct { *ListDataCatalogsOutput // contains filtered or unexported fields }
ListDataCatalogsResponse is the response type for the ListDataCatalogs API operation.
func (*ListDataCatalogsResponse) SDKResponseMetdata ¶
func (r *ListDataCatalogsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListDataCatalogs request.
type ListDatabasesInput ¶
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) String ¶
func (s ListDatabasesInput) String() string
String returns the string representation
func (*ListDatabasesInput) Validate ¶
func (s *ListDatabasesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListDatabasesOutput ¶
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) String ¶
func (s ListDatabasesOutput) String() string
String returns the string representation
type ListDatabasesPaginator ¶
ListDatabasesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListDatabasesPaginator ¶
func NewListDatabasesPaginator(req ListDatabasesRequest) ListDatabasesPaginator
NewListDatabasesRequestPaginator returns a paginator for ListDatabases. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListDatabasesRequest(input) p := athena.NewListDatabasesRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListDatabasesPaginator) CurrentPage ¶
func (p *ListDatabasesPaginator) CurrentPage() *ListDatabasesOutput
type ListDatabasesRequest ¶
type ListDatabasesRequest struct { *aws.Request Input *ListDatabasesInput Copy func(*ListDatabasesInput) ListDatabasesRequest }
ListDatabasesRequest is the request type for the ListDatabases API operation.
func (ListDatabasesRequest) Send ¶
func (r ListDatabasesRequest) Send(ctx context.Context) (*ListDatabasesResponse, error)
Send marshals and sends the ListDatabases API request.
type ListDatabasesResponse ¶
type ListDatabasesResponse struct { *ListDatabasesOutput // contains filtered or unexported fields }
ListDatabasesResponse is the response type for the ListDatabases API operation.
func (*ListDatabasesResponse) SDKResponseMetdata ¶
func (r *ListDatabasesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListDatabases request.
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) String ¶
func (s ListNamedQueriesInput) String() string
String returns the string representation
func (*ListNamedQueriesInput) Validate ¶
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) String ¶
func (s ListNamedQueriesOutput) String() string
String returns the string representation
type ListNamedQueriesPaginator ¶
ListNamedQueriesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListNamedQueriesPaginator ¶
func NewListNamedQueriesPaginator(req ListNamedQueriesRequest) ListNamedQueriesPaginator
NewListNamedQueriesRequestPaginator returns a paginator for ListNamedQueries. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListNamedQueriesRequest(input) p := athena.NewListNamedQueriesRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListNamedQueriesPaginator) CurrentPage ¶
func (p *ListNamedQueriesPaginator) CurrentPage() *ListNamedQueriesOutput
type ListNamedQueriesRequest ¶
type ListNamedQueriesRequest struct { *aws.Request Input *ListNamedQueriesInput Copy func(*ListNamedQueriesInput) ListNamedQueriesRequest }
ListNamedQueriesRequest is the request type for the ListNamedQueries API operation.
func (ListNamedQueriesRequest) Send ¶
func (r ListNamedQueriesRequest) Send(ctx context.Context) (*ListNamedQueriesResponse, error)
Send marshals and sends the ListNamedQueries API request.
type ListNamedQueriesResponse ¶
type ListNamedQueriesResponse struct { *ListNamedQueriesOutput // contains filtered or unexported fields }
ListNamedQueriesResponse is the response type for the ListNamedQueries API operation.
func (*ListNamedQueriesResponse) SDKResponseMetdata ¶
func (r *ListNamedQueriesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListNamedQueries request.
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) String ¶
func (s ListQueryExecutionsInput) String() string
String returns the string representation
func (*ListQueryExecutionsInput) Validate ¶
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) String ¶
func (s ListQueryExecutionsOutput) String() string
String returns the string representation
type ListQueryExecutionsPaginator ¶
ListQueryExecutionsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListQueryExecutionsPaginator ¶
func NewListQueryExecutionsPaginator(req ListQueryExecutionsRequest) ListQueryExecutionsPaginator
NewListQueryExecutionsRequestPaginator returns a paginator for ListQueryExecutions. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListQueryExecutionsRequest(input) p := athena.NewListQueryExecutionsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListQueryExecutionsPaginator) CurrentPage ¶
func (p *ListQueryExecutionsPaginator) CurrentPage() *ListQueryExecutionsOutput
type ListQueryExecutionsRequest ¶
type ListQueryExecutionsRequest struct { *aws.Request Input *ListQueryExecutionsInput Copy func(*ListQueryExecutionsInput) ListQueryExecutionsRequest }
ListQueryExecutionsRequest is the request type for the ListQueryExecutions API operation.
func (ListQueryExecutionsRequest) Send ¶
func (r ListQueryExecutionsRequest) Send(ctx context.Context) (*ListQueryExecutionsResponse, error)
Send marshals and sends the ListQueryExecutions API request.
type ListQueryExecutionsResponse ¶
type ListQueryExecutionsResponse struct { *ListQueryExecutionsOutput // contains filtered or unexported fields }
ListQueryExecutionsResponse is the response type for the ListQueryExecutions API operation.
func (*ListQueryExecutionsResponse) SDKResponseMetdata ¶
func (r *ListQueryExecutionsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListQueryExecutions request.
type ListTableMetadataInput ¶
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) String ¶
func (s ListTableMetadataInput) String() string
String returns the string representation
func (*ListTableMetadataInput) Validate ¶
func (s *ListTableMetadataInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTableMetadataOutput ¶
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) String ¶
func (s ListTableMetadataOutput) String() string
String returns the string representation
type ListTableMetadataPaginator ¶
ListTableMetadataPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListTableMetadataPaginator ¶
func NewListTableMetadataPaginator(req ListTableMetadataRequest) ListTableMetadataPaginator
NewListTableMetadataRequestPaginator returns a paginator for ListTableMetadata. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListTableMetadataRequest(input) p := athena.NewListTableMetadataRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListTableMetadataPaginator) CurrentPage ¶
func (p *ListTableMetadataPaginator) CurrentPage() *ListTableMetadataOutput
type ListTableMetadataRequest ¶
type ListTableMetadataRequest struct { *aws.Request Input *ListTableMetadataInput Copy func(*ListTableMetadataInput) ListTableMetadataRequest }
ListTableMetadataRequest is the request type for the ListTableMetadata API operation.
func (ListTableMetadataRequest) Send ¶
func (r ListTableMetadataRequest) Send(ctx context.Context) (*ListTableMetadataResponse, error)
Send marshals and sends the ListTableMetadata API request.
type ListTableMetadataResponse ¶
type ListTableMetadataResponse struct { *ListTableMetadataOutput // contains filtered or unexported fields }
ListTableMetadataResponse is the response type for the ListTableMetadata API operation.
func (*ListTableMetadataResponse) SDKResponseMetdata ¶
func (r *ListTableMetadataResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListTableMetadata request.
type ListTagsForResourceInput ¶
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) String ¶
func (s ListTagsForResourceInput) String() string
String returns the string representation
func (*ListTagsForResourceInput) Validate ¶
func (s *ListTagsForResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsForResourceOutput ¶
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) String ¶
func (s ListTagsForResourceOutput) String() string
String returns the string representation
type ListTagsForResourcePaginator ¶
ListTagsForResourcePaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListTagsForResourcePaginator ¶
func NewListTagsForResourcePaginator(req ListTagsForResourceRequest) ListTagsForResourcePaginator
NewListTagsForResourceRequestPaginator returns a paginator for ListTagsForResource. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListTagsForResourceRequest(input) p := athena.NewListTagsForResourceRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListTagsForResourcePaginator) CurrentPage ¶
func (p *ListTagsForResourcePaginator) CurrentPage() *ListTagsForResourceOutput
type ListTagsForResourceRequest ¶
type ListTagsForResourceRequest struct { *aws.Request Input *ListTagsForResourceInput Copy func(*ListTagsForResourceInput) ListTagsForResourceRequest }
ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.
func (ListTagsForResourceRequest) Send ¶
func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)
Send marshals and sends the ListTagsForResource API request.
type ListTagsForResourceResponse ¶
type ListTagsForResourceResponse struct { *ListTagsForResourceOutput // contains filtered or unexported fields }
ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.
func (*ListTagsForResourceResponse) SDKResponseMetdata ¶
func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListTagsForResource request.
type ListWorkGroupsInput ¶
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) String ¶
func (s ListWorkGroupsInput) String() string
String returns the string representation
func (*ListWorkGroupsInput) Validate ¶
func (s *ListWorkGroupsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListWorkGroupsOutput ¶
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"` // The list of workgroups, including their names, descriptions, creation times, // and states. WorkGroups []WorkGroupSummary `type:"list"` // contains filtered or unexported fields }
func (ListWorkGroupsOutput) String ¶
func (s ListWorkGroupsOutput) String() string
String returns the string representation
type ListWorkGroupsPaginator ¶
ListWorkGroupsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListWorkGroupsPaginator ¶
func NewListWorkGroupsPaginator(req ListWorkGroupsRequest) ListWorkGroupsPaginator
NewListWorkGroupsRequestPaginator returns a paginator for ListWorkGroups. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListWorkGroupsRequest(input) p := athena.NewListWorkGroupsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListWorkGroupsPaginator) CurrentPage ¶
func (p *ListWorkGroupsPaginator) CurrentPage() *ListWorkGroupsOutput
type ListWorkGroupsRequest ¶
type ListWorkGroupsRequest struct { *aws.Request Input *ListWorkGroupsInput Copy func(*ListWorkGroupsInput) ListWorkGroupsRequest }
ListWorkGroupsRequest is the request type for the ListWorkGroups API operation.
func (ListWorkGroupsRequest) Send ¶
func (r ListWorkGroupsRequest) Send(ctx context.Context) (*ListWorkGroupsResponse, error)
Send marshals and sends the ListWorkGroups API request.
type ListWorkGroupsResponse ¶
type ListWorkGroupsResponse struct { *ListWorkGroupsOutput // contains filtered or unexported fields }
ListWorkGroupsResponse is the response type for the ListWorkGroups API operation.
func (*ListWorkGroupsResponse) SDKResponseMetdata ¶
func (r *ListWorkGroupsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListWorkGroups request.
type NamedQuery ¶
type NamedQuery struct { // The database to which the query belongs. // // Database is a required field Database *string `min:"1" type:"string" required:"true"` // 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) String ¶
func (s NamedQuery) String() string
String returns the string representation
type QueryExecution ¶
type QueryExecution struct { // The SQL query statements which the query execution ran. Query *string `min:"1" type:"string"` // The database in which the query execution occurred. QueryExecutionContext *QueryExecutionContext `type:"structure"` // The unique identifier for each query execution. QueryExecutionId *string `type:"string"` // The location in Amazon S3 where query results were stored and the encryption // option, if any, used for query results. These are known as "client-side settings". // If workgroup settings override client-side settings, then the query uses // the location for the query results and the encryption configuration that // are specified for the workgroup. ResultConfiguration *ResultConfiguration `type:"structure"` // The type of query statement that was run. DDL indicates DDL query statements. // DML indicates DML (Data Manipulation Language) query statements, such as // CREATE TABLE AS SELECT. UTILITY indicates query statements other than DDL // and DML, such as SHOW CREATE TABLE, or DESCRIBE <table>. StatementType StatementType `type:"string" enum:"true"` // 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) 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) String ¶
func (s QueryExecutionContext) String() string
String returns the string representation
func (*QueryExecutionContext) Validate ¶
func (s *QueryExecutionContext) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type QueryExecutionState ¶
type QueryExecutionState string
const ( QueryExecutionStateQueued QueryExecutionState = "QUEUED" QueryExecutionStateRunning QueryExecutionState = "RUNNING" QueryExecutionStateSucceeded QueryExecutionState = "SUCCEEDED" QueryExecutionStateFailed QueryExecutionState = "FAILED" QueryExecutionStateCancelled QueryExecutionState = "CANCELLED" )
Enum values for QueryExecutionState
func (QueryExecutionState) MarshalValue ¶
func (enum QueryExecutionState) MarshalValue() (string, error)
func (QueryExecutionState) MarshalValueBuf ¶
func (enum QueryExecutionState) MarshalValueBuf(b []byte) ([]byte, error)
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) 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 QueryExecutionState `type:"string" enum:"true"` // Further detail about the status of the query. StateChangeReason *string `type:"string"` // The date and time that the query was submitted. SubmissionDateTime *time.Time `type:"timestamp"` // contains filtered or unexported fields }
The completion date, current state, submission time, and state change reason (if applicable) for the query execution.
func (QueryExecutionStatus) String ¶
func (s QueryExecutionStatus) String() string
String returns the string representation
type ResultConfiguration ¶
type ResultConfiguration struct { // If query results are encrypted in Amazon S3, indicates the encryption option // used (for example, SSE-KMS or CSE-KMS) and key information. This is a client-side // setting. If workgroup settings override client-side settings, then the query // uses the encryption configuration that is specified for the workgroup, and // also uses the location for storing query results specified in the workgroup. // See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings // Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). EncryptionConfiguration *EncryptionConfiguration `type:"structure"` // The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/. // 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) 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 ¶
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) String ¶
func (s ResultConfigurationUpdates) String() string
String returns the string representation
func (*ResultConfigurationUpdates) Validate ¶
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) 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) 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) 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) 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) String ¶
func (s StartQueryExecutionOutput) String() string
String returns the string representation
type StartQueryExecutionRequest ¶
type StartQueryExecutionRequest struct { *aws.Request Input *StartQueryExecutionInput Copy func(*StartQueryExecutionInput) StartQueryExecutionRequest }
StartQueryExecutionRequest is the request type for the StartQueryExecution API operation.
func (StartQueryExecutionRequest) Send ¶
func (r StartQueryExecutionRequest) Send(ctx context.Context) (*StartQueryExecutionResponse, error)
Send marshals and sends the StartQueryExecution API request.
type StartQueryExecutionResponse ¶
type StartQueryExecutionResponse struct { *StartQueryExecutionOutput // contains filtered or unexported fields }
StartQueryExecutionResponse is the response type for the StartQueryExecution API operation.
func (*StartQueryExecutionResponse) SDKResponseMetdata ¶
func (r *StartQueryExecutionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the StartQueryExecution request.
type StatementType ¶
type StatementType string
const ( StatementTypeDdl StatementType = "DDL" StatementTypeDml StatementType = "DML" StatementTypeUtility StatementType = "UTILITY" )
Enum values for StatementType
func (StatementType) MarshalValue ¶
func (enum StatementType) MarshalValue() (string, error)
func (StatementType) MarshalValueBuf ¶
func (enum StatementType) MarshalValueBuf(b []byte) ([]byte, error)
type StopQueryExecutionInput ¶
type StopQueryExecutionInput struct { // The unique ID of the query execution to stop. // // QueryExecutionId is a required field QueryExecutionId *string `type:"string" required:"true" idempotencyToken:"true"` // contains filtered or unexported fields }
func (StopQueryExecutionInput) String ¶
func (s StopQueryExecutionInput) String() string
String returns the string representation
func (*StopQueryExecutionInput) Validate ¶
func (s *StopQueryExecutionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StopQueryExecutionOutput ¶
type StopQueryExecutionOutput struct {
// contains filtered or unexported fields
}
func (StopQueryExecutionOutput) String ¶
func (s StopQueryExecutionOutput) String() string
String returns the string representation
type StopQueryExecutionRequest ¶
type StopQueryExecutionRequest struct { *aws.Request Input *StopQueryExecutionInput Copy func(*StopQueryExecutionInput) StopQueryExecutionRequest }
StopQueryExecutionRequest is the request type for the StopQueryExecution API operation.
func (StopQueryExecutionRequest) Send ¶
func (r StopQueryExecutionRequest) Send(ctx context.Context) (*StopQueryExecutionResponse, error)
Send marshals and sends the StopQueryExecution API request.
type StopQueryExecutionResponse ¶
type StopQueryExecutionResponse struct { *StopQueryExecutionOutput // contains filtered or unexported fields }
StopQueryExecutionResponse is the response type for the StopQueryExecution API operation.
func (*StopQueryExecutionResponse) SDKResponseMetdata ¶
func (r *StopQueryExecutionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the StopQueryExecution request.
type TableMetadata ¶
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) String ¶
func (s TableMetadata) String() string
String returns the string representation
type Tag ¶
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) String ¶
String returns the string representation
func (*Tag) Validate ¶
Validate inspects the fields of the type to determine if they are valid.
type TagResourceInput ¶
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) String ¶
func (s TagResourceInput) String() string
String returns the string representation
func (*TagResourceInput) Validate ¶
func (s *TagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceOutput ¶
type TagResourceOutput struct {
// contains filtered or unexported fields
}
func (TagResourceOutput) String ¶
func (s TagResourceOutput) String() string
String returns the string representation
type TagResourceRequest ¶
type TagResourceRequest struct { *aws.Request Input *TagResourceInput Copy func(*TagResourceInput) TagResourceRequest }
TagResourceRequest is the request type for the TagResource API operation.
func (TagResourceRequest) Send ¶
func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)
Send marshals and sends the TagResource API request.
type TagResourceResponse ¶
type TagResourceResponse struct { *TagResourceOutput // contains filtered or unexported fields }
TagResourceResponse is the response type for the TagResource API operation.
func (*TagResourceResponse) SDKResponseMetdata ¶
func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the TagResource request.
type ThrottleReason ¶
type ThrottleReason string
The reason for the query throttling, for example, when it exceeds the concurrent query limit.
const ( ThrottleReasonConcurrentQueryLimitExceeded ThrottleReason = "CONCURRENT_QUERY_LIMIT_EXCEEDED" )
Enum values for ThrottleReason
func (ThrottleReason) MarshalValue ¶
func (enum ThrottleReason) MarshalValue() (string, error)
func (ThrottleReason) MarshalValueBuf ¶
func (enum ThrottleReason) MarshalValueBuf(b []byte) ([]byte, error)
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) 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) String ¶
func (s UnprocessedQueryExecutionId) String() string
String returns the string representation
type UntagResourceInput ¶
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) String ¶
func (s UntagResourceInput) String() string
String returns the string representation
func (*UntagResourceInput) Validate ¶
func (s *UntagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagResourceOutput ¶
type UntagResourceOutput struct {
// contains filtered or unexported fields
}
func (UntagResourceOutput) String ¶
func (s UntagResourceOutput) String() string
String returns the string representation
type UntagResourceRequest ¶
type UntagResourceRequest struct { *aws.Request Input *UntagResourceInput Copy func(*UntagResourceInput) UntagResourceRequest }
UntagResourceRequest is the request type for the UntagResource API operation.
func (UntagResourceRequest) Send ¶
func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)
Send marshals and sends the UntagResource API request.
type UntagResourceResponse ¶
type UntagResourceResponse struct { *UntagResourceOutput // contains filtered or unexported fields }
UntagResourceResponse is the response type for the UntagResource API operation.
func (*UntagResourceResponse) SDKResponseMetdata ¶
func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UntagResource request.
type UpdateDataCatalogInput ¶
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 // // * The GLUE type has no parameters. Parameters map[string]string `type:"map"` // Specifies the type of data catalog to update. Specify LAMBDA for a federated // catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore. // // Type is a required field Type DataCatalogType `type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
func (UpdateDataCatalogInput) String ¶
func (s UpdateDataCatalogInput) String() string
String returns the string representation
func (*UpdateDataCatalogInput) Validate ¶
func (s *UpdateDataCatalogInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateDataCatalogOutput ¶
type UpdateDataCatalogOutput struct {
// contains filtered or unexported fields
}
func (UpdateDataCatalogOutput) String ¶
func (s UpdateDataCatalogOutput) String() string
String returns the string representation
type UpdateDataCatalogRequest ¶
type UpdateDataCatalogRequest struct { *aws.Request Input *UpdateDataCatalogInput Copy func(*UpdateDataCatalogInput) UpdateDataCatalogRequest }
UpdateDataCatalogRequest is the request type for the UpdateDataCatalog API operation.
func (UpdateDataCatalogRequest) Send ¶
func (r UpdateDataCatalogRequest) Send(ctx context.Context) (*UpdateDataCatalogResponse, error)
Send marshals and sends the UpdateDataCatalog API request.
type UpdateDataCatalogResponse ¶
type UpdateDataCatalogResponse struct { *UpdateDataCatalogOutput // contains filtered or unexported fields }
UpdateDataCatalogResponse is the response type for the UpdateDataCatalog API operation.
func (*UpdateDataCatalogResponse) SDKResponseMetdata ¶
func (r *UpdateDataCatalogResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateDataCatalog request.
type UpdateWorkGroupInput ¶
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 WorkGroupState `type:"string" enum:"true"` // 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) String ¶
func (s UpdateWorkGroupInput) String() string
String returns the string representation
func (*UpdateWorkGroupInput) Validate ¶
func (s *UpdateWorkGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateWorkGroupOutput ¶
type UpdateWorkGroupOutput struct {
// contains filtered or unexported fields
}
func (UpdateWorkGroupOutput) String ¶
func (s UpdateWorkGroupOutput) String() string
String returns the string representation
type UpdateWorkGroupRequest ¶
type UpdateWorkGroupRequest struct { *aws.Request Input *UpdateWorkGroupInput Copy func(*UpdateWorkGroupInput) UpdateWorkGroupRequest }
UpdateWorkGroupRequest is the request type for the UpdateWorkGroup API operation.
func (UpdateWorkGroupRequest) Send ¶
func (r UpdateWorkGroupRequest) Send(ctx context.Context) (*UpdateWorkGroupResponse, error)
Send marshals and sends the UpdateWorkGroup API request.
type UpdateWorkGroupResponse ¶
type UpdateWorkGroupResponse struct { *UpdateWorkGroupOutput // contains filtered or unexported fields }
UpdateWorkGroupResponse is the response type for the UpdateWorkGroup API operation.
func (*UpdateWorkGroupResponse) SDKResponseMetdata ¶
func (r *UpdateWorkGroupResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateWorkGroup request.
type WorkGroup ¶
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 WorkGroupState `type:"string" enum:"true"` // 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) String ¶
String returns the string representation
type WorkGroupConfiguration ¶
type WorkGroupConfiguration struct { // The upper data usage limit (cutoff) for the amount of bytes a single query // in a workgroup is allowed to scan. BytesScannedCutoffPerQuery *int64 `min:"1e+07" type:"long"` // If set to "true", the settings for the workgroup override client-side settings. // If set to "false", client-side settings are used. For more information, see // Workgroup Settings Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). EnforceWorkGroupConfiguration *bool `type:"boolean"` // Indicates that the Amazon CloudWatch metrics are enabled for the workgroup. PublishCloudWatchMetricsEnabled *bool `type:"boolean"` // 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) String ¶
func (s WorkGroupConfiguration) String() string
String returns the string representation
func (*WorkGroupConfiguration) Validate ¶
func (s *WorkGroupConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type WorkGroupConfigurationUpdates ¶
type WorkGroupConfigurationUpdates struct { // The upper limit (cutoff) for the amount of bytes a single query in a workgroup // is allowed to scan. BytesScannedCutoffPerQuery *int64 `min:"1e+07" type:"long"` // If set to "true", the settings for the workgroup override client-side settings. // If set to "false" client-side settings are used. For more information, see // Workgroup Settings Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). EnforceWorkGroupConfiguration *bool `type:"boolean"` // Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch. PublishCloudWatchMetricsEnabled *bool `type:"boolean"` // Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery RemoveBytesScannedCutoffPerQuery *bool `type:"boolean"` // 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) String ¶
func (s WorkGroupConfigurationUpdates) String() string
String returns the string representation
func (*WorkGroupConfigurationUpdates) Validate ¶
func (s *WorkGroupConfigurationUpdates) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type WorkGroupState ¶
type WorkGroupState string
const ( WorkGroupStateEnabled WorkGroupState = "ENABLED" WorkGroupStateDisabled WorkGroupState = "DISABLED" )
Enum values for WorkGroupState
func (WorkGroupState) MarshalValue ¶
func (enum WorkGroupState) MarshalValue() (string, error)
func (WorkGroupState) MarshalValueBuf ¶
func (enum WorkGroupState) MarshalValueBuf(b []byte) ([]byte, error)
type WorkGroupSummary ¶
type WorkGroupSummary struct { // The workgroup creation date and time. CreationTime *time.Time `type:"timestamp"` // The workgroup description. Description *string `type:"string"` // The name of the workgroup. Name *string `type:"string"` // The state of the workgroup. State WorkGroupState `type:"string" enum:"true"` // 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) String ¶
func (s WorkGroupSummary) String() string
String returns the string representation
Source Files ¶
api_client.go api_doc.go api_enums.go api_errors.go api_op_BatchGetNamedQuery.go api_op_BatchGetQueryExecution.go api_op_CreateDataCatalog.go api_op_CreateNamedQuery.go api_op_CreateWorkGroup.go api_op_DeleteDataCatalog.go api_op_DeleteNamedQuery.go api_op_DeleteWorkGroup.go api_op_GetDataCatalog.go api_op_GetDatabase.go api_op_GetNamedQuery.go api_op_GetQueryExecution.go api_op_GetQueryResults.go api_op_GetTableMetadata.go api_op_GetWorkGroup.go api_op_ListDataCatalogs.go api_op_ListDatabases.go api_op_ListNamedQueries.go api_op_ListQueryExecutions.go api_op_ListTableMetadata.go api_op_ListTagsForResource.go api_op_ListWorkGroups.go api_op_StartQueryExecution.go api_op_StopQueryExecution.go api_op_TagResource.go api_op_UntagResource.go api_op_UpdateDataCatalog.go api_op_UpdateWorkGroup.go api_types.go
Directories ¶
Path | Synopsis |
---|---|
service/athena/athenaiface | Package athenaiface provides an interface to enable mocking the Amazon Athena service client for testing your code. |
- Version
- v0.24.0
- Published
- Jul 22, 2020
- Platform
- windows/amd64
- Imports
- 8 packages
- Last checked
- 4 minutes ago –
Tools for package owners.