athena

package
v1.51.25 Latest Latest
Warning

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

Go to latest
Published: Apr 19, 2024 License: Apache-2.0 Imports: 10 Imported by: 162

Documentation

Overview

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

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

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

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

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

Using the Client

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

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

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

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

Index

Constants

View Source
const (
	// CalculationExecutionStateCreating is a CalculationExecutionState enum value
	CalculationExecutionStateCreating = "CREATING"

	// CalculationExecutionStateCreated is a CalculationExecutionState enum value
	CalculationExecutionStateCreated = "CREATED"

	// CalculationExecutionStateQueued is a CalculationExecutionState enum value
	CalculationExecutionStateQueued = "QUEUED"

	// CalculationExecutionStateRunning is a CalculationExecutionState enum value
	CalculationExecutionStateRunning = "RUNNING"

	// CalculationExecutionStateCanceling is a CalculationExecutionState enum value
	CalculationExecutionStateCanceling = "CANCELING"

	// CalculationExecutionStateCanceled is a CalculationExecutionState enum value
	CalculationExecutionStateCanceled = "CANCELED"

	// CalculationExecutionStateCompleted is a CalculationExecutionState enum value
	CalculationExecutionStateCompleted = "COMPLETED"

	// CalculationExecutionStateFailed is a CalculationExecutionState enum value
	CalculationExecutionStateFailed = "FAILED"
)
View Source
const (
	// CapacityAllocationStatusPending is a CapacityAllocationStatus enum value
	CapacityAllocationStatusPending = "PENDING"

	// CapacityAllocationStatusSucceeded is a CapacityAllocationStatus enum value
	CapacityAllocationStatusSucceeded = "SUCCEEDED"

	// CapacityAllocationStatusFailed is a CapacityAllocationStatus enum value
	CapacityAllocationStatusFailed = "FAILED"
)
View Source
const (
	// CapacityReservationStatusPending is a CapacityReservationStatus enum value
	CapacityReservationStatusPending = "PENDING"

	// CapacityReservationStatusActive is a CapacityReservationStatus enum value
	CapacityReservationStatusActive = "ACTIVE"

	// CapacityReservationStatusCancelling is a CapacityReservationStatus enum value
	CapacityReservationStatusCancelling = "CANCELLING"

	// CapacityReservationStatusCancelled is a CapacityReservationStatus enum value
	CapacityReservationStatusCancelled = "CANCELLED"

	// CapacityReservationStatusFailed is a CapacityReservationStatus enum value
	CapacityReservationStatusFailed = "FAILED"

	// CapacityReservationStatusUpdatePending is a CapacityReservationStatus enum value
	CapacityReservationStatusUpdatePending = "UPDATE_PENDING"
)
View Source
const (
	// ColumnNullableNotNull is a ColumnNullable enum value
	ColumnNullableNotNull = "NOT_NULL"

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

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

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

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

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

	// EncryptionOptionCseKms is a EncryptionOption enum value
	EncryptionOptionCseKms = "CSE_KMS"
)
View Source
const (
	// ExecutorStateCreating is a ExecutorState enum value
	ExecutorStateCreating = "CREATING"

	// ExecutorStateCreated is a ExecutorState enum value
	ExecutorStateCreated = "CREATED"

	// ExecutorStateRegistered is a ExecutorState enum value
	ExecutorStateRegistered = "REGISTERED"

	// ExecutorStateTerminating is a ExecutorState enum value
	ExecutorStateTerminating = "TERMINATING"

	// ExecutorStateTerminated is a ExecutorState enum value
	ExecutorStateTerminated = "TERMINATED"

	// ExecutorStateFailed is a ExecutorState enum value
	ExecutorStateFailed = "FAILED"
)
View Source
const (
	// ExecutorTypeCoordinator is a ExecutorType enum value
	ExecutorTypeCoordinator = "COORDINATOR"

	// ExecutorTypeGateway is a ExecutorType enum value
	ExecutorTypeGateway = "GATEWAY"

	// ExecutorTypeWorker is a ExecutorType enum value
	ExecutorTypeWorker = "WORKER"
)
View Source
const (
	// QueryExecutionStateQueued is a QueryExecutionState enum value
	QueryExecutionStateQueued = "QUEUED"

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

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

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

	// QueryExecutionStateCancelled is a QueryExecutionState enum value
	QueryExecutionStateCancelled = "CANCELLED"
)
View Source
const (
	// SessionStateCreating is a SessionState enum value
	SessionStateCreating = "CREATING"

	// SessionStateCreated is a SessionState enum value
	SessionStateCreated = "CREATED"

	// SessionStateIdle is a SessionState enum value
	SessionStateIdle = "IDLE"

	// SessionStateBusy is a SessionState enum value
	SessionStateBusy = "BUSY"

	// SessionStateTerminating is a SessionState enum value
	SessionStateTerminating = "TERMINATING"

	// SessionStateTerminated is a SessionState enum value
	SessionStateTerminated = "TERMINATED"

	// SessionStateDegraded is a SessionState enum value
	SessionStateDegraded = "DEGRADED"

	// SessionStateFailed is a SessionState enum value
	SessionStateFailed = "FAILED"
)
View Source
const (
	// StatementTypeDdl is a StatementType enum value
	StatementTypeDdl = "DDL"

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

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

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

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

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

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

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

	// ErrCodeSessionAlreadyExistsException for service response error code
	// "SessionAlreadyExistsException".
	//
	// The specified session already exists.
	ErrCodeSessionAlreadyExistsException = "SessionAlreadyExistsException"

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

Service information constants

View Source
const (
	// AuthenticationTypeDirectoryIdentity is a AuthenticationType enum value
	AuthenticationTypeDirectoryIdentity = "DIRECTORY_IDENTITY"
)
View Source
const (
	// NotebookTypeIpynb is a NotebookType enum value
	NotebookTypeIpynb = "IPYNB"
)
View Source
const (
	// S3AclOptionBucketOwnerFullControl is a S3AclOption enum value
	S3AclOptionBucketOwnerFullControl = "BUCKET_OWNER_FULL_CONTROL"
)
View Source
const (
	// ThrottleReasonConcurrentQueryLimitExceeded is a ThrottleReason enum value
	ThrottleReasonConcurrentQueryLimitExceeded = "CONCURRENT_QUERY_LIMIT_EXCEEDED"
)

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

Variables

This section is empty.

Functions

func AuthenticationType_Values added in v1.48.13

func AuthenticationType_Values() []string

AuthenticationType_Values returns all elements of the AuthenticationType enum

func CalculationExecutionState_Values added in v1.44.150

func CalculationExecutionState_Values() []string

CalculationExecutionState_Values returns all elements of the CalculationExecutionState enum

func CapacityAllocationStatus_Values added in v1.44.253

func CapacityAllocationStatus_Values() []string

CapacityAllocationStatus_Values returns all elements of the CapacityAllocationStatus enum

func CapacityReservationStatus_Values added in v1.44.253

func CapacityReservationStatus_Values() []string

CapacityReservationStatus_Values returns all elements of the CapacityReservationStatus enum

func ColumnNullable_Values added in v1.34.3

func ColumnNullable_Values() []string

ColumnNullable_Values returns all elements of the ColumnNullable enum

func DataCatalogType_Values added in v1.34.3

func DataCatalogType_Values() []string

DataCatalogType_Values returns all elements of the DataCatalogType enum

func EncryptionOption_Values added in v1.34.3

func EncryptionOption_Values() []string

EncryptionOption_Values returns all elements of the EncryptionOption enum

func ExecutorState_Values added in v1.44.150

func ExecutorState_Values() []string

ExecutorState_Values returns all elements of the ExecutorState enum

func ExecutorType_Values added in v1.44.150

func ExecutorType_Values() []string

ExecutorType_Values returns all elements of the ExecutorType enum

func NotebookType_Values added in v1.44.150

func NotebookType_Values() []string

NotebookType_Values returns all elements of the NotebookType enum

func QueryExecutionState_Values added in v1.34.3

func QueryExecutionState_Values() []string

QueryExecutionState_Values returns all elements of the QueryExecutionState enum

func S3AclOption_Values added in v1.43.10

func S3AclOption_Values() []string

S3AclOption_Values returns all elements of the S3AclOption enum

func SessionState_Values added in v1.44.150

func SessionState_Values() []string

SessionState_Values returns all elements of the SessionState enum

func StatementType_Values added in v1.34.3

func StatementType_Values() []string

StatementType_Values returns all elements of the StatementType enum

func ThrottleReason_Values added in v1.34.3

func ThrottleReason_Values() []string

ThrottleReason_Values returns all elements of the ThrottleReason enum

func WorkGroupState_Values added in v1.34.3

func WorkGroupState_Values() []string

WorkGroupState_Values returns all elements of the WorkGroupState enum

Types

type AclConfiguration added in v1.43.10

type AclConfiguration struct {

	// The Amazon S3 canned ACL that Athena should specify when storing query results.
	// Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL. If
	// a query runs in a workgroup and the workgroup overrides client-side settings,
	// then the Amazon S3 canned ACL specified in the workgroup's settings is used
	// for all queries that run in the workgroup. For more information about Amazon
	// S3 canned ACLs, see Canned ACL (https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl)
	// in the Amazon S3 User Guide.
	//
	// S3AclOption is a required field
	S3AclOption *string `type:"string" required:"true" enum:"S3AclOption"`
	// contains filtered or unexported fields
}

Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. When Athena stores query results in Amazon S3, the canned ACL is set with the x-amz-acl request header. For more information about S3 Object Ownership, see Object Ownership settings (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html#object-ownership-overview) in the Amazon S3 User Guide.

func (AclConfiguration) GoString added in v1.43.10

func (s AclConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AclConfiguration) SetS3AclOption added in v1.43.10

func (s *AclConfiguration) SetS3AclOption(v string) *AclConfiguration

SetS3AclOption sets the S3AclOption field's value.

func (AclConfiguration) String added in v1.43.10

func (s AclConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AclConfiguration) Validate added in v1.43.10

func (s *AclConfiguration) Validate() error

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

type ApplicationDPUSizes added in v1.44.150

type ApplicationDPUSizes struct {

	// The name of the supported application runtime (for example, Athena notebook
	// version 1).
	ApplicationRuntimeId *string `min:"1" type:"string"`

	// A list of the supported DPU sizes that the application runtime supports.
	SupportedDPUSizes []*int64 `type:"list"`
	// contains filtered or unexported fields
}

Contains the application runtime IDs and their supported DPU sizes.

func (ApplicationDPUSizes) GoString added in v1.44.150

func (s ApplicationDPUSizes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ApplicationDPUSizes) SetApplicationRuntimeId added in v1.44.150

func (s *ApplicationDPUSizes) SetApplicationRuntimeId(v string) *ApplicationDPUSizes

SetApplicationRuntimeId sets the ApplicationRuntimeId field's value.

func (*ApplicationDPUSizes) SetSupportedDPUSizes added in v1.44.150

func (s *ApplicationDPUSizes) SetSupportedDPUSizes(v []*int64) *ApplicationDPUSizes

SetSupportedDPUSizes sets the SupportedDPUSizes field's value.

func (ApplicationDPUSizes) String added in v1.44.150

func (s ApplicationDPUSizes) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Athena

type Athena struct {
	*client.Client
}

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

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

func New

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

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

Example:

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

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

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

func (*Athena) BatchGetNamedQuery

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

BatchGetNamedQuery API operation for Amazon Athena.

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

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

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

Returned Error Types:

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

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

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

func (*Athena) BatchGetNamedQueryRequest

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

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

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

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

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

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

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

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

func (*Athena) BatchGetNamedQueryWithContext

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

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

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

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

func (*Athena) BatchGetPreparedStatement added in v1.44.46

func (c *Athena) BatchGetPreparedStatement(input *BatchGetPreparedStatementInput) (*BatchGetPreparedStatementOutput, error)

BatchGetPreparedStatement API operation for Amazon Athena.

Returns the details of a single prepared statement or a list of up to 256 prepared statements for the array of prepared statement names that you provide. Requires you to have access to the workgroup to which the prepared statements belong. If a prepared statement cannot be retrieved for the name specified, the statement is listed in UnprocessedPreparedStatementNames.

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

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

Returned Error Types:

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

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

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

func (*Athena) BatchGetPreparedStatementRequest added in v1.44.46

func (c *Athena) BatchGetPreparedStatementRequest(input *BatchGetPreparedStatementInput) (req *request.Request, output *BatchGetPreparedStatementOutput)

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

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

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

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

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

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

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

func (*Athena) BatchGetPreparedStatementWithContext added in v1.44.46

func (c *Athena) BatchGetPreparedStatementWithContext(ctx aws.Context, input *BatchGetPreparedStatementInput, opts ...request.Option) (*BatchGetPreparedStatementOutput, error)

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

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

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

func (*Athena) BatchGetQueryExecution

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

BatchGetQueryExecution API operation for Amazon Athena.

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

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

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

Returned Error Types:

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

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

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

func (*Athena) BatchGetQueryExecutionRequest

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

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

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

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

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

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

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

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

func (*Athena) BatchGetQueryExecutionWithContext

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

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

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

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

func (*Athena) CancelCapacityReservation added in v1.44.253

func (c *Athena) CancelCapacityReservation(input *CancelCapacityReservationInput) (*CancelCapacityReservationOutput, error)

CancelCapacityReservation API operation for Amazon Athena.

Cancels the capacity reservation with the specified name. Cancelled reservations remain in your account and will be deleted 45 days after cancellation. During the 45 days, you cannot re-purpose or reuse a reservation that has been cancelled, but you can refer to its tags and view it for historical reference.

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

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

Returned Error Types:

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

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

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

func (*Athena) CancelCapacityReservationRequest added in v1.44.253

func (c *Athena) CancelCapacityReservationRequest(input *CancelCapacityReservationInput) (req *request.Request, output *CancelCapacityReservationOutput)

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

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

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

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

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

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

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

func (*Athena) CancelCapacityReservationWithContext added in v1.44.253

func (c *Athena) CancelCapacityReservationWithContext(ctx aws.Context, input *CancelCapacityReservationInput, opts ...request.Option) (*CancelCapacityReservationOutput, error)

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

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

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

func (*Athena) CreateCapacityReservation added in v1.44.253

func (c *Athena) CreateCapacityReservation(input *CreateCapacityReservationInput) (*CreateCapacityReservationOutput, error)

CreateCapacityReservation API operation for Amazon Athena.

Creates a capacity reservation with the specified name and number of requested data processing units.

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

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

Returned Error Types:

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

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

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

func (*Athena) CreateCapacityReservationRequest added in v1.44.253

func (c *Athena) CreateCapacityReservationRequest(input *CreateCapacityReservationInput) (req *request.Request, output *CreateCapacityReservationOutput)

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

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

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

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

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

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

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

func (*Athena) CreateCapacityReservationWithContext added in v1.44.253

func (c *Athena) CreateCapacityReservationWithContext(ctx aws.Context, input *CreateCapacityReservationInput, opts ...request.Option) (*CreateCapacityReservationOutput, error)

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

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

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

func (*Athena) CreateDataCatalog added in v1.31.8

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

CreateDataCatalog API operation for Amazon Athena.

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

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

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

Returned Error Types:

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

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

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

func (*Athena) CreateDataCatalogRequest added in v1.31.8

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

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

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

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

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

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

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

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

func (*Athena) CreateDataCatalogWithContext added in v1.31.8

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

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

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

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

func (*Athena) CreateNamedQuery

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

CreateNamedQuery API operation for Amazon Athena.

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

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

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

Returned Error Types:

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

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

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

func (*Athena) CreateNamedQueryRequest

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

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

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

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

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

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

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

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

func (*Athena) CreateNamedQueryWithContext

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

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

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

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

func (*Athena) CreateNotebook added in v1.44.150

func (c *Athena) CreateNotebook(input *CreateNotebookInput) (*CreateNotebookOutput, error)

CreateNotebook API operation for Amazon Athena.

Creates an empty ipynb file in the specified Apache Spark enabled workgroup. Throws an error if a file in the workgroup with the same name already exists.

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

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

Returned Error Types:

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

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

  • TooManyRequestsException Indicates that the request was throttled.

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

func (*Athena) CreateNotebookRequest added in v1.44.150

func (c *Athena) CreateNotebookRequest(input *CreateNotebookInput) (req *request.Request, output *CreateNotebookOutput)

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

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

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

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

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

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

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

func (*Athena) CreateNotebookWithContext added in v1.44.150

func (c *Athena) CreateNotebookWithContext(ctx aws.Context, input *CreateNotebookInput, opts ...request.Option) (*CreateNotebookOutput, error)

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

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

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

func (*Athena) CreatePreparedStatement added in v1.37.25

func (c *Athena) CreatePreparedStatement(input *CreatePreparedStatementInput) (*CreatePreparedStatementOutput, error)

CreatePreparedStatement API operation for Amazon Athena.

Creates a prepared statement for use with SQL queries in Athena.

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

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

Returned Error Types:

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

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

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

func (*Athena) CreatePreparedStatementRequest added in v1.37.25

func (c *Athena) CreatePreparedStatementRequest(input *CreatePreparedStatementInput) (req *request.Request, output *CreatePreparedStatementOutput)

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

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

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

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

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

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

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

func (*Athena) CreatePreparedStatementWithContext added in v1.37.25

func (c *Athena) CreatePreparedStatementWithContext(ctx aws.Context, input *CreatePreparedStatementInput, opts ...request.Option) (*CreatePreparedStatementOutput, error)

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

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

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

func (*Athena) CreatePresignedNotebookUrl added in v1.44.150

func (c *Athena) CreatePresignedNotebookUrl(input *CreatePresignedNotebookUrlInput) (*CreatePresignedNotebookUrlOutput, error)

CreatePresignedNotebookUrl API operation for Amazon Athena.

Gets an authentication token and the URL at which the notebook can be accessed. During programmatic access, CreatePresignedNotebookUrl must be called every 10 minutes to refresh the authentication token. For information about granting programmatic access, see Grant programmatic access (https://docs.aws.amazon.com/athena/latest/ug/setting-up.html#setting-up-grant-programmatic-access).

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

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

Returned Error Types:

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

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

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

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

func (*Athena) CreatePresignedNotebookUrlRequest added in v1.44.150

func (c *Athena) CreatePresignedNotebookUrlRequest(input *CreatePresignedNotebookUrlInput) (req *request.Request, output *CreatePresignedNotebookUrlOutput)

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

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

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

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

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

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

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

func (*Athena) CreatePresignedNotebookUrlWithContext added in v1.44.150

func (c *Athena) CreatePresignedNotebookUrlWithContext(ctx aws.Context, input *CreatePresignedNotebookUrlInput, opts ...request.Option) (*CreatePresignedNotebookUrlOutput, error)

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

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

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

func (*Athena) CreateWorkGroup added in v1.17.0

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

CreateWorkGroup API operation for Amazon Athena.

Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.

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

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

Returned Error Types:

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

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

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

func (*Athena) CreateWorkGroupRequest added in v1.17.0

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

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

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

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

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

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

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

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

func (*Athena) CreateWorkGroupWithContext added in v1.17.0

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

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

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

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

func (*Athena) DeleteCapacityReservation added in v1.44.275

func (c *Athena) DeleteCapacityReservation(input *DeleteCapacityReservationInput) (*DeleteCapacityReservationOutput, error)

DeleteCapacityReservation API operation for Amazon Athena.

Deletes a cancelled capacity reservation. A reservation must be cancelled before it can be deleted. A deleted reservation is immediately removed from your account and can no longer be referenced, including by its ARN. A deleted reservation cannot be called by GetCapacityReservation, and deleted reservations do not appear in the output of ListCapacityReservations.

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

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

Returned Error Types:

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

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

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

func (*Athena) DeleteCapacityReservationRequest added in v1.44.275

func (c *Athena) DeleteCapacityReservationRequest(input *DeleteCapacityReservationInput) (req *request.Request, output *DeleteCapacityReservationOutput)

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

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

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

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

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

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

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

func (*Athena) DeleteCapacityReservationWithContext added in v1.44.275

func (c *Athena) DeleteCapacityReservationWithContext(ctx aws.Context, input *DeleteCapacityReservationInput, opts ...request.Option) (*DeleteCapacityReservationOutput, error)

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

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

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

func (*Athena) DeleteDataCatalog added in v1.31.8

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

DeleteDataCatalog API operation for Amazon Athena.

Deletes a data catalog.

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

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

Returned Error Types:

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

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

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

func (*Athena) DeleteDataCatalogRequest added in v1.31.8

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

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

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

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

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

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

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

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

func (*Athena) DeleteDataCatalogWithContext added in v1.31.8

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

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

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

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

func (*Athena) DeleteNamedQuery

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

DeleteNamedQuery API operation for Amazon Athena.

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

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

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

Returned Error Types:

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

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

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

func (*Athena) DeleteNamedQueryRequest

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

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

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

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

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

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

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

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

func (*Athena) DeleteNamedQueryWithContext

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

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

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

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

func (*Athena) DeleteNotebook added in v1.44.150

func (c *Athena) DeleteNotebook(input *DeleteNotebookInput) (*DeleteNotebookOutput, error)

DeleteNotebook API operation for Amazon Athena.

Deletes the specified notebook.

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

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

Returned Error Types:

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

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

  • TooManyRequestsException Indicates that the request was throttled.

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

func (*Athena) DeleteNotebookRequest added in v1.44.150

func (c *Athena) DeleteNotebookRequest(input *DeleteNotebookInput) (req *request.Request, output *DeleteNotebookOutput)

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

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

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

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

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

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

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

func (*Athena) DeleteNotebookWithContext added in v1.44.150

func (c *Athena) DeleteNotebookWithContext(ctx aws.Context, input *DeleteNotebookInput, opts ...request.Option) (*DeleteNotebookOutput, error)

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

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

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

func (*Athena) DeletePreparedStatement added in v1.37.25

func (c *Athena) DeletePreparedStatement(input *DeletePreparedStatementInput) (*DeletePreparedStatementOutput, error)

DeletePreparedStatement API operation for Amazon Athena.

Deletes the prepared statement with the specified name from the specified workgroup.

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

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

Returned Error Types:

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

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

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

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

func (*Athena) DeletePreparedStatementRequest added in v1.37.25

func (c *Athena) DeletePreparedStatementRequest(input *DeletePreparedStatementInput) (req *request.Request, output *DeletePreparedStatementOutput)

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

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

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

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

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

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

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

func (*Athena) DeletePreparedStatementWithContext added in v1.37.25

func (c *Athena) DeletePreparedStatementWithContext(ctx aws.Context, input *DeletePreparedStatementInput, opts ...request.Option) (*DeletePreparedStatementOutput, error)

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

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

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

func (*Athena) DeleteWorkGroup added in v1.17.0

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

DeleteWorkGroup API operation for Amazon Athena.

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

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

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

Returned Error Types:

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

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

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

func (*Athena) DeleteWorkGroupRequest added in v1.17.0

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

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

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

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

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

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

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

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

func (*Athena) DeleteWorkGroupWithContext added in v1.17.0

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

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

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

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

func (*Athena) ExportNotebook added in v1.44.150

func (c *Athena) ExportNotebook(input *ExportNotebookInput) (*ExportNotebookOutput, error)

ExportNotebook API operation for Amazon Athena.

Exports the specified notebook and its metadata.

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

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

Returned Error Types:

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

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

  • TooManyRequestsException Indicates that the request was throttled.

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

func (*Athena) ExportNotebookRequest added in v1.44.150

func (c *Athena) ExportNotebookRequest(input *ExportNotebookInput) (req *request.Request, output *ExportNotebookOutput)

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

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

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

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

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

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

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

func (*Athena) ExportNotebookWithContext added in v1.44.150

func (c *Athena) ExportNotebookWithContext(ctx aws.Context, input *ExportNotebookInput, opts ...request.Option) (*ExportNotebookOutput, error)

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

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

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

func (*Athena) GetCalculationExecution added in v1.44.150

func (c *Athena) GetCalculationExecution(input *GetCalculationExecutionInput) (*GetCalculationExecutionOutput, error)

GetCalculationExecution API operation for Amazon Athena.

Describes a previously submitted calculation execution.

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

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

Returned Error Types:

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

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

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

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

func (*Athena) GetCalculationExecutionCode added in v1.44.150

func (c *Athena) GetCalculationExecutionCode(input *GetCalculationExecutionCodeInput) (*GetCalculationExecutionCodeOutput, error)

GetCalculationExecutionCode API operation for Amazon Athena.

Retrieves the unencrypted code that was executed for the calculation.

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

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

Returned Error Types:

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

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

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

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

func (*Athena) GetCalculationExecutionCodeRequest added in v1.44.150

func (c *Athena) GetCalculationExecutionCodeRequest(input *GetCalculationExecutionCodeInput) (req *request.Request, output *GetCalculationExecutionCodeOutput)

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

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

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

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

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

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

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

func (*Athena) GetCalculationExecutionCodeWithContext added in v1.44.150

func (c *Athena) GetCalculationExecutionCodeWithContext(ctx aws.Context, input *GetCalculationExecutionCodeInput, opts ...request.Option) (*GetCalculationExecutionCodeOutput, error)

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

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

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

func (*Athena) GetCalculationExecutionRequest added in v1.44.150

func (c *Athena) GetCalculationExecutionRequest(input *GetCalculationExecutionInput) (req *request.Request, output *GetCalculationExecutionOutput)

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

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

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

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

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

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

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

func (*Athena) GetCalculationExecutionStatus added in v1.44.150

func (c *Athena) GetCalculationExecutionStatus(input *GetCalculationExecutionStatusInput) (*GetCalculationExecutionStatusOutput, error)

GetCalculationExecutionStatus API operation for Amazon Athena.

Gets the status of a current calculation.

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

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

Returned Error Types:

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

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

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

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

func (*Athena) GetCalculationExecutionStatusRequest added in v1.44.150

func (c *Athena) GetCalculationExecutionStatusRequest(input *GetCalculationExecutionStatusInput) (req *request.Request, output *GetCalculationExecutionStatusOutput)

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

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

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

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

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

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

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

func (*Athena) GetCalculationExecutionStatusWithContext added in v1.44.150

func (c *Athena) GetCalculationExecutionStatusWithContext(ctx aws.Context, input *GetCalculationExecutionStatusInput, opts ...request.Option) (*GetCalculationExecutionStatusOutput, error)

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

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

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

func (*Athena) GetCalculationExecutionWithContext added in v1.44.150

func (c *Athena) GetCalculationExecutionWithContext(ctx aws.Context, input *GetCalculationExecutionInput, opts ...request.Option) (*GetCalculationExecutionOutput, error)

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

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

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

func (*Athena) GetCapacityAssignmentConfiguration added in v1.44.253

func (c *Athena) GetCapacityAssignmentConfiguration(input *GetCapacityAssignmentConfigurationInput) (*GetCapacityAssignmentConfigurationOutput, error)

GetCapacityAssignmentConfiguration API operation for Amazon Athena.

Gets the capacity assignment configuration for a capacity reservation, if one exists.

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

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

Returned Error Types:

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

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

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

func (*Athena) GetCapacityAssignmentConfigurationRequest added in v1.44.253

func (c *Athena) GetCapacityAssignmentConfigurationRequest(input *GetCapacityAssignmentConfigurationInput) (req *request.Request, output *GetCapacityAssignmentConfigurationOutput)

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

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

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

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

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

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

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

func (*Athena) GetCapacityAssignmentConfigurationWithContext added in v1.44.253

func (c *Athena) GetCapacityAssignmentConfigurationWithContext(ctx aws.Context, input *GetCapacityAssignmentConfigurationInput, opts ...request.Option) (*GetCapacityAssignmentConfigurationOutput, error)

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

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

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

func (*Athena) GetCapacityReservation added in v1.44.253

func (c *Athena) GetCapacityReservation(input *GetCapacityReservationInput) (*GetCapacityReservationOutput, error)

GetCapacityReservation API operation for Amazon Athena.

Returns information about the capacity reservation with the specified name.

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

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

Returned Error Types:

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

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

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

func (*Athena) GetCapacityReservationRequest added in v1.44.253

func (c *Athena) GetCapacityReservationRequest(input *GetCapacityReservationInput) (req *request.Request, output *GetCapacityReservationOutput)

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

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

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

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

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

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

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

func (*Athena) GetCapacityReservationWithContext added in v1.44.253

func (c *Athena) GetCapacityReservationWithContext(ctx aws.Context, input *GetCapacityReservationInput, opts ...request.Option) (*GetCapacityReservationOutput, error)

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

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

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

func (*Athena) GetDataCatalog added in v1.31.8

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

GetDataCatalog API operation for Amazon Athena.

Returns the specified data catalog.

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

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

Returned Error Types:

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

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

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

func (*Athena) GetDataCatalogRequest added in v1.31.8

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

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

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

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

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

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

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

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

func (*Athena) GetDataCatalogWithContext added in v1.31.8

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

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

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

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

func (*Athena) GetDatabase added in v1.31.8

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

GetDatabase API operation for Amazon Athena.

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

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

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

Returned Error Types:

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

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

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

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

func (*Athena) GetDatabaseRequest added in v1.31.8

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

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

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

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

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

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

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

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

func (*Athena) GetDatabaseWithContext added in v1.31.8

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

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

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

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

func (*Athena) GetNamedQuery

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

GetNamedQuery API operation for Amazon Athena.

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

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

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

Returned Error Types:

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

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

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

func (*Athena) GetNamedQueryRequest

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

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

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

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

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

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

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

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

func (*Athena) GetNamedQueryWithContext

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

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

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

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

func (*Athena) GetNotebookMetadata added in v1.44.150

func (c *Athena) GetNotebookMetadata(input *GetNotebookMetadataInput) (*GetNotebookMetadataOutput, error)

GetNotebookMetadata API operation for Amazon Athena.

Retrieves notebook metadata for the specified notebook ID.

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

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

Returned Error Types:

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

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

  • TooManyRequestsException Indicates that the request was throttled.

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

func (*Athena) GetNotebookMetadataRequest added in v1.44.150

func (c *Athena) GetNotebookMetadataRequest(input *GetNotebookMetadataInput) (req *request.Request, output *GetNotebookMetadataOutput)

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

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

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

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

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

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

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

func (*Athena) GetNotebookMetadataWithContext added in v1.44.150

func (c *Athena) GetNotebookMetadataWithContext(ctx aws.Context, input *GetNotebookMetadataInput, opts ...request.Option) (*GetNotebookMetadataOutput, error)

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

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

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

func (*Athena) GetPreparedStatement added in v1.37.25

func (c *Athena) GetPreparedStatement(input *GetPreparedStatementInput) (*GetPreparedStatementOutput, error)

GetPreparedStatement API operation for Amazon Athena.

Retrieves the prepared statement with the specified name from the specified workgroup.

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

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

Returned Error Types:

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

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

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

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

func (*Athena) GetPreparedStatementRequest added in v1.37.25

func (c *Athena) GetPreparedStatementRequest(input *GetPreparedStatementInput) (req *request.Request, output *GetPreparedStatementOutput)

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

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

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

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

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

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

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

func (*Athena) GetPreparedStatementWithContext added in v1.37.25

func (c *Athena) GetPreparedStatementWithContext(ctx aws.Context, input *GetPreparedStatementInput, opts ...request.Option) (*GetPreparedStatementOutput, error)

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

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

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

func (*Athena) GetQueryExecution

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

GetQueryExecution API operation for Amazon Athena.

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

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

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

Returned Error Types:

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

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

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

func (*Athena) GetQueryExecutionRequest

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

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

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

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

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

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

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

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

func (*Athena) GetQueryExecutionWithContext

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

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

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

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

func (*Athena) GetQueryResults

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

GetQueryResults API operation for Amazon Athena.

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

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

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

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

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

Returned Error Types:

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

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

  • TooManyRequestsException Indicates that the request was throttled.

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

func (*Athena) GetQueryResultsPages

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

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

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

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

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

func (*Athena) GetQueryResultsPagesWithContext

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

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

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

func (*Athena) GetQueryResultsRequest

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

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

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

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

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

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

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

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

func (*Athena) GetQueryResultsWithContext

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

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

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

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

func (*Athena) GetQueryRuntimeStatistics added in v1.44.60

func (c *Athena) GetQueryRuntimeStatistics(input *GetQueryRuntimeStatisticsInput) (*GetQueryRuntimeStatisticsOutput, error)

GetQueryRuntimeStatistics API operation for Amazon Athena.

Returns query execution runtime statistics related to a single execution of a query if you have access to the workgroup in which the query ran. Query execution runtime statistics are returned only when QueryExecutionStatus$State is in a SUCCEEDED or FAILED state. Stage-level input and output row count and data size statistics are not shown when a query has row-level filters defined in Lake Formation.

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

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

Returned Error Types:

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

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

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

func (*Athena) GetQueryRuntimeStatisticsRequest added in v1.44.60

func (c *Athena) GetQueryRuntimeStatisticsRequest(input *GetQueryRuntimeStatisticsInput) (req *request.Request, output *GetQueryRuntimeStatisticsOutput)

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

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

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

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

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

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

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

func (*Athena) GetQueryRuntimeStatisticsWithContext added in v1.44.60

func (c *Athena) GetQueryRuntimeStatisticsWithContext(ctx aws.Context, input *GetQueryRuntimeStatisticsInput, opts ...request.Option) (*GetQueryRuntimeStatisticsOutput, error)

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

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

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

func (*Athena) GetSession added in v1.44.150

func (c *Athena) GetSession(input *GetSessionInput) (*GetSessionOutput, error)

GetSession API operation for Amazon Athena.

Gets the full details of a previously created session, including the session status and configuration.

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

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

Returned Error Types:

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

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

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

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

func (*Athena) GetSessionRequest added in v1.44.150

func (c *Athena) GetSessionRequest(input *GetSessionInput) (req *request.Request, output *GetSessionOutput)

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

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

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

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

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

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

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

func (*Athena) GetSessionStatus added in v1.44.150

func (c *Athena) GetSessionStatus(input *GetSessionStatusInput) (*GetSessionStatusOutput, error)

GetSessionStatus API operation for Amazon Athena.

Gets the current status of a session.

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

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

Returned Error Types:

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

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

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

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

func (*Athena) GetSessionStatusRequest added in v1.44.150

func (c *Athena) GetSessionStatusRequest(input *GetSessionStatusInput) (req *request.Request, output *GetSessionStatusOutput)

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

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

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

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

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

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

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

func (*Athena) GetSessionStatusWithContext added in v1.44.150

func (c *Athena) GetSessionStatusWithContext(ctx aws.Context, input *GetSessionStatusInput, opts ...request.Option) (*GetSessionStatusOutput, error)

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

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

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

func (*Athena) GetSessionWithContext added in v1.44.150

func (c *Athena) GetSessionWithContext(ctx aws.Context, input *GetSessionInput, opts ...request.Option) (*GetSessionOutput, error)

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

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

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

func (*Athena) GetTableMetadata added in v1.31.8

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

GetTableMetadata API operation for Amazon Athena.

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

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

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

Returned Error Types:

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

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

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

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

func (*Athena) GetTableMetadataRequest added in v1.31.8

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

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

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

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

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

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

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

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

func (*Athena) GetTableMetadataWithContext added in v1.31.8

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

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

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

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

func (*Athena) GetWorkGroup added in v1.17.0

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

GetWorkGroup API operation for Amazon Athena.

Returns information about the workgroup with the specified name.

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

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

Returned Error Types:

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

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

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

func (*Athena) GetWorkGroupRequest added in v1.17.0

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

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

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

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

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

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

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

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

func (*Athena) GetWorkGroupWithContext added in v1.17.0

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

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

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

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

func (*Athena) ImportNotebook added in v1.44.150

func (c *Athena) ImportNotebook(input *ImportNotebookInput) (*ImportNotebookOutput, error)

ImportNotebook API operation for Amazon Athena.

Imports a single ipynb file to a Spark enabled workgroup. To import the notebook, the request must specify a value for either Payload or NoteBookS3LocationUri. If neither is specified or both are specified, an InvalidRequestException occurs. The maximum file size that can be imported is 10 megabytes. If an ipynb file with the same name already exists in the workgroup, throws an error.

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

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

Returned Error Types:

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

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

  • TooManyRequestsException Indicates that the request was throttled.

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

func (*Athena) ImportNotebookRequest added in v1.44.150

func (c *Athena) ImportNotebookRequest(input *ImportNotebookInput) (req *request.Request, output *ImportNotebookOutput)

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

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

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

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

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

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

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

func (*Athena) ImportNotebookWithContext added in v1.44.150

func (c *Athena) ImportNotebookWithContext(ctx aws.Context, input *ImportNotebookInput, opts ...request.Option) (*ImportNotebookOutput, error)

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

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

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

func (*Athena) ListApplicationDPUSizes added in v1.44.150

func (c *Athena) ListApplicationDPUSizes(input *ListApplicationDPUSizesInput) (*ListApplicationDPUSizesOutput, error)

ListApplicationDPUSizes API operation for Amazon Athena.

Returns the supported DPU sizes for the supported application runtimes (for example, Athena notebook version 1).

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

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

Returned Error Types:

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

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

  • TooManyRequestsException Indicates that the request was throttled.

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

func (*Athena) ListApplicationDPUSizesPages added in v1.44.150

func (c *Athena) ListApplicationDPUSizesPages(input *ListApplicationDPUSizesInput, fn func(*ListApplicationDPUSizesOutput, bool) bool) error

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

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

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

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

func (*Athena) ListApplicationDPUSizesPagesWithContext added in v1.44.150

func (c *Athena) ListApplicationDPUSizesPagesWithContext(ctx aws.Context, input *ListApplicationDPUSizesInput, fn func(*ListApplicationDPUSizesOutput, bool) bool, opts ...request.Option) error

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

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

func (*Athena) ListApplicationDPUSizesRequest added in v1.44.150

func (c *Athena) ListApplicationDPUSizesRequest(input *ListApplicationDPUSizesInput) (req *request.Request, output *ListApplicationDPUSizesOutput)

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

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

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

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

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

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

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

func (*Athena) ListApplicationDPUSizesWithContext added in v1.44.150

func (c *Athena) ListApplicationDPUSizesWithContext(ctx aws.Context, input *ListApplicationDPUSizesInput, opts ...request.Option) (*ListApplicationDPUSizesOutput, error)

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

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

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

func (*Athena) ListCalculationExecutions added in v1.44.150

func (c *Athena) ListCalculationExecutions(input *ListCalculationExecutionsInput) (*ListCalculationExecutionsOutput, error)

ListCalculationExecutions API operation for Amazon Athena.

Lists the calculations that have been submitted to a session in descending order. Newer calculations are listed first; older calculations are listed later.

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

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

Returned Error Types:

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

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

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

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

func (*Athena) ListCalculationExecutionsPages added in v1.44.150

func (c *Athena) ListCalculationExecutionsPages(input *ListCalculationExecutionsInput, fn func(*ListCalculationExecutionsOutput, bool) bool) error

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

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

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

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

func (*Athena) ListCalculationExecutionsPagesWithContext added in v1.44.150

func (c *Athena) ListCalculationExecutionsPagesWithContext(ctx aws.Context, input *ListCalculationExecutionsInput, fn func(*ListCalculationExecutionsOutput, bool) bool, opts ...request.Option) error

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

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

func (*Athena) ListCalculationExecutionsRequest added in v1.44.150

func (c *Athena) ListCalculationExecutionsRequest(input *ListCalculationExecutionsInput) (req *request.Request, output *ListCalculationExecutionsOutput)

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

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

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

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

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

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

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

func (*Athena) ListCalculationExecutionsWithContext added in v1.44.150

func (c *Athena) ListCalculationExecutionsWithContext(ctx aws.Context, input *ListCalculationExecutionsInput, opts ...request.Option) (*ListCalculationExecutionsOutput, error)

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

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

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

func (*Athena) ListCapacityReservations added in v1.44.253

func (c *Athena) ListCapacityReservations(input *ListCapacityReservationsInput) (*ListCapacityReservationsOutput, error)

ListCapacityReservations API operation for Amazon Athena.

Lists the capacity reservations for the current account.

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

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

Returned Error Types:

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

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

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

func (*Athena) ListCapacityReservationsPages added in v1.44.253

func (c *Athena) ListCapacityReservationsPages(input *ListCapacityReservationsInput, fn func(*ListCapacityReservationsOutput, bool) bool) error

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

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

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

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

func (*Athena) ListCapacityReservationsPagesWithContext added in v1.44.253

func (c *Athena) ListCapacityReservationsPagesWithContext(ctx aws.Context, input *ListCapacityReservationsInput, fn func(*ListCapacityReservationsOutput, bool) bool, opts ...request.Option) error

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

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

func (*Athena) ListCapacityReservationsRequest added in v1.44.253

func (c *Athena) ListCapacityReservationsRequest(input *ListCapacityReservationsInput) (req *request.Request, output *ListCapacityReservationsOutput)

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

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

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

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

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

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

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

func (*Athena) ListCapacityReservationsWithContext added in v1.44.253

func (c *Athena) ListCapacityReservationsWithContext(ctx aws.Context, input *ListCapacityReservationsInput, opts ...request.Option) (*ListCapacityReservationsOutput, error)

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

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

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

func (*Athena) ListDataCatalogs added in v1.31.8

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

ListDataCatalogs API operation for Amazon Athena.

Lists the data catalogs in the current Amazon Web Services account.

In the Athena console, data catalogs are listed as "data sources" on the Data sources page under the Data source name column.

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

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

Returned Error Types:

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

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

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

func (*Athena) ListDataCatalogsPages added in v1.31.8

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

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

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

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

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

func (*Athena) ListDataCatalogsPagesWithContext added in v1.31.8

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

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

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

func (*Athena) ListDataCatalogsRequest added in v1.31.8

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

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

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

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

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

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

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

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

func (*Athena) ListDataCatalogsWithContext added in v1.31.8

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

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

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

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

func (*Athena) ListDatabases added in v1.31.8

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

ListDatabases API operation for Amazon Athena.

Lists the databases in the specified data catalog.

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

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

Returned Error Types:

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

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

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

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

func (*Athena) ListDatabasesPages added in v1.31.8

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

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

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

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

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

func (*Athena) ListDatabasesPagesWithContext added in v1.31.8

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

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

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

func (*Athena) ListDatabasesRequest added in v1.31.8

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

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

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

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

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

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

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

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

func (*Athena) ListDatabasesWithContext added in v1.31.8

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

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

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

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

func (*Athena) ListEngineVersions added in v1.37.4

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

ListEngineVersions API operation for Amazon Athena.

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

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

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

Returned Error Types:

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

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

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

func (*Athena) ListEngineVersionsPages added in v1.44.60

func (c *Athena) ListEngineVersionsPages(input *ListEngineVersionsInput, fn func(*ListEngineVersionsOutput, bool) bool) error

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

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

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

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

func (*Athena) ListEngineVersionsPagesWithContext added in v1.44.60

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

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

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

func (*Athena) ListEngineVersionsRequest added in v1.37.4

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

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

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

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

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

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

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

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

func (*Athena) ListEngineVersionsWithContext added in v1.37.4

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

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

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

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

func (*Athena) ListExecutors added in v1.44.150

func (c *Athena) ListExecutors(input *ListExecutorsInput) (*ListExecutorsOutput, error)

ListExecutors API operation for Amazon Athena.

Lists, in descending order, the executors that joined a session. Newer executors are listed first; older executors are listed later. The result can be optionally filtered by state.

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

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

Returned Error Types:

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

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

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

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

func (*Athena) ListExecutorsPages added in v1.44.150

func (c *Athena) ListExecutorsPages(input *ListExecutorsInput, fn func(*ListExecutorsOutput, bool) bool) error

ListExecutorsPages iterates over the pages of a ListExecutors operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListExecutors method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListExecutors operation.
pageNum := 0
err := client.ListExecutorsPages(params,
    func(page *athena.ListExecutorsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Athena) ListExecutorsPagesWithContext added in v1.44.150

func (c *Athena) ListExecutorsPagesWithContext(ctx aws.Context, input *ListExecutorsInput, fn func(*ListExecutorsOutput, bool) bool, opts ...request.Option) error

ListExecutorsPagesWithContext same as ListExecutorsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) ListExecutorsRequest added in v1.44.150

func (c *Athena) ListExecutorsRequest(input *ListExecutorsInput) (req *request.Request, output *ListExecutorsOutput)

ListExecutorsRequest generates a "aws/request.Request" representing the client's request for the ListExecutors operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListExecutors for more information on using the ListExecutors API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListExecutorsRequest method.
req, resp := client.ListExecutorsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListExecutors

func (*Athena) ListExecutorsWithContext added in v1.44.150

func (c *Athena) ListExecutorsWithContext(ctx aws.Context, input *ListExecutorsInput, opts ...request.Option) (*ListExecutorsOutput, error)

ListExecutorsWithContext is the same as ListExecutors with the addition of the ability to pass a context and additional request options.

See ListExecutors for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) ListNamedQueries

func (c *Athena) ListNamedQueries(input *ListNamedQueriesInput) (*ListNamedQueriesOutput, error)

ListNamedQueries API operation for Amazon Athena.

Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the specified workgroup. If a workgroup is not specified, lists the saved queries for the primary workgroup.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation ListNamedQueries for usage and error information.

Returned Error Types:

  • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.

  • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListNamedQueries

func (*Athena) ListNamedQueriesPages

func (c *Athena) ListNamedQueriesPages(input *ListNamedQueriesInput, fn func(*ListNamedQueriesOutput, bool) bool) error

ListNamedQueriesPages iterates over the pages of a ListNamedQueries operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListNamedQueries method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListNamedQueries operation.
pageNum := 0
err := client.ListNamedQueriesPages(params,
    func(page *athena.ListNamedQueriesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Athena) ListNamedQueriesPagesWithContext

func (c *Athena) ListNamedQueriesPagesWithContext(ctx aws.Context, input *ListNamedQueriesInput, fn func(*ListNamedQueriesOutput, bool) bool, opts ...request.Option) error

ListNamedQueriesPagesWithContext same as ListNamedQueriesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) ListNamedQueriesRequest

func (c *Athena) ListNamedQueriesRequest(input *ListNamedQueriesInput) (req *request.Request, output *ListNamedQueriesOutput)

ListNamedQueriesRequest generates a "aws/request.Request" representing the client's request for the ListNamedQueries operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListNamedQueries for more information on using the ListNamedQueries API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListNamedQueriesRequest method.
req, resp := client.ListNamedQueriesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListNamedQueries

func (*Athena) ListNamedQueriesWithContext

func (c *Athena) ListNamedQueriesWithContext(ctx aws.Context, input *ListNamedQueriesInput, opts ...request.Option) (*ListNamedQueriesOutput, error)

ListNamedQueriesWithContext is the same as ListNamedQueries with the addition of the ability to pass a context and additional request options.

See ListNamedQueries for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) ListNotebookMetadata added in v1.44.150

func (c *Athena) ListNotebookMetadata(input *ListNotebookMetadataInput) (*ListNotebookMetadataOutput, error)

ListNotebookMetadata API operation for Amazon Athena.

Displays the notebook files for the specified workgroup in paginated format.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation ListNotebookMetadata for usage and error information.

Returned Error Types:

  • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.

  • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

  • TooManyRequestsException Indicates that the request was throttled.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListNotebookMetadata

func (*Athena) ListNotebookMetadataRequest added in v1.44.150

func (c *Athena) ListNotebookMetadataRequest(input *ListNotebookMetadataInput) (req *request.Request, output *ListNotebookMetadataOutput)

ListNotebookMetadataRequest generates a "aws/request.Request" representing the client's request for the ListNotebookMetadata operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListNotebookMetadata for more information on using the ListNotebookMetadata API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListNotebookMetadataRequest method.
req, resp := client.ListNotebookMetadataRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListNotebookMetadata

func (*Athena) ListNotebookMetadataWithContext added in v1.44.150

func (c *Athena) ListNotebookMetadataWithContext(ctx aws.Context, input *ListNotebookMetadataInput, opts ...request.Option) (*ListNotebookMetadataOutput, error)

ListNotebookMetadataWithContext is the same as ListNotebookMetadata with the addition of the ability to pass a context and additional request options.

See ListNotebookMetadata for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) ListNotebookSessions added in v1.44.150

func (c *Athena) ListNotebookSessions(input *ListNotebookSessionsInput) (*ListNotebookSessionsOutput, error)

ListNotebookSessions API operation for Amazon Athena.

Lists, in descending order, the sessions that have been created in a notebook that are in an active state like CREATING, CREATED, IDLE or BUSY. Newer sessions are listed first; older sessions are listed later.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation ListNotebookSessions for usage and error information.

Returned Error Types:

  • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.

  • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

  • ResourceNotFoundException A resource, such as a workgroup, was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListNotebookSessions

func (*Athena) ListNotebookSessionsRequest added in v1.44.150

func (c *Athena) ListNotebookSessionsRequest(input *ListNotebookSessionsInput) (req *request.Request, output *ListNotebookSessionsOutput)

ListNotebookSessionsRequest generates a "aws/request.Request" representing the client's request for the ListNotebookSessions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListNotebookSessions for more information on using the ListNotebookSessions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListNotebookSessionsRequest method.
req, resp := client.ListNotebookSessionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListNotebookSessions

func (*Athena) ListNotebookSessionsWithContext added in v1.44.150

func (c *Athena) ListNotebookSessionsWithContext(ctx aws.Context, input *ListNotebookSessionsInput, opts ...request.Option) (*ListNotebookSessionsOutput, error)

ListNotebookSessionsWithContext is the same as ListNotebookSessions with the addition of the ability to pass a context and additional request options.

See ListNotebookSessions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) ListPreparedStatements added in v1.37.25

func (c *Athena) ListPreparedStatements(input *ListPreparedStatementsInput) (*ListPreparedStatementsOutput, error)

ListPreparedStatements API operation for Amazon Athena.

Lists the prepared statements in the specified workgroup.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation ListPreparedStatements for usage and error information.

Returned Error Types:

  • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.

  • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListPreparedStatements

func (*Athena) ListPreparedStatementsPages added in v1.37.25

func (c *Athena) ListPreparedStatementsPages(input *ListPreparedStatementsInput, fn func(*ListPreparedStatementsOutput, bool) bool) error

ListPreparedStatementsPages iterates over the pages of a ListPreparedStatements operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListPreparedStatements method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListPreparedStatements operation.
pageNum := 0
err := client.ListPreparedStatementsPages(params,
    func(page *athena.ListPreparedStatementsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Athena) ListPreparedStatementsPagesWithContext added in v1.37.25

func (c *Athena) ListPreparedStatementsPagesWithContext(ctx aws.Context, input *ListPreparedStatementsInput, fn func(*ListPreparedStatementsOutput, bool) bool, opts ...request.Option) error

ListPreparedStatementsPagesWithContext same as ListPreparedStatementsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) ListPreparedStatementsRequest added in v1.37.25

func (c *Athena) ListPreparedStatementsRequest(input *ListPreparedStatementsInput) (req *request.Request, output *ListPreparedStatementsOutput)

ListPreparedStatementsRequest generates a "aws/request.Request" representing the client's request for the ListPreparedStatements operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListPreparedStatements for more information on using the ListPreparedStatements API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListPreparedStatementsRequest method.
req, resp := client.ListPreparedStatementsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListPreparedStatements

func (*Athena) ListPreparedStatementsWithContext added in v1.37.25

func (c *Athena) ListPreparedStatementsWithContext(ctx aws.Context, input *ListPreparedStatementsInput, opts ...request.Option) (*ListPreparedStatementsOutput, error)

ListPreparedStatementsWithContext is the same as ListPreparedStatements with the addition of the ability to pass a context and additional request options.

See ListPreparedStatements for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) ListQueryExecutions

func (c *Athena) ListQueryExecutions(input *ListQueryExecutionsInput) (*ListQueryExecutionsOutput, error)

ListQueryExecutions API operation for Amazon Athena.

Provides a list of available query execution IDs for the queries in the specified workgroup. Athena keeps a query history for 45 days. 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation ListQueryExecutions for usage and error information.

Returned Error Types:

  • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.

  • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListQueryExecutions

func (*Athena) ListQueryExecutionsPages

func (c *Athena) ListQueryExecutionsPages(input *ListQueryExecutionsInput, fn func(*ListQueryExecutionsOutput, bool) bool) error

ListQueryExecutionsPages iterates over the pages of a ListQueryExecutions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListQueryExecutions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListQueryExecutions operation.
pageNum := 0
err := client.ListQueryExecutionsPages(params,
    func(page *athena.ListQueryExecutionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Athena) ListQueryExecutionsPagesWithContext

func (c *Athena) ListQueryExecutionsPagesWithContext(ctx aws.Context, input *ListQueryExecutionsInput, fn func(*ListQueryExecutionsOutput, bool) bool, opts ...request.Option) error

ListQueryExecutionsPagesWithContext same as ListQueryExecutionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) ListQueryExecutionsRequest

func (c *Athena) ListQueryExecutionsRequest(input *ListQueryExecutionsInput) (req *request.Request, output *ListQueryExecutionsOutput)

ListQueryExecutionsRequest generates a "aws/request.Request" representing the client's request for the ListQueryExecutions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListQueryExecutions for more information on using the ListQueryExecutions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListQueryExecutionsRequest method.
req, resp := client.ListQueryExecutionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListQueryExecutions

func (*Athena) ListQueryExecutionsWithContext

func (c *Athena) ListQueryExecutionsWithContext(ctx aws.Context, input *ListQueryExecutionsInput, opts ...request.Option) (*ListQueryExecutionsOutput, error)

ListQueryExecutionsWithContext is the same as ListQueryExecutions with the addition of the ability to pass a context and additional request options.

See ListQueryExecutions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) ListSessions added in v1.44.150

func (c *Athena) ListSessions(input *ListSessionsInput) (*ListSessionsOutput, error)

ListSessions API operation for Amazon Athena.

Lists the sessions in a workgroup that are in an active state like CREATING, CREATED, IDLE, or BUSY. Newer sessions are listed first; older sessions are listed later.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation ListSessions for usage and error information.

Returned Error Types:

  • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.

  • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

  • ResourceNotFoundException A resource, such as a workgroup, was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListSessions

func (*Athena) ListSessionsPages added in v1.44.150

func (c *Athena) ListSessionsPages(input *ListSessionsInput, fn func(*ListSessionsOutput, bool) bool) error

ListSessionsPages iterates over the pages of a ListSessions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListSessions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListSessions operation.
pageNum := 0
err := client.ListSessionsPages(params,
    func(page *athena.ListSessionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Athena) ListSessionsPagesWithContext added in v1.44.150

func (c *Athena) ListSessionsPagesWithContext(ctx aws.Context, input *ListSessionsInput, fn func(*ListSessionsOutput, bool) bool, opts ...request.Option) error

ListSessionsPagesWithContext same as ListSessionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) ListSessionsRequest added in v1.44.150

func (c *Athena) ListSessionsRequest(input *ListSessionsInput) (req *request.Request, output *ListSessionsOutput)

ListSessionsRequest generates a "aws/request.Request" representing the client's request for the ListSessions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListSessions for more information on using the ListSessions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListSessionsRequest method.
req, resp := client.ListSessionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListSessions

func (*Athena) ListSessionsWithContext added in v1.44.150

func (c *Athena) ListSessionsWithContext(ctx aws.Context, input *ListSessionsInput, opts ...request.Option) (*ListSessionsOutput, error)

ListSessionsWithContext is the same as ListSessions with the addition of the ability to pass a context and additional request options.

See ListSessions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) ListTableMetadata added in v1.31.8

func (c *Athena) ListTableMetadata(input *ListTableMetadataInput) (*ListTableMetadataOutput, error)

ListTableMetadata API operation for Amazon Athena.

Lists the metadata for the tables in the specified data catalog database.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation ListTableMetadata for usage and error information.

Returned Error Types:

  • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.

  • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

  • MetadataException An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform (InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListTableMetadata

func (*Athena) ListTableMetadataPages added in v1.31.8

func (c *Athena) ListTableMetadataPages(input *ListTableMetadataInput, fn func(*ListTableMetadataOutput, bool) bool) error

ListTableMetadataPages iterates over the pages of a ListTableMetadata operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTableMetadata method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListTableMetadata operation.
pageNum := 0
err := client.ListTableMetadataPages(params,
    func(page *athena.ListTableMetadataOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Athena) ListTableMetadataPagesWithContext added in v1.31.8

func (c *Athena) ListTableMetadataPagesWithContext(ctx aws.Context, input *ListTableMetadataInput, fn func(*ListTableMetadataOutput, bool) bool, opts ...request.Option) error

ListTableMetadataPagesWithContext same as ListTableMetadataPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) ListTableMetadataRequest added in v1.31.8

func (c *Athena) ListTableMetadataRequest(input *ListTableMetadataInput) (req *request.Request, output *ListTableMetadataOutput)

ListTableMetadataRequest generates a "aws/request.Request" representing the client's request for the ListTableMetadata operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTableMetadata for more information on using the ListTableMetadata API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTableMetadataRequest method.
req, resp := client.ListTableMetadataRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListTableMetadata

func (*Athena) ListTableMetadataWithContext added in v1.31.8

func (c *Athena) ListTableMetadataWithContext(ctx aws.Context, input *ListTableMetadataInput, opts ...request.Option) (*ListTableMetadataOutput, error)

ListTableMetadataWithContext is the same as ListTableMetadata with the addition of the ability to pass a context and additional request options.

See ListTableMetadata for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) ListTagsForResource added in v1.17.4

func (c *Athena) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Athena.

Lists the tags associated with an Athena resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.

  • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

  • ResourceNotFoundException A resource, such as a workgroup, was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListTagsForResource

func (*Athena) ListTagsForResourcePages added in v1.31.8

func (c *Athena) ListTagsForResourcePages(input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool) error

ListTagsForResourcePages iterates over the pages of a ListTagsForResource operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTagsForResource method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListTagsForResource operation.
pageNum := 0
err := client.ListTagsForResourcePages(params,
    func(page *athena.ListTagsForResourceOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Athena) ListTagsForResourcePagesWithContext added in v1.31.8

func (c *Athena) ListTagsForResourcePagesWithContext(ctx aws.Context, input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool, opts ...request.Option) error

ListTagsForResourcePagesWithContext same as ListTagsForResourcePages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) ListTagsForResourceRequest added in v1.17.4

func (c *Athena) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListTagsForResource

func (*Athena) ListTagsForResourceWithContext added in v1.17.4

func (c *Athena) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) ListWorkGroups added in v1.17.0

func (c *Athena) ListWorkGroups(input *ListWorkGroupsInput) (*ListWorkGroupsOutput, error)

ListWorkGroups API operation for Amazon Athena.

Lists available workgroups for the account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation ListWorkGroups for usage and error information.

Returned Error Types:

  • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.

  • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListWorkGroups

func (*Athena) ListWorkGroupsPages added in v1.17.0

func (c *Athena) ListWorkGroupsPages(input *ListWorkGroupsInput, fn func(*ListWorkGroupsOutput, bool) bool) error

ListWorkGroupsPages iterates over the pages of a ListWorkGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListWorkGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListWorkGroups operation.
pageNum := 0
err := client.ListWorkGroupsPages(params,
    func(page *athena.ListWorkGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Athena) ListWorkGroupsPagesWithContext added in v1.17.0

func (c *Athena) ListWorkGroupsPagesWithContext(ctx aws.Context, input *ListWorkGroupsInput, fn func(*ListWorkGroupsOutput, bool) bool, opts ...request.Option) error

ListWorkGroupsPagesWithContext same as ListWorkGroupsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) ListWorkGroupsRequest added in v1.17.0

func (c *Athena) ListWorkGroupsRequest(input *ListWorkGroupsInput) (req *request.Request, output *ListWorkGroupsOutput)

ListWorkGroupsRequest generates a "aws/request.Request" representing the client's request for the ListWorkGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListWorkGroups for more information on using the ListWorkGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListWorkGroupsRequest method.
req, resp := client.ListWorkGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListWorkGroups

func (*Athena) ListWorkGroupsWithContext added in v1.17.0

func (c *Athena) ListWorkGroupsWithContext(ctx aws.Context, input *ListWorkGroupsInput, opts ...request.Option) (*ListWorkGroupsOutput, error)

ListWorkGroupsWithContext is the same as ListWorkGroups with the addition of the ability to pass a context and additional request options.

See ListWorkGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) PutCapacityAssignmentConfiguration added in v1.44.253

func (c *Athena) PutCapacityAssignmentConfiguration(input *PutCapacityAssignmentConfigurationInput) (*PutCapacityAssignmentConfigurationOutput, error)

PutCapacityAssignmentConfiguration API operation for Amazon Athena.

Puts a new capacity assignment configuration for a specified capacity reservation. If a capacity assignment configuration already exists for the capacity reservation, replaces the existing capacity assignment configuration.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation PutCapacityAssignmentConfiguration for usage and error information.

Returned Error Types:

  • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

  • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/PutCapacityAssignmentConfiguration

func (*Athena) PutCapacityAssignmentConfigurationRequest added in v1.44.253

func (c *Athena) PutCapacityAssignmentConfigurationRequest(input *PutCapacityAssignmentConfigurationInput) (req *request.Request, output *PutCapacityAssignmentConfigurationOutput)

PutCapacityAssignmentConfigurationRequest generates a "aws/request.Request" representing the client's request for the PutCapacityAssignmentConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutCapacityAssignmentConfiguration for more information on using the PutCapacityAssignmentConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutCapacityAssignmentConfigurationRequest method.
req, resp := client.PutCapacityAssignmentConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/PutCapacityAssignmentConfiguration

func (*Athena) PutCapacityAssignmentConfigurationWithContext added in v1.44.253

func (c *Athena) PutCapacityAssignmentConfigurationWithContext(ctx aws.Context, input *PutCapacityAssignmentConfigurationInput, opts ...request.Option) (*PutCapacityAssignmentConfigurationOutput, error)

PutCapacityAssignmentConfigurationWithContext is the same as PutCapacityAssignmentConfiguration with the addition of the ability to pass a context and additional request options.

See PutCapacityAssignmentConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) StartCalculationExecution added in v1.44.150

func (c *Athena) StartCalculationExecution(input *StartCalculationExecutionInput) (*StartCalculationExecutionOutput, error)

StartCalculationExecution API operation for Amazon Athena.

Submits calculations for execution within a session. You can supply the code to run as an inline code block within the request.

The request syntax requires the StartCalculationExecutionRequest$CodeBlock parameter or the CalculationConfiguration$CodeBlock parameter, but not both. Because CalculationConfiguration$CodeBlock is deprecated, use the StartCalculationExecutionRequest$CodeBlock parameter instead.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation StartCalculationExecution for usage and error information.

Returned Error Types:

  • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.

  • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

  • ResourceNotFoundException A resource, such as a workgroup, was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StartCalculationExecution

func (*Athena) StartCalculationExecutionRequest added in v1.44.150

func (c *Athena) StartCalculationExecutionRequest(input *StartCalculationExecutionInput) (req *request.Request, output *StartCalculationExecutionOutput)

StartCalculationExecutionRequest generates a "aws/request.Request" representing the client's request for the StartCalculationExecution operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartCalculationExecution for more information on using the StartCalculationExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartCalculationExecutionRequest method.
req, resp := client.StartCalculationExecutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StartCalculationExecution

func (*Athena) StartCalculationExecutionWithContext added in v1.44.150

func (c *Athena) StartCalculationExecutionWithContext(ctx aws.Context, input *StartCalculationExecutionInput, opts ...request.Option) (*StartCalculationExecutionOutput, error)

StartCalculationExecutionWithContext is the same as StartCalculationExecution with the addition of the ability to pass a context and additional request options.

See StartCalculationExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) StartQueryExecution

func (c *Athena) StartQueryExecution(input *StartQueryExecutionInput) (*StartQueryExecutionOutput, error)

StartQueryExecution API operation for Amazon Athena.

Runs the SQL query statements contained in the Query. Requires you to have access to the workgroup in which the query ran. Running queries against an external catalog requires GetDataCatalog permission to the catalog. For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples (http://docs.aws.amazon.com/athena/latest/ug/code-samples.html) in the Amazon Athena User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation StartQueryExecution for usage and error information.

Returned Error Types:

  • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.

  • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

  • TooManyRequestsException Indicates that the request was throttled.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StartQueryExecution

func (*Athena) StartQueryExecutionRequest

func (c *Athena) StartQueryExecutionRequest(input *StartQueryExecutionInput) (req *request.Request, output *StartQueryExecutionOutput)

StartQueryExecutionRequest generates a "aws/request.Request" representing the client's request for the StartQueryExecution operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartQueryExecution for more information on using the StartQueryExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartQueryExecutionRequest method.
req, resp := client.StartQueryExecutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StartQueryExecution

func (*Athena) StartQueryExecutionWithContext

func (c *Athena) StartQueryExecutionWithContext(ctx aws.Context, input *StartQueryExecutionInput, opts ...request.Option) (*StartQueryExecutionOutput, error)

StartQueryExecutionWithContext is the same as StartQueryExecution with the addition of the ability to pass a context and additional request options.

See StartQueryExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) StartSession added in v1.44.150

func (c *Athena) StartSession(input *StartSessionInput) (*StartSessionOutput, error)

StartSession API operation for Amazon Athena.

Creates a session for running calculations within a workgroup. The session is ready when it reaches an IDLE state.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation StartSession for usage and error information.

Returned Error Types:

  • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.

  • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

  • ResourceNotFoundException A resource, such as a workgroup, was not found.

  • SessionAlreadyExistsException The specified session already exists.

  • TooManyRequestsException Indicates that the request was throttled.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StartSession

func (*Athena) StartSessionRequest added in v1.44.150

func (c *Athena) StartSessionRequest(input *StartSessionInput) (req *request.Request, output *StartSessionOutput)

StartSessionRequest generates a "aws/request.Request" representing the client's request for the StartSession operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartSession for more information on using the StartSession API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartSessionRequest method.
req, resp := client.StartSessionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StartSession

func (*Athena) StartSessionWithContext added in v1.44.150

func (c *Athena) StartSessionWithContext(ctx aws.Context, input *StartSessionInput, opts ...request.Option) (*StartSessionOutput, error)

StartSessionWithContext is the same as StartSession with the addition of the ability to pass a context and additional request options.

See StartSession for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) StopCalculationExecution added in v1.44.150

func (c *Athena) StopCalculationExecution(input *StopCalculationExecutionInput) (*StopCalculationExecutionOutput, error)

StopCalculationExecution API operation for Amazon Athena.

Requests the cancellation of a calculation. A StopCalculationExecution call on a calculation that is already in a terminal state (for example, STOPPED, FAILED, or COMPLETED) succeeds but has no effect.

Cancelling a calculation is done on a best effort basis. If a calculation cannot be cancelled, you can be charged for its completion. If you are concerned about being charged for a calculation that cannot be cancelled, consider terminating the session in which the calculation is running.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation StopCalculationExecution for usage and error information.

Returned Error Types:

  • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.

  • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

  • ResourceNotFoundException A resource, such as a workgroup, was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StopCalculationExecution

func (*Athena) StopCalculationExecutionRequest added in v1.44.150

func (c *Athena) StopCalculationExecutionRequest(input *StopCalculationExecutionInput) (req *request.Request, output *StopCalculationExecutionOutput)

StopCalculationExecutionRequest generates a "aws/request.Request" representing the client's request for the StopCalculationExecution operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopCalculationExecution for more information on using the StopCalculationExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopCalculationExecutionRequest method.
req, resp := client.StopCalculationExecutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StopCalculationExecution

func (*Athena) StopCalculationExecutionWithContext added in v1.44.150

func (c *Athena) StopCalculationExecutionWithContext(ctx aws.Context, input *StopCalculationExecutionInput, opts ...request.Option) (*StopCalculationExecutionOutput, error)

StopCalculationExecutionWithContext is the same as StopCalculationExecution with the addition of the ability to pass a context and additional request options.

See StopCalculationExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) StopQueryExecution

func (c *Athena) StopQueryExecution(input *StopQueryExecutionInput) (*StopQueryExecutionOutput, error)

StopQueryExecution API operation for Amazon Athena.

Stops a query execution. Requires you to have access to the workgroup in which the query ran.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation StopQueryExecution for usage and error information.

Returned Error Types:

  • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.

  • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StopQueryExecution

func (*Athena) StopQueryExecutionRequest

func (c *Athena) StopQueryExecutionRequest(input *StopQueryExecutionInput) (req *request.Request, output *StopQueryExecutionOutput)

StopQueryExecutionRequest generates a "aws/request.Request" representing the client's request for the StopQueryExecution operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopQueryExecution for more information on using the StopQueryExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopQueryExecutionRequest method.
req, resp := client.StopQueryExecutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StopQueryExecution

func (*Athena) StopQueryExecutionWithContext

func (c *Athena) StopQueryExecutionWithContext(ctx aws.Context, input *StopQueryExecutionInput, opts ...request.Option) (*StopQueryExecutionOutput, error)

StopQueryExecutionWithContext is the same as StopQueryExecution with the addition of the ability to pass a context and additional request options.

See StopQueryExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) TagResource added in v1.17.4

func (c *Athena) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Athena.

Adds one or more tags to an Athena resource. A tag is a label that you assign to a resource. 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, data catalogs, or capacity reservations by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter the resources in your account. For best practices, see Tagging Best Practices (https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html). Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation TagResource for usage and error information.

Returned Error Types:

  • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.

  • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

  • ResourceNotFoundException A resource, such as a workgroup, was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/TagResource

func (*Athena) TagResourceRequest added in v1.17.4

func (c *Athena) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/TagResource

func (*Athena) TagResourceWithContext added in v1.17.4

func (c *Athena) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) TerminateSession added in v1.44.150

func (c *Athena) TerminateSession(input *TerminateSessionInput) (*TerminateSessionOutput, error)

TerminateSession API operation for Amazon Athena.

Terminates an active session. A TerminateSession call on a session that is already inactive (for example, in a FAILED, TERMINATED or TERMINATING state) succeeds but has no effect. Calculations running in the session when TerminateSession is called are forcefully stopped, but may display as FAILED instead of STOPPED.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation TerminateSession for usage and error information.

Returned Error Types:

  • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.

  • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

  • ResourceNotFoundException A resource, such as a workgroup, was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/TerminateSession

func (*Athena) TerminateSessionRequest added in v1.44.150

func (c *Athena) TerminateSessionRequest(input *TerminateSessionInput) (req *request.Request, output *TerminateSessionOutput)

TerminateSessionRequest generates a "aws/request.Request" representing the client's request for the TerminateSession operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TerminateSession for more information on using the TerminateSession API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TerminateSessionRequest method.
req, resp := client.TerminateSessionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/TerminateSession

func (*Athena) TerminateSessionWithContext added in v1.44.150

func (c *Athena) TerminateSessionWithContext(ctx aws.Context, input *TerminateSessionInput, opts ...request.Option) (*TerminateSessionOutput, error)

TerminateSessionWithContext is the same as TerminateSession with the addition of the ability to pass a context and additional request options.

See TerminateSession for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) UntagResource added in v1.17.4

func (c *Athena) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Athena.

Removes one or more tags from an Athena resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation UntagResource for usage and error information.

Returned Error Types:

  • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.

  • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

  • ResourceNotFoundException A resource, such as a workgroup, was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UntagResource

func (*Athena) UntagResourceRequest added in v1.17.4

func (c *Athena) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UntagResource

func (*Athena) UntagResourceWithContext added in v1.17.4

func (c *Athena) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) UpdateCapacityReservation added in v1.44.253

func (c *Athena) UpdateCapacityReservation(input *UpdateCapacityReservationInput) (*UpdateCapacityReservationOutput, error)

UpdateCapacityReservation API operation for Amazon Athena.

Updates the number of requested data processing units for the capacity reservation with the specified name.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation UpdateCapacityReservation for usage and error information.

Returned Error Types:

  • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

  • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateCapacityReservation

func (*Athena) UpdateCapacityReservationRequest added in v1.44.253

func (c *Athena) UpdateCapacityReservationRequest(input *UpdateCapacityReservationInput) (req *request.Request, output *UpdateCapacityReservationOutput)

UpdateCapacityReservationRequest generates a "aws/request.Request" representing the client's request for the UpdateCapacityReservation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateCapacityReservation for more information on using the UpdateCapacityReservation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateCapacityReservationRequest method.
req, resp := client.UpdateCapacityReservationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateCapacityReservation

func (*Athena) UpdateCapacityReservationWithContext added in v1.44.253

func (c *Athena) UpdateCapacityReservationWithContext(ctx aws.Context, input *UpdateCapacityReservationInput, opts ...request.Option) (*UpdateCapacityReservationOutput, error)

UpdateCapacityReservationWithContext is the same as UpdateCapacityReservation with the addition of the ability to pass a context and additional request options.

See UpdateCapacityReservation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) UpdateDataCatalog added in v1.31.8

func (c *Athena) UpdateDataCatalog(input *UpdateDataCatalogInput) (*UpdateDataCatalogOutput, error)

UpdateDataCatalog API operation for Amazon Athena.

Updates the data catalog that has the specified name.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation UpdateDataCatalog for usage and error information.

Returned Error Types:

  • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.

  • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateDataCatalog

func (*Athena) UpdateDataCatalogRequest added in v1.31.8

func (c *Athena) UpdateDataCatalogRequest(input *UpdateDataCatalogInput) (req *request.Request, output *UpdateDataCatalogOutput)

UpdateDataCatalogRequest generates a "aws/request.Request" representing the client's request for the UpdateDataCatalog operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateDataCatalog for more information on using the UpdateDataCatalog API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateDataCatalogRequest method.
req, resp := client.UpdateDataCatalogRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateDataCatalog

func (*Athena) UpdateDataCatalogWithContext added in v1.31.8

func (c *Athena) UpdateDataCatalogWithContext(ctx aws.Context, input *UpdateDataCatalogInput, opts ...request.Option) (*UpdateDataCatalogOutput, error)

UpdateDataCatalogWithContext is the same as UpdateDataCatalog with the addition of the ability to pass a context and additional request options.

See UpdateDataCatalog for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) UpdateNamedQuery added in v1.43.8

func (c *Athena) UpdateNamedQuery(input *UpdateNamedQueryInput) (*UpdateNamedQueryOutput, error)

UpdateNamedQuery API operation for Amazon Athena.

Updates a NamedQuery object. The database or workgroup cannot be updated.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation UpdateNamedQuery for usage and error information.

Returned Error Types:

  • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.

  • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateNamedQuery

func (*Athena) UpdateNamedQueryRequest added in v1.43.8

func (c *Athena) UpdateNamedQueryRequest(input *UpdateNamedQueryInput) (req *request.Request, output *UpdateNamedQueryOutput)

UpdateNamedQueryRequest generates a "aws/request.Request" representing the client's request for the UpdateNamedQuery operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateNamedQuery for more information on using the UpdateNamedQuery API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateNamedQueryRequest method.
req, resp := client.UpdateNamedQueryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateNamedQuery

func (*Athena) UpdateNamedQueryWithContext added in v1.43.8

func (c *Athena) UpdateNamedQueryWithContext(ctx aws.Context, input *UpdateNamedQueryInput, opts ...request.Option) (*UpdateNamedQueryOutput, error)

UpdateNamedQueryWithContext is the same as UpdateNamedQuery with the addition of the ability to pass a context and additional request options.

See UpdateNamedQuery for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) UpdateNotebook added in v1.44.150

func (c *Athena) UpdateNotebook(input *UpdateNotebookInput) (*UpdateNotebookOutput, error)

UpdateNotebook API operation for Amazon Athena.

Updates the contents of a Spark notebook.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation UpdateNotebook for usage and error information.

Returned Error Types:

  • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.

  • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

  • TooManyRequestsException Indicates that the request was throttled.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateNotebook

func (*Athena) UpdateNotebookMetadata added in v1.44.150

func (c *Athena) UpdateNotebookMetadata(input *UpdateNotebookMetadataInput) (*UpdateNotebookMetadataOutput, error)

UpdateNotebookMetadata API operation for Amazon Athena.

Updates the metadata for a notebook.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation UpdateNotebookMetadata for usage and error information.

Returned Error Types:

  • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.

  • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

  • TooManyRequestsException Indicates that the request was throttled.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateNotebookMetadata

func (*Athena) UpdateNotebookMetadataRequest added in v1.44.150

func (c *Athena) UpdateNotebookMetadataRequest(input *UpdateNotebookMetadataInput) (req *request.Request, output *UpdateNotebookMetadataOutput)

UpdateNotebookMetadataRequest generates a "aws/request.Request" representing the client's request for the UpdateNotebookMetadata operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateNotebookMetadata for more information on using the UpdateNotebookMetadata API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateNotebookMetadataRequest method.
req, resp := client.UpdateNotebookMetadataRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateNotebookMetadata

func (*Athena) UpdateNotebookMetadataWithContext added in v1.44.150

func (c *Athena) UpdateNotebookMetadataWithContext(ctx aws.Context, input *UpdateNotebookMetadataInput, opts ...request.Option) (*UpdateNotebookMetadataOutput, error)

UpdateNotebookMetadataWithContext is the same as UpdateNotebookMetadata with the addition of the ability to pass a context and additional request options.

See UpdateNotebookMetadata for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) UpdateNotebookRequest added in v1.44.150

func (c *Athena) UpdateNotebookRequest(input *UpdateNotebookInput) (req *request.Request, output *UpdateNotebookOutput)

UpdateNotebookRequest generates a "aws/request.Request" representing the client's request for the UpdateNotebook operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateNotebook for more information on using the UpdateNotebook API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateNotebookRequest method.
req, resp := client.UpdateNotebookRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateNotebook

func (*Athena) UpdateNotebookWithContext added in v1.44.150

func (c *Athena) UpdateNotebookWithContext(ctx aws.Context, input *UpdateNotebookInput, opts ...request.Option) (*UpdateNotebookOutput, error)

UpdateNotebookWithContext is the same as UpdateNotebook with the addition of the ability to pass a context and additional request options.

See UpdateNotebook for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) UpdatePreparedStatement added in v1.37.25

func (c *Athena) UpdatePreparedStatement(input *UpdatePreparedStatementInput) (*UpdatePreparedStatementOutput, error)

UpdatePreparedStatement API operation for Amazon Athena.

Updates a prepared statement.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation UpdatePreparedStatement for usage and error information.

Returned Error Types:

  • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.

  • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

  • ResourceNotFoundException A resource, such as a workgroup, was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdatePreparedStatement

func (*Athena) UpdatePreparedStatementRequest added in v1.37.25

func (c *Athena) UpdatePreparedStatementRequest(input *UpdatePreparedStatementInput) (req *request.Request, output *UpdatePreparedStatementOutput)

UpdatePreparedStatementRequest generates a "aws/request.Request" representing the client's request for the UpdatePreparedStatement operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdatePreparedStatement for more information on using the UpdatePreparedStatement API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdatePreparedStatementRequest method.
req, resp := client.UpdatePreparedStatementRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdatePreparedStatement

func (*Athena) UpdatePreparedStatementWithContext added in v1.37.25

func (c *Athena) UpdatePreparedStatementWithContext(ctx aws.Context, input *UpdatePreparedStatementInput, opts ...request.Option) (*UpdatePreparedStatementOutput, error)

UpdatePreparedStatementWithContext is the same as UpdatePreparedStatement with the addition of the ability to pass a context and additional request options.

See UpdatePreparedStatement for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Athena) UpdateWorkGroup added in v1.17.0

func (c *Athena) UpdateWorkGroup(input *UpdateWorkGroupInput) (*UpdateWorkGroupOutput, error)

UpdateWorkGroup API operation for Amazon Athena.

Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only ConfigurationUpdates can be specified.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Athena's API operation UpdateWorkGroup for usage and error information.

Returned Error Types:

  • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.

  • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateWorkGroup

func (*Athena) UpdateWorkGroupRequest added in v1.17.0

func (c *Athena) UpdateWorkGroupRequest(input *UpdateWorkGroupInput) (req *request.Request, output *UpdateWorkGroupOutput)

UpdateWorkGroupRequest generates a "aws/request.Request" representing the client's request for the UpdateWorkGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateWorkGroup for more information on using the UpdateWorkGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateWorkGroupRequest method.
req, resp := client.UpdateWorkGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateWorkGroup

func (*Athena) UpdateWorkGroupWithContext added in v1.17.0

func (c *Athena) UpdateWorkGroupWithContext(ctx aws.Context, input *UpdateWorkGroupInput, opts ...request.Option) (*UpdateWorkGroupOutput, error)

UpdateWorkGroupWithContext is the same as UpdateWorkGroup with the addition of the ability to pass a context and additional request options.

See UpdateWorkGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type AthenaError added in v1.42.44

type AthenaError struct {

	// An integer value that specifies the category of a query failure error. The
	// following list shows the category for each integer value.
	//
	// 1 - System
	//
	// 2 - User
	//
	// 3 - Other
	ErrorCategory *int64 `min:"1" type:"integer"`

	// Contains a short description of the error that occurred.
	ErrorMessage *string `type:"string"`

	// An integer value that provides specific information about an Athena query
	// error. For the meaning of specific values, see the Error Type Reference (https://docs.aws.amazon.com/athena/latest/ug/error-reference.html#error-reference-error-type-reference)
	// in the Amazon Athena User Guide.
	ErrorType *int64 `type:"integer"`

	// True if the query might succeed if resubmitted.
	Retryable *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Provides information about an Athena query error. The AthenaError feature provides standardized error information to help you understand failed queries and take steps after a query failure occurs. AthenaError includes an ErrorCategory field that specifies whether the cause of the failed query is due to system error, user error, or other error.

func (AthenaError) GoString added in v1.42.44

func (s AthenaError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AthenaError) SetErrorCategory added in v1.42.44

func (s *AthenaError) SetErrorCategory(v int64) *AthenaError

SetErrorCategory sets the ErrorCategory field's value.

func (*AthenaError) SetErrorMessage added in v1.43.41

func (s *AthenaError) SetErrorMessage(v string) *AthenaError

SetErrorMessage sets the ErrorMessage field's value.

func (*AthenaError) SetErrorType added in v1.42.53

func (s *AthenaError) SetErrorType(v int64) *AthenaError

SetErrorType sets the ErrorType field's value.

func (*AthenaError) SetRetryable added in v1.43.41

func (s *AthenaError) SetRetryable(v bool) *AthenaError

SetRetryable sets the Retryable field's value.

func (AthenaError) String added in v1.42.44

func (s AthenaError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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
}

Contains an array of named query IDs.

func (BatchGetNamedQueryInput) GoString

func (s BatchGetNamedQueryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetNamedQueryInput) SetNamedQueryIds

func (s *BatchGetNamedQueryInput) SetNamedQueryIds(v []*string) *BatchGetNamedQueryInput

SetNamedQueryIds sets the NamedQueryIds field's value.

func (BatchGetNamedQueryInput) String

func (s BatchGetNamedQueryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetNamedQueryInput) Validate

func (s *BatchGetNamedQueryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchGetNamedQueryOutput

type BatchGetNamedQueryOutput struct {

	// Information about the named query IDs submitted.
	NamedQueries []*NamedQuery `type:"list"`

	// Information about provided query IDs.
	UnprocessedNamedQueryIds []*UnprocessedNamedQueryId `type:"list"`
	// contains filtered or unexported fields
}

func (BatchGetNamedQueryOutput) GoString

func (s BatchGetNamedQueryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetNamedQueryOutput) SetNamedQueries

SetNamedQueries sets the NamedQueries field's value.

func (*BatchGetNamedQueryOutput) SetUnprocessedNamedQueryIds

func (s *BatchGetNamedQueryOutput) SetUnprocessedNamedQueryIds(v []*UnprocessedNamedQueryId) *BatchGetNamedQueryOutput

SetUnprocessedNamedQueryIds sets the UnprocessedNamedQueryIds field's value.

func (BatchGetNamedQueryOutput) String

func (s BatchGetNamedQueryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetPreparedStatementInput added in v1.44.46

type BatchGetPreparedStatementInput struct {

	// A list of prepared statement names to return.
	//
	// PreparedStatementNames is a required field
	PreparedStatementNames []*string `type:"list" required:"true"`

	// The name of the workgroup to which the prepared statements belong.
	//
	// WorkGroup is a required field
	WorkGroup *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (BatchGetPreparedStatementInput) GoString added in v1.44.46

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetPreparedStatementInput) SetPreparedStatementNames added in v1.44.46

func (s *BatchGetPreparedStatementInput) SetPreparedStatementNames(v []*string) *BatchGetPreparedStatementInput

SetPreparedStatementNames sets the PreparedStatementNames field's value.

func (*BatchGetPreparedStatementInput) SetWorkGroup added in v1.44.46

SetWorkGroup sets the WorkGroup field's value.

func (BatchGetPreparedStatementInput) String added in v1.44.46

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetPreparedStatementInput) Validate added in v1.44.46

func (s *BatchGetPreparedStatementInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchGetPreparedStatementOutput added in v1.44.46

type BatchGetPreparedStatementOutput struct {

	// The list of prepared statements returned.
	PreparedStatements []*PreparedStatement `type:"list"`

	// A list of one or more prepared statements that were requested but could not
	// be returned.
	UnprocessedPreparedStatementNames []*UnprocessedPreparedStatementName `type:"list"`
	// contains filtered or unexported fields
}

func (BatchGetPreparedStatementOutput) GoString added in v1.44.46

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetPreparedStatementOutput) SetPreparedStatements added in v1.44.46

SetPreparedStatements sets the PreparedStatements field's value.

func (*BatchGetPreparedStatementOutput) SetUnprocessedPreparedStatementNames added in v1.44.46

SetUnprocessedPreparedStatementNames sets the UnprocessedPreparedStatementNames field's value.

func (BatchGetPreparedStatementOutput) String added in v1.44.46

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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
}

Contains an array of query execution IDs.

func (BatchGetQueryExecutionInput) GoString

func (s BatchGetQueryExecutionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetQueryExecutionInput) SetQueryExecutionIds

func (s *BatchGetQueryExecutionInput) SetQueryExecutionIds(v []*string) *BatchGetQueryExecutionInput

SetQueryExecutionIds sets the QueryExecutionIds field's value.

func (BatchGetQueryExecutionInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetQueryExecutionInput) Validate

func (s *BatchGetQueryExecutionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchGetQueryExecutionOutput

type BatchGetQueryExecutionOutput struct {

	// Information about a query execution.
	QueryExecutions []*QueryExecution `type:"list"`

	// Information about the query executions that failed to run.
	UnprocessedQueryExecutionIds []*UnprocessedQueryExecutionId `type:"list"`
	// contains filtered or unexported fields
}

func (BatchGetQueryExecutionOutput) GoString

func (s BatchGetQueryExecutionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetQueryExecutionOutput) SetQueryExecutions

SetQueryExecutions sets the QueryExecutions field's value.

func (*BatchGetQueryExecutionOutput) SetUnprocessedQueryExecutionIds

SetUnprocessedQueryExecutionIds sets the UnprocessedQueryExecutionIds field's value.

func (BatchGetQueryExecutionOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CalculationConfiguration added in v1.44.150

type CalculationConfiguration struct {

	// A string that contains the code for the calculation.
	CodeBlock *string `type:"string"`
	// contains filtered or unexported fields
}

Contains configuration information for the calculation.

func (CalculationConfiguration) GoString added in v1.44.150

func (s CalculationConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CalculationConfiguration) SetCodeBlock added in v1.44.150

SetCodeBlock sets the CodeBlock field's value.

func (CalculationConfiguration) String added in v1.44.150

func (s CalculationConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CalculationResult added in v1.44.150

type CalculationResult struct {

	// The Amazon S3 location of the folder for the calculation results.
	ResultS3Uri *string `type:"string"`

	// The data format of the calculation result.
	ResultType *string `min:"1" type:"string"`

	// The Amazon S3 location of the stderr error messages file for the calculation.
	StdErrorS3Uri *string `type:"string"`

	// The Amazon S3 location of the stdout file for the calculation.
	StdOutS3Uri *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about an application-specific calculation result.

func (CalculationResult) GoString added in v1.44.150

func (s CalculationResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CalculationResult) SetResultS3Uri added in v1.44.150

func (s *CalculationResult) SetResultS3Uri(v string) *CalculationResult

SetResultS3Uri sets the ResultS3Uri field's value.

func (*CalculationResult) SetResultType added in v1.44.150

func (s *CalculationResult) SetResultType(v string) *CalculationResult

SetResultType sets the ResultType field's value.

func (*CalculationResult) SetStdErrorS3Uri added in v1.44.150

func (s *CalculationResult) SetStdErrorS3Uri(v string) *CalculationResult

SetStdErrorS3Uri sets the StdErrorS3Uri field's value.

func (*CalculationResult) SetStdOutS3Uri added in v1.44.150

func (s *CalculationResult) SetStdOutS3Uri(v string) *CalculationResult

SetStdOutS3Uri sets the StdOutS3Uri field's value.

func (CalculationResult) String added in v1.44.150

func (s CalculationResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CalculationStatistics added in v1.44.150

type CalculationStatistics struct {

	// The data processing unit execution time in milliseconds for the calculation.
	DpuExecutionInMillis *int64 `type:"long"`

	// The progress of the calculation.
	Progress *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains statistics for a notebook calculation.

func (CalculationStatistics) GoString added in v1.44.150

func (s CalculationStatistics) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CalculationStatistics) SetDpuExecutionInMillis added in v1.44.150

func (s *CalculationStatistics) SetDpuExecutionInMillis(v int64) *CalculationStatistics

SetDpuExecutionInMillis sets the DpuExecutionInMillis field's value.

func (*CalculationStatistics) SetProgress added in v1.44.150

SetProgress sets the Progress field's value.

func (CalculationStatistics) String added in v1.44.150

func (s CalculationStatistics) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CalculationStatus added in v1.44.150

type CalculationStatus struct {

	// The date and time the calculation completed processing.
	CompletionDateTime *time.Time `type:"timestamp"`

	// The state of the calculation execution. A description of each state follows.
	//
	// CREATING - The calculation is in the process of being created.
	//
	// CREATED - The calculation has been created and is ready to run.
	//
	// QUEUED - The calculation has been queued for processing.
	//
	// RUNNING - The calculation is running.
	//
	// CANCELING - A request to cancel the calculation has been received and the
	// system is working to stop it.
	//
	// CANCELED - The calculation is no longer running as the result of a cancel
	// request.
	//
	// COMPLETED - The calculation has completed without error.
	//
	// FAILED - The calculation failed and is no longer running.
	State *string `type:"string" enum:"CalculationExecutionState"`

	// The reason for the calculation state change (for example, the calculation
	// was canceled because the session was terminated).
	StateChangeReason *string `min:"1" type:"string"`

	// The date and time the calculation was submitted for processing.
	SubmissionDateTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Contains information about the status of a notebook calculation.

func (CalculationStatus) GoString added in v1.44.150

func (s CalculationStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CalculationStatus) SetCompletionDateTime added in v1.44.150

func (s *CalculationStatus) SetCompletionDateTime(v time.Time) *CalculationStatus

SetCompletionDateTime sets the CompletionDateTime field's value.

func (*CalculationStatus) SetState added in v1.44.150

func (s *CalculationStatus) SetState(v string) *CalculationStatus

SetState sets the State field's value.

func (*CalculationStatus) SetStateChangeReason added in v1.44.150

func (s *CalculationStatus) SetStateChangeReason(v string) *CalculationStatus

SetStateChangeReason sets the StateChangeReason field's value.

func (*CalculationStatus) SetSubmissionDateTime added in v1.44.150

func (s *CalculationStatus) SetSubmissionDateTime(v time.Time) *CalculationStatus

SetSubmissionDateTime sets the SubmissionDateTime field's value.

func (CalculationStatus) String added in v1.44.150

func (s CalculationStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CalculationSummary added in v1.44.150

type CalculationSummary struct {

	// The calculation execution UUID.
	CalculationExecutionId *string `min:"1" type:"string"`

	// A description of the calculation.
	Description *string `min:"1" type:"string"`

	// Contains information about the status of the calculation.
	Status *CalculationStatus `type:"structure"`
	// contains filtered or unexported fields
}

Summary information for a notebook calculation.

func (CalculationSummary) GoString added in v1.44.150

func (s CalculationSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CalculationSummary) SetCalculationExecutionId added in v1.44.150

func (s *CalculationSummary) SetCalculationExecutionId(v string) *CalculationSummary

SetCalculationExecutionId sets the CalculationExecutionId field's value.

func (*CalculationSummary) SetDescription added in v1.44.150

func (s *CalculationSummary) SetDescription(v string) *CalculationSummary

SetDescription sets the Description field's value.

func (*CalculationSummary) SetStatus added in v1.44.150

SetStatus sets the Status field's value.

func (CalculationSummary) String added in v1.44.150

func (s CalculationSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CancelCapacityReservationInput added in v1.44.253

type CancelCapacityReservationInput struct {

	// The name of the capacity reservation to cancel.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelCapacityReservationInput) GoString added in v1.44.253

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelCapacityReservationInput) SetName added in v1.44.253

SetName sets the Name field's value.

func (CancelCapacityReservationInput) String added in v1.44.253

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelCapacityReservationInput) Validate added in v1.44.253

func (s *CancelCapacityReservationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CancelCapacityReservationOutput added in v1.44.253

type CancelCapacityReservationOutput struct {
	// contains filtered or unexported fields
}

func (CancelCapacityReservationOutput) GoString added in v1.44.253

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CancelCapacityReservationOutput) String added in v1.44.253

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CapacityAllocation added in v1.44.253

type CapacityAllocation struct {

	// The time when the capacity allocation request was completed.
	RequestCompletionTime *time.Time `type:"timestamp"`

	// The time when the capacity allocation was requested.
	//
	// RequestTime is a required field
	RequestTime *time.Time `type:"timestamp" required:"true"`

	// The status of the capacity allocation.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"CapacityAllocationStatus"`

	// The status message of the capacity allocation.
	StatusMessage *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the submission time of a single allocation request for a capacity reservation and the most recent status of the attempted allocation.

func (CapacityAllocation) GoString added in v1.44.253

func (s CapacityAllocation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CapacityAllocation) SetRequestCompletionTime added in v1.44.253

func (s *CapacityAllocation) SetRequestCompletionTime(v time.Time) *CapacityAllocation

SetRequestCompletionTime sets the RequestCompletionTime field's value.

func (*CapacityAllocation) SetRequestTime added in v1.44.253

func (s *CapacityAllocation) SetRequestTime(v time.Time) *CapacityAllocation

SetRequestTime sets the RequestTime field's value.

func (*CapacityAllocation) SetStatus added in v1.44.253

func (s *CapacityAllocation) SetStatus(v string) *CapacityAllocation

SetStatus sets the Status field's value.

func (*CapacityAllocation) SetStatusMessage added in v1.44.253

func (s *CapacityAllocation) SetStatusMessage(v string) *CapacityAllocation

SetStatusMessage sets the StatusMessage field's value.

func (CapacityAllocation) String added in v1.44.253

func (s CapacityAllocation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CapacityAssignment added in v1.44.253

type CapacityAssignment struct {

	// The list of workgroup names for the capacity assignment.
	WorkGroupNames []*string `type:"list"`
	// contains filtered or unexported fields
}

A mapping between one or more workgroups and a capacity reservation.

func (CapacityAssignment) GoString added in v1.44.253

func (s CapacityAssignment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CapacityAssignment) SetWorkGroupNames added in v1.44.253

func (s *CapacityAssignment) SetWorkGroupNames(v []*string) *CapacityAssignment

SetWorkGroupNames sets the WorkGroupNames field's value.

func (CapacityAssignment) String added in v1.44.253

func (s CapacityAssignment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CapacityAssignmentConfiguration added in v1.44.253

type CapacityAssignmentConfiguration struct {

	// The list of assignments that make up the capacity assignment configuration.
	CapacityAssignments []*CapacityAssignment `type:"list"`

	// The name of the reservation that the capacity assignment configuration is
	// for.
	CapacityReservationName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Assigns Athena workgroups (and hence their queries) to capacity reservations. A capacity reservation can have only one capacity assignment configuration, but the capacity assignment configuration can be made up of multiple individual assignments. Each assignment specifies how Athena queries can consume capacity from the capacity reservation that their workgroup is mapped to.

func (CapacityAssignmentConfiguration) GoString added in v1.44.253

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CapacityAssignmentConfiguration) SetCapacityAssignments added in v1.44.253

SetCapacityAssignments sets the CapacityAssignments field's value.

func (*CapacityAssignmentConfiguration) SetCapacityReservationName added in v1.44.253

SetCapacityReservationName sets the CapacityReservationName field's value.

func (CapacityAssignmentConfiguration) String added in v1.44.253

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CapacityReservation added in v1.44.253

type CapacityReservation struct {

	// The number of data processing units currently allocated.
	//
	// AllocatedDpus is a required field
	AllocatedDpus *int64 `type:"integer" required:"true"`

	// The time in UTC epoch millis when the capacity reservation was created.
	//
	// CreationTime is a required field
	CreationTime *time.Time `type:"timestamp" required:"true"`

	// Contains the submission time of a single allocation request for a capacity
	// reservation and the most recent status of the attempted allocation.
	LastAllocation *CapacityAllocation `type:"structure"`

	// The time of the most recent capacity allocation that succeeded.
	LastSuccessfulAllocationTime *time.Time `type:"timestamp"`

	// The name of the capacity reservation.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The status of the capacity reservation.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"CapacityReservationStatus"`

	// The number of data processing units requested.
	//
	// TargetDpus is a required field
	TargetDpus *int64 `min:"24" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

A reservation for a specified number of data processing units (DPUs). When a reservation is initially created, it has no DPUs. Athena allocates DPUs until the allocated amount equals the requested amount.

func (CapacityReservation) GoString added in v1.44.253

func (s CapacityReservation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CapacityReservation) SetAllocatedDpus added in v1.44.253

func (s *CapacityReservation) SetAllocatedDpus(v int64) *CapacityReservation

SetAllocatedDpus sets the AllocatedDpus field's value.

func (*CapacityReservation) SetCreationTime added in v1.44.253

func (s *CapacityReservation) SetCreationTime(v time.Time) *CapacityReservation

SetCreationTime sets the CreationTime field's value.

func (*CapacityReservation) SetLastAllocation added in v1.44.253

SetLastAllocation sets the LastAllocation field's value.

func (*CapacityReservation) SetLastSuccessfulAllocationTime added in v1.44.253

func (s *CapacityReservation) SetLastSuccessfulAllocationTime(v time.Time) *CapacityReservation

SetLastSuccessfulAllocationTime sets the LastSuccessfulAllocationTime field's value.

func (*CapacityReservation) SetName added in v1.44.253

SetName sets the Name field's value.

func (*CapacityReservation) SetStatus added in v1.44.253

SetStatus sets the Status field's value.

func (*CapacityReservation) SetTargetDpus added in v1.44.253

func (s *CapacityReservation) SetTargetDpus(v int64) *CapacityReservation

SetTargetDpus sets the TargetDpus field's value.

func (CapacityReservation) String added in v1.44.253

func (s CapacityReservation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Column added in v1.31.8

type Column struct {

	// Optional information about the column.
	Comment *string `type:"string"`

	// The name of the column.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The data type of the column.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Contains metadata for a column in a table.

func (Column) GoString added in v1.31.8

func (s Column) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Column) SetComment added in v1.31.8

func (s *Column) SetComment(v string) *Column

SetComment sets the Comment field's value.

func (*Column) SetName added in v1.31.8

func (s *Column) SetName(v string) *Column

SetName sets the Name field's value.

func (*Column) SetType added in v1.31.8

func (s *Column) SetType(v string) *Column

SetType sets the Type field's value.

func (Column) String added in v1.31.8

func (s Column) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// Unsupported constraint. This value always shows as UNKNOWN.
	Nullable *string `type:"string" enum:"ColumnNullable"`

	// For DECIMAL data types, specifies the total number of digits, up to 38. For
	// performance reasons, we recommend up to 18 digits.
	Precision *int64 `type:"integer"`

	// For DECIMAL data types, specifies the total number of digits in the fractional
	// part of the value. Defaults to 0.
	Scale *int64 `type:"integer"`

	// The schema name (database name) to which the query results belong.
	SchemaName *string `type:"string"`

	// The table name for the query results.
	TableName *string `type:"string"`

	// The data type of the column.
	//
	// Type is a required field
	Type *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information about the columns in a query execution result.

func (ColumnInfo) GoString

func (s ColumnInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ColumnInfo) SetCaseSensitive

func (s *ColumnInfo) SetCaseSensitive(v bool) *ColumnInfo

SetCaseSensitive sets the CaseSensitive field's value.

func (*ColumnInfo) SetCatalogName

func (s *ColumnInfo) SetCatalogName(v string) *ColumnInfo

SetCatalogName sets the CatalogName field's value.

func (*ColumnInfo) SetLabel

func (s *ColumnInfo) SetLabel(v string) *ColumnInfo

SetLabel sets the Label field's value.

func (*ColumnInfo) SetName

func (s *ColumnInfo) SetName(v string) *ColumnInfo

SetName sets the Name field's value.

func (*ColumnInfo) SetNullable

func (s *ColumnInfo) SetNullable(v string) *ColumnInfo

SetNullable sets the Nullable field's value.

func (*ColumnInfo) SetPrecision

func (s *ColumnInfo) SetPrecision(v int64) *ColumnInfo

SetPrecision sets the Precision field's value.

func (*ColumnInfo) SetScale

func (s *ColumnInfo) SetScale(v int64) *ColumnInfo

SetScale sets the Scale field's value.

func (*ColumnInfo) SetSchemaName

func (s *ColumnInfo) SetSchemaName(v string) *ColumnInfo

SetSchemaName sets the SchemaName field's value.

func (*ColumnInfo) SetTableName

func (s *ColumnInfo) SetTableName(v string) *ColumnInfo

SetTableName sets the TableName field's value.

func (*ColumnInfo) SetType

func (s *ColumnInfo) SetType(v string) *ColumnInfo

SetType sets the Type field's value.

func (ColumnInfo) String

func (s ColumnInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateCapacityReservationInput added in v1.44.253

type CreateCapacityReservationInput struct {

	// The name of the capacity reservation to create.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The tags for the capacity reservation.
	Tags []*Tag `type:"list"`

	// The number of requested data processing units.
	//
	// TargetDpus is a required field
	TargetDpus *int64 `min:"24" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

func (CreateCapacityReservationInput) GoString added in v1.44.253

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCapacityReservationInput) SetName added in v1.44.253

SetName sets the Name field's value.

func (*CreateCapacityReservationInput) SetTags added in v1.44.253

SetTags sets the Tags field's value.

func (*CreateCapacityReservationInput) SetTargetDpus added in v1.44.253

SetTargetDpus sets the TargetDpus field's value.

func (CreateCapacityReservationInput) String added in v1.44.253

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCapacityReservationInput) Validate added in v1.44.253

func (s *CreateCapacityReservationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateCapacityReservationOutput added in v1.44.253

type CreateCapacityReservationOutput struct {
	// contains filtered or unexported fields
}

func (CreateCapacityReservationOutput) GoString added in v1.44.253

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CreateCapacityReservationOutput) String added in v1.44.253

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDataCatalogInput added in v1.31.8

type CreateDataCatalogInput struct {

	// A description of the data catalog to be created.
	Description *string `min:"1" type:"string"`

	// The name of the data catalog to create. The catalog name must be unique for
	// the Amazon Web Services account and can use a maximum of 127 alphanumeric,
	// underscore, at sign, or hyphen characters. The remainder of the length constraint
	// of 256 is reserved for use by Athena.
	//
	// 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 takes a catalog ID parameter and is required. The catalog_id
	//    is the account ID of the Amazon Web Services account to which the Glue
	//    Data Catalog belongs. catalog-id=catalog_id The GLUE data catalog type
	//    also applies to the default AwsDataCatalog that already exists in your
	//    account, of which you can have only one and cannot modify.
	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, HIVE
	// for an external hive metastore, or GLUE for an Glue Data Catalog.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"DataCatalogType"`
	// contains filtered or unexported fields
}

func (CreateDataCatalogInput) GoString added in v1.31.8

func (s CreateDataCatalogInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDataCatalogInput) SetDescription added in v1.31.8

SetDescription sets the Description field's value.

func (*CreateDataCatalogInput) SetName added in v1.31.8

SetName sets the Name field's value.

func (*CreateDataCatalogInput) SetParameters added in v1.31.8

func (s *CreateDataCatalogInput) SetParameters(v map[string]*string) *CreateDataCatalogInput

SetParameters sets the Parameters field's value.

func (*CreateDataCatalogInput) SetTags added in v1.31.8

SetTags sets the Tags field's value.

func (*CreateDataCatalogInput) SetType added in v1.31.8

SetType sets the Type field's value.

func (CreateDataCatalogInput) String added in v1.31.8

func (s CreateDataCatalogInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDataCatalogInput) Validate added in v1.31.8

func (s *CreateDataCatalogInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDataCatalogOutput added in v1.31.8

type CreateDataCatalogOutput struct {
	// contains filtered or unexported fields
}

func (CreateDataCatalogOutput) GoString added in v1.31.8

func (s CreateDataCatalogOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CreateDataCatalogOutput) String added in v1.31.8

func (s CreateDataCatalogOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services SDKs (for
	// example the Amazon Web Services SDK for Java) auto-generate the token for
	// users. If you are not using the Amazon Web Services SDK or the Amazon Web
	// Services CLI, you must provide this token or the action will fail.
	ClientRequestToken *string `min:"32" type:"string" idempotencyToken:"true"`

	// The database to which the query belongs.
	//
	// Database is a required field
	Database *string `min:"1" type:"string" required:"true"`

	// The query description.
	Description *string `min:"1" type:"string"`

	// The query name.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The contents of the query with all query statements.
	//
	// QueryString is a required field
	QueryString *string `min:"1" type:"string" required:"true"`

	// The name of the workgroup in which the named query is being created.
	WorkGroup *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateNamedQueryInput) GoString

func (s CreateNamedQueryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateNamedQueryInput) SetClientRequestToken

func (s *CreateNamedQueryInput) SetClientRequestToken(v string) *CreateNamedQueryInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateNamedQueryInput) SetDatabase

SetDatabase sets the Database field's value.

func (*CreateNamedQueryInput) SetDescription

func (s *CreateNamedQueryInput) SetDescription(v string) *CreateNamedQueryInput

SetDescription sets the Description field's value.

func (*CreateNamedQueryInput) SetName

SetName sets the Name field's value.

func (*CreateNamedQueryInput) SetQueryString

func (s *CreateNamedQueryInput) SetQueryString(v string) *CreateNamedQueryInput

SetQueryString sets the QueryString field's value.

func (*CreateNamedQueryInput) SetWorkGroup added in v1.17.0

SetWorkGroup sets the WorkGroup field's value.

func (CreateNamedQueryInput) String

func (s CreateNamedQueryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateNamedQueryOutput) GoString

func (s CreateNamedQueryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateNamedQueryOutput) SetNamedQueryId

func (s *CreateNamedQueryOutput) SetNamedQueryId(v string) *CreateNamedQueryOutput

SetNamedQueryId sets the NamedQueryId field's value.

func (CreateNamedQueryOutput) String

func (s CreateNamedQueryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateNotebookInput added in v1.44.150

type CreateNotebookInput struct {

	// A unique case-sensitive string used to ensure the request to create the notebook
	// is idempotent (executes only once).
	//
	// This token is listed as not required because Amazon Web Services SDKs (for
	// example the Amazon Web Services SDK for Java) auto-generate the token for
	// you. If you are not using the Amazon Web Services SDK or the Amazon Web Services
	// CLI, you must provide this token or the action will fail.
	ClientRequestToken *string `min:"1" type:"string"`

	// The name of the ipynb file to be created in the Spark workgroup, without
	// the .ipynb extension.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The name of the Spark enabled workgroup in which the notebook will be created.
	//
	// WorkGroup is a required field
	WorkGroup *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateNotebookInput) GoString added in v1.44.150

func (s CreateNotebookInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateNotebookInput) SetClientRequestToken added in v1.44.150

func (s *CreateNotebookInput) SetClientRequestToken(v string) *CreateNotebookInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateNotebookInput) SetName added in v1.44.150

SetName sets the Name field's value.

func (*CreateNotebookInput) SetWorkGroup added in v1.44.150

func (s *CreateNotebookInput) SetWorkGroup(v string) *CreateNotebookInput

SetWorkGroup sets the WorkGroup field's value.

func (CreateNotebookInput) String added in v1.44.150

func (s CreateNotebookInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateNotebookInput) Validate added in v1.44.150

func (s *CreateNotebookInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateNotebookOutput added in v1.44.150

type CreateNotebookOutput struct {

	// A unique identifier for the notebook.
	NotebookId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateNotebookOutput) GoString added in v1.44.150

func (s CreateNotebookOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateNotebookOutput) SetNotebookId added in v1.44.150

func (s *CreateNotebookOutput) SetNotebookId(v string) *CreateNotebookOutput

SetNotebookId sets the NotebookId field's value.

func (CreateNotebookOutput) String added in v1.44.150

func (s CreateNotebookOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreatePreparedStatementInput added in v1.37.25

type CreatePreparedStatementInput struct {

	// The description of the prepared statement.
	Description *string `min:"1" type:"string"`

	// The query string for the prepared statement.
	//
	// QueryStatement is a required field
	QueryStatement *string `min:"1" type:"string" required:"true"`

	// The name of the prepared statement.
	//
	// StatementName is a required field
	StatementName *string `min:"1" type:"string" required:"true"`

	// The name of the workgroup to which the prepared statement belongs.
	//
	// WorkGroup is a required field
	WorkGroup *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreatePreparedStatementInput) GoString added in v1.37.25

func (s CreatePreparedStatementInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePreparedStatementInput) SetDescription added in v1.37.25

SetDescription sets the Description field's value.

func (*CreatePreparedStatementInput) SetQueryStatement added in v1.37.25

SetQueryStatement sets the QueryStatement field's value.

func (*CreatePreparedStatementInput) SetStatementName added in v1.37.25

SetStatementName sets the StatementName field's value.

func (*CreatePreparedStatementInput) SetWorkGroup added in v1.37.25

SetWorkGroup sets the WorkGroup field's value.

func (CreatePreparedStatementInput) String added in v1.37.25

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePreparedStatementInput) Validate added in v1.37.25

func (s *CreatePreparedStatementInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreatePreparedStatementOutput added in v1.37.25

type CreatePreparedStatementOutput struct {
	// contains filtered or unexported fields
}

func (CreatePreparedStatementOutput) GoString added in v1.37.25

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CreatePreparedStatementOutput) String added in v1.37.25

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreatePresignedNotebookUrlInput added in v1.44.150

type CreatePresignedNotebookUrlInput struct {

	// The session ID.
	//
	// SessionId is a required field
	SessionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreatePresignedNotebookUrlInput) GoString added in v1.44.150

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePresignedNotebookUrlInput) SetSessionId added in v1.44.150

SetSessionId sets the SessionId field's value.

func (CreatePresignedNotebookUrlInput) String added in v1.44.150

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePresignedNotebookUrlInput) Validate added in v1.44.150

func (s *CreatePresignedNotebookUrlInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreatePresignedNotebookUrlOutput added in v1.44.150

type CreatePresignedNotebookUrlOutput struct {

	// The authentication token for the notebook.
	//
	// AuthToken is a required field
	AuthToken *string `type:"string" required:"true"`

	// The UTC epoch time when the authentication token expires.
	//
	// AuthTokenExpirationTime is a required field
	AuthTokenExpirationTime *int64 `type:"long" required:"true"`

	// The URL of the notebook. The URL includes the authentication token and notebook
	// file name and points directly to the opened notebook.
	//
	// NotebookUrl is a required field
	NotebookUrl *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreatePresignedNotebookUrlOutput) GoString added in v1.44.150

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePresignedNotebookUrlOutput) SetAuthToken added in v1.44.150

SetAuthToken sets the AuthToken field's value.

func (*CreatePresignedNotebookUrlOutput) SetAuthTokenExpirationTime added in v1.44.150

SetAuthTokenExpirationTime sets the AuthTokenExpirationTime field's value.

func (*CreatePresignedNotebookUrlOutput) SetNotebookUrl added in v1.44.150

SetNotebookUrl sets the NotebookUrl field's value.

func (CreatePresignedNotebookUrlOutput) String added in v1.44.150

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateWorkGroupInput added in v1.17.0

type CreateWorkGroupInput struct {

	// Contains configuration information for creating an Athena SQL workgroup or
	// Spark enabled Athena workgroup. Athena SQL workgroup configuration includes
	// the location in Amazon S3 where query and calculation results are stored,
	// the encryption configuration, if any, used for encrypting query results,
	// whether the Amazon CloudWatch Metrics are enabled for the workgroup, the
	// limit for the amount of bytes scanned (cutoff) per query, if it is specified,
	// and whether workgroup's settings (specified with EnforceWorkGroupConfiguration)
	// in the WorkGroupConfiguration override client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
	Configuration *WorkGroupConfiguration `type:"structure"`

	// The workgroup description.
	Description *string `type:"string"`

	// The workgroup name.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// A list of comma separated tags to add to the workgroup that is created.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateWorkGroupInput) GoString added in v1.17.0

func (s CreateWorkGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkGroupInput) SetConfiguration added in v1.17.0

SetConfiguration sets the Configuration field's value.

func (*CreateWorkGroupInput) SetDescription added in v1.17.0

func (s *CreateWorkGroupInput) SetDescription(v string) *CreateWorkGroupInput

SetDescription sets the Description field's value.

func (*CreateWorkGroupInput) SetName added in v1.17.0

SetName sets the Name field's value.

func (*CreateWorkGroupInput) SetTags added in v1.17.4

func (s *CreateWorkGroupInput) SetTags(v []*Tag) *CreateWorkGroupInput

SetTags sets the Tags field's value.

func (CreateWorkGroupInput) String added in v1.17.0

func (s CreateWorkGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkGroupInput) Validate added in v1.17.0

func (s *CreateWorkGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateWorkGroupOutput added in v1.17.0

type CreateWorkGroupOutput struct {
	// contains filtered or unexported fields
}

func (CreateWorkGroupOutput) GoString added in v1.17.0

func (s CreateWorkGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CreateWorkGroupOutput) String added in v1.17.0

func (s CreateWorkGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CustomerContentEncryptionConfiguration added in v1.44.150

type CustomerContentEncryptionConfiguration struct {

	// The customer managed KMS key that is used to encrypt the user's data stores
	// in Athena.
	//
	// KmsKey is a required field
	KmsKey *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Specifies the customer managed KMS key that is used to encrypt the user's data stores in Athena. When an Amazon Web Services managed key is used, this value is null. This setting does not apply to Athena SQL workgroups.

func (CustomerContentEncryptionConfiguration) GoString added in v1.44.150

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomerContentEncryptionConfiguration) SetKmsKey added in v1.44.150

SetKmsKey sets the KmsKey field's value.

func (CustomerContentEncryptionConfiguration) String added in v1.44.150

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomerContentEncryptionConfiguration) Validate added in v1.44.150

Validate inspects the fields of the type to determine if they are valid.

type DataCatalog added in v1.31.8

type DataCatalog struct {

	// An optional description of the data catalog.
	Description *string `min:"1" type:"string"`

	// The name of the data catalog. The catalog name must be unique for the Amazon
	// Web Services account and can use a maximum of 127 alphanumeric, underscore,
	// at sign, or hyphen characters. The remainder of the length constraint of
	// 256 is reserved for use by Athena.
	//
	// 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 takes a catalog ID parameter and is required. The catalog_id
	//    is the account ID of the Amazon Web Services account to which the Glue
	//    catalog belongs. catalog-id=catalog_id The GLUE data catalog type also
	//    applies to the default AwsDataCatalog that already exists in your account,
	//    of which you can have only one and cannot modify.
	Parameters map[string]*string `type:"map"`

	// The type of data catalog to create: LAMBDA for a federated catalog, HIVE
	// for an external hive metastore, or GLUE for an Glue Data Catalog.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"DataCatalogType"`
	// contains filtered or unexported fields
}

Contains information about a data catalog in an Amazon Web Services account.

In the Athena console, data catalogs are listed as "data sources" on the Data sources page under the Data source name column.

func (DataCatalog) GoString added in v1.31.8

func (s DataCatalog) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataCatalog) SetDescription added in v1.31.8

func (s *DataCatalog) SetDescription(v string) *DataCatalog

SetDescription sets the Description field's value.

func (*DataCatalog) SetName added in v1.31.8

func (s *DataCatalog) SetName(v string) *DataCatalog

SetName sets the Name field's value.

func (*DataCatalog) SetParameters added in v1.31.8

func (s *DataCatalog) SetParameters(v map[string]*string) *DataCatalog

SetParameters sets the Parameters field's value.

func (*DataCatalog) SetType added in v1.31.8

func (s *DataCatalog) SetType(v string) *DataCatalog

SetType sets the Type field's value.

func (DataCatalog) String added in v1.31.8

func (s DataCatalog) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataCatalogSummary added in v1.31.8

type DataCatalogSummary struct {

	// The name of the data catalog. The catalog name is unique for the Amazon Web
	// Services account and can use a maximum of 127 alphanumeric, underscore, at
	// sign, or hyphen characters. The remainder of the length constraint of 256
	// is reserved for use by Athena.
	CatalogName *string `min:"1" type:"string"`

	// The data catalog type.
	Type *string `type:"string" enum:"DataCatalogType"`
	// contains filtered or unexported fields
}

The summary information for the data catalog, which includes its name and type.

func (DataCatalogSummary) GoString added in v1.31.8

func (s DataCatalogSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataCatalogSummary) SetCatalogName added in v1.31.8

func (s *DataCatalogSummary) SetCatalogName(v string) *DataCatalogSummary

SetCatalogName sets the CatalogName field's value.

func (*DataCatalogSummary) SetType added in v1.31.8

SetType sets the Type field's value.

func (DataCatalogSummary) String added in v1.31.8

func (s DataCatalogSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Database added in v1.31.8

type Database struct {

	// An optional description of the database.
	Description *string `min:"1" type:"string"`

	// The name of the database.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// A set of custom key/value pairs.
	Parameters map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

Contains metadata information for a database in a data catalog.

func (Database) GoString added in v1.31.8

func (s Database) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Database) SetDescription added in v1.31.8

func (s *Database) SetDescription(v string) *Database

SetDescription sets the Description field's value.

func (*Database) SetName added in v1.31.8

func (s *Database) SetName(v string) *Database

SetName sets the Name field's value.

func (*Database) SetParameters added in v1.31.8

func (s *Database) SetParameters(v map[string]*string) *Database

SetParameters sets the Parameters field's value.

func (Database) String added in v1.31.8

func (s Database) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Datum

type Datum struct {

	// The value of the datum.
	VarCharValue *string `type:"string"`
	// contains filtered or unexported fields
}

A piece of data (a field in the table).

func (Datum) GoString

func (s Datum) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Datum) SetVarCharValue

func (s *Datum) SetVarCharValue(v string) *Datum

SetVarCharValue sets the VarCharValue field's value.

func (Datum) String

func (s Datum) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteCapacityReservationInput added in v1.44.275

type DeleteCapacityReservationInput struct {

	// The name of the capacity reservation to delete.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteCapacityReservationInput) GoString added in v1.44.275

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCapacityReservationInput) SetName added in v1.44.275

SetName sets the Name field's value.

func (DeleteCapacityReservationInput) String added in v1.44.275

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCapacityReservationInput) Validate added in v1.44.275

func (s *DeleteCapacityReservationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteCapacityReservationOutput added in v1.44.275

type DeleteCapacityReservationOutput struct {
	// contains filtered or unexported fields
}

func (DeleteCapacityReservationOutput) GoString added in v1.44.275

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteCapacityReservationOutput) String added in v1.44.275

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDataCatalogInput added in v1.31.8

type DeleteDataCatalogInput struct {

	// The name of the data catalog to delete.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDataCatalogInput) GoString added in v1.31.8

func (s DeleteDataCatalogInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDataCatalogInput) SetName added in v1.31.8

SetName sets the Name field's value.

func (DeleteDataCatalogInput) String added in v1.31.8

func (s DeleteDataCatalogInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDataCatalogInput) Validate added in v1.31.8

func (s *DeleteDataCatalogInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDataCatalogOutput added in v1.31.8

type DeleteDataCatalogOutput struct {
	// contains filtered or unexported fields
}

func (DeleteDataCatalogOutput) GoString added in v1.31.8

func (s DeleteDataCatalogOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDataCatalogOutput) String added in v1.31.8

func (s DeleteDataCatalogOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteNamedQueryInput

type DeleteNamedQueryInput struct {

	// The unique ID of the query to delete.
	NamedQueryId *string `min:"1" type:"string" idempotencyToken:"true"`
	// contains filtered or unexported fields
}

func (DeleteNamedQueryInput) GoString

func (s DeleteNamedQueryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteNamedQueryInput) SetNamedQueryId

func (s *DeleteNamedQueryInput) SetNamedQueryId(v string) *DeleteNamedQueryInput

SetNamedQueryId sets the NamedQueryId field's value.

func (DeleteNamedQueryInput) String

func (s DeleteNamedQueryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s DeleteNamedQueryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteNamedQueryOutput) String

func (s DeleteNamedQueryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteNotebookInput added in v1.44.150

type DeleteNotebookInput struct {

	// The ID of the notebook to delete.
	//
	// NotebookId is a required field
	NotebookId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteNotebookInput) GoString added in v1.44.150

func (s DeleteNotebookInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteNotebookInput) SetNotebookId added in v1.44.150

func (s *DeleteNotebookInput) SetNotebookId(v string) *DeleteNotebookInput

SetNotebookId sets the NotebookId field's value.

func (DeleteNotebookInput) String added in v1.44.150

func (s DeleteNotebookInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteNotebookInput) Validate added in v1.44.150

func (s *DeleteNotebookInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteNotebookOutput added in v1.44.150

type DeleteNotebookOutput struct {
	// contains filtered or unexported fields
}

func (DeleteNotebookOutput) GoString added in v1.44.150

func (s DeleteNotebookOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteNotebookOutput) String added in v1.44.150

func (s DeleteNotebookOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeletePreparedStatementInput added in v1.37.25

type DeletePreparedStatementInput struct {

	// The name of the prepared statement to delete.
	//
	// StatementName is a required field
	StatementName *string `min:"1" type:"string" required:"true"`

	// The workgroup to which the statement to be deleted belongs.
	//
	// WorkGroup is a required field
	WorkGroup *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeletePreparedStatementInput) GoString added in v1.37.25

func (s DeletePreparedStatementInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletePreparedStatementInput) SetStatementName added in v1.37.25

SetStatementName sets the StatementName field's value.

func (*DeletePreparedStatementInput) SetWorkGroup added in v1.37.25

SetWorkGroup sets the WorkGroup field's value.

func (DeletePreparedStatementInput) String added in v1.37.25

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletePreparedStatementInput) Validate added in v1.37.25

func (s *DeletePreparedStatementInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeletePreparedStatementOutput added in v1.37.25

type DeletePreparedStatementOutput struct {
	// contains filtered or unexported fields
}

func (DeletePreparedStatementOutput) GoString added in v1.37.25

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeletePreparedStatementOutput) String added in v1.37.25

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteWorkGroupInput added in v1.17.0

type DeleteWorkGroupInput struct {

	// The option to delete the workgroup and its contents even if the workgroup
	// contains any named queries, query executions, or notebooks.
	RecursiveDeleteOption *bool `type:"boolean"`

	// The unique name of the workgroup to delete.
	//
	// WorkGroup is a required field
	WorkGroup *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteWorkGroupInput) GoString added in v1.17.0

func (s DeleteWorkGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWorkGroupInput) SetRecursiveDeleteOption added in v1.17.0

func (s *DeleteWorkGroupInput) SetRecursiveDeleteOption(v bool) *DeleteWorkGroupInput

SetRecursiveDeleteOption sets the RecursiveDeleteOption field's value.

func (*DeleteWorkGroupInput) SetWorkGroup added in v1.17.0

func (s *DeleteWorkGroupInput) SetWorkGroup(v string) *DeleteWorkGroupInput

SetWorkGroup sets the WorkGroup field's value.

func (DeleteWorkGroupInput) String added in v1.17.0

func (s DeleteWorkGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWorkGroupInput) Validate added in v1.17.0

func (s *DeleteWorkGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteWorkGroupOutput added in v1.17.0

type DeleteWorkGroupOutput struct {
	// contains filtered or unexported fields
}

func (DeleteWorkGroupOutput) GoString added in v1.17.0

func (s DeleteWorkGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteWorkGroupOutput) String added in v1.17.0

func (s DeleteWorkGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EncryptionConfiguration

type EncryptionConfiguration struct {

	// Indicates whether Amazon S3 server-side encryption with Amazon S3-managed
	// keys (SSE_S3), server-side encryption with KMS-managed keys (SSE_KMS), or
	// client-side encryption with KMS-managed keys (CSE_KMS) is used.
	//
	// If a query runs in a workgroup and the workgroup overrides client-side settings,
	// then the workgroup's setting for encryption is used. It specifies whether
	// query results must be encrypted, for all queries that run in this workgroup.
	//
	// EncryptionOption is a required field
	EncryptionOption *string `type:"string" required:"true" enum:"EncryptionOption"`

	// For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.
	KmsKey *string `type:"string"`
	// contains filtered or unexported fields
}

If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information.

func (EncryptionConfiguration) GoString

func (s EncryptionConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EncryptionConfiguration) SetEncryptionOption

func (s *EncryptionConfiguration) SetEncryptionOption(v string) *EncryptionConfiguration

SetEncryptionOption sets the EncryptionOption field's value.

func (*EncryptionConfiguration) SetKmsKey

SetKmsKey sets the KmsKey field's value.

func (EncryptionConfiguration) String

func (s EncryptionConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EncryptionConfiguration) Validate

func (s *EncryptionConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EngineConfiguration added in v1.44.150

type EngineConfiguration struct {

	// Contains additional notebook engine MAP<string, string> parameter mappings
	// in the form of key-value pairs. To specify an Athena notebook that the Jupyter
	// server will download and serve, specify a value for the StartSessionRequest$NotebookVersion
	// field, and then add a key named NotebookId to AdditionalConfigs that has
	// the value of the Athena notebook ID.
	AdditionalConfigs map[string]*string `type:"map"`

	// The number of DPUs to use for the coordinator. A coordinator is a special
	// executor that orchestrates processing work and manages other executors in
	// a notebook session. The default is 1.
	CoordinatorDpuSize *int64 `min:"1" type:"integer"`

	// The default number of DPUs to use for executors. An executor is the smallest
	// unit of compute that a notebook session can request from Athena. The default
	// is 1.
	DefaultExecutorDpuSize *int64 `min:"1" type:"integer"`

	// The maximum number of DPUs that can run concurrently.
	//
	// MaxConcurrentDpus is a required field
	MaxConcurrentDpus *int64 `min:"2" type:"integer" required:"true"`

	// Specifies custom jar files and Spark properties for use cases like cluster
	// encryption, table formats, and general Spark tuning.
	SparkProperties map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

Contains data processing unit (DPU) configuration settings and parameter mappings for a notebook engine.

func (EngineConfiguration) GoString added in v1.44.150

func (s EngineConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EngineConfiguration) SetAdditionalConfigs added in v1.44.150

func (s *EngineConfiguration) SetAdditionalConfigs(v map[string]*string) *EngineConfiguration

SetAdditionalConfigs sets the AdditionalConfigs field's value.

func (*EngineConfiguration) SetCoordinatorDpuSize added in v1.44.150

func (s *EngineConfiguration) SetCoordinatorDpuSize(v int64) *EngineConfiguration

SetCoordinatorDpuSize sets the CoordinatorDpuSize field's value.

func (*EngineConfiguration) SetDefaultExecutorDpuSize added in v1.44.150

func (s *EngineConfiguration) SetDefaultExecutorDpuSize(v int64) *EngineConfiguration

SetDefaultExecutorDpuSize sets the DefaultExecutorDpuSize field's value.

func (*EngineConfiguration) SetMaxConcurrentDpus added in v1.44.150

func (s *EngineConfiguration) SetMaxConcurrentDpus(v int64) *EngineConfiguration

SetMaxConcurrentDpus sets the MaxConcurrentDpus field's value.

func (*EngineConfiguration) SetSparkProperties added in v1.44.263

func (s *EngineConfiguration) SetSparkProperties(v map[string]*string) *EngineConfiguration

SetSparkProperties sets the SparkProperties field's value.

func (EngineConfiguration) String added in v1.44.150

func (s EngineConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EngineConfiguration) Validate added in v1.44.150

func (s *EngineConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EngineVersion added in v1.37.4

type EngineVersion struct {

	// Read only. The engine version on which the query runs. If the user requests
	// a valid engine version other than Auto, the effective engine version is the
	// same as the engine version that the user requested. If the user requests
	// Auto, the effective engine version is chosen by Athena. When a request to
	// update the engine version is made by a CreateWorkGroup or UpdateWorkGroup
	// operation, the EffectiveEngineVersion field is ignored.
	EffectiveEngineVersion *string `min:"1" type:"string"`

	// The engine version requested by the user. Possible values are determined
	// by the output of ListEngineVersions, including AUTO. The default is AUTO.
	SelectedEngineVersion *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The Athena engine version for running queries, or the PySpark engine version for running sessions.

func (EngineVersion) GoString added in v1.37.4

func (s EngineVersion) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EngineVersion) SetEffectiveEngineVersion added in v1.37.4

func (s *EngineVersion) SetEffectiveEngineVersion(v string) *EngineVersion

SetEffectiveEngineVersion sets the EffectiveEngineVersion field's value.

func (*EngineVersion) SetSelectedEngineVersion added in v1.37.4

func (s *EngineVersion) SetSelectedEngineVersion(v string) *EngineVersion

SetSelectedEngineVersion sets the SelectedEngineVersion field's value.

func (EngineVersion) String added in v1.37.4

func (s EngineVersion) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EngineVersion) Validate added in v1.37.4

func (s *EngineVersion) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExecutorsSummary added in v1.44.150

type ExecutorsSummary struct {

	// The UUID of the executor.
	//
	// ExecutorId is a required field
	ExecutorId *string `type:"string" required:"true"`

	// The smallest unit of compute that a session can request from Athena. Size
	// is measured in data processing unit (DPU) values, a relative measure of processing
	// power.
	ExecutorSize *int64 `type:"long"`

	// The processing state of the executor. A description of each state follows.
	//
	// CREATING - The executor is being started, including acquiring resources.
	//
	// CREATED - The executor has been started.
	//
	// REGISTERED - The executor has been registered.
	//
	// TERMINATING - The executor is in the process of shutting down.
	//
	// TERMINATED - The executor is no longer running.
	//
	// FAILED - Due to a failure, the executor is no longer running.
	ExecutorState *string `type:"string" enum:"ExecutorState"`

	// The type of executor used for the application (COORDINATOR, GATEWAY, or WORKER).
	ExecutorType *string `type:"string" enum:"ExecutorType"`

	// The date and time that the executor started.
	StartDateTime *int64 `type:"long"`

	// The date and time that the executor was terminated.
	TerminationDateTime *int64 `type:"long"`
	// contains filtered or unexported fields
}

Contains summary information about an executor.

func (ExecutorsSummary) GoString added in v1.44.150

func (s ExecutorsSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecutorsSummary) SetExecutorId added in v1.44.150

func (s *ExecutorsSummary) SetExecutorId(v string) *ExecutorsSummary

SetExecutorId sets the ExecutorId field's value.

func (*ExecutorsSummary) SetExecutorSize added in v1.44.150

func (s *ExecutorsSummary) SetExecutorSize(v int64) *ExecutorsSummary

SetExecutorSize sets the ExecutorSize field's value.

func (*ExecutorsSummary) SetExecutorState added in v1.44.150

func (s *ExecutorsSummary) SetExecutorState(v string) *ExecutorsSummary

SetExecutorState sets the ExecutorState field's value.

func (*ExecutorsSummary) SetExecutorType added in v1.44.150

func (s *ExecutorsSummary) SetExecutorType(v string) *ExecutorsSummary

SetExecutorType sets the ExecutorType field's value.

func (*ExecutorsSummary) SetStartDateTime added in v1.44.150

func (s *ExecutorsSummary) SetStartDateTime(v int64) *ExecutorsSummary

SetStartDateTime sets the StartDateTime field's value.

func (*ExecutorsSummary) SetTerminationDateTime added in v1.44.150

func (s *ExecutorsSummary) SetTerminationDateTime(v int64) *ExecutorsSummary

SetTerminationDateTime sets the TerminationDateTime field's value.

func (ExecutorsSummary) String added in v1.44.150

func (s ExecutorsSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExportNotebookInput added in v1.44.150

type ExportNotebookInput struct {

	// The ID of the notebook to export.
	//
	// NotebookId is a required field
	NotebookId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ExportNotebookInput) GoString added in v1.44.150

func (s ExportNotebookInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportNotebookInput) SetNotebookId added in v1.44.150

func (s *ExportNotebookInput) SetNotebookId(v string) *ExportNotebookInput

SetNotebookId sets the NotebookId field's value.

func (ExportNotebookInput) String added in v1.44.150

func (s ExportNotebookInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportNotebookInput) Validate added in v1.44.150

func (s *ExportNotebookInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExportNotebookOutput added in v1.44.150

type ExportNotebookOutput struct {

	// The notebook metadata, including notebook ID, notebook name, and workgroup
	// name.
	NotebookMetadata *NotebookMetadata `type:"structure"`

	// The content of the exported notebook.
	Payload *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ExportNotebookOutput) GoString added in v1.44.150

func (s ExportNotebookOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportNotebookOutput) SetNotebookMetadata added in v1.44.150

func (s *ExportNotebookOutput) SetNotebookMetadata(v *NotebookMetadata) *ExportNotebookOutput

SetNotebookMetadata sets the NotebookMetadata field's value.

func (*ExportNotebookOutput) SetPayload added in v1.44.150

SetPayload sets the Payload field's value.

func (ExportNotebookOutput) String added in v1.44.150

func (s ExportNotebookOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FilterDefinition added in v1.44.150

type FilterDefinition struct {

	// The name of the notebook to search for.
	Name *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A string for searching notebook names.

func (FilterDefinition) GoString added in v1.44.150

func (s FilterDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FilterDefinition) SetName added in v1.44.150

func (s *FilterDefinition) SetName(v string) *FilterDefinition

SetName sets the Name field's value.

func (FilterDefinition) String added in v1.44.150

func (s FilterDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FilterDefinition) Validate added in v1.44.150

func (s *FilterDefinition) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetCalculationExecutionCodeInput added in v1.44.150

type GetCalculationExecutionCodeInput struct {

	// The calculation execution UUID.
	//
	// CalculationExecutionId is a required field
	CalculationExecutionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetCalculationExecutionCodeInput) GoString added in v1.44.150

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCalculationExecutionCodeInput) SetCalculationExecutionId added in v1.44.150

SetCalculationExecutionId sets the CalculationExecutionId field's value.

func (GetCalculationExecutionCodeInput) String added in v1.44.150

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCalculationExecutionCodeInput) Validate added in v1.44.150

Validate inspects the fields of the type to determine if they are valid.

type GetCalculationExecutionCodeOutput added in v1.44.150

type GetCalculationExecutionCodeOutput struct {

	// The unencrypted code that was executed for the calculation.
	CodeBlock *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetCalculationExecutionCodeOutput) GoString added in v1.44.150

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCalculationExecutionCodeOutput) SetCodeBlock added in v1.44.150

SetCodeBlock sets the CodeBlock field's value.

func (GetCalculationExecutionCodeOutput) String added in v1.44.150

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetCalculationExecutionInput added in v1.44.150

type GetCalculationExecutionInput struct {

	// The calculation execution UUID.
	//
	// CalculationExecutionId is a required field
	CalculationExecutionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetCalculationExecutionInput) GoString added in v1.44.150

func (s GetCalculationExecutionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCalculationExecutionInput) SetCalculationExecutionId added in v1.44.150

func (s *GetCalculationExecutionInput) SetCalculationExecutionId(v string) *GetCalculationExecutionInput

SetCalculationExecutionId sets the CalculationExecutionId field's value.

func (GetCalculationExecutionInput) String added in v1.44.150

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCalculationExecutionInput) Validate added in v1.44.150

func (s *GetCalculationExecutionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetCalculationExecutionOutput added in v1.44.150

type GetCalculationExecutionOutput struct {

	// The calculation execution UUID.
	CalculationExecutionId *string `min:"1" type:"string"`

	// The description of the calculation execution.
	Description *string `min:"1" type:"string"`

	// Contains result information. This field is populated only if the calculation
	// is completed.
	Result *CalculationResult `type:"structure"`

	// The session ID that the calculation ran in.
	SessionId *string `min:"1" type:"string"`

	// Contains information about the data processing unit (DPU) execution time
	// and progress. This field is populated only when statistics are available.
	Statistics *CalculationStatistics `type:"structure"`

	// Contains information about the status of the calculation.
	Status *CalculationStatus `type:"structure"`

	// The Amazon S3 location in which calculation results are stored.
	WorkingDirectory *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetCalculationExecutionOutput) GoString added in v1.44.150

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCalculationExecutionOutput) SetCalculationExecutionId added in v1.44.150

func (s *GetCalculationExecutionOutput) SetCalculationExecutionId(v string) *GetCalculationExecutionOutput

SetCalculationExecutionId sets the CalculationExecutionId field's value.

func (*GetCalculationExecutionOutput) SetDescription added in v1.44.150

SetDescription sets the Description field's value.

func (*GetCalculationExecutionOutput) SetResult added in v1.44.150

SetResult sets the Result field's value.

func (*GetCalculationExecutionOutput) SetSessionId added in v1.44.150

SetSessionId sets the SessionId field's value.

func (*GetCalculationExecutionOutput) SetStatistics added in v1.44.150

SetStatistics sets the Statistics field's value.

func (*GetCalculationExecutionOutput) SetStatus added in v1.44.150

SetStatus sets the Status field's value.

func (*GetCalculationExecutionOutput) SetWorkingDirectory added in v1.44.150

SetWorkingDirectory sets the WorkingDirectory field's value.

func (GetCalculationExecutionOutput) String added in v1.44.150

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetCalculationExecutionStatusInput added in v1.44.150

type GetCalculationExecutionStatusInput struct {

	// The calculation execution UUID.
	//
	// CalculationExecutionId is a required field
	CalculationExecutionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetCalculationExecutionStatusInput) GoString added in v1.44.150

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCalculationExecutionStatusInput) SetCalculationExecutionId added in v1.44.150

SetCalculationExecutionId sets the CalculationExecutionId field's value.

func (GetCalculationExecutionStatusInput) String added in v1.44.150

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCalculationExecutionStatusInput) Validate added in v1.44.150

Validate inspects the fields of the type to determine if they are valid.

type GetCalculationExecutionStatusOutput added in v1.44.150

type GetCalculationExecutionStatusOutput struct {

	// Contains information about the DPU execution time and progress.
	Statistics *CalculationStatistics `type:"structure"`

	// Contains information about the calculation execution status.
	Status *CalculationStatus `type:"structure"`
	// contains filtered or unexported fields
}

func (GetCalculationExecutionStatusOutput) GoString added in v1.44.150

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCalculationExecutionStatusOutput) SetStatistics added in v1.44.150

SetStatistics sets the Statistics field's value.

func (*GetCalculationExecutionStatusOutput) SetStatus added in v1.44.150

SetStatus sets the Status field's value.

func (GetCalculationExecutionStatusOutput) String added in v1.44.150

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetCapacityAssignmentConfigurationInput added in v1.44.253

type GetCapacityAssignmentConfigurationInput struct {

	// The name of the capacity reservation to retrieve the capacity assignment
	// configuration for.
	//
	// CapacityReservationName is a required field
	CapacityReservationName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetCapacityAssignmentConfigurationInput) GoString added in v1.44.253

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCapacityAssignmentConfigurationInput) SetCapacityReservationName added in v1.44.253

SetCapacityReservationName sets the CapacityReservationName field's value.

func (GetCapacityAssignmentConfigurationInput) String added in v1.44.253

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCapacityAssignmentConfigurationInput) Validate added in v1.44.253

Validate inspects the fields of the type to determine if they are valid.

type GetCapacityAssignmentConfigurationOutput added in v1.44.253

type GetCapacityAssignmentConfigurationOutput struct {

	// The requested capacity assignment configuration for the specified capacity
	// reservation.
	//
	// CapacityAssignmentConfiguration is a required field
	CapacityAssignmentConfiguration *CapacityAssignmentConfiguration `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetCapacityAssignmentConfigurationOutput) GoString added in v1.44.253

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCapacityAssignmentConfigurationOutput) SetCapacityAssignmentConfiguration added in v1.44.253

SetCapacityAssignmentConfiguration sets the CapacityAssignmentConfiguration field's value.

func (GetCapacityAssignmentConfigurationOutput) String added in v1.44.253

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetCapacityReservationInput added in v1.44.253

type GetCapacityReservationInput struct {

	// The name of the capacity reservation.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetCapacityReservationInput) GoString added in v1.44.253

func (s GetCapacityReservationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCapacityReservationInput) SetName added in v1.44.253

SetName sets the Name field's value.

func (GetCapacityReservationInput) String added in v1.44.253

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCapacityReservationInput) Validate added in v1.44.253

func (s *GetCapacityReservationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetCapacityReservationOutput added in v1.44.253

type GetCapacityReservationOutput struct {

	// The requested capacity reservation structure.
	//
	// CapacityReservation is a required field
	CapacityReservation *CapacityReservation `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetCapacityReservationOutput) GoString added in v1.44.253

func (s GetCapacityReservationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCapacityReservationOutput) SetCapacityReservation added in v1.44.253

SetCapacityReservation sets the CapacityReservation field's value.

func (GetCapacityReservationOutput) String added in v1.44.253

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDataCatalogInput added in v1.31.8

type GetDataCatalogInput struct {

	// The name of the data catalog to return.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The name of the workgroup. Required if making an IAM Identity Center request.
	WorkGroup *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetDataCatalogInput) GoString added in v1.31.8

func (s GetDataCatalogInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDataCatalogInput) SetName added in v1.31.8

SetName sets the Name field's value.

func (*GetDataCatalogInput) SetWorkGroup added in v1.48.13

func (s *GetDataCatalogInput) SetWorkGroup(v string) *GetDataCatalogInput

SetWorkGroup sets the WorkGroup field's value.

func (GetDataCatalogInput) String added in v1.31.8

func (s GetDataCatalogInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDataCatalogInput) Validate added in v1.31.8

func (s *GetDataCatalogInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDataCatalogOutput added in v1.31.8

type GetDataCatalogOutput struct {

	// The data catalog returned.
	DataCatalog *DataCatalog `type:"structure"`
	// contains filtered or unexported fields
}

func (GetDataCatalogOutput) GoString added in v1.31.8

func (s GetDataCatalogOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDataCatalogOutput) SetDataCatalog added in v1.31.8

func (s *GetDataCatalogOutput) SetDataCatalog(v *DataCatalog) *GetDataCatalogOutput

SetDataCatalog sets the DataCatalog field's value.

func (GetDataCatalogOutput) String added in v1.31.8

func (s GetDataCatalogOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDatabaseInput added in v1.31.8

type GetDatabaseInput struct {

	// The name of the data catalog that contains the database to return.
	//
	// CatalogName is a required field
	CatalogName *string `min:"1" type:"string" required:"true"`

	// The name of the database to return.
	//
	// DatabaseName is a required field
	DatabaseName *string `min:"1" type:"string" required:"true"`

	// The name of the workgroup for which the metadata is being fetched. Required
	// if requesting an IAM Identity Center enabled Glue Data Catalog.
	WorkGroup *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetDatabaseInput) GoString added in v1.31.8

func (s GetDatabaseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDatabaseInput) SetCatalogName added in v1.31.8

func (s *GetDatabaseInput) SetCatalogName(v string) *GetDatabaseInput

SetCatalogName sets the CatalogName field's value.

func (*GetDatabaseInput) SetDatabaseName added in v1.31.8

func (s *GetDatabaseInput) SetDatabaseName(v string) *GetDatabaseInput

SetDatabaseName sets the DatabaseName field's value.

func (*GetDatabaseInput) SetWorkGroup added in v1.48.13

func (s *GetDatabaseInput) SetWorkGroup(v string) *GetDatabaseInput

SetWorkGroup sets the WorkGroup field's value.

func (GetDatabaseInput) String added in v1.31.8

func (s GetDatabaseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDatabaseInput) Validate added in v1.31.8

func (s *GetDatabaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDatabaseOutput added in v1.31.8

type GetDatabaseOutput struct {

	// The database returned.
	Database *Database `type:"structure"`
	// contains filtered or unexported fields
}

func (GetDatabaseOutput) GoString added in v1.31.8

func (s GetDatabaseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDatabaseOutput) SetDatabase added in v1.31.8

func (s *GetDatabaseOutput) SetDatabase(v *Database) *GetDatabaseOutput

SetDatabase sets the Database field's value.

func (GetDatabaseOutput) String added in v1.31.8

func (s GetDatabaseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetNamedQueryInput

type GetNamedQueryInput struct {

	// The unique ID of the query. Use ListNamedQueries to get query IDs.
	//
	// NamedQueryId is a required field
	NamedQueryId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetNamedQueryInput) GoString

func (s GetNamedQueryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetNamedQueryInput) SetNamedQueryId

func (s *GetNamedQueryInput) SetNamedQueryId(v string) *GetNamedQueryInput

SetNamedQueryId sets the NamedQueryId field's value.

func (GetNamedQueryInput) String

func (s GetNamedQueryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetNamedQueryInput) Validate

func (s *GetNamedQueryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetNamedQueryOutput

type GetNamedQueryOutput struct {

	// Information about the query.
	NamedQuery *NamedQuery `type:"structure"`
	// contains filtered or unexported fields
}

func (GetNamedQueryOutput) GoString

func (s GetNamedQueryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetNamedQueryOutput) SetNamedQuery

func (s *GetNamedQueryOutput) SetNamedQuery(v *NamedQuery) *GetNamedQueryOutput

SetNamedQuery sets the NamedQuery field's value.

func (GetNamedQueryOutput) String

func (s GetNamedQueryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetNotebookMetadataInput added in v1.44.150

type GetNotebookMetadataInput struct {

	// The ID of the notebook whose metadata is to be retrieved.
	//
	// NotebookId is a required field
	NotebookId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetNotebookMetadataInput) GoString added in v1.44.150

func (s GetNotebookMetadataInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetNotebookMetadataInput) SetNotebookId added in v1.44.150

SetNotebookId sets the NotebookId field's value.

func (GetNotebookMetadataInput) String added in v1.44.150

func (s GetNotebookMetadataInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetNotebookMetadataInput) Validate added in v1.44.150

func (s *GetNotebookMetadataInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetNotebookMetadataOutput added in v1.44.150

type GetNotebookMetadataOutput struct {

	// The metadata that is returned for the specified notebook ID.
	NotebookMetadata *NotebookMetadata `type:"structure"`
	// contains filtered or unexported fields
}

func (GetNotebookMetadataOutput) GoString added in v1.44.150

func (s GetNotebookMetadataOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetNotebookMetadataOutput) SetNotebookMetadata added in v1.44.150

SetNotebookMetadata sets the NotebookMetadata field's value.

func (GetNotebookMetadataOutput) String added in v1.44.150

func (s GetNotebookMetadataOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetPreparedStatementInput added in v1.37.25

type GetPreparedStatementInput struct {

	// The name of the prepared statement to retrieve.
	//
	// StatementName is a required field
	StatementName *string `min:"1" type:"string" required:"true"`

	// The workgroup to which the statement to be retrieved belongs.
	//
	// WorkGroup is a required field
	WorkGroup *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetPreparedStatementInput) GoString added in v1.37.25

func (s GetPreparedStatementInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPreparedStatementInput) SetStatementName added in v1.37.25

SetStatementName sets the StatementName field's value.

func (*GetPreparedStatementInput) SetWorkGroup added in v1.37.25

SetWorkGroup sets the WorkGroup field's value.

func (GetPreparedStatementInput) String added in v1.37.25

func (s GetPreparedStatementInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPreparedStatementInput) Validate added in v1.37.25

func (s *GetPreparedStatementInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetPreparedStatementOutput added in v1.37.25

type GetPreparedStatementOutput struct {

	// The name of the prepared statement that was retrieved.
	PreparedStatement *PreparedStatement `type:"structure"`
	// contains filtered or unexported fields
}

func (GetPreparedStatementOutput) GoString added in v1.37.25

func (s GetPreparedStatementOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetPreparedStatementOutput) SetPreparedStatement added in v1.37.25

SetPreparedStatement sets the PreparedStatement field's value.

func (GetPreparedStatementOutput) String added in v1.37.25

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetQueryExecutionInput

type GetQueryExecutionInput struct {

	// The unique ID of the query execution.
	//
	// QueryExecutionId is a required field
	QueryExecutionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetQueryExecutionInput) GoString

func (s GetQueryExecutionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetQueryExecutionInput) SetQueryExecutionId

func (s *GetQueryExecutionInput) SetQueryExecutionId(v string) *GetQueryExecutionInput

SetQueryExecutionId sets the QueryExecutionId field's value.

func (GetQueryExecutionInput) String

func (s GetQueryExecutionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetQueryExecutionInput) Validate

func (s *GetQueryExecutionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetQueryExecutionOutput

type GetQueryExecutionOutput struct {

	// Information about the query execution.
	QueryExecution *QueryExecution `type:"structure"`
	// contains filtered or unexported fields
}

func (GetQueryExecutionOutput) GoString

func (s GetQueryExecutionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetQueryExecutionOutput) SetQueryExecution

SetQueryExecution sets the QueryExecution field's value.

func (GetQueryExecutionOutput) String

func (s GetQueryExecutionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetQueryResultsInput) GoString

func (s GetQueryResultsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetQueryResultsInput) SetMaxResults

func (s *GetQueryResultsInput) SetMaxResults(v int64) *GetQueryResultsInput

SetMaxResults sets the MaxResults field's value.

func (*GetQueryResultsInput) SetNextToken

func (s *GetQueryResultsInput) SetNextToken(v string) *GetQueryResultsInput

SetNextToken sets the NextToken field's value.

func (*GetQueryResultsInput) SetQueryExecutionId

func (s *GetQueryResultsInput) SetQueryExecutionId(v string) *GetQueryResultsInput

SetQueryExecutionId sets the QueryExecutionId field's value.

func (GetQueryResultsInput) String

func (s GetQueryResultsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetQueryResultsInput) Validate

func (s *GetQueryResultsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetQueryResultsOutput

type GetQueryResultsOutput struct {

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`

	// The results of the query execution.
	ResultSet *ResultSet `type:"structure"`

	// The number of rows inserted with a CREATE TABLE AS SELECT statement.
	UpdateCount *int64 `type:"long"`
	// contains filtered or unexported fields
}

func (GetQueryResultsOutput) GoString

func (s GetQueryResultsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetQueryResultsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*GetQueryResultsOutput) SetResultSet

SetResultSet sets the ResultSet field's value.

func (*GetQueryResultsOutput) SetUpdateCount added in v1.15.53

func (s *GetQueryResultsOutput) SetUpdateCount(v int64) *GetQueryResultsOutput

SetUpdateCount sets the UpdateCount field's value.

func (GetQueryResultsOutput) String

func (s GetQueryResultsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetQueryRuntimeStatisticsInput added in v1.44.60

type GetQueryRuntimeStatisticsInput struct {

	// The unique ID of the query execution.
	//
	// QueryExecutionId is a required field
	QueryExecutionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetQueryRuntimeStatisticsInput) GoString added in v1.44.60

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetQueryRuntimeStatisticsInput) SetQueryExecutionId added in v1.44.60

SetQueryExecutionId sets the QueryExecutionId field's value.

func (GetQueryRuntimeStatisticsInput) String added in v1.44.60

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetQueryRuntimeStatisticsInput) Validate added in v1.44.60

func (s *GetQueryRuntimeStatisticsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetQueryRuntimeStatisticsOutput added in v1.44.60

type GetQueryRuntimeStatisticsOutput struct {

	// Runtime statistics about the query execution.
	QueryRuntimeStatistics *QueryRuntimeStatistics `type:"structure"`
	// contains filtered or unexported fields
}

func (GetQueryRuntimeStatisticsOutput) GoString added in v1.44.60

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetQueryRuntimeStatisticsOutput) SetQueryRuntimeStatistics added in v1.44.60

SetQueryRuntimeStatistics sets the QueryRuntimeStatistics field's value.

func (GetQueryRuntimeStatisticsOutput) String added in v1.44.60

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetSessionInput added in v1.44.150

type GetSessionInput struct {

	// The session ID.
	//
	// SessionId is a required field
	SessionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetSessionInput) GoString added in v1.44.150

func (s GetSessionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSessionInput) SetSessionId added in v1.44.150

func (s *GetSessionInput) SetSessionId(v string) *GetSessionInput

SetSessionId sets the SessionId field's value.

func (GetSessionInput) String added in v1.44.150

func (s GetSessionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSessionInput) Validate added in v1.44.150

func (s *GetSessionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetSessionOutput added in v1.44.150

type GetSessionOutput struct {

	// The session description.
	Description *string `min:"1" type:"string"`

	// Contains engine configuration information like DPU usage.
	EngineConfiguration *EngineConfiguration `type:"structure"`

	// The engine version used by the session (for example, PySpark engine version
	// 3). You can get a list of engine versions by calling ListEngineVersions.
	EngineVersion *string `min:"1" type:"string"`

	// The notebook version.
	NotebookVersion *string `min:"1" type:"string"`

	// Contains the workgroup configuration information used by the session.
	SessionConfiguration *SessionConfiguration `type:"structure"`

	// The session ID.
	SessionId *string `min:"1" type:"string"`

	// Contains the DPU execution time.
	Statistics *SessionStatistics `type:"structure"`

	// Contains information about the status of the session.
	Status *SessionStatus `type:"structure"`

	// The workgroup to which the session belongs.
	WorkGroup *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetSessionOutput) GoString added in v1.44.150

func (s GetSessionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSessionOutput) SetDescription added in v1.44.150

func (s *GetSessionOutput) SetDescription(v string) *GetSessionOutput

SetDescription sets the Description field's value.

func (*GetSessionOutput) SetEngineConfiguration added in v1.44.150

func (s *GetSessionOutput) SetEngineConfiguration(v *EngineConfiguration) *GetSessionOutput

SetEngineConfiguration sets the EngineConfiguration field's value.

func (*GetSessionOutput) SetEngineVersion added in v1.44.150

func (s *GetSessionOutput) SetEngineVersion(v string) *GetSessionOutput

SetEngineVersion sets the EngineVersion field's value.

func (*GetSessionOutput) SetNotebookVersion added in v1.44.150

func (s *GetSessionOutput) SetNotebookVersion(v string) *GetSessionOutput

SetNotebookVersion sets the NotebookVersion field's value.

func (*GetSessionOutput) SetSessionConfiguration added in v1.44.150

func (s *GetSessionOutput) SetSessionConfiguration(v *SessionConfiguration) *GetSessionOutput

SetSessionConfiguration sets the SessionConfiguration field's value.

func (*GetSessionOutput) SetSessionId added in v1.44.150

func (s *GetSessionOutput) SetSessionId(v string) *GetSessionOutput

SetSessionId sets the SessionId field's value.

func (*GetSessionOutput) SetStatistics added in v1.44.150

func (s *GetSessionOutput) SetStatistics(v *SessionStatistics) *GetSessionOutput

SetStatistics sets the Statistics field's value.

func (*GetSessionOutput) SetStatus added in v1.44.150

SetStatus sets the Status field's value.

func (*GetSessionOutput) SetWorkGroup added in v1.44.150

func (s *GetSessionOutput) SetWorkGroup(v string) *GetSessionOutput

SetWorkGroup sets the WorkGroup field's value.

func (GetSessionOutput) String added in v1.44.150

func (s GetSessionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetSessionStatusInput added in v1.44.150

type GetSessionStatusInput struct {

	// The session ID.
	//
	// SessionId is a required field
	SessionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetSessionStatusInput) GoString added in v1.44.150

func (s GetSessionStatusInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSessionStatusInput) SetSessionId added in v1.44.150

SetSessionId sets the SessionId field's value.

func (GetSessionStatusInput) String added in v1.44.150

func (s GetSessionStatusInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSessionStatusInput) Validate added in v1.44.150

func (s *GetSessionStatusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetSessionStatusOutput added in v1.44.150

type GetSessionStatusOutput struct {

	// The session ID.
	SessionId *string `min:"1" type:"string"`

	// Contains information about the status of the session.
	Status *SessionStatus `type:"structure"`
	// contains filtered or unexported fields
}

func (GetSessionStatusOutput) GoString added in v1.44.150

func (s GetSessionStatusOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSessionStatusOutput) SetSessionId added in v1.44.150

SetSessionId sets the SessionId field's value.

func (*GetSessionStatusOutput) SetStatus added in v1.44.150

SetStatus sets the Status field's value.

func (GetSessionStatusOutput) String added in v1.44.150

func (s GetSessionStatusOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetTableMetadataInput added in v1.31.8

type GetTableMetadataInput struct {

	// The name of the data catalog that contains the database and table metadata
	// to return.
	//
	// CatalogName is a required field
	CatalogName *string `min:"1" type:"string" required:"true"`

	// The name of the database that contains the table metadata to return.
	//
	// DatabaseName is a required field
	DatabaseName *string `min:"1" type:"string" required:"true"`

	// The name of the table for which metadata is returned.
	//
	// TableName is a required field
	TableName *string `min:"1" type:"string" required:"true"`

	// The name of the workgroup for which the metadata is being fetched. Required
	// if requesting an IAM Identity Center enabled Glue Data Catalog.
	WorkGroup *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetTableMetadataInput) GoString added in v1.31.8

func (s GetTableMetadataInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTableMetadataInput) SetCatalogName added in v1.31.8

func (s *GetTableMetadataInput) SetCatalogName(v string) *GetTableMetadataInput

SetCatalogName sets the CatalogName field's value.

func (*GetTableMetadataInput) SetDatabaseName added in v1.31.8

func (s *GetTableMetadataInput) SetDatabaseName(v string) *GetTableMetadataInput

SetDatabaseName sets the DatabaseName field's value.

func (*GetTableMetadataInput) SetTableName added in v1.31.8

SetTableName sets the TableName field's value.

func (*GetTableMetadataInput) SetWorkGroup added in v1.48.13

SetWorkGroup sets the WorkGroup field's value.

func (GetTableMetadataInput) String added in v1.31.8

func (s GetTableMetadataInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTableMetadataInput) Validate added in v1.31.8

func (s *GetTableMetadataInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetTableMetadataOutput added in v1.31.8

type GetTableMetadataOutput struct {

	// An object that contains table metadata.
	TableMetadata *TableMetadata `type:"structure"`
	// contains filtered or unexported fields
}

func (GetTableMetadataOutput) GoString added in v1.31.8

func (s GetTableMetadataOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTableMetadataOutput) SetTableMetadata added in v1.31.8

SetTableMetadata sets the TableMetadata field's value.

func (GetTableMetadataOutput) String added in v1.31.8

func (s GetTableMetadataOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetWorkGroupInput added in v1.17.0

type GetWorkGroupInput struct {

	// The name of the workgroup.
	//
	// WorkGroup is a required field
	WorkGroup *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetWorkGroupInput) GoString added in v1.17.0

func (s GetWorkGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetWorkGroupInput) SetWorkGroup added in v1.17.0

func (s *GetWorkGroupInput) SetWorkGroup(v string) *GetWorkGroupInput

SetWorkGroup sets the WorkGroup field's value.

func (GetWorkGroupInput) String added in v1.17.0

func (s GetWorkGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetWorkGroupInput) Validate added in v1.17.0

func (s *GetWorkGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetWorkGroupOutput added in v1.17.0

type GetWorkGroupOutput struct {

	// Information about the workgroup.
	WorkGroup *WorkGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (GetWorkGroupOutput) GoString added in v1.17.0

func (s GetWorkGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetWorkGroupOutput) SetWorkGroup added in v1.17.0

func (s *GetWorkGroupOutput) SetWorkGroup(v *WorkGroup) *GetWorkGroupOutput

SetWorkGroup sets the WorkGroup field's value.

func (GetWorkGroupOutput) String added in v1.17.0

func (s GetWorkGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IdentityCenterConfiguration added in v1.48.13

type IdentityCenterConfiguration struct {

	// Specifies whether the workgroup is IAM Identity Center supported.
	EnableIdentityCenter *bool `type:"boolean"`

	// The IAM Identity Center instance ARN that the workgroup associates to.
	IdentityCenterInstanceArn *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies whether the workgroup is IAM Identity Center supported.

func (IdentityCenterConfiguration) GoString added in v1.48.13

func (s IdentityCenterConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IdentityCenterConfiguration) SetEnableIdentityCenter added in v1.48.13

func (s *IdentityCenterConfiguration) SetEnableIdentityCenter(v bool) *IdentityCenterConfiguration

SetEnableIdentityCenter sets the EnableIdentityCenter field's value.

func (*IdentityCenterConfiguration) SetIdentityCenterInstanceArn added in v1.48.13

func (s *IdentityCenterConfiguration) SetIdentityCenterInstanceArn(v string) *IdentityCenterConfiguration

SetIdentityCenterInstanceArn sets the IdentityCenterInstanceArn field's value.

func (IdentityCenterConfiguration) String added in v1.48.13

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ImportNotebookInput added in v1.44.150

type ImportNotebookInput struct {

	// A unique case-sensitive string used to ensure the request to import the notebook
	// is idempotent (executes only once).
	//
	// This token is listed as not required because Amazon Web Services SDKs (for
	// example the Amazon Web Services SDK for Java) auto-generate the token for
	// you. If you are not using the Amazon Web Services SDK or the Amazon Web Services
	// CLI, you must provide this token or the action will fail.
	ClientRequestToken *string `min:"1" type:"string"`

	// The name of the notebook to import.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// A URI that specifies the Amazon S3 location of a notebook file in ipynb format.
	NotebookS3LocationUri *string `type:"string"`

	// The notebook content to be imported. The payload must be in ipynb format.
	Payload *string `min:"1" type:"string"`

	// The notebook content type. Currently, the only valid type is IPYNB.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"NotebookType"`

	// The name of the Spark enabled workgroup to import the notebook to.
	//
	// WorkGroup is a required field
	WorkGroup *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ImportNotebookInput) GoString added in v1.44.150

func (s ImportNotebookInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportNotebookInput) SetClientRequestToken added in v1.44.150

func (s *ImportNotebookInput) SetClientRequestToken(v string) *ImportNotebookInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*ImportNotebookInput) SetName added in v1.44.150

SetName sets the Name field's value.

func (*ImportNotebookInput) SetNotebookS3LocationUri added in v1.50.0

func (s *ImportNotebookInput) SetNotebookS3LocationUri(v string) *ImportNotebookInput

SetNotebookS3LocationUri sets the NotebookS3LocationUri field's value.

func (*ImportNotebookInput) SetPayload added in v1.44.150

SetPayload sets the Payload field's value.

func (*ImportNotebookInput) SetType added in v1.44.150

SetType sets the Type field's value.

func (*ImportNotebookInput) SetWorkGroup added in v1.44.150

func (s *ImportNotebookInput) SetWorkGroup(v string) *ImportNotebookInput

SetWorkGroup sets the WorkGroup field's value.

func (ImportNotebookInput) String added in v1.44.150

func (s ImportNotebookInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportNotebookInput) Validate added in v1.44.150

func (s *ImportNotebookInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ImportNotebookOutput added in v1.44.150

type ImportNotebookOutput struct {

	// The ID assigned to the imported notebook.
	NotebookId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ImportNotebookOutput) GoString added in v1.44.150

func (s ImportNotebookOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportNotebookOutput) SetNotebookId added in v1.44.150

func (s *ImportNotebookOutput) SetNotebookId(v string) *ImportNotebookOutput

SetNotebookId sets the NotebookId field's value.

func (ImportNotebookOutput) String added in v1.44.150

func (s ImportNotebookOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException added in v1.28.0

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Indicates a platform issue, which may be due to a transient condition or outage.

func (*InternalServerException) Code added in v1.28.0

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error added in v1.28.0

func (s *InternalServerException) Error() string

func (InternalServerException) GoString added in v1.28.0

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message added in v1.28.0

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr added in v1.28.0

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID added in v1.28.0

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode added in v1.28.0

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String added in v1.28.0

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidRequestException added in v1.28.0

type InvalidRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error code returned when the query execution failed to process, or when
	// the processing request for the named query failed.
	AthenaErrorCode *string `min:"1" type:"string"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

func (*InvalidRequestException) Code added in v1.28.0

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error added in v1.28.0

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString added in v1.28.0

func (s InvalidRequestException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidRequestException) Message added in v1.28.0

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr added in v1.28.0

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID added in v1.28.0

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode added in v1.28.0

func (s *InvalidRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidRequestException) String added in v1.28.0

func (s InvalidRequestException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListApplicationDPUSizesInput added in v1.44.150

type ListApplicationDPUSizesInput struct {

	// 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.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListApplicationDPUSizesInput) GoString added in v1.44.150

func (s ListApplicationDPUSizesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListApplicationDPUSizesInput) SetMaxResults added in v1.44.150

SetMaxResults sets the MaxResults field's value.

func (*ListApplicationDPUSizesInput) SetNextToken added in v1.44.150

SetNextToken sets the NextToken field's value.

func (ListApplicationDPUSizesInput) String added in v1.44.150

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListApplicationDPUSizesInput) Validate added in v1.44.150

func (s *ListApplicationDPUSizesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListApplicationDPUSizesOutput added in v1.44.150

type ListApplicationDPUSizesOutput struct {

	// A list of the supported DPU sizes that the application runtime supports.
	ApplicationDPUSizes []*ApplicationDPUSizes `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 (ListApplicationDPUSizesOutput) GoString added in v1.44.150

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListApplicationDPUSizesOutput) SetApplicationDPUSizes added in v1.44.150

SetApplicationDPUSizes sets the ApplicationDPUSizes field's value.

func (*ListApplicationDPUSizesOutput) SetNextToken added in v1.44.150

SetNextToken sets the NextToken field's value.

func (ListApplicationDPUSizesOutput) String added in v1.44.150

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListCalculationExecutionsInput added in v1.44.150

type ListCalculationExecutionsInput struct {

	// The maximum number of calculation executions 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 `type:"string"`

	// The session ID.
	//
	// SessionId is a required field
	SessionId *string `min:"1" type:"string" required:"true"`

	// A filter for a specific calculation execution state. A description of each
	// state follows.
	//
	// CREATING - The calculation is in the process of being created.
	//
	// CREATED - The calculation has been created and is ready to run.
	//
	// QUEUED - The calculation has been queued for processing.
	//
	// RUNNING - The calculation is running.
	//
	// CANCELING - A request to cancel the calculation has been received and the
	// system is working to stop it.
	//
	// CANCELED - The calculation is no longer running as the result of a cancel
	// request.
	//
	// COMPLETED - The calculation has completed without error.
	//
	// FAILED - The calculation failed and is no longer running.
	StateFilter *string `type:"string" enum:"CalculationExecutionState"`
	// contains filtered or unexported fields
}

func (ListCalculationExecutionsInput) GoString added in v1.44.150

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCalculationExecutionsInput) SetMaxResults added in v1.44.150

SetMaxResults sets the MaxResults field's value.

func (*ListCalculationExecutionsInput) SetNextToken added in v1.44.150

SetNextToken sets the NextToken field's value.

func (*ListCalculationExecutionsInput) SetSessionId added in v1.44.150

SetSessionId sets the SessionId field's value.

func (*ListCalculationExecutionsInput) SetStateFilter added in v1.44.150

SetStateFilter sets the StateFilter field's value.

func (ListCalculationExecutionsInput) String added in v1.44.150

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCalculationExecutionsInput) Validate added in v1.44.150

func (s *ListCalculationExecutionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListCalculationExecutionsOutput added in v1.44.150

type ListCalculationExecutionsOutput struct {

	// A list of CalculationSummary objects.
	Calculations []*CalculationSummary `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 `type:"string"`
	// contains filtered or unexported fields
}

func (ListCalculationExecutionsOutput) GoString added in v1.44.150

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCalculationExecutionsOutput) SetCalculations added in v1.44.150

SetCalculations sets the Calculations field's value.

func (*ListCalculationExecutionsOutput) SetNextToken added in v1.44.150

SetNextToken sets the NextToken field's value.

func (ListCalculationExecutionsOutput) String added in v1.44.150

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListCapacityReservationsInput added in v1.44.253

type ListCapacityReservationsInput struct {

	// 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.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListCapacityReservationsInput) GoString added in v1.44.253

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCapacityReservationsInput) SetMaxResults added in v1.44.253

SetMaxResults sets the MaxResults field's value.

func (*ListCapacityReservationsInput) SetNextToken added in v1.44.253

SetNextToken sets the NextToken field's value.

func (ListCapacityReservationsInput) String added in v1.44.253

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCapacityReservationsInput) Validate added in v1.44.253

func (s *ListCapacityReservationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListCapacityReservationsOutput added in v1.44.253

type ListCapacityReservationsOutput struct {

	// The capacity reservations for the current account.
	//
	// CapacityReservations is a required field
	CapacityReservations []*CapacityReservation `type:"list" required:"true"`

	// 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 (ListCapacityReservationsOutput) GoString added in v1.44.253

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCapacityReservationsOutput) SetCapacityReservations added in v1.44.253

SetCapacityReservations sets the CapacityReservations field's value.

func (*ListCapacityReservationsOutput) SetNextToken added in v1.44.253

SetNextToken sets the NextToken field's value.

func (ListCapacityReservationsOutput) String added in v1.44.253

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDataCatalogsInput added in v1.31.8

type ListDataCatalogsInput struct {

	// Specifies the maximum number of data catalogs to return.
	MaxResults *int64 `min:"2" type:"integer"`

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`

	// The name of the workgroup. Required if making an IAM Identity Center request.
	WorkGroup *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListDataCatalogsInput) GoString added in v1.31.8

func (s ListDataCatalogsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDataCatalogsInput) SetMaxResults added in v1.31.8

func (s *ListDataCatalogsInput) SetMaxResults(v int64) *ListDataCatalogsInput

SetMaxResults sets the MaxResults field's value.

func (*ListDataCatalogsInput) SetNextToken added in v1.31.8

SetNextToken sets the NextToken field's value.

func (*ListDataCatalogsInput) SetWorkGroup added in v1.48.13

SetWorkGroup sets the WorkGroup field's value.

func (ListDataCatalogsInput) String added in v1.31.8

func (s ListDataCatalogsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDataCatalogsInput) Validate added in v1.31.8

func (s *ListDataCatalogsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDataCatalogsOutput added in v1.31.8

type ListDataCatalogsOutput struct {

	// A summary list of data catalogs.
	DataCatalogsSummary []*DataCatalogSummary `type:"list"`

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDataCatalogsOutput) GoString added in v1.31.8

func (s ListDataCatalogsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDataCatalogsOutput) SetDataCatalogsSummary added in v1.31.8

func (s *ListDataCatalogsOutput) SetDataCatalogsSummary(v []*DataCatalogSummary) *ListDataCatalogsOutput

SetDataCatalogsSummary sets the DataCatalogsSummary field's value.

func (*ListDataCatalogsOutput) SetNextToken added in v1.31.8

SetNextToken sets the NextToken field's value.

func (ListDataCatalogsOutput) String added in v1.31.8

func (s ListDataCatalogsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDatabasesInput added in v1.31.8

type ListDatabasesInput struct {

	// The name of the data catalog that contains the databases to return.
	//
	// CatalogName is a required field
	CatalogName *string `min:"1" type:"string" required:"true"`

	// Specifies the maximum number of results to return.
	MaxResults *int64 `min:"1" type:"integer"`

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`

	// The name of the workgroup for which the metadata is being fetched. Required
	// if requesting an IAM Identity Center enabled Glue Data Catalog.
	WorkGroup *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListDatabasesInput) GoString added in v1.31.8

func (s ListDatabasesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDatabasesInput) SetCatalogName added in v1.31.8

func (s *ListDatabasesInput) SetCatalogName(v string) *ListDatabasesInput

SetCatalogName sets the CatalogName field's value.

func (*ListDatabasesInput) SetMaxResults added in v1.31.8

func (s *ListDatabasesInput) SetMaxResults(v int64) *ListDatabasesInput

SetMaxResults sets the MaxResults field's value.

func (*ListDatabasesInput) SetNextToken added in v1.31.8

func (s *ListDatabasesInput) SetNextToken(v string) *ListDatabasesInput

SetNextToken sets the NextToken field's value.

func (*ListDatabasesInput) SetWorkGroup added in v1.48.13

func (s *ListDatabasesInput) SetWorkGroup(v string) *ListDatabasesInput

SetWorkGroup sets the WorkGroup field's value.

func (ListDatabasesInput) String added in v1.31.8

func (s ListDatabasesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDatabasesInput) Validate added in v1.31.8

func (s *ListDatabasesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDatabasesOutput added in v1.31.8

type ListDatabasesOutput struct {

	// A list of databases from a data catalog.
	DatabaseList []*Database `type:"list"`

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDatabasesOutput) GoString added in v1.31.8

func (s ListDatabasesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDatabasesOutput) SetDatabaseList added in v1.31.8

func (s *ListDatabasesOutput) SetDatabaseList(v []*Database) *ListDatabasesOutput

SetDatabaseList sets the DatabaseList field's value.

func (*ListDatabasesOutput) SetNextToken added in v1.31.8

func (s *ListDatabasesOutput) SetNextToken(v string) *ListDatabasesOutput

SetNextToken sets the NextToken field's value.

func (ListDatabasesOutput) String added in v1.31.8

func (s ListDatabasesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListEngineVersionsInput added in v1.37.4

type ListEngineVersionsInput struct {

	// The maximum number of engine versions to return in this request.
	MaxResults *int64 `min:"1" type:"integer"`

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEngineVersionsInput) GoString added in v1.37.4

func (s ListEngineVersionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEngineVersionsInput) SetMaxResults added in v1.37.4

SetMaxResults sets the MaxResults field's value.

func (*ListEngineVersionsInput) SetNextToken added in v1.37.4

SetNextToken sets the NextToken field's value.

func (ListEngineVersionsInput) String added in v1.37.4

func (s ListEngineVersionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEngineVersionsInput) Validate added in v1.37.4

func (s *ListEngineVersionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListEngineVersionsOutput added in v1.37.4

type ListEngineVersionsOutput struct {

	// A list of engine versions that are available to choose from.
	EngineVersions []*EngineVersion `type:"list"`

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEngineVersionsOutput) GoString added in v1.37.4

func (s ListEngineVersionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEngineVersionsOutput) SetEngineVersions added in v1.37.4

SetEngineVersions sets the EngineVersions field's value.

func (*ListEngineVersionsOutput) SetNextToken added in v1.37.4

SetNextToken sets the NextToken field's value.

func (ListEngineVersionsOutput) String added in v1.37.4

func (s ListEngineVersionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListExecutorsInput added in v1.44.150

type ListExecutorsInput struct {

	// A filter for a specific executor state. A description of each state follows.
	//
	// CREATING - The executor is being started, including acquiring resources.
	//
	// CREATED - The executor has been started.
	//
	// REGISTERED - The executor has been registered.
	//
	// TERMINATING - The executor is in the process of shutting down.
	//
	// TERMINATED - The executor is no longer running.
	//
	// FAILED - Due to a failure, the executor is no longer running.
	ExecutorStateFilter *string `type:"string" enum:"ExecutorState"`

	// The maximum number of executors 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 `type:"string"`

	// The session ID.
	//
	// SessionId is a required field
	SessionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListExecutorsInput) GoString added in v1.44.150

func (s ListExecutorsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListExecutorsInput) SetExecutorStateFilter added in v1.44.150

func (s *ListExecutorsInput) SetExecutorStateFilter(v string) *ListExecutorsInput

SetExecutorStateFilter sets the ExecutorStateFilter field's value.

func (*ListExecutorsInput) SetMaxResults added in v1.44.150

func (s *ListExecutorsInput) SetMaxResults(v int64) *ListExecutorsInput

SetMaxResults sets the MaxResults field's value.

func (*ListExecutorsInput) SetNextToken added in v1.44.150

func (s *ListExecutorsInput) SetNextToken(v string) *ListExecutorsInput

SetNextToken sets the NextToken field's value.

func (*ListExecutorsInput) SetSessionId added in v1.44.150

func (s *ListExecutorsInput) SetSessionId(v string) *ListExecutorsInput

SetSessionId sets the SessionId field's value.

func (ListExecutorsInput) String added in v1.44.150

func (s ListExecutorsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListExecutorsInput) Validate added in v1.44.150

func (s *ListExecutorsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListExecutorsOutput added in v1.44.150

type ListExecutorsOutput struct {

	// Contains summary information about the executor.
	ExecutorsSummary []*ExecutorsSummary `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 `type:"string"`

	// The session ID.
	//
	// SessionId is a required field
	SessionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListExecutorsOutput) GoString added in v1.44.150

func (s ListExecutorsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListExecutorsOutput) SetExecutorsSummary added in v1.44.150

func (s *ListExecutorsOutput) SetExecutorsSummary(v []*ExecutorsSummary) *ListExecutorsOutput

SetExecutorsSummary sets the ExecutorsSummary field's value.

func (*ListExecutorsOutput) SetNextToken added in v1.44.150

func (s *ListExecutorsOutput) SetNextToken(v string) *ListExecutorsOutput

SetNextToken sets the NextToken field's value.

func (*ListExecutorsOutput) SetSessionId added in v1.44.150

func (s *ListExecutorsOutput) SetSessionId(v string) *ListExecutorsOutput

SetSessionId sets the SessionId field's value.

func (ListExecutorsOutput) String added in v1.44.150

func (s ListExecutorsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListNamedQueriesInput

type ListNamedQueriesInput struct {

	// The maximum number of queries to return in this request.
	MaxResults *int64 `type:"integer"`

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`

	// The name of the workgroup from which the named queries are being returned.
	// If a workgroup is not specified, the saved queries for the primary workgroup
	// are returned.
	WorkGroup *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListNamedQueriesInput) GoString

func (s ListNamedQueriesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListNamedQueriesInput) SetMaxResults

func (s *ListNamedQueriesInput) SetMaxResults(v int64) *ListNamedQueriesInput

SetMaxResults sets the MaxResults field's value.

func (*ListNamedQueriesInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListNamedQueriesInput) SetWorkGroup added in v1.17.0

SetWorkGroup sets the WorkGroup field's value.

func (ListNamedQueriesInput) String

func (s ListNamedQueriesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListNamedQueriesInput) Validate added in v1.17.0

func (s *ListNamedQueriesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListNamedQueriesOutput

type ListNamedQueriesOutput struct {

	// The list of unique query IDs.
	NamedQueryIds []*string `min:"1" type:"list"`

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListNamedQueriesOutput) GoString

func (s ListNamedQueriesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListNamedQueriesOutput) SetNamedQueryIds

func (s *ListNamedQueriesOutput) SetNamedQueryIds(v []*string) *ListNamedQueriesOutput

SetNamedQueryIds sets the NamedQueryIds field's value.

func (*ListNamedQueriesOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListNamedQueriesOutput) String

func (s ListNamedQueriesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListNotebookMetadataInput added in v1.44.150

type ListNotebookMetadataInput struct {

	// Search filter string.
	Filters *FilterDefinition `type:"structure"`

	// 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.
	NextToken *string `min:"1" type:"string"`

	// The name of the Spark enabled workgroup to retrieve notebook metadata for.
	//
	// WorkGroup is a required field
	WorkGroup *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListNotebookMetadataInput) GoString added in v1.44.150

func (s ListNotebookMetadataInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListNotebookMetadataInput) SetFilters added in v1.44.150

SetFilters sets the Filters field's value.

func (*ListNotebookMetadataInput) SetMaxResults added in v1.44.150

SetMaxResults sets the MaxResults field's value.

func (*ListNotebookMetadataInput) SetNextToken added in v1.44.150

SetNextToken sets the NextToken field's value.

func (*ListNotebookMetadataInput) SetWorkGroup added in v1.44.150

SetWorkGroup sets the WorkGroup field's value.

func (ListNotebookMetadataInput) String added in v1.44.150

func (s ListNotebookMetadataInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListNotebookMetadataInput) Validate added in v1.44.150

func (s *ListNotebookMetadataInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListNotebookMetadataOutput added in v1.44.150

type ListNotebookMetadataOutput 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 notebook metadata for the specified workgroup.
	NotebookMetadataList []*NotebookMetadata `type:"list"`
	// contains filtered or unexported fields
}

func (ListNotebookMetadataOutput) GoString added in v1.44.150

func (s ListNotebookMetadataOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListNotebookMetadataOutput) SetNextToken added in v1.44.150

SetNextToken sets the NextToken field's value.

func (*ListNotebookMetadataOutput) SetNotebookMetadataList added in v1.44.150

SetNotebookMetadataList sets the NotebookMetadataList field's value.

func (ListNotebookMetadataOutput) String added in v1.44.150

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListNotebookSessionsInput added in v1.44.150

type ListNotebookSessionsInput struct {

	// The maximum number of notebook sessions 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"`

	// The ID of the notebook to list sessions for.
	//
	// NotebookId is a required field
	NotebookId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListNotebookSessionsInput) GoString added in v1.44.150

func (s ListNotebookSessionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListNotebookSessionsInput) SetMaxResults added in v1.44.150

SetMaxResults sets the MaxResults field's value.

func (*ListNotebookSessionsInput) SetNextToken added in v1.44.150

SetNextToken sets the NextToken field's value.

func (*ListNotebookSessionsInput) SetNotebookId added in v1.44.150

SetNotebookId sets the NotebookId field's value.

func (ListNotebookSessionsInput) String added in v1.44.150

func (s ListNotebookSessionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListNotebookSessionsInput) Validate added in v1.44.150

func (s *ListNotebookSessionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListNotebookSessionsOutput added in v1.44.150

type ListNotebookSessionsOutput 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 the sessions belonging to the notebook.
	//
	// NotebookSessionsList is a required field
	NotebookSessionsList []*NotebookSessionSummary `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListNotebookSessionsOutput) GoString added in v1.44.150

func (s ListNotebookSessionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListNotebookSessionsOutput) SetNextToken added in v1.44.150

SetNextToken sets the NextToken field's value.

func (*ListNotebookSessionsOutput) SetNotebookSessionsList added in v1.44.150

SetNotebookSessionsList sets the NotebookSessionsList field's value.

func (ListNotebookSessionsOutput) String added in v1.44.150

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListPreparedStatementsInput added in v1.37.25

type ListPreparedStatementsInput struct {

	// The maximum number of results 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 workgroup to list the prepared statements for.
	//
	// WorkGroup is a required field
	WorkGroup *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListPreparedStatementsInput) GoString added in v1.37.25

func (s ListPreparedStatementsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPreparedStatementsInput) SetMaxResults added in v1.37.25

SetMaxResults sets the MaxResults field's value.

func (*ListPreparedStatementsInput) SetNextToken added in v1.37.25

SetNextToken sets the NextToken field's value.

func (*ListPreparedStatementsInput) SetWorkGroup added in v1.37.25

SetWorkGroup sets the WorkGroup field's value.

func (ListPreparedStatementsInput) String added in v1.37.25

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPreparedStatementsInput) Validate added in v1.37.25

func (s *ListPreparedStatementsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListPreparedStatementsOutput added in v1.37.25

type ListPreparedStatementsOutput 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 prepared statements for the workgroup.
	PreparedStatements []*PreparedStatementSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListPreparedStatementsOutput) GoString added in v1.37.25

func (s ListPreparedStatementsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPreparedStatementsOutput) SetNextToken added in v1.37.25

SetNextToken sets the NextToken field's value.

func (*ListPreparedStatementsOutput) SetPreparedStatements added in v1.37.25

SetPreparedStatements sets the PreparedStatements field's value.

func (ListPreparedStatementsOutput) String added in v1.37.25

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListQueryExecutionsInput

type ListQueryExecutionsInput struct {

	// The maximum number of query executions to return in this request.
	MaxResults *int64 `type:"integer"`

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`

	// The name of the workgroup from which queries are being returned. If a workgroup
	// is not specified, a list of available query execution IDs for the queries
	// in the primary workgroup is returned.
	WorkGroup *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListQueryExecutionsInput) GoString

func (s ListQueryExecutionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListQueryExecutionsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListQueryExecutionsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListQueryExecutionsInput) SetWorkGroup added in v1.17.0

SetWorkGroup sets the WorkGroup field's value.

func (ListQueryExecutionsInput) String

func (s ListQueryExecutionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListQueryExecutionsInput) Validate added in v1.17.0

func (s *ListQueryExecutionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListQueryExecutionsOutput

type ListQueryExecutionsOutput struct {

	// A token to be used by the next request if this request is truncated.
	NextToken *string `min:"1" type:"string"`

	// The unique IDs of each query execution as an array of strings.
	QueryExecutionIds []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (ListQueryExecutionsOutput) GoString

func (s ListQueryExecutionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListQueryExecutionsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListQueryExecutionsOutput) SetQueryExecutionIds

func (s *ListQueryExecutionsOutput) SetQueryExecutionIds(v []*string) *ListQueryExecutionsOutput

SetQueryExecutionIds sets the QueryExecutionIds field's value.

func (ListQueryExecutionsOutput) String

func (s ListQueryExecutionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListSessionsInput added in v1.44.150

type ListSessionsInput struct {

	// The maximum number of sessions 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 `type:"string"`

	// A filter for a specific session state. A description of each state follows.
	//
	// CREATING - The session is being started, including acquiring resources.
	//
	// CREATED - The session has been started.
	//
	// IDLE - The session is able to accept a calculation.
	//
	// BUSY - The session is processing another task and is unable to accept a calculation.
	//
	// TERMINATING - The session is in the process of shutting down.
	//
	// TERMINATED - The session and its resources are no longer running.
	//
	// DEGRADED - The session has no healthy coordinators.
	//
	// FAILED - Due to a failure, the session and its resources are no longer running.
	StateFilter *string `type:"string" enum:"SessionState"`

	// The workgroup to which the session belongs.
	//
	// WorkGroup is a required field
	WorkGroup *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListSessionsInput) GoString added in v1.44.150

func (s ListSessionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSessionsInput) SetMaxResults added in v1.44.150

func (s *ListSessionsInput) SetMaxResults(v int64) *ListSessionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListSessionsInput) SetNextToken added in v1.44.150

func (s *ListSessionsInput) SetNextToken(v string) *ListSessionsInput

SetNextToken sets the NextToken field's value.

func (*ListSessionsInput) SetStateFilter added in v1.44.150

func (s *ListSessionsInput) SetStateFilter(v string) *ListSessionsInput

SetStateFilter sets the StateFilter field's value.

func (*ListSessionsInput) SetWorkGroup added in v1.44.150

func (s *ListSessionsInput) SetWorkGroup(v string) *ListSessionsInput

SetWorkGroup sets the WorkGroup field's value.

func (ListSessionsInput) String added in v1.44.150

func (s ListSessionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSessionsInput) Validate added in v1.44.150

func (s *ListSessionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListSessionsOutput added in v1.44.150

type ListSessionsOutput 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 `type:"string"`

	// A list of sessions.
	Sessions []*SessionSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListSessionsOutput) GoString added in v1.44.150

func (s ListSessionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSessionsOutput) SetNextToken added in v1.44.150

func (s *ListSessionsOutput) SetNextToken(v string) *ListSessionsOutput

SetNextToken sets the NextToken field's value.

func (*ListSessionsOutput) SetSessions added in v1.44.150

SetSessions sets the Sessions field's value.

func (ListSessionsOutput) String added in v1.44.150

func (s ListSessionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTableMetadataInput added in v1.31.8

type ListTableMetadataInput struct {

	// The name of the data catalog for which table metadata should be returned.
	//
	// CatalogName is a required field
	CatalogName *string `min:"1" type:"string" required:"true"`

	// The name of the database for which table metadata should be returned.
	//
	// DatabaseName is a required field
	DatabaseName *string `min:"1" type:"string" required:"true"`

	// A regex filter that pattern-matches table names. If no expression is supplied,
	// metadata for all tables are listed.
	Expression *string `type:"string"`

	// Specifies the maximum number of results to return.
	MaxResults *int64 `min:"1" type:"integer"`

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`

	// The name of the workgroup for which the metadata is being fetched. Required
	// if requesting an IAM Identity Center enabled Glue Data Catalog.
	WorkGroup *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListTableMetadataInput) GoString added in v1.31.8

func (s ListTableMetadataInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTableMetadataInput) SetCatalogName added in v1.31.8

SetCatalogName sets the CatalogName field's value.

func (*ListTableMetadataInput) SetDatabaseName added in v1.31.8

func (s *ListTableMetadataInput) SetDatabaseName(v string) *ListTableMetadataInput

SetDatabaseName sets the DatabaseName field's value.

func (*ListTableMetadataInput) SetExpression added in v1.31.8

SetExpression sets the Expression field's value.

func (*ListTableMetadataInput) SetMaxResults added in v1.31.8

SetMaxResults sets the MaxResults field's value.

func (*ListTableMetadataInput) SetNextToken added in v1.31.8

SetNextToken sets the NextToken field's value.

func (*ListTableMetadataInput) SetWorkGroup added in v1.48.13

SetWorkGroup sets the WorkGroup field's value.

func (ListTableMetadataInput) String added in v1.31.8

func (s ListTableMetadataInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTableMetadataInput) Validate added in v1.31.8

func (s *ListTableMetadataInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTableMetadataOutput added in v1.31.8

type ListTableMetadataOutput struct {

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`

	// A list of table metadata.
	TableMetadataList []*TableMetadata `type:"list"`
	// contains filtered or unexported fields
}

func (ListTableMetadataOutput) GoString added in v1.31.8

func (s ListTableMetadataOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTableMetadataOutput) SetNextToken added in v1.31.8

SetNextToken sets the NextToken field's value.

func (*ListTableMetadataOutput) SetTableMetadataList added in v1.31.8

func (s *ListTableMetadataOutput) SetTableMetadataList(v []*TableMetadata) *ListTableMetadataOutput

SetTableMetadataList sets the TableMetadataList field's value.

func (ListTableMetadataOutput) String added in v1.31.8

func (s ListTableMetadataOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput added in v1.17.4

type ListTagsForResourceInput struct {

	// The maximum number of results to be returned per request that lists the tags
	// for the resource.
	MaxResults *int64 `min:"75" type:"integer"`

	// The token for the next set of results, or null if there are no additional
	// results for this request, where the request lists the tags for the resource
	// with the specified ARN.
	NextToken *string `min:"1" type:"string"`

	// Lists the tags for the resource with the specified ARN.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.17.4

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetMaxResults added in v1.17.4

SetMaxResults sets the MaxResults field's value.

func (*ListTagsForResourceInput) SetNextToken added in v1.17.4

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceInput) SetResourceARN added in v1.17.4

SetResourceARN sets the ResourceARN field's value.

func (ListTagsForResourceInput) String added in v1.17.4

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate added in v1.17.4

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v1.17.4

type ListTagsForResourceOutput struct {

	// A token to be used by the next request if this request is truncated.
	NextToken *string `min:"1" type:"string"`

	// The list of tags associated with the specified resource.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.17.4

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetNextToken added in v1.17.4

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceOutput) SetTags added in v1.17.4

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.17.4

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListWorkGroupsInput added in v1.17.0

type ListWorkGroupsInput struct {

	// The maximum number of workgroups to return in this request.
	MaxResults *int64 `min:"1" type:"integer"`

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListWorkGroupsInput) GoString added in v1.17.0

func (s ListWorkGroupsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWorkGroupsInput) SetMaxResults added in v1.17.0

func (s *ListWorkGroupsInput) SetMaxResults(v int64) *ListWorkGroupsInput

SetMaxResults sets the MaxResults field's value.

func (*ListWorkGroupsInput) SetNextToken added in v1.17.0

func (s *ListWorkGroupsInput) SetNextToken(v string) *ListWorkGroupsInput

SetNextToken sets the NextToken field's value.

func (ListWorkGroupsInput) String added in v1.17.0

func (s ListWorkGroupsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWorkGroupsInput) Validate added in v1.17.0

func (s *ListWorkGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListWorkGroupsOutput added in v1.17.0

type ListWorkGroupsOutput struct {

	// A token generated by the Athena service that specifies where to continue
	// pagination if a previous request was truncated. To obtain the next set of
	// pages, pass in the NextToken from the response object of the previous page
	// call.
	NextToken *string `min:"1" type:"string"`

	// A list of WorkGroupSummary objects that include the names, descriptions,
	// creation times, and states for each workgroup.
	WorkGroups []*WorkGroupSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListWorkGroupsOutput) GoString added in v1.17.0

func (s ListWorkGroupsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWorkGroupsOutput) SetNextToken added in v1.17.0

func (s *ListWorkGroupsOutput) SetNextToken(v string) *ListWorkGroupsOutput

SetNextToken sets the NextToken field's value.

func (*ListWorkGroupsOutput) SetWorkGroups added in v1.17.0

SetWorkGroups sets the WorkGroups field's value.

func (ListWorkGroupsOutput) String added in v1.17.0

func (s ListWorkGroupsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MetadataException added in v1.31.8

type MetadataException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform (InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.

func (*MetadataException) Code added in v1.31.8

func (s *MetadataException) Code() string

Code returns the exception type name.

func (*MetadataException) Error added in v1.31.8

func (s *MetadataException) Error() string

func (MetadataException) GoString added in v1.31.8

func (s MetadataException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetadataException) Message added in v1.31.8

func (s *MetadataException) Message() string

Message returns the exception's message.

func (*MetadataException) OrigErr added in v1.31.8

func (s *MetadataException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MetadataException) RequestID added in v1.31.8

func (s *MetadataException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MetadataException) StatusCode added in v1.31.8

func (s *MetadataException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (MetadataException) String added in v1.31.8

func (s MetadataException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 `min:"1" type:"string"`

	// The SQL statements that make up 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 contains the SQL statements that make up the query.

func (NamedQuery) GoString

func (s NamedQuery) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NamedQuery) SetDatabase

func (s *NamedQuery) SetDatabase(v string) *NamedQuery

SetDatabase sets the Database field's value.

func (*NamedQuery) SetDescription

func (s *NamedQuery) SetDescription(v string) *NamedQuery

SetDescription sets the Description field's value.

func (*NamedQuery) SetName

func (s *NamedQuery) SetName(v string) *NamedQuery

SetName sets the Name field's value.

func (*NamedQuery) SetNamedQueryId

func (s *NamedQuery) SetNamedQueryId(v string) *NamedQuery

SetNamedQueryId sets the NamedQueryId field's value.

func (*NamedQuery) SetQueryString

func (s *NamedQuery) SetQueryString(v string) *NamedQuery

SetQueryString sets the QueryString field's value.

func (*NamedQuery) SetWorkGroup added in v1.17.0

func (s *NamedQuery) SetWorkGroup(v string) *NamedQuery

SetWorkGroup sets the WorkGroup field's value.

func (NamedQuery) String

func (s NamedQuery) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NotebookMetadata added in v1.44.150

type NotebookMetadata struct {

	// The time when the notebook was created.
	CreationTime *time.Time `type:"timestamp"`

	// The time when the notebook was last modified.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The name of the notebook.
	Name *string `min:"1" type:"string"`

	// The notebook ID.
	NotebookId *string `min:"1" type:"string"`

	// The type of notebook. Currently, the only valid type is IPYNB.
	Type *string `type:"string" enum:"NotebookType"`

	// The name of the Spark enabled workgroup to which the notebook belongs.
	WorkGroup *string `type:"string"`
	// contains filtered or unexported fields
}

Contains metadata for notebook, including the notebook name, ID, workgroup, and time created.

func (NotebookMetadata) GoString added in v1.44.150

func (s NotebookMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotebookMetadata) SetCreationTime added in v1.44.150

func (s *NotebookMetadata) SetCreationTime(v time.Time) *NotebookMetadata

SetCreationTime sets the CreationTime field's value.

func (*NotebookMetadata) SetLastModifiedTime added in v1.44.150

func (s *NotebookMetadata) SetLastModifiedTime(v time.Time) *NotebookMetadata

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*NotebookMetadata) SetName added in v1.44.150

func (s *NotebookMetadata) SetName(v string) *NotebookMetadata

SetName sets the Name field's value.

func (*NotebookMetadata) SetNotebookId added in v1.44.150

func (s *NotebookMetadata) SetNotebookId(v string) *NotebookMetadata

SetNotebookId sets the NotebookId field's value.

func (*NotebookMetadata) SetType added in v1.44.150

func (s *NotebookMetadata) SetType(v string) *NotebookMetadata

SetType sets the Type field's value.

func (*NotebookMetadata) SetWorkGroup added in v1.44.150

func (s *NotebookMetadata) SetWorkGroup(v string) *NotebookMetadata

SetWorkGroup sets the WorkGroup field's value.

func (NotebookMetadata) String added in v1.44.150

func (s NotebookMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NotebookSessionSummary added in v1.44.150

type NotebookSessionSummary struct {

	// The time when the notebook session was created.
	CreationTime *time.Time `type:"timestamp"`

	// The notebook session ID.
	SessionId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains the notebook session ID and notebook session creation time.

func (NotebookSessionSummary) GoString added in v1.44.150

func (s NotebookSessionSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotebookSessionSummary) SetCreationTime added in v1.44.150

func (s *NotebookSessionSummary) SetCreationTime(v time.Time) *NotebookSessionSummary

SetCreationTime sets the CreationTime field's value.

func (*NotebookSessionSummary) SetSessionId added in v1.44.150

SetSessionId sets the SessionId field's value.

func (NotebookSessionSummary) String added in v1.44.150

func (s NotebookSessionSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PreparedStatement added in v1.37.25

type PreparedStatement struct {

	// The description of the prepared statement.
	Description *string `min:"1" type:"string"`

	// The last modified time of the prepared statement.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The query string for the prepared statement.
	QueryStatement *string `min:"1" type:"string"`

	// The name of the prepared statement.
	StatementName *string `min:"1" type:"string"`

	// The name of the workgroup to which the prepared statement belongs.
	WorkGroupName *string `type:"string"`
	// contains filtered or unexported fields
}

A prepared SQL statement for use with Athena.

func (PreparedStatement) GoString added in v1.37.25

func (s PreparedStatement) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PreparedStatement) SetDescription added in v1.37.25

func (s *PreparedStatement) SetDescription(v string) *PreparedStatement

SetDescription sets the Description field's value.

func (*PreparedStatement) SetLastModifiedTime added in v1.37.25

func (s *PreparedStatement) SetLastModifiedTime(v time.Time) *PreparedStatement

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*PreparedStatement) SetQueryStatement added in v1.37.25

func (s *PreparedStatement) SetQueryStatement(v string) *PreparedStatement

SetQueryStatement sets the QueryStatement field's value.

func (*PreparedStatement) SetStatementName added in v1.37.25

func (s *PreparedStatement) SetStatementName(v string) *PreparedStatement

SetStatementName sets the StatementName field's value.

func (*PreparedStatement) SetWorkGroupName added in v1.37.25

func (s *PreparedStatement) SetWorkGroupName(v string) *PreparedStatement

SetWorkGroupName sets the WorkGroupName field's value.

func (PreparedStatement) String added in v1.37.25

func (s PreparedStatement) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PreparedStatementSummary added in v1.37.25

type PreparedStatementSummary struct {

	// The last modified time of the prepared statement.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The name of the prepared statement.
	StatementName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The name and last modified time of the prepared statement.

func (PreparedStatementSummary) GoString added in v1.37.25

func (s PreparedStatementSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PreparedStatementSummary) SetLastModifiedTime added in v1.37.25

func (s *PreparedStatementSummary) SetLastModifiedTime(v time.Time) *PreparedStatementSummary

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*PreparedStatementSummary) SetStatementName added in v1.37.25

SetStatementName sets the StatementName field's value.

func (PreparedStatementSummary) String added in v1.37.25

func (s PreparedStatementSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutCapacityAssignmentConfigurationInput added in v1.44.253

type PutCapacityAssignmentConfigurationInput struct {

	// The list of assignments for the capacity assignment configuration.
	//
	// CapacityAssignments is a required field
	CapacityAssignments []*CapacityAssignment `type:"list" required:"true"`

	// The name of the capacity reservation to put a capacity assignment configuration
	// for.
	//
	// CapacityReservationName is a required field
	CapacityReservationName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutCapacityAssignmentConfigurationInput) GoString added in v1.44.253

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutCapacityAssignmentConfigurationInput) SetCapacityAssignments added in v1.44.253

SetCapacityAssignments sets the CapacityAssignments field's value.

func (*PutCapacityAssignmentConfigurationInput) SetCapacityReservationName added in v1.44.253

SetCapacityReservationName sets the CapacityReservationName field's value.

func (PutCapacityAssignmentConfigurationInput) String added in v1.44.253

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutCapacityAssignmentConfigurationInput) Validate added in v1.44.253

Validate inspects the fields of the type to determine if they are valid.

type PutCapacityAssignmentConfigurationOutput added in v1.44.253

type PutCapacityAssignmentConfigurationOutput struct {
	// contains filtered or unexported fields
}

func (PutCapacityAssignmentConfigurationOutput) GoString added in v1.44.253

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutCapacityAssignmentConfigurationOutput) String added in v1.44.253

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QueryExecution

type QueryExecution struct {

	// The engine version that executed the query.
	EngineVersion *EngineVersion `type:"structure"`

	// A list of values for the parameters in a query. The values are applied sequentially
	// to the parameters in the query in the order in which the parameters occur.
	// The list of parameters is not returned in the response.
	ExecutionParameters []*string `min:"1" type:"list"`

	// 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 `min:"1" type:"string"`

	// Specifies whether Amazon S3 access grants are enabled for query results.
	QueryResultsS3AccessGrantsConfiguration *QueryResultsS3AccessGrantsConfiguration `type:"structure"`

	// The location in Amazon S3 where query and calculation results are stored
	// and the encryption option, if any, used for query results. These are known
	// as "client-side settings". If workgroup settings override client-side settings,
	// then the query uses the location for the query results and the encryption
	// configuration that are specified for the workgroup.
	ResultConfiguration *ResultConfiguration `type:"structure"`

	// Specifies the query result reuse behavior that was used for the query.
	ResultReuseConfiguration *ResultReuseConfiguration `type:"structure"`

	// The type of query statement that was run. DDL indicates DDL query statements.
	// DML indicates DML (Data Manipulation Language) query statements, such as
	// CREATE TABLE AS SELECT. UTILITY indicates query statements other than DDL
	// and DML, such as SHOW CREATE TABLE, or DESCRIBE TABLE.
	StatementType *string `type:"string" enum:"StatementType"`

	// Query execution statistics, such as the amount of data scanned, the amount
	// of time that the query took to process, and the type of statement that was
	// run.
	Statistics *QueryExecutionStatistics `type:"structure"`

	// The completion date, current state, submission time, and state change reason
	// (if applicable) for the query execution.
	Status *QueryExecutionStatus `type:"structure"`

	// The kind of query statement that was run.
	SubstatementType *string `type:"string"`

	// The name of the workgroup in which the query ran.
	WorkGroup *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a single instance of a query execution.

func (QueryExecution) GoString

func (s QueryExecution) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryExecution) SetEngineVersion added in v1.37.4

func (s *QueryExecution) SetEngineVersion(v *EngineVersion) *QueryExecution

SetEngineVersion sets the EngineVersion field's value.

func (*QueryExecution) SetExecutionParameters added in v1.44.46

func (s *QueryExecution) SetExecutionParameters(v []*string) *QueryExecution

SetExecutionParameters sets the ExecutionParameters field's value.

func (*QueryExecution) SetQuery

func (s *QueryExecution) SetQuery(v string) *QueryExecution

SetQuery sets the Query field's value.

func (*QueryExecution) SetQueryExecutionContext

func (s *QueryExecution) SetQueryExecutionContext(v *QueryExecutionContext) *QueryExecution

SetQueryExecutionContext sets the QueryExecutionContext field's value.

func (*QueryExecution) SetQueryExecutionId

func (s *QueryExecution) SetQueryExecutionId(v string) *QueryExecution

SetQueryExecutionId sets the QueryExecutionId field's value.

func (*QueryExecution) SetQueryResultsS3AccessGrantsConfiguration added in v1.48.13

func (s *QueryExecution) SetQueryResultsS3AccessGrantsConfiguration(v *QueryResultsS3AccessGrantsConfiguration) *QueryExecution

SetQueryResultsS3AccessGrantsConfiguration sets the QueryResultsS3AccessGrantsConfiguration field's value.

func (*QueryExecution) SetResultConfiguration

func (s *QueryExecution) SetResultConfiguration(v *ResultConfiguration) *QueryExecution

SetResultConfiguration sets the ResultConfiguration field's value.

func (*QueryExecution) SetResultReuseConfiguration added in v1.44.132

func (s *QueryExecution) SetResultReuseConfiguration(v *ResultReuseConfiguration) *QueryExecution

SetResultReuseConfiguration sets the ResultReuseConfiguration field's value.

func (*QueryExecution) SetStatementType added in v1.15.53

func (s *QueryExecution) SetStatementType(v string) *QueryExecution

SetStatementType sets the StatementType field's value.

func (*QueryExecution) SetStatistics

SetStatistics sets the Statistics field's value.

func (*QueryExecution) SetStatus

SetStatus sets the Status field's value.

func (*QueryExecution) SetSubstatementType added in v1.44.217

func (s *QueryExecution) SetSubstatementType(v string) *QueryExecution

SetSubstatementType sets the SubstatementType field's value.

func (*QueryExecution) SetWorkGroup added in v1.17.0

func (s *QueryExecution) SetWorkGroup(v string) *QueryExecution

SetWorkGroup sets the WorkGroup field's value.

func (QueryExecution) String

func (s QueryExecution) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. The database must exist
	// in the catalog.
	Database *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The database and data catalog context in which the query execution occurs.

func (QueryExecutionContext) GoString

func (s QueryExecutionContext) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryExecutionContext) SetCatalog added in v1.31.8

SetCatalog sets the Catalog field's value.

func (*QueryExecutionContext) SetDatabase

SetDatabase sets the Database field's value.

func (QueryExecutionContext) String

func (s QueryExecutionContext) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryExecutionContext) Validate

func (s *QueryExecutionContext) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type QueryExecutionStatistics

type QueryExecutionStatistics struct {

	// The location and file name of a data manifest file. The manifest file is
	// saved to the Athena query results location in Amazon S3. The manifest file
	// tracks files that the query wrote to Amazon S3. If the query fails, the manifest
	// file also tracks files that the query intended to write. The manifest is
	// useful for identifying orphaned files resulting from a failed query. For
	// more information, see Working with Query Results, Output Files, and Query
	// History (https://docs.aws.amazon.com/athena/latest/ug/querying.html) in the
	// Amazon Athena User Guide.
	DataManifestLocation *string `type:"string"`

	// The number of bytes in the data that was queried.
	DataScannedInBytes *int64 `type:"long"`

	// The number of milliseconds that the query took to execute.
	EngineExecutionTimeInMillis *int64 `type:"long"`

	// The number of milliseconds that Athena took to plan the query processing
	// flow. This includes the time spent retrieving table partitions from the data
	// source. Note that because the query engine performs the query planning, query
	// planning time is a subset of engine processing time.
	QueryPlanningTimeInMillis *int64 `type:"long"`

	// The number of milliseconds that the query was in your query queue waiting
	// for resources. Note that if transient errors occur, Athena might automatically
	// add the query back to the queue.
	QueryQueueTimeInMillis *int64 `type:"long"`

	// Contains information about whether previous query results were reused for
	// the query.
	ResultReuseInformation *ResultReuseInformation `type:"structure"`

	// The number of milliseconds that Athena took to preprocess the query before
	// submitting the query to the query engine.
	ServicePreProcessingTimeInMillis *int64 `type:"long"`

	// The number of milliseconds that Athena took to finalize and publish the query
	// results after the query engine finished running the query.
	ServiceProcessingTimeInMillis *int64 `type:"long"`

	// The number of milliseconds that Athena took to run the query.
	TotalExecutionTimeInMillis *int64 `type:"long"`
	// contains filtered or unexported fields
}

The amount of data scanned during the query execution and the amount of time that it took to execute, and the type of statement that was run.

func (QueryExecutionStatistics) GoString

func (s QueryExecutionStatistics) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryExecutionStatistics) SetDataManifestLocation added in v1.24.0

func (s *QueryExecutionStatistics) SetDataManifestLocation(v string) *QueryExecutionStatistics

SetDataManifestLocation sets the DataManifestLocation field's value.

func (*QueryExecutionStatistics) SetDataScannedInBytes

func (s *QueryExecutionStatistics) SetDataScannedInBytes(v int64) *QueryExecutionStatistics

SetDataScannedInBytes sets the DataScannedInBytes field's value.

func (*QueryExecutionStatistics) SetEngineExecutionTimeInMillis

func (s *QueryExecutionStatistics) SetEngineExecutionTimeInMillis(v int64) *QueryExecutionStatistics

SetEngineExecutionTimeInMillis sets the EngineExecutionTimeInMillis field's value.

func (*QueryExecutionStatistics) SetQueryPlanningTimeInMillis added in v1.25.42

func (s *QueryExecutionStatistics) SetQueryPlanningTimeInMillis(v int64) *QueryExecutionStatistics

SetQueryPlanningTimeInMillis sets the QueryPlanningTimeInMillis field's value.

func (*QueryExecutionStatistics) SetQueryQueueTimeInMillis added in v1.25.42

func (s *QueryExecutionStatistics) SetQueryQueueTimeInMillis(v int64) *QueryExecutionStatistics

SetQueryQueueTimeInMillis sets the QueryQueueTimeInMillis field's value.

func (*QueryExecutionStatistics) SetResultReuseInformation added in v1.44.132

SetResultReuseInformation sets the ResultReuseInformation field's value.

func (*QueryExecutionStatistics) SetServicePreProcessingTimeInMillis added in v1.48.0

func (s *QueryExecutionStatistics) SetServicePreProcessingTimeInMillis(v int64) *QueryExecutionStatistics

SetServicePreProcessingTimeInMillis sets the ServicePreProcessingTimeInMillis field's value.

func (*QueryExecutionStatistics) SetServiceProcessingTimeInMillis added in v1.25.42

func (s *QueryExecutionStatistics) SetServiceProcessingTimeInMillis(v int64) *QueryExecutionStatistics

SetServiceProcessingTimeInMillis sets the ServiceProcessingTimeInMillis field's value.

func (*QueryExecutionStatistics) SetTotalExecutionTimeInMillis added in v1.25.42

func (s *QueryExecutionStatistics) SetTotalExecutionTimeInMillis(v int64) *QueryExecutionStatistics

SetTotalExecutionTimeInMillis sets the TotalExecutionTimeInMillis field's value.

func (QueryExecutionStatistics) String

func (s QueryExecutionStatistics) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QueryExecutionStatus

type QueryExecutionStatus struct {

	// Provides information about an Athena query error.
	AthenaError *AthenaError `type:"structure"`

	// The date and time that the query completed.
	CompletionDateTime *time.Time `type:"timestamp"`

	// The state of query execution. QUEUED indicates that the query has been submitted
	// to the service, and Athena will execute the query as soon as resources are
	// available. RUNNING indicates that the query is in execution phase. SUCCEEDED
	// indicates that the query completed without errors. FAILED indicates that
	// the query experienced an error and did not complete processing. CANCELLED
	// indicates that a user input interrupted query execution.
	//
	// Athena automatically retries your queries in cases of certain transient errors.
	// As a result, you may see the query state transition from RUNNING or FAILED
	// to QUEUED.
	State *string `type:"string" enum:"QueryExecutionState"`

	// Further detail about the status of the query.
	StateChangeReason *string `type:"string"`

	// The date and time that the query was submitted.
	SubmissionDateTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

The completion date, current state, submission time, and state change reason (if applicable) for the query execution.

func (QueryExecutionStatus) GoString

func (s QueryExecutionStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryExecutionStatus) SetAthenaError added in v1.42.44

func (s *QueryExecutionStatus) SetAthenaError(v *AthenaError) *QueryExecutionStatus

SetAthenaError sets the AthenaError field's value.

func (*QueryExecutionStatus) SetCompletionDateTime

func (s *QueryExecutionStatus) SetCompletionDateTime(v time.Time) *QueryExecutionStatus

SetCompletionDateTime sets the CompletionDateTime field's value.

func (*QueryExecutionStatus) SetState

SetState sets the State field's value.

func (*QueryExecutionStatus) SetStateChangeReason

func (s *QueryExecutionStatus) SetStateChangeReason(v string) *QueryExecutionStatus

SetStateChangeReason sets the StateChangeReason field's value.

func (*QueryExecutionStatus) SetSubmissionDateTime

func (s *QueryExecutionStatus) SetSubmissionDateTime(v time.Time) *QueryExecutionStatus

SetSubmissionDateTime sets the SubmissionDateTime field's value.

func (QueryExecutionStatus) String

func (s QueryExecutionStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QueryResultsS3AccessGrantsConfiguration added in v1.48.13

type QueryResultsS3AccessGrantsConfiguration struct {

	// The authentication type used for Amazon S3 access grants. Currently, only
	// DIRECTORY_IDENTITY is supported.
	//
	// AuthenticationType is a required field
	AuthenticationType *string `type:"string" required:"true" enum:"AuthenticationType"`

	// When enabled, appends the user ID as an Amazon S3 path prefix to the query
	// result output location.
	CreateUserLevelPrefix *bool `type:"boolean"`

	// Specifies whether Amazon S3 access grants are enabled for query results.
	//
	// EnableS3AccessGrants is a required field
	EnableS3AccessGrants *bool `type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

Specifies whether Amazon S3 access grants are enabled for query results.

func (QueryResultsS3AccessGrantsConfiguration) GoString added in v1.48.13

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryResultsS3AccessGrantsConfiguration) SetAuthenticationType added in v1.48.13

SetAuthenticationType sets the AuthenticationType field's value.

func (*QueryResultsS3AccessGrantsConfiguration) SetCreateUserLevelPrefix added in v1.48.13

SetCreateUserLevelPrefix sets the CreateUserLevelPrefix field's value.

func (*QueryResultsS3AccessGrantsConfiguration) SetEnableS3AccessGrants added in v1.48.13

SetEnableS3AccessGrants sets the EnableS3AccessGrants field's value.

func (QueryResultsS3AccessGrantsConfiguration) String added in v1.48.13

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryResultsS3AccessGrantsConfiguration) Validate added in v1.48.13

Validate inspects the fields of the type to determine if they are valid.

type QueryRuntimeStatistics added in v1.44.60

type QueryRuntimeStatistics struct {

	// Stage statistics such as input and output rows and bytes, execution time,
	// and stage state. This information also includes substages and the query stage
	// plan.
	OutputStage *QueryStage `type:"structure"`

	// Statistics such as input rows and bytes read by the query, rows and bytes
	// output by the query, and the number of rows written by the query.
	Rows *QueryRuntimeStatisticsRows `type:"structure"`

	// Timeline statistics such as query queue time, planning time, execution time,
	// service processing time, and total execution time.
	Timeline *QueryRuntimeStatisticsTimeline `type:"structure"`
	// contains filtered or unexported fields
}

The query execution timeline, statistics on input and output rows and bytes, and the different query stages that form the query execution plan.

func (QueryRuntimeStatistics) GoString added in v1.44.60

func (s QueryRuntimeStatistics) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryRuntimeStatistics) SetOutputStage added in v1.44.60

SetOutputStage sets the OutputStage field's value.

func (*QueryRuntimeStatistics) SetRows added in v1.44.60

SetRows sets the Rows field's value.

func (*QueryRuntimeStatistics) SetTimeline added in v1.44.60

SetTimeline sets the Timeline field's value.

func (QueryRuntimeStatistics) String added in v1.44.60

func (s QueryRuntimeStatistics) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QueryRuntimeStatisticsRows added in v1.44.60

type QueryRuntimeStatisticsRows struct {

	// The number of bytes read to execute the query.
	InputBytes *int64 `type:"long"`

	// The number of rows read to execute the query.
	InputRows *int64 `type:"long"`

	// The number of bytes returned by the query.
	OutputBytes *int64 `type:"long"`

	// The number of rows returned by the query.
	OutputRows *int64 `type:"long"`
	// contains filtered or unexported fields
}

Statistics such as input rows and bytes read by the query, rows and bytes output by the query, and the number of rows written by the query.

func (QueryRuntimeStatisticsRows) GoString added in v1.44.60

func (s QueryRuntimeStatisticsRows) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryRuntimeStatisticsRows) SetInputBytes added in v1.44.60

SetInputBytes sets the InputBytes field's value.

func (*QueryRuntimeStatisticsRows) SetInputRows added in v1.44.60

SetInputRows sets the InputRows field's value.

func (*QueryRuntimeStatisticsRows) SetOutputBytes added in v1.44.60

SetOutputBytes sets the OutputBytes field's value.

func (*QueryRuntimeStatisticsRows) SetOutputRows added in v1.44.60

SetOutputRows sets the OutputRows field's value.

func (QueryRuntimeStatisticsRows) String added in v1.44.60

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QueryRuntimeStatisticsTimeline added in v1.44.60

type QueryRuntimeStatisticsTimeline struct {

	// 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 spends on preprocessing before it
	// submits the query to the engine.
	ServicePreProcessingTimeInMillis *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
}

Timeline statistics such as query queue time, planning time, execution time, service processing time, and total execution time.

func (QueryRuntimeStatisticsTimeline) GoString added in v1.44.60

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryRuntimeStatisticsTimeline) SetEngineExecutionTimeInMillis added in v1.44.60

func (s *QueryRuntimeStatisticsTimeline) SetEngineExecutionTimeInMillis(v int64) *QueryRuntimeStatisticsTimeline

SetEngineExecutionTimeInMillis sets the EngineExecutionTimeInMillis field's value.

func (*QueryRuntimeStatisticsTimeline) SetQueryPlanningTimeInMillis added in v1.44.60

func (s *QueryRuntimeStatisticsTimeline) SetQueryPlanningTimeInMillis(v int64) *QueryRuntimeStatisticsTimeline

SetQueryPlanningTimeInMillis sets the QueryPlanningTimeInMillis field's value.

func (*QueryRuntimeStatisticsTimeline) SetQueryQueueTimeInMillis added in v1.44.60

func (s *QueryRuntimeStatisticsTimeline) SetQueryQueueTimeInMillis(v int64) *QueryRuntimeStatisticsTimeline

SetQueryQueueTimeInMillis sets the QueryQueueTimeInMillis field's value.

func (*QueryRuntimeStatisticsTimeline) SetServicePreProcessingTimeInMillis added in v1.48.0

func (s *QueryRuntimeStatisticsTimeline) SetServicePreProcessingTimeInMillis(v int64) *QueryRuntimeStatisticsTimeline

SetServicePreProcessingTimeInMillis sets the ServicePreProcessingTimeInMillis field's value.

func (*QueryRuntimeStatisticsTimeline) SetServiceProcessingTimeInMillis added in v1.44.60

func (s *QueryRuntimeStatisticsTimeline) SetServiceProcessingTimeInMillis(v int64) *QueryRuntimeStatisticsTimeline

SetServiceProcessingTimeInMillis sets the ServiceProcessingTimeInMillis field's value.

func (*QueryRuntimeStatisticsTimeline) SetTotalExecutionTimeInMillis added in v1.44.60

func (s *QueryRuntimeStatisticsTimeline) SetTotalExecutionTimeInMillis(v int64) *QueryRuntimeStatisticsTimeline

SetTotalExecutionTimeInMillis sets the TotalExecutionTimeInMillis field's value.

func (QueryRuntimeStatisticsTimeline) String added in v1.44.60

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QueryStage added in v1.44.60

type QueryStage struct {

	// Time taken to execute this stage.
	ExecutionTime *int64 `type:"long"`

	// The number of bytes input into the stage for execution.
	InputBytes *int64 `type:"long"`

	// The number of rows input into the stage for execution.
	InputRows *int64 `type:"long"`

	// The number of bytes output from the stage after execution.
	OutputBytes *int64 `type:"long"`

	// The number of rows output from the stage after execution.
	OutputRows *int64 `type:"long"`

	// Stage plan information such as name, identifier, sub plans, and source stages.
	QueryStagePlan *QueryStagePlanNode `type:"structure"`

	// The identifier for a stage.
	StageId *int64 `type:"long"`

	// State of the stage after query execution.
	State *string `type:"string"`

	// List of sub query stages that form this stage execution plan.
	SubStages []*QueryStage `type:"list"`
	// contains filtered or unexported fields
}

Stage statistics such as input and output rows and bytes, execution time and stage state. This information also includes substages and the query stage plan.

func (QueryStage) GoString added in v1.44.60

func (s QueryStage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryStage) SetExecutionTime added in v1.44.60

func (s *QueryStage) SetExecutionTime(v int64) *QueryStage

SetExecutionTime sets the ExecutionTime field's value.

func (*QueryStage) SetInputBytes added in v1.44.60

func (s *QueryStage) SetInputBytes(v int64) *QueryStage

SetInputBytes sets the InputBytes field's value.

func (*QueryStage) SetInputRows added in v1.44.60

func (s *QueryStage) SetInputRows(v int64) *QueryStage

SetInputRows sets the InputRows field's value.

func (*QueryStage) SetOutputBytes added in v1.44.60

func (s *QueryStage) SetOutputBytes(v int64) *QueryStage

SetOutputBytes sets the OutputBytes field's value.

func (*QueryStage) SetOutputRows added in v1.44.60

func (s *QueryStage) SetOutputRows(v int64) *QueryStage

SetOutputRows sets the OutputRows field's value.

func (*QueryStage) SetQueryStagePlan added in v1.44.60

func (s *QueryStage) SetQueryStagePlan(v *QueryStagePlanNode) *QueryStage

SetQueryStagePlan sets the QueryStagePlan field's value.

func (*QueryStage) SetStageId added in v1.44.60

func (s *QueryStage) SetStageId(v int64) *QueryStage

SetStageId sets the StageId field's value.

func (*QueryStage) SetState added in v1.44.60

func (s *QueryStage) SetState(v string) *QueryStage

SetState sets the State field's value.

func (*QueryStage) SetSubStages added in v1.44.60

func (s *QueryStage) SetSubStages(v []*QueryStage) *QueryStage

SetSubStages sets the SubStages field's value.

func (QueryStage) String added in v1.44.60

func (s QueryStage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QueryStagePlanNode added in v1.44.60

type QueryStagePlanNode struct {

	// Stage plan information such as name, identifier, sub plans, and remote sources
	// of child plan nodes/
	Children []*QueryStagePlanNode `type:"list"`

	// Information about the operation this query stage plan node is performing.
	Identifier *string `type:"string"`

	// Name of the query stage plan that describes the operation this stage is performing
	// as part of query execution.
	Name *string `type:"string"`

	// Source plan node IDs.
	RemoteSources []*string `type:"list"`
	// contains filtered or unexported fields
}

Stage plan information such as name, identifier, sub plans, and remote sources.

func (QueryStagePlanNode) GoString added in v1.44.60

func (s QueryStagePlanNode) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryStagePlanNode) SetChildren added in v1.44.60

SetChildren sets the Children field's value.

func (*QueryStagePlanNode) SetIdentifier added in v1.44.60

func (s *QueryStagePlanNode) SetIdentifier(v string) *QueryStagePlanNode

SetIdentifier sets the Identifier field's value.

func (*QueryStagePlanNode) SetName added in v1.44.60

SetName sets the Name field's value.

func (*QueryStagePlanNode) SetRemoteSources added in v1.44.60

func (s *QueryStagePlanNode) SetRemoteSources(v []*string) *QueryStagePlanNode

SetRemoteSources sets the RemoteSources field's value.

func (QueryStagePlanNode) String added in v1.44.60

func (s QueryStagePlanNode) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException added in v1.28.0

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`

	// The name of the Amazon resource.
	ResourceName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A resource, such as a workgroup, was not found.

func (*ResourceNotFoundException) Code added in v1.28.0

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message added in v1.28.0

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.0

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResultConfiguration

type ResultConfiguration struct {

	// Indicates that an Amazon S3 canned ACL should be set to control ownership
	// of stored query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL.
	// This is a client-side setting. If workgroup settings override client-side
	// settings, then the query uses the ACL configuration that is specified for
	// the workgroup, and also uses the location for storing query results specified
	// in the workgroup. For more information, see WorkGroupConfiguration$EnforceWorkGroupConfiguration
	// and Workgroup Settings Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html).
	AclConfiguration *AclConfiguration `type:"structure"`

	// If query and calculation 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 Amazon Web Services account ID that you expect to be the owner of the
	// Amazon S3 bucket specified by ResultConfiguration$OutputLocation. If set,
	// Athena uses the value for ExpectedBucketOwner when it makes Amazon S3 calls
	// to your specified output location. If the ExpectedBucketOwner Amazon Web
	// Services account ID does not match the actual owner of the Amazon S3 bucket,
	// the call fails with a permissions error.
	//
	// This is a client-side setting. If workgroup settings override client-side
	// settings, then the query uses the ExpectedBucketOwner setting 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).
	ExpectedBucketOwner *string `min:"12" type:"string"`

	// The location in Amazon S3 where your query and calculation 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 Working with query results, recent queries,
	// and output files (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 and calculation results are stored and the encryption option, if any, used for query and calculation results. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the workgroup settings.

func (ResultConfiguration) GoString

func (s ResultConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResultConfiguration) SetAclConfiguration added in v1.43.10

func (s *ResultConfiguration) SetAclConfiguration(v *AclConfiguration) *ResultConfiguration

SetAclConfiguration sets the AclConfiguration field's value.

func (*ResultConfiguration) SetEncryptionConfiguration

func (s *ResultConfiguration) SetEncryptionConfiguration(v *EncryptionConfiguration) *ResultConfiguration

SetEncryptionConfiguration sets the EncryptionConfiguration field's value.

func (*ResultConfiguration) SetExpectedBucketOwner added in v1.42.47

func (s *ResultConfiguration) SetExpectedBucketOwner(v string) *ResultConfiguration

SetExpectedBucketOwner sets the ExpectedBucketOwner field's value.

func (*ResultConfiguration) SetOutputLocation

func (s *ResultConfiguration) SetOutputLocation(v string) *ResultConfiguration

SetOutputLocation sets the OutputLocation field's value.

func (ResultConfiguration) String

func (s ResultConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResultConfiguration) Validate

func (s *ResultConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResultConfigurationUpdates added in v1.17.0

type ResultConfigurationUpdates struct {

	// The ACL configuration for the query results.
	AclConfiguration *AclConfiguration `type:"structure"`

	// The encryption configuration for query and calculation results.
	EncryptionConfiguration *EncryptionConfiguration `type:"structure"`

	// The Amazon Web Services account ID that you expect to be the owner of the
	// Amazon S3 bucket specified by ResultConfiguration$OutputLocation. If set,
	// Athena uses the value for ExpectedBucketOwner when it makes Amazon S3 calls
	// to your specified output location. If the ExpectedBucketOwner Amazon Web
	// Services account ID does not match the actual owner of the Amazon S3 bucket,
	// the call fails with a permissions error.
	//
	// If workgroup settings override client-side settings, then the query uses
	// the ExpectedBucketOwner setting 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).
	ExpectedBucketOwner *string `min:"12" type:"string"`

	// The location in Amazon S3 where your query and calculation results are stored,
	// such as s3://path/to/query/bucket/. For more information, see Working with
	// query results, recent queries, and output files (https://docs.aws.amazon.com/athena/latest/ug/querying.html).
	// If workgroup settings override client-side settings, then the query uses
	// the location for the query results and the encryption configuration that
	// are specified for the workgroup. The "workgroup settings override" is specified
	// in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration.
	// See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
	OutputLocation *string `type:"string"`

	// If set to true, indicates that the previously-specified ACL configuration
	// 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 AclConfiguration of ResultConfigurationUpdates,
	// the AclConfiguration in the workgroup's ResultConfiguration is 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).
	RemoveAclConfiguration *bool `type:"boolean"`

	// 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", removes the Amazon Web Services account ID previously specified
	// for ResultConfiguration$ExpectedBucketOwner. If set to "false" or not set,
	// and a value is present in the ExpectedBucketOwner in ResultConfigurationUpdates
	// (the client-side setting), the ExpectedBucketOwner in the workgroup's ResultConfiguration
	// is 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).
	RemoveExpectedBucketOwner *bool `type:"boolean"`

	// If set to "true", indicates that the previously-specified query results location
	// (also known as a client-side setting) for queries in this workgroup should
	// be ignored and set to null. If set to "false" or not set, and a value is
	// present in the OutputLocation in ResultConfigurationUpdates (the client-side
	// setting), the OutputLocation in the workgroup's ResultConfiguration will
	// be updated with the new value. For more information, see Workgroup Settings
	// Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html).
	RemoveOutputLocation *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The information about the updates in the query results, such as output location and encryption configuration for the query results.

func (ResultConfigurationUpdates) GoString added in v1.17.0

func (s ResultConfigurationUpdates) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResultConfigurationUpdates) SetAclConfiguration added in v1.43.10

SetAclConfiguration sets the AclConfiguration field's value.

func (*ResultConfigurationUpdates) SetEncryptionConfiguration added in v1.17.0

SetEncryptionConfiguration sets the EncryptionConfiguration field's value.

func (*ResultConfigurationUpdates) SetExpectedBucketOwner added in v1.42.47

func (s *ResultConfigurationUpdates) SetExpectedBucketOwner(v string) *ResultConfigurationUpdates

SetExpectedBucketOwner sets the ExpectedBucketOwner field's value.

func (*ResultConfigurationUpdates) SetOutputLocation added in v1.17.0

SetOutputLocation sets the OutputLocation field's value.

func (*ResultConfigurationUpdates) SetRemoveAclConfiguration added in v1.43.10

func (s *ResultConfigurationUpdates) SetRemoveAclConfiguration(v bool) *ResultConfigurationUpdates

SetRemoveAclConfiguration sets the RemoveAclConfiguration field's value.

func (*ResultConfigurationUpdates) SetRemoveEncryptionConfiguration added in v1.17.0

func (s *ResultConfigurationUpdates) SetRemoveEncryptionConfiguration(v bool) *ResultConfigurationUpdates

SetRemoveEncryptionConfiguration sets the RemoveEncryptionConfiguration field's value.

func (*ResultConfigurationUpdates) SetRemoveExpectedBucketOwner added in v1.42.47

func (s *ResultConfigurationUpdates) SetRemoveExpectedBucketOwner(v bool) *ResultConfigurationUpdates

SetRemoveExpectedBucketOwner sets the RemoveExpectedBucketOwner field's value.

func (*ResultConfigurationUpdates) SetRemoveOutputLocation added in v1.17.0

func (s *ResultConfigurationUpdates) SetRemoveOutputLocation(v bool) *ResultConfigurationUpdates

SetRemoveOutputLocation sets the RemoveOutputLocation field's value.

func (ResultConfigurationUpdates) String added in v1.17.0

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResultConfigurationUpdates) Validate added in v1.17.0

func (s *ResultConfigurationUpdates) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResultReuseByAgeConfiguration added in v1.44.132

type ResultReuseByAgeConfiguration struct {

	// True if previous query results can be reused when the query is run; otherwise,
	// false. The default is false.
	//
	// Enabled is a required field
	Enabled *bool `type:"boolean" required:"true"`

	// Specifies, in minutes, the maximum age of a previous query result that Athena
	// should consider for reuse. The default is 60.
	MaxAgeInMinutes *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Specifies whether previous query results are reused, and if so, their maximum age.

func (ResultReuseByAgeConfiguration) GoString added in v1.44.132

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResultReuseByAgeConfiguration) SetEnabled added in v1.44.132

SetEnabled sets the Enabled field's value.

func (*ResultReuseByAgeConfiguration) SetMaxAgeInMinutes added in v1.44.132

SetMaxAgeInMinutes sets the MaxAgeInMinutes field's value.

func (ResultReuseByAgeConfiguration) String added in v1.44.132

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResultReuseByAgeConfiguration) Validate added in v1.44.132

func (s *ResultReuseByAgeConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResultReuseConfiguration added in v1.44.132

type ResultReuseConfiguration struct {

	// Specifies whether previous query results are reused, and if so, their maximum
	// age.
	ResultReuseByAgeConfiguration *ResultReuseByAgeConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the query result reuse behavior for the query.

func (ResultReuseConfiguration) GoString added in v1.44.132

func (s ResultReuseConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResultReuseConfiguration) SetResultReuseByAgeConfiguration added in v1.44.132

func (s *ResultReuseConfiguration) SetResultReuseByAgeConfiguration(v *ResultReuseByAgeConfiguration) *ResultReuseConfiguration

SetResultReuseByAgeConfiguration sets the ResultReuseByAgeConfiguration field's value.

func (ResultReuseConfiguration) String added in v1.44.132

func (s ResultReuseConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResultReuseConfiguration) Validate added in v1.44.132

func (s *ResultReuseConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResultReuseInformation added in v1.44.132

type ResultReuseInformation struct {

	// True if a previous query result was reused; false if the result was generated
	// from a new run of the query.
	//
	// ReusedPreviousResult is a required field
	ReusedPreviousResult *bool `type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

Contains information about whether the result of a previous query was reused.

func (ResultReuseInformation) GoString added in v1.44.132

func (s ResultReuseInformation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResultReuseInformation) SetReusedPreviousResult added in v1.44.132

func (s *ResultReuseInformation) SetReusedPreviousResult(v bool) *ResultReuseInformation

SetReusedPreviousResult sets the ReusedPreviousResult field's value.

func (ResultReuseInformation) String added in v1.44.132

func (s ResultReuseInformation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 make up a query result set. The metadata describes the column structure and data types. To return a ResultSet object, use GetQueryResults.

func (ResultSet) GoString

func (s ResultSet) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResultSet) SetResultSetMetadata

func (s *ResultSet) SetResultSetMetadata(v *ResultSetMetadata) *ResultSet

SetResultSetMetadata sets the ResultSetMetadata field's value.

func (*ResultSet) SetRows

func (s *ResultSet) SetRows(v []*Row) *ResultSet

SetRows sets the Rows field's value.

func (ResultSet) String

func (s ResultSet) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResultSetMetadata

type ResultSetMetadata struct {

	// Information about the columns returned in a query result metadata.
	ColumnInfo []*ColumnInfo `type:"list"`
	// contains filtered or unexported fields
}

The metadata that describes the column structure and data types of a table of query results. To return a ResultSetMetadata object, use GetQueryResults.

func (ResultSetMetadata) GoString

func (s ResultSetMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResultSetMetadata) SetColumnInfo

func (s *ResultSetMetadata) SetColumnInfo(v []*ColumnInfo) *ResultSetMetadata

SetColumnInfo sets the ColumnInfo field's value.

func (ResultSetMetadata) String

func (s ResultSetMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 make up a query result table.

func (Row) GoString

func (s Row) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Row) SetData

func (s *Row) SetData(v []*Datum) *Row

SetData sets the Data field's value.

func (Row) String

func (s Row) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SessionAlreadyExistsException added in v1.44.150

type SessionAlreadyExistsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The specified session already exists.

func (*SessionAlreadyExistsException) Code added in v1.44.150

Code returns the exception type name.

func (*SessionAlreadyExistsException) Error added in v1.44.150

func (SessionAlreadyExistsException) GoString added in v1.44.150

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SessionAlreadyExistsException) Message added in v1.44.150

Message returns the exception's message.

func (*SessionAlreadyExistsException) OrigErr added in v1.44.150

func (s *SessionAlreadyExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*SessionAlreadyExistsException) RequestID added in v1.44.150

func (s *SessionAlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*SessionAlreadyExistsException) StatusCode added in v1.44.150

func (s *SessionAlreadyExistsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (SessionAlreadyExistsException) String added in v1.44.150

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SessionConfiguration added in v1.44.150

type SessionConfiguration struct {

	// If query and calculation results are encrypted in Amazon S3, indicates the
	// encryption option used (for example, SSE_KMS or CSE_KMS) and key information.
	EncryptionConfiguration *EncryptionConfiguration `type:"structure"`

	// The ARN of the execution role used to access user resources for Spark sessions
	// and Identity Center enabled workgroups. This property applies only to Spark
	// enabled workgroups and Identity Center enabled workgroups.
	ExecutionRole *string `min:"20" type:"string"`

	// The idle timeout in seconds for the session.
	IdleTimeoutSeconds *int64 `type:"long"`

	// The Amazon S3 location that stores information for the notebook.
	WorkingDirectory *string `type:"string"`
	// contains filtered or unexported fields
}

Contains session configuration information.

func (SessionConfiguration) GoString added in v1.44.150

func (s SessionConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SessionConfiguration) SetEncryptionConfiguration added in v1.44.150

func (s *SessionConfiguration) SetEncryptionConfiguration(v *EncryptionConfiguration) *SessionConfiguration

SetEncryptionConfiguration sets the EncryptionConfiguration field's value.

func (*SessionConfiguration) SetExecutionRole added in v1.44.150

func (s *SessionConfiguration) SetExecutionRole(v string) *SessionConfiguration

SetExecutionRole sets the ExecutionRole field's value.

func (*SessionConfiguration) SetIdleTimeoutSeconds added in v1.44.150

func (s *SessionConfiguration) SetIdleTimeoutSeconds(v int64) *SessionConfiguration

SetIdleTimeoutSeconds sets the IdleTimeoutSeconds field's value.

func (*SessionConfiguration) SetWorkingDirectory added in v1.44.150

func (s *SessionConfiguration) SetWorkingDirectory(v string) *SessionConfiguration

SetWorkingDirectory sets the WorkingDirectory field's value.

func (SessionConfiguration) String added in v1.44.150

func (s SessionConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SessionStatistics added in v1.44.150

type SessionStatistics struct {

	// The data processing unit execution time for a session in milliseconds.
	DpuExecutionInMillis *int64 `type:"long"`
	// contains filtered or unexported fields
}

Contains statistics for a session.

func (SessionStatistics) GoString added in v1.44.150

func (s SessionStatistics) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SessionStatistics) SetDpuExecutionInMillis added in v1.44.150

func (s *SessionStatistics) SetDpuExecutionInMillis(v int64) *SessionStatistics

SetDpuExecutionInMillis sets the DpuExecutionInMillis field's value.

func (SessionStatistics) String added in v1.44.150

func (s SessionStatistics) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SessionStatus added in v1.44.150

type SessionStatus struct {

	// The date and time that the session ended.
	EndDateTime *time.Time `type:"timestamp"`

	// The date and time starting at which the session became idle. Can be empty
	// if the session is not currently idle.
	IdleSinceDateTime *time.Time `type:"timestamp"`

	// The most recent date and time that the session was modified.
	LastModifiedDateTime *time.Time `type:"timestamp"`

	// The date and time that the session started.
	StartDateTime *time.Time `type:"timestamp"`

	// The state of the session. A description of each state follows.
	//
	// CREATING - The session is being started, including acquiring resources.
	//
	// CREATED - The session has been started.
	//
	// IDLE - The session is able to accept a calculation.
	//
	// BUSY - The session is processing another task and is unable to accept a calculation.
	//
	// TERMINATING - The session is in the process of shutting down.
	//
	// TERMINATED - The session and its resources are no longer running.
	//
	// DEGRADED - The session has no healthy coordinators.
	//
	// FAILED - Due to a failure, the session and its resources are no longer running.
	State *string `type:"string" enum:"SessionState"`

	// The reason for the session state change (for example, canceled because the
	// session was terminated).
	StateChangeReason *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains information about the status of a session.

func (SessionStatus) GoString added in v1.44.150

func (s SessionStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SessionStatus) SetEndDateTime added in v1.44.150

func (s *SessionStatus) SetEndDateTime(v time.Time) *SessionStatus

SetEndDateTime sets the EndDateTime field's value.

func (*SessionStatus) SetIdleSinceDateTime added in v1.44.150

func (s *SessionStatus) SetIdleSinceDateTime(v time.Time) *SessionStatus

SetIdleSinceDateTime sets the IdleSinceDateTime field's value.

func (*SessionStatus) SetLastModifiedDateTime added in v1.44.150

func (s *SessionStatus) SetLastModifiedDateTime(v time.Time) *SessionStatus

SetLastModifiedDateTime sets the LastModifiedDateTime field's value.

func (*SessionStatus) SetStartDateTime added in v1.44.150

func (s *SessionStatus) SetStartDateTime(v time.Time) *SessionStatus

SetStartDateTime sets the StartDateTime field's value.

func (*SessionStatus) SetState added in v1.44.150

func (s *SessionStatus) SetState(v string) *SessionStatus

SetState sets the State field's value.

func (*SessionStatus) SetStateChangeReason added in v1.44.150

func (s *SessionStatus) SetStateChangeReason(v string) *SessionStatus

SetStateChangeReason sets the StateChangeReason field's value.

func (SessionStatus) String added in v1.44.150

func (s SessionStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SessionSummary added in v1.44.150

type SessionSummary struct {

	// The session description.
	Description *string `min:"1" type:"string"`

	// The engine version used by the session (for example, PySpark engine version
	// 3).
	EngineVersion *EngineVersion `type:"structure"`

	// The notebook version.
	NotebookVersion *string `min:"1" type:"string"`

	// The session ID.
	SessionId *string `min:"1" type:"string"`

	// Contains information about the session status.
	Status *SessionStatus `type:"structure"`
	// contains filtered or unexported fields
}

Contains summary information about a session.

func (SessionSummary) GoString added in v1.44.150

func (s SessionSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SessionSummary) SetDescription added in v1.44.150

func (s *SessionSummary) SetDescription(v string) *SessionSummary

SetDescription sets the Description field's value.

func (*SessionSummary) SetEngineVersion added in v1.44.150

func (s *SessionSummary) SetEngineVersion(v *EngineVersion) *SessionSummary

SetEngineVersion sets the EngineVersion field's value.

func (*SessionSummary) SetNotebookVersion added in v1.44.150

func (s *SessionSummary) SetNotebookVersion(v string) *SessionSummary

SetNotebookVersion sets the NotebookVersion field's value.

func (*SessionSummary) SetSessionId added in v1.44.150

func (s *SessionSummary) SetSessionId(v string) *SessionSummary

SetSessionId sets the SessionId field's value.

func (*SessionSummary) SetStatus added in v1.44.150

func (s *SessionSummary) SetStatus(v *SessionStatus) *SessionSummary

SetStatus sets the Status field's value.

func (SessionSummary) String added in v1.44.150

func (s SessionSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartCalculationExecutionInput added in v1.44.150

type StartCalculationExecutionInput struct {

	// Contains configuration information for the calculation.
	//
	// Deprecated: Kepler Post GA Tasks : https://sim.amazon.com/issues/ATHENA-39828
	CalculationConfiguration *CalculationConfiguration `deprecated:"true" type:"structure"`

	// A unique case-sensitive string used to ensure the request to create the calculation
	// is idempotent (executes only once). If another StartCalculationExecutionRequest
	// is received, the same response is returned and another calculation is not
	// created. If a parameter has changed, an error is returned.
	//
	// This token is listed as not required because Amazon Web Services SDKs (for
	// example the Amazon Web Services SDK for Java) auto-generate the token for
	// users. If you are not using the Amazon Web Services SDK or the Amazon Web
	// Services CLI, you must provide this token or the action will fail.
	ClientRequestToken *string `min:"32" type:"string"`

	// A string that contains the code of the calculation. Use this parameter instead
	// of CalculationConfiguration$CodeBlock, which is deprecated.
	CodeBlock *string `type:"string"`

	// A description of the calculation.
	Description *string `min:"1" type:"string"`

	// The session ID.
	//
	// SessionId is a required field
	SessionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartCalculationExecutionInput) GoString added in v1.44.150

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartCalculationExecutionInput) SetCalculationConfiguration added in v1.44.150

SetCalculationConfiguration sets the CalculationConfiguration field's value.

func (*StartCalculationExecutionInput) SetClientRequestToken added in v1.44.150

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartCalculationExecutionInput) SetCodeBlock added in v1.44.150

SetCodeBlock sets the CodeBlock field's value.

func (*StartCalculationExecutionInput) SetDescription added in v1.44.150

SetDescription sets the Description field's value.

func (*StartCalculationExecutionInput) SetSessionId added in v1.44.150

SetSessionId sets the SessionId field's value.

func (StartCalculationExecutionInput) String added in v1.44.150

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartCalculationExecutionInput) Validate added in v1.44.150

func (s *StartCalculationExecutionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartCalculationExecutionOutput added in v1.44.150

type StartCalculationExecutionOutput struct {

	// The calculation execution UUID.
	CalculationExecutionId *string `min:"1" type:"string"`

	// CREATING - The calculation is in the process of being created.
	//
	// CREATED - The calculation has been created and is ready to run.
	//
	// QUEUED - The calculation has been queued for processing.
	//
	// RUNNING - The calculation is running.
	//
	// CANCELING - A request to cancel the calculation has been received and the
	// system is working to stop it.
	//
	// CANCELED - The calculation is no longer running as the result of a cancel
	// request.
	//
	// COMPLETED - The calculation has completed without error.
	//
	// FAILED - The calculation failed and is no longer running.
	State *string `type:"string" enum:"CalculationExecutionState"`
	// contains filtered or unexported fields
}

func (StartCalculationExecutionOutput) GoString added in v1.44.150

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartCalculationExecutionOutput) SetCalculationExecutionId added in v1.44.150

SetCalculationExecutionId sets the CalculationExecutionId field's value.

func (*StartCalculationExecutionOutput) SetState added in v1.44.150

SetState sets the State field's value.

func (StartCalculationExecutionOutput) String added in v1.44.150

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	// An error is returned if a parameter, such as QueryString, has changed. A
	// call to StartQueryExecution that uses a previous client request token returns
	// the same QueryExecutionId even if the requester doesn't have permission on
	// the tables specified in QueryString.
	//
	// This token is listed as not required because Amazon Web Services SDKs (for
	// example the Amazon Web Services SDK for Java) auto-generate the token for
	// users. If you are not using the Amazon Web Services SDK or the Amazon Web
	// Services CLI, you must provide this token or the action will fail.
	ClientRequestToken *string `min:"32" type:"string" idempotencyToken:"true"`

	// A list of values for the parameters in a query. The values are applied sequentially
	// to the parameters in the query in the order in which the parameters occur.
	ExecutionParameters []*string `min:"1" type:"list"`

	// 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"`

	// Specifies the query result reuse behavior for the query.
	ResultReuseConfiguration *ResultReuseConfiguration `type:"structure"`

	// The name of the workgroup in which the query is being started.
	WorkGroup *string `type:"string"`
	// contains filtered or unexported fields
}

func (StartQueryExecutionInput) GoString

func (s StartQueryExecutionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartQueryExecutionInput) SetClientRequestToken

func (s *StartQueryExecutionInput) SetClientRequestToken(v string) *StartQueryExecutionInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartQueryExecutionInput) SetExecutionParameters added in v1.44.46

func (s *StartQueryExecutionInput) SetExecutionParameters(v []*string) *StartQueryExecutionInput

SetExecutionParameters sets the ExecutionParameters field's value.

func (*StartQueryExecutionInput) SetQueryExecutionContext

SetQueryExecutionContext sets the QueryExecutionContext field's value.

func (*StartQueryExecutionInput) SetQueryString

SetQueryString sets the QueryString field's value.

func (*StartQueryExecutionInput) SetResultConfiguration

SetResultConfiguration sets the ResultConfiguration field's value.

func (*StartQueryExecutionInput) SetResultReuseConfiguration added in v1.44.132

SetResultReuseConfiguration sets the ResultReuseConfiguration field's value.

func (*StartQueryExecutionInput) SetWorkGroup added in v1.17.0

SetWorkGroup sets the WorkGroup field's value.

func (StartQueryExecutionInput) String

func (s StartQueryExecutionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartQueryExecutionOutput) GoString

func (s StartQueryExecutionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartQueryExecutionOutput) SetQueryExecutionId

func (s *StartQueryExecutionOutput) SetQueryExecutionId(v string) *StartQueryExecutionOutput

SetQueryExecutionId sets the QueryExecutionId field's value.

func (StartQueryExecutionOutput) String

func (s StartQueryExecutionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartSessionInput added in v1.44.150

type StartSessionInput struct {

	// A unique case-sensitive string used to ensure the request to create the session
	// is idempotent (executes only once). If another StartSessionRequest is received,
	// the same response is returned and another session is not created. If a parameter
	// has changed, an error is returned.
	//
	// This token is listed as not required because Amazon Web Services SDKs (for
	// example the Amazon Web Services SDK for Java) auto-generate the token for
	// users. If you are not using the Amazon Web Services SDK or the Amazon Web
	// Services CLI, you must provide this token or the action will fail.
	ClientRequestToken *string `min:"32" type:"string"`

	// The session description.
	Description *string `min:"1" type:"string"`

	// Contains engine data processing unit (DPU) configuration settings and parameter
	// mappings.
	//
	// EngineConfiguration is a required field
	EngineConfiguration *EngineConfiguration `type:"structure" required:"true"`

	// The notebook version. This value is supplied automatically for notebook sessions
	// in the Athena console and is not required for programmatic session access.
	// The only valid notebook version is Athena notebook version 1. If you specify
	// a value for NotebookVersion, you must also specify a value for NotebookId.
	// See EngineConfiguration$AdditionalConfigs.
	NotebookVersion *string `min:"1" type:"string"`

	// The idle timeout in minutes for the session.
	SessionIdleTimeoutInMinutes *int64 `min:"1" type:"integer"`

	// The workgroup to which the session belongs.
	//
	// WorkGroup is a required field
	WorkGroup *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartSessionInput) GoString added in v1.44.150

func (s StartSessionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartSessionInput) SetClientRequestToken added in v1.44.150

func (s *StartSessionInput) SetClientRequestToken(v string) *StartSessionInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartSessionInput) SetDescription added in v1.44.150

func (s *StartSessionInput) SetDescription(v string) *StartSessionInput

SetDescription sets the Description field's value.

func (*StartSessionInput) SetEngineConfiguration added in v1.44.150

func (s *StartSessionInput) SetEngineConfiguration(v *EngineConfiguration) *StartSessionInput

SetEngineConfiguration sets the EngineConfiguration field's value.

func (*StartSessionInput) SetNotebookVersion added in v1.44.150

func (s *StartSessionInput) SetNotebookVersion(v string) *StartSessionInput

SetNotebookVersion sets the NotebookVersion field's value.

func (*StartSessionInput) SetSessionIdleTimeoutInMinutes added in v1.44.150

func (s *StartSessionInput) SetSessionIdleTimeoutInMinutes(v int64) *StartSessionInput

SetSessionIdleTimeoutInMinutes sets the SessionIdleTimeoutInMinutes field's value.

func (*StartSessionInput) SetWorkGroup added in v1.44.150

func (s *StartSessionInput) SetWorkGroup(v string) *StartSessionInput

SetWorkGroup sets the WorkGroup field's value.

func (StartSessionInput) String added in v1.44.150

func (s StartSessionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartSessionInput) Validate added in v1.44.150

func (s *StartSessionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartSessionOutput added in v1.44.150

type StartSessionOutput struct {

	// The session ID.
	SessionId *string `min:"1" type:"string"`

	// The state of the session. A description of each state follows.
	//
	// CREATING - The session is being started, including acquiring resources.
	//
	// CREATED - The session has been started.
	//
	// IDLE - The session is able to accept a calculation.
	//
	// BUSY - The session is processing another task and is unable to accept a calculation.
	//
	// TERMINATING - The session is in the process of shutting down.
	//
	// TERMINATED - The session and its resources are no longer running.
	//
	// DEGRADED - The session has no healthy coordinators.
	//
	// FAILED - Due to a failure, the session and its resources are no longer running.
	State *string `type:"string" enum:"SessionState"`
	// contains filtered or unexported fields
}

func (StartSessionOutput) GoString added in v1.44.150

func (s StartSessionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartSessionOutput) SetSessionId added in v1.44.150

func (s *StartSessionOutput) SetSessionId(v string) *StartSessionOutput

SetSessionId sets the SessionId field's value.

func (*StartSessionOutput) SetState added in v1.44.150

SetState sets the State field's value.

func (StartSessionOutput) String added in v1.44.150

func (s StartSessionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopCalculationExecutionInput added in v1.44.150

type StopCalculationExecutionInput struct {

	// The calculation execution UUID.
	//
	// CalculationExecutionId is a required field
	CalculationExecutionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopCalculationExecutionInput) GoString added in v1.44.150

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopCalculationExecutionInput) SetCalculationExecutionId added in v1.44.150

func (s *StopCalculationExecutionInput) SetCalculationExecutionId(v string) *StopCalculationExecutionInput

SetCalculationExecutionId sets the CalculationExecutionId field's value.

func (StopCalculationExecutionInput) String added in v1.44.150

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopCalculationExecutionInput) Validate added in v1.44.150

func (s *StopCalculationExecutionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopCalculationExecutionOutput added in v1.44.150

type StopCalculationExecutionOutput struct {

	// CREATING - The calculation is in the process of being created.
	//
	// CREATED - The calculation has been created and is ready to run.
	//
	// QUEUED - The calculation has been queued for processing.
	//
	// RUNNING - The calculation is running.
	//
	// CANCELING - A request to cancel the calculation has been received and the
	// system is working to stop it.
	//
	// CANCELED - The calculation is no longer running as the result of a cancel
	// request.
	//
	// COMPLETED - The calculation has completed without error.
	//
	// FAILED - The calculation failed and is no longer running.
	State *string `type:"string" enum:"CalculationExecutionState"`
	// contains filtered or unexported fields
}

func (StopCalculationExecutionOutput) GoString added in v1.44.150

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopCalculationExecutionOutput) SetState added in v1.44.150

SetState sets the State field's value.

func (StopCalculationExecutionOutput) String added in v1.44.150

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopQueryExecutionInput

type StopQueryExecutionInput struct {

	// The unique ID of the query execution to stop.
	QueryExecutionId *string `min:"1" type:"string" idempotencyToken:"true"`
	// contains filtered or unexported fields
}

func (StopQueryExecutionInput) GoString

func (s StopQueryExecutionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopQueryExecutionInput) SetQueryExecutionId

func (s *StopQueryExecutionInput) SetQueryExecutionId(v string) *StopQueryExecutionInput

SetQueryExecutionId sets the QueryExecutionId field's value.

func (StopQueryExecutionInput) String

func (s StopQueryExecutionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString

func (s StopQueryExecutionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (StopQueryExecutionOutput) String

func (s StopQueryExecutionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TableMetadata added in v1.31.8

type TableMetadata struct {

	// A list of the columns in the table.
	Columns []*Column `type:"list"`

	// The time that the table was created.
	CreateTime *time.Time `type:"timestamp"`

	// The last time the table was accessed.
	LastAccessTime *time.Time `type:"timestamp"`

	// The name of the table.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// A set of custom key/value pairs for table properties.
	Parameters map[string]*string `type:"map"`

	// A list of the partition keys in the table.
	PartitionKeys []*Column `type:"list"`

	// The type of table. In Athena, only EXTERNAL_TABLE is supported.
	TableType *string `type:"string"`
	// contains filtered or unexported fields
}

Contains metadata for a table.

func (TableMetadata) GoString added in v1.31.8

func (s TableMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TableMetadata) SetColumns added in v1.31.8

func (s *TableMetadata) SetColumns(v []*Column) *TableMetadata

SetColumns sets the Columns field's value.

func (*TableMetadata) SetCreateTime added in v1.31.8

func (s *TableMetadata) SetCreateTime(v time.Time) *TableMetadata

SetCreateTime sets the CreateTime field's value.

func (*TableMetadata) SetLastAccessTime added in v1.31.8

func (s *TableMetadata) SetLastAccessTime(v time.Time) *TableMetadata

SetLastAccessTime sets the LastAccessTime field's value.

func (*TableMetadata) SetName added in v1.31.8

func (s *TableMetadata) SetName(v string) *TableMetadata

SetName sets the Name field's value.

func (*TableMetadata) SetParameters added in v1.31.8

func (s *TableMetadata) SetParameters(v map[string]*string) *TableMetadata

SetParameters sets the Parameters field's value.

func (*TableMetadata) SetPartitionKeys added in v1.31.8

func (s *TableMetadata) SetPartitionKeys(v []*Column) *TableMetadata

SetPartitionKeys sets the PartitionKeys field's value.

func (*TableMetadata) SetTableType added in v1.31.8

func (s *TableMetadata) SetTableType(v string) *TableMetadata

SetTableType sets the TableType field's value.

func (TableMetadata) String added in v1.31.8

func (s TableMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Tag added in v1.17.4

type Tag struct {

	// A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8.
	// You can use letters and numbers representable in UTF-8, and the following
	// characters: + - = . _ : / @. Tag keys are case-sensitive and must be unique
	// per resource.
	Key *string `min:"1" type:"string"`

	// A tag value. The tag value length is from 0 to 256 Unicode characters in
	// UTF-8. You can use letters and numbers representable in UTF-8, and the following
	// characters: + - = . _ : / @. Tag values are case-sensitive.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A label that you assign to a resource. Athena resources include workgroups, data catalogs, and capacity reservations. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena resources by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter the resources in your account. For best practices, see Tagging Best Practices (https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html). Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas.

func (Tag) GoString added in v1.17.4

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey added in v1.17.4

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.17.4

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v1.17.4

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate added in v1.17.4

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput added in v1.17.4

type TagResourceInput struct {

	// Specifies the ARN of the Athena resource 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 resource.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.17.4

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceARN added in v1.17.4

func (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetTags added in v1.17.4

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.17.4

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate added in v1.17.4

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v1.17.4

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString added in v1.17.4

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String added in v1.17.4

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TerminateSessionInput added in v1.44.150

type TerminateSessionInput struct {

	// The session ID.
	//
	// SessionId is a required field
	SessionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (TerminateSessionInput) GoString added in v1.44.150

func (s TerminateSessionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TerminateSessionInput) SetSessionId added in v1.44.150

SetSessionId sets the SessionId field's value.

func (TerminateSessionInput) String added in v1.44.150

func (s TerminateSessionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TerminateSessionInput) Validate added in v1.44.150

func (s *TerminateSessionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TerminateSessionOutput added in v1.44.150

type TerminateSessionOutput struct {

	// The state of the session. A description of each state follows.
	//
	// CREATING - The session is being started, including acquiring resources.
	//
	// CREATED - The session has been started.
	//
	// IDLE - The session is able to accept a calculation.
	//
	// BUSY - The session is processing another task and is unable to accept a calculation.
	//
	// TERMINATING - The session is in the process of shutting down.
	//
	// TERMINATED - The session and its resources are no longer running.
	//
	// DEGRADED - The session has no healthy coordinators.
	//
	// FAILED - Due to a failure, the session and its resources are no longer running.
	State *string `type:"string" enum:"SessionState"`
	// contains filtered or unexported fields
}

func (TerminateSessionOutput) GoString added in v1.44.150

func (s TerminateSessionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TerminateSessionOutput) SetState added in v1.44.150

SetState sets the State field's value.

func (TerminateSessionOutput) String added in v1.44.150

func (s TerminateSessionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TooManyRequestsException added in v1.28.0

type TooManyRequestsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`

	// The reason for the query throttling, for example, when it exceeds the concurrent
	// query limit.
	Reason *string `type:"string" enum:"ThrottleReason"`
	// contains filtered or unexported fields
}

Indicates that the request was throttled.

func (*TooManyRequestsException) Code added in v1.28.0

func (s *TooManyRequestsException) Code() string

Code returns the exception type name.

func (*TooManyRequestsException) Error added in v1.28.0

func (s *TooManyRequestsException) Error() string

func (TooManyRequestsException) GoString added in v1.28.0

func (s TooManyRequestsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TooManyRequestsException) Message added in v1.28.0

func (s *TooManyRequestsException) Message() string

Message returns the exception's message.

func (*TooManyRequestsException) OrigErr added in v1.28.0

func (s *TooManyRequestsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyRequestsException) RequestID added in v1.28.0

func (s *TooManyRequestsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyRequestsException) StatusCode added in v1.28.0

func (s *TooManyRequestsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TooManyRequestsException) String added in v1.28.0

func (s TooManyRequestsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Information about a named query ID that could not be processed.

func (UnprocessedNamedQueryId) GoString

func (s UnprocessedNamedQueryId) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnprocessedNamedQueryId) SetErrorCode

SetErrorCode sets the ErrorCode field's value.

func (*UnprocessedNamedQueryId) SetErrorMessage

SetErrorMessage sets the ErrorMessage field's value.

func (*UnprocessedNamedQueryId) SetNamedQueryId

SetNamedQueryId sets the NamedQueryId field's value.

func (UnprocessedNamedQueryId) String

func (s UnprocessedNamedQueryId) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnprocessedPreparedStatementName added in v1.44.46

type UnprocessedPreparedStatementName struct {

	// The error code returned when the request for the prepared statement failed.
	ErrorCode *string `min:"1" type:"string"`

	// The error message containing the reason why the prepared statement could
	// not be returned. The following error messages are possible:
	//
	//    * INVALID_INPUT - The name of the prepared statement that was provided
	//    is not valid (for example, the name is too long).
	//
	//    * STATEMENT_NOT_FOUND - A prepared statement with the name provided could
	//    not be found.
	//
	//    * UNAUTHORIZED - The requester does not have permission to access the
	//    workgroup that contains the prepared statement.
	ErrorMessage *string `type:"string"`

	// The name of a prepared statement that could not be returned due to an error.
	StatementName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The name of a prepared statement that could not be returned.

func (UnprocessedPreparedStatementName) GoString added in v1.44.46

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnprocessedPreparedStatementName) SetErrorCode added in v1.44.46

SetErrorCode sets the ErrorCode field's value.

func (*UnprocessedPreparedStatementName) SetErrorMessage added in v1.44.46

SetErrorMessage sets the ErrorMessage field's value.

func (*UnprocessedPreparedStatementName) SetStatementName added in v1.44.46

SetStatementName sets the StatementName field's value.

func (UnprocessedPreparedStatementName) String added in v1.44.46

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes a query execution that failed to process.

func (UnprocessedQueryExecutionId) GoString

func (s UnprocessedQueryExecutionId) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnprocessedQueryExecutionId) SetErrorCode

SetErrorCode sets the ErrorCode field's value.

func (*UnprocessedQueryExecutionId) SetErrorMessage

SetErrorMessage sets the ErrorMessage field's value.

func (*UnprocessedQueryExecutionId) SetQueryExecutionId

SetQueryExecutionId sets the QueryExecutionId field's value.

func (UnprocessedQueryExecutionId) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput added in v1.17.4

type UntagResourceInput struct {

	// Specifies the ARN of the resource from which tags are to be removed.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// A comma-separated list of one or more tag keys whose tags are to be removed
	// from the specified resource.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.17.4

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceARN added in v1.17.4

func (s *UntagResourceInput) SetResourceARN(v string) *UntagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*UntagResourceInput) SetTagKeys added in v1.17.4

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.17.4

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate added in v1.17.4

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v1.17.4

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString added in v1.17.4

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String added in v1.17.4

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateCapacityReservationInput added in v1.44.253

type UpdateCapacityReservationInput struct {

	// The name of the capacity reservation.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The new number of requested data processing units.
	//
	// TargetDpus is a required field
	TargetDpus *int64 `min:"24" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateCapacityReservationInput) GoString added in v1.44.253

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateCapacityReservationInput) SetName added in v1.44.253

SetName sets the Name field's value.

func (*UpdateCapacityReservationInput) SetTargetDpus added in v1.44.253

SetTargetDpus sets the TargetDpus field's value.

func (UpdateCapacityReservationInput) String added in v1.44.253

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateCapacityReservationInput) Validate added in v1.44.253

func (s *UpdateCapacityReservationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateCapacityReservationOutput added in v1.44.253

type UpdateCapacityReservationOutput struct {
	// contains filtered or unexported fields
}

func (UpdateCapacityReservationOutput) GoString added in v1.44.253

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateCapacityReservationOutput) String added in v1.44.253

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateDataCatalogInput added in v1.31.8

type UpdateDataCatalogInput struct {

	// New or modified text that describes the data catalog.
	Description *string `min:"1" type:"string"`

	// The name of the data catalog to update. The catalog name must be unique for
	// the Amazon Web Services account and can use a maximum of 127 alphanumeric,
	// underscore, at sign, or hyphen characters. The remainder of the length constraint
	// of 256 is reserved for use by Athena.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// Specifies the Lambda function or functions to use for updating the data catalog.
	// This is a mapping whose values depend on the catalog type.
	//
	//    * For the HIVE data catalog type, use the following syntax. The metadata-function
	//    parameter is required. The sdk-version parameter is optional and defaults
	//    to the currently supported version. metadata-function=lambda_arn, sdk-version=version_number
	//
	//    * For the LAMBDA data catalog type, use one of the following sets of required
	//    parameters, but not both. If you have one Lambda function that processes
	//    metadata and another for reading the actual data, use the following syntax.
	//    Both parameters are required. metadata-function=lambda_arn, record-function=lambda_arn
	//    If you have a composite Lambda function that processes both metadata and
	//    data, use the following syntax to specify your Lambda function. function=lambda_arn
	Parameters map[string]*string `type:"map"`

	// Specifies the type of data catalog to update. Specify LAMBDA for a federated
	// catalog, HIVE for an external hive metastore, or GLUE for an Glue Data Catalog.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"DataCatalogType"`
	// contains filtered or unexported fields
}

func (UpdateDataCatalogInput) GoString added in v1.31.8

func (s UpdateDataCatalogInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDataCatalogInput) SetDescription added in v1.31.8

SetDescription sets the Description field's value.

func (*UpdateDataCatalogInput) SetName added in v1.31.8

SetName sets the Name field's value.

func (*UpdateDataCatalogInput) SetParameters added in v1.31.8

func (s *UpdateDataCatalogInput) SetParameters(v map[string]*string) *UpdateDataCatalogInput

SetParameters sets the Parameters field's value.

func (*UpdateDataCatalogInput) SetType added in v1.31.8

SetType sets the Type field's value.

func (UpdateDataCatalogInput) String added in v1.31.8

func (s UpdateDataCatalogInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDataCatalogInput) Validate added in v1.31.8

func (s *UpdateDataCatalogInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateDataCatalogOutput added in v1.31.8

type UpdateDataCatalogOutput struct {
	// contains filtered or unexported fields
}

func (UpdateDataCatalogOutput) GoString added in v1.31.8

func (s UpdateDataCatalogOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateDataCatalogOutput) String added in v1.31.8

func (s UpdateDataCatalogOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateNamedQueryInput added in v1.43.8

type UpdateNamedQueryInput struct {

	// The query description.
	Description *string `type:"string"`

	// The name of the query.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The unique identifier (UUID) of the query.
	//
	// NamedQueryId is a required field
	NamedQueryId *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"`
	// contains filtered or unexported fields
}

func (UpdateNamedQueryInput) GoString added in v1.43.8

func (s UpdateNamedQueryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateNamedQueryInput) SetDescription added in v1.43.8

func (s *UpdateNamedQueryInput) SetDescription(v string) *UpdateNamedQueryInput

SetDescription sets the Description field's value.

func (*UpdateNamedQueryInput) SetName added in v1.43.8

SetName sets the Name field's value.

func (*UpdateNamedQueryInput) SetNamedQueryId added in v1.43.8

func (s *UpdateNamedQueryInput) SetNamedQueryId(v string) *UpdateNamedQueryInput

SetNamedQueryId sets the NamedQueryId field's value.

func (*UpdateNamedQueryInput) SetQueryString added in v1.43.8

func (s *UpdateNamedQueryInput) SetQueryString(v string) *UpdateNamedQueryInput

SetQueryString sets the QueryString field's value.

func (UpdateNamedQueryInput) String added in v1.43.8

func (s UpdateNamedQueryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateNamedQueryInput) Validate added in v1.43.8

func (s *UpdateNamedQueryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateNamedQueryOutput added in v1.43.8

type UpdateNamedQueryOutput struct {
	// contains filtered or unexported fields
}

func (UpdateNamedQueryOutput) GoString added in v1.43.8

func (s UpdateNamedQueryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateNamedQueryOutput) String added in v1.43.8

func (s UpdateNamedQueryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateNotebookInput added in v1.44.150

type UpdateNotebookInput struct {

	// A unique case-sensitive string used to ensure the request to create the notebook
	// is idempotent (executes only once).
	//
	// This token is listed as not required because Amazon Web Services SDKs (for
	// example the Amazon Web Services SDK for Java) auto-generate the token for
	// you. If you are not using the Amazon Web Services SDK or the Amazon Web Services
	// CLI, you must provide this token or the action will fail.
	ClientRequestToken *string `min:"1" type:"string"`

	// The ID of the notebook to update.
	//
	// NotebookId is a required field
	NotebookId *string `min:"1" type:"string" required:"true"`

	// The updated content for the notebook.
	//
	// Payload is a required field
	Payload *string `min:"1" type:"string" required:"true"`

	// The active notebook session ID. Required if the notebook has an active session.
	SessionId *string `min:"1" type:"string"`

	// The notebook content type. Currently, the only valid type is IPYNB.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"NotebookType"`
	// contains filtered or unexported fields
}

func (UpdateNotebookInput) GoString added in v1.44.150

func (s UpdateNotebookInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateNotebookInput) SetClientRequestToken added in v1.44.150

func (s *UpdateNotebookInput) SetClientRequestToken(v string) *UpdateNotebookInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*UpdateNotebookInput) SetNotebookId added in v1.44.150

func (s *UpdateNotebookInput) SetNotebookId(v string) *UpdateNotebookInput

SetNotebookId sets the NotebookId field's value.

func (*UpdateNotebookInput) SetPayload added in v1.44.150

SetPayload sets the Payload field's value.

func (*UpdateNotebookInput) SetSessionId added in v1.44.150

func (s *UpdateNotebookInput) SetSessionId(v string) *UpdateNotebookInput

SetSessionId sets the SessionId field's value.

func (*UpdateNotebookInput) SetType added in v1.44.150

SetType sets the Type field's value.

func (UpdateNotebookInput) String added in v1.44.150

func (s UpdateNotebookInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateNotebookInput) Validate added in v1.44.150

func (s *UpdateNotebookInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateNotebookMetadataInput added in v1.44.150

type UpdateNotebookMetadataInput struct {

	// A unique case-sensitive string used to ensure the request to create the notebook
	// is idempotent (executes only once).
	//
	// This token is listed as not required because Amazon Web Services SDKs (for
	// example the Amazon Web Services SDK for Java) auto-generate the token for
	// you. If you are not using the Amazon Web Services SDK or the Amazon Web Services
	// CLI, you must provide this token or the action will fail.
	ClientRequestToken *string `min:"1" type:"string"`

	// The name to update the notebook to.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The ID of the notebook to update the metadata for.
	//
	// NotebookId is a required field
	NotebookId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateNotebookMetadataInput) GoString added in v1.44.150

func (s UpdateNotebookMetadataInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateNotebookMetadataInput) SetClientRequestToken added in v1.44.150

func (s *UpdateNotebookMetadataInput) SetClientRequestToken(v string) *UpdateNotebookMetadataInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*UpdateNotebookMetadataInput) SetName added in v1.44.150

SetName sets the Name field's value.

func (*UpdateNotebookMetadataInput) SetNotebookId added in v1.44.150

SetNotebookId sets the NotebookId field's value.

func (UpdateNotebookMetadataInput) String added in v1.44.150

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateNotebookMetadataInput) Validate added in v1.44.150

func (s *UpdateNotebookMetadataInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateNotebookMetadataOutput added in v1.44.150

type UpdateNotebookMetadataOutput struct {
	// contains filtered or unexported fields
}

func (UpdateNotebookMetadataOutput) GoString added in v1.44.150

func (s UpdateNotebookMetadataOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateNotebookMetadataOutput) String added in v1.44.150

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateNotebookOutput added in v1.44.150

type UpdateNotebookOutput struct {
	// contains filtered or unexported fields
}

func (UpdateNotebookOutput) GoString added in v1.44.150

func (s UpdateNotebookOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateNotebookOutput) String added in v1.44.150

func (s UpdateNotebookOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdatePreparedStatementInput added in v1.37.25

type UpdatePreparedStatementInput struct {

	// The description of the prepared statement.
	Description *string `min:"1" type:"string"`

	// The query string for the prepared statement.
	//
	// QueryStatement is a required field
	QueryStatement *string `min:"1" type:"string" required:"true"`

	// The name of the prepared statement.
	//
	// StatementName is a required field
	StatementName *string `min:"1" type:"string" required:"true"`

	// The workgroup for the prepared statement.
	//
	// WorkGroup is a required field
	WorkGroup *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdatePreparedStatementInput) GoString added in v1.37.25

func (s UpdatePreparedStatementInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdatePreparedStatementInput) SetDescription added in v1.37.25

SetDescription sets the Description field's value.

func (*UpdatePreparedStatementInput) SetQueryStatement added in v1.37.25

SetQueryStatement sets the QueryStatement field's value.

func (*UpdatePreparedStatementInput) SetStatementName added in v1.37.25

SetStatementName sets the StatementName field's value.

func (*UpdatePreparedStatementInput) SetWorkGroup added in v1.37.25

SetWorkGroup sets the WorkGroup field's value.

func (UpdatePreparedStatementInput) String added in v1.37.25

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdatePreparedStatementInput) Validate added in v1.37.25

func (s *UpdatePreparedStatementInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdatePreparedStatementOutput added in v1.37.25

type UpdatePreparedStatementOutput struct {
	// contains filtered or unexported fields
}

func (UpdatePreparedStatementOutput) GoString added in v1.37.25

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdatePreparedStatementOutput) String added in v1.37.25

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateWorkGroupInput added in v1.17.0

type UpdateWorkGroupInput struct {

	// Contains configuration updates for an Athena SQL workgroup.
	ConfigurationUpdates *WorkGroupConfigurationUpdates `type:"structure"`

	// The workgroup description.
	Description *string `type:"string"`

	// The workgroup state that will be updated for the given workgroup.
	State *string `type:"string" enum:"WorkGroupState"`

	// The specified workgroup that will be updated.
	//
	// WorkGroup is a required field
	WorkGroup *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateWorkGroupInput) GoString added in v1.17.0

func (s UpdateWorkGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWorkGroupInput) SetConfigurationUpdates added in v1.17.0

SetConfigurationUpdates sets the ConfigurationUpdates field's value.

func (*UpdateWorkGroupInput) SetDescription added in v1.17.0

func (s *UpdateWorkGroupInput) SetDescription(v string) *UpdateWorkGroupInput

SetDescription sets the Description field's value.

func (*UpdateWorkGroupInput) SetState added in v1.17.0

SetState sets the State field's value.

func (*UpdateWorkGroupInput) SetWorkGroup added in v1.17.0

func (s *UpdateWorkGroupInput) SetWorkGroup(v string) *UpdateWorkGroupInput

SetWorkGroup sets the WorkGroup field's value.

func (UpdateWorkGroupInput) String added in v1.17.0

func (s UpdateWorkGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWorkGroupInput) Validate added in v1.17.0

func (s *UpdateWorkGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateWorkGroupOutput added in v1.17.0

type UpdateWorkGroupOutput struct {
	// contains filtered or unexported fields
}

func (UpdateWorkGroupOutput) GoString added in v1.17.0

func (s UpdateWorkGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateWorkGroupOutput) String added in v1.17.0

func (s UpdateWorkGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkGroup added in v1.17.0

type WorkGroup struct {

	// The configuration of the workgroup, which includes the location in Amazon
	// S3 where query and calculation results are stored, the encryption configuration,
	// if any, used for query and calculation 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 ARN of the IAM Identity Center enabled application associated with the
	// workgroup.
	IdentityCenterApplicationArn *string `type:"string"`

	// The workgroup name.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The state of the workgroup: ENABLED or DISABLED.
	State *string `type:"string" enum:"WorkGroupState"`
	// contains filtered or unexported fields
}

A workgroup, which contains a name, description, creation time, state, and other configuration, listed under WorkGroup$Configuration. Each workgroup enables you to isolate queries for you or your group of users from other queries in the same account, to configure the query results location and the encryption configuration (known as workgroup settings), to enable sending query metrics to Amazon CloudWatch, and to establish per-query data usage control limits for all queries in a workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

func (WorkGroup) GoString added in v1.17.0

func (s WorkGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkGroup) SetConfiguration added in v1.17.0

func (s *WorkGroup) SetConfiguration(v *WorkGroupConfiguration) *WorkGroup

SetConfiguration sets the Configuration field's value.

func (*WorkGroup) SetCreationTime added in v1.17.0

func (s *WorkGroup) SetCreationTime(v time.Time) *WorkGroup

SetCreationTime sets the CreationTime field's value.

func (*WorkGroup) SetDescription added in v1.17.0

func (s *WorkGroup) SetDescription(v string) *WorkGroup

SetDescription sets the Description field's value.

func (*WorkGroup) SetIdentityCenterApplicationArn added in v1.48.13

func (s *WorkGroup) SetIdentityCenterApplicationArn(v string) *WorkGroup

SetIdentityCenterApplicationArn sets the IdentityCenterApplicationArn field's value.

func (*WorkGroup) SetName added in v1.17.0

func (s *WorkGroup) SetName(v string) *WorkGroup

SetName sets the Name field's value.

func (*WorkGroup) SetState added in v1.17.0

func (s *WorkGroup) SetState(v string) *WorkGroup

SetState sets the State field's value.

func (WorkGroup) String added in v1.17.0

func (s WorkGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkGroupConfiguration added in v1.17.0

type WorkGroupConfiguration struct {

	// Specifies a user defined JSON string that is passed to the notebook engine.
	AdditionalConfiguration *string `min:"1" type:"string"`

	// 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"`

	// Specifies the KMS key that is used to encrypt the user's data stores in Athena.
	// This setting does not apply to Athena SQL workgroups.
	CustomerContentEncryptionConfiguration *CustomerContentEncryptionConfiguration `type:"structure"`

	// Enforces a minimal level of encryption for the workgroup for query and calculation
	// results that are written to Amazon S3. When enabled, workgroup users can
	// set encryption only to the minimum level set by the administrator or higher
	// when they submit queries.
	//
	// The EnforceWorkGroupConfiguration setting takes precedence over the EnableMinimumEncryptionConfiguration
	// flag. This means that if EnforceWorkGroupConfiguration is true, the EnableMinimumEncryptionConfiguration
	// flag is ignored, and the workgroup configuration for encryption is used.
	EnableMinimumEncryptionConfiguration *bool `type:"boolean"`

	// If set to "true", the settings for the workgroup override client-side settings.
	// If set to "false", client-side settings are used. For more information, see
	// Workgroup Settings Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html).
	EnforceWorkGroupConfiguration *bool `type:"boolean"`

	// The engine version that all queries running on the workgroup use. Queries
	// on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine
	// regardless of this setting.
	EngineVersion *EngineVersion `type:"structure"`

	// The ARN of the execution role used to access user resources for Spark sessions
	// and IAM Identity Center enabled workgroups. This property applies only to
	// Spark enabled workgroups and IAM Identity Center enabled workgroups. The
	// property is required for IAM Identity Center enabled workgroups.
	ExecutionRole *string `min:"20" type:"string"`

	// Specifies whether the workgroup is IAM Identity Center supported.
	IdentityCenterConfiguration *IdentityCenterConfiguration `type:"structure"`

	// Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
	PublishCloudWatchMetricsEnabled *bool `type:"boolean"`

	// Specifies whether Amazon S3 access grants are enabled for query results.
	QueryResultsS3AccessGrantsConfiguration *QueryResultsS3AccessGrantsConfiguration `type:"structure"`

	// 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 and calculation results are stored and the encryption option,
	// if any, used for query and calculation 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 Working with query results, recent queries,
	// and output files (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 and calculation results are stored, the encryption option, if any, used for query and calculation results, whether the Amazon CloudWatch Metrics are enabled for the workgroup and whether workgroup settings override query settings, and the data usage limits for the amount of data scanned per query or per workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

func (WorkGroupConfiguration) GoString added in v1.17.0

func (s WorkGroupConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkGroupConfiguration) SetAdditionalConfiguration added in v1.44.150

func (s *WorkGroupConfiguration) SetAdditionalConfiguration(v string) *WorkGroupConfiguration

SetAdditionalConfiguration sets the AdditionalConfiguration field's value.

func (*WorkGroupConfiguration) SetBytesScannedCutoffPerQuery added in v1.17.0

func (s *WorkGroupConfiguration) SetBytesScannedCutoffPerQuery(v int64) *WorkGroupConfiguration

SetBytesScannedCutoffPerQuery sets the BytesScannedCutoffPerQuery field's value.

func (*WorkGroupConfiguration) SetCustomerContentEncryptionConfiguration added in v1.44.150

func (s *WorkGroupConfiguration) SetCustomerContentEncryptionConfiguration(v *CustomerContentEncryptionConfiguration) *WorkGroupConfiguration

SetCustomerContentEncryptionConfiguration sets the CustomerContentEncryptionConfiguration field's value.

func (*WorkGroupConfiguration) SetEnableMinimumEncryptionConfiguration added in v1.44.230

func (s *WorkGroupConfiguration) SetEnableMinimumEncryptionConfiguration(v bool) *WorkGroupConfiguration

SetEnableMinimumEncryptionConfiguration sets the EnableMinimumEncryptionConfiguration field's value.

func (*WorkGroupConfiguration) SetEnforceWorkGroupConfiguration added in v1.17.0

func (s *WorkGroupConfiguration) SetEnforceWorkGroupConfiguration(v bool) *WorkGroupConfiguration

SetEnforceWorkGroupConfiguration sets the EnforceWorkGroupConfiguration field's value.

func (*WorkGroupConfiguration) SetEngineVersion added in v1.37.4

SetEngineVersion sets the EngineVersion field's value.

func (*WorkGroupConfiguration) SetExecutionRole added in v1.44.150

func (s *WorkGroupConfiguration) SetExecutionRole(v string) *WorkGroupConfiguration

SetExecutionRole sets the ExecutionRole field's value.

func (*WorkGroupConfiguration) SetIdentityCenterConfiguration added in v1.48.13

func (s *WorkGroupConfiguration) SetIdentityCenterConfiguration(v *IdentityCenterConfiguration) *WorkGroupConfiguration

SetIdentityCenterConfiguration sets the IdentityCenterConfiguration field's value.

func (*WorkGroupConfiguration) SetPublishCloudWatchMetricsEnabled added in v1.17.0

func (s *WorkGroupConfiguration) SetPublishCloudWatchMetricsEnabled(v bool) *WorkGroupConfiguration

SetPublishCloudWatchMetricsEnabled sets the PublishCloudWatchMetricsEnabled field's value.

func (*WorkGroupConfiguration) SetQueryResultsS3AccessGrantsConfiguration added in v1.48.13

func (s *WorkGroupConfiguration) SetQueryResultsS3AccessGrantsConfiguration(v *QueryResultsS3AccessGrantsConfiguration) *WorkGroupConfiguration

SetQueryResultsS3AccessGrantsConfiguration sets the QueryResultsS3AccessGrantsConfiguration field's value.

func (*WorkGroupConfiguration) SetRequesterPaysEnabled added in v1.23.2

func (s *WorkGroupConfiguration) SetRequesterPaysEnabled(v bool) *WorkGroupConfiguration

SetRequesterPaysEnabled sets the RequesterPaysEnabled field's value.

func (*WorkGroupConfiguration) SetResultConfiguration added in v1.17.0

func (s *WorkGroupConfiguration) SetResultConfiguration(v *ResultConfiguration) *WorkGroupConfiguration

SetResultConfiguration sets the ResultConfiguration field's value.

func (WorkGroupConfiguration) String added in v1.17.0

func (s WorkGroupConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkGroupConfiguration) Validate added in v1.17.0

func (s *WorkGroupConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type WorkGroupConfigurationUpdates added in v1.17.0

type WorkGroupConfigurationUpdates struct {

	// Contains a user defined string in JSON format for a Spark-enabled workgroup.
	AdditionalConfiguration *string `min:"1" type:"string"`

	// 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"`

	// Specifies the customer managed KMS key that is used to encrypt the user's
	// data stores in Athena. When an Amazon Web Services managed key is used, this
	// value is null. This setting does not apply to Athena SQL workgroups.
	CustomerContentEncryptionConfiguration *CustomerContentEncryptionConfiguration `type:"structure"`

	// Enforces a minimal level of encryption for the workgroup for query and calculation
	// results that are written to Amazon S3. When enabled, workgroup users can
	// set encryption only to the minimum level set by the administrator or higher
	// when they submit queries. This setting does not apply to Spark-enabled workgroups.
	//
	// The EnforceWorkGroupConfiguration setting takes precedence over the EnableMinimumEncryptionConfiguration
	// flag. This means that if EnforceWorkGroupConfiguration is true, the EnableMinimumEncryptionConfiguration
	// flag is ignored, and the workgroup configuration for encryption is used.
	EnableMinimumEncryptionConfiguration *bool `type:"boolean"`

	// If set to "true", the settings for the workgroup override client-side settings.
	// If set to "false" client-side settings are used. For more information, see
	// Workgroup Settings Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html).
	EnforceWorkGroupConfiguration *bool `type:"boolean"`

	// The engine version requested when a workgroup is updated. After the update,
	// all queries on the workgroup run on the requested engine version. If no value
	// was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality
	// workgroup run on the preview engine regardless of this setting.
	EngineVersion *EngineVersion `type:"structure"`

	// The ARN of the execution role used to access user resources for Spark sessions
	// and Identity Center enabled workgroups. This property applies only to Spark
	// enabled workgroups and Identity Center enabled workgroups.
	ExecutionRole *string `min:"20" type:"string"`

	// Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
	PublishCloudWatchMetricsEnabled *bool `type:"boolean"`

	// Specifies whether Amazon S3 access grants are enabled for query results.
	QueryResultsS3AccessGrantsConfiguration *QueryResultsS3AccessGrantsConfiguration `type:"structure"`

	// Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery
	RemoveBytesScannedCutoffPerQuery *bool `type:"boolean"`

	// Removes content encryption configuration from an Apache Spark-enabled Athena
	// workgroup.
	RemoveCustomerContentEncryptionConfiguration *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 and calculation results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.

func (WorkGroupConfigurationUpdates) GoString added in v1.17.0

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkGroupConfigurationUpdates) SetAdditionalConfiguration added in v1.44.150

func (s *WorkGroupConfigurationUpdates) SetAdditionalConfiguration(v string) *WorkGroupConfigurationUpdates

SetAdditionalConfiguration sets the AdditionalConfiguration field's value.

func (*WorkGroupConfigurationUpdates) SetBytesScannedCutoffPerQuery added in v1.17.0

func (s *WorkGroupConfigurationUpdates) SetBytesScannedCutoffPerQuery(v int64) *WorkGroupConfigurationUpdates

SetBytesScannedCutoffPerQuery sets the BytesScannedCutoffPerQuery field's value.

func (*WorkGroupConfigurationUpdates) SetCustomerContentEncryptionConfiguration added in v1.44.150

SetCustomerContentEncryptionConfiguration sets the CustomerContentEncryptionConfiguration field's value.

func (*WorkGroupConfigurationUpdates) SetEnableMinimumEncryptionConfiguration added in v1.44.230

func (s *WorkGroupConfigurationUpdates) SetEnableMinimumEncryptionConfiguration(v bool) *WorkGroupConfigurationUpdates

SetEnableMinimumEncryptionConfiguration sets the EnableMinimumEncryptionConfiguration field's value.

func (*WorkGroupConfigurationUpdates) SetEnforceWorkGroupConfiguration added in v1.17.0

func (s *WorkGroupConfigurationUpdates) SetEnforceWorkGroupConfiguration(v bool) *WorkGroupConfigurationUpdates

SetEnforceWorkGroupConfiguration sets the EnforceWorkGroupConfiguration field's value.

func (*WorkGroupConfigurationUpdates) SetEngineVersion added in v1.37.4

SetEngineVersion sets the EngineVersion field's value.

func (*WorkGroupConfigurationUpdates) SetExecutionRole added in v1.44.150

SetExecutionRole sets the ExecutionRole field's value.

func (*WorkGroupConfigurationUpdates) SetPublishCloudWatchMetricsEnabled added in v1.17.0

func (s *WorkGroupConfigurationUpdates) SetPublishCloudWatchMetricsEnabled(v bool) *WorkGroupConfigurationUpdates

SetPublishCloudWatchMetricsEnabled sets the PublishCloudWatchMetricsEnabled field's value.

func (*WorkGroupConfigurationUpdates) SetQueryResultsS3AccessGrantsConfiguration added in v1.48.13

SetQueryResultsS3AccessGrantsConfiguration sets the QueryResultsS3AccessGrantsConfiguration field's value.

func (*WorkGroupConfigurationUpdates) SetRemoveBytesScannedCutoffPerQuery added in v1.17.0

func (s *WorkGroupConfigurationUpdates) SetRemoveBytesScannedCutoffPerQuery(v bool) *WorkGroupConfigurationUpdates

SetRemoveBytesScannedCutoffPerQuery sets the RemoveBytesScannedCutoffPerQuery field's value.

func (*WorkGroupConfigurationUpdates) SetRemoveCustomerContentEncryptionConfiguration added in v1.44.150

func (s *WorkGroupConfigurationUpdates) SetRemoveCustomerContentEncryptionConfiguration(v bool) *WorkGroupConfigurationUpdates

SetRemoveCustomerContentEncryptionConfiguration sets the RemoveCustomerContentEncryptionConfiguration field's value.

func (*WorkGroupConfigurationUpdates) SetRequesterPaysEnabled added in v1.23.2

func (s *WorkGroupConfigurationUpdates) SetRequesterPaysEnabled(v bool) *WorkGroupConfigurationUpdates

SetRequesterPaysEnabled sets the RequesterPaysEnabled field's value.

func (*WorkGroupConfigurationUpdates) SetResultConfigurationUpdates added in v1.17.0

SetResultConfigurationUpdates sets the ResultConfigurationUpdates field's value.

func (WorkGroupConfigurationUpdates) String added in v1.17.0

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkGroupConfigurationUpdates) Validate added in v1.17.0

func (s *WorkGroupConfigurationUpdates) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type WorkGroupSummary added in v1.17.0

type WorkGroupSummary struct {

	// The workgroup creation date and time.
	CreationTime *time.Time `type:"timestamp"`

	// The workgroup description.
	Description *string `type:"string"`

	// The engine version setting for all queries on the workgroup. Queries on the
	// AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless
	// of this setting.
	EngineVersion *EngineVersion `type:"structure"`

	// The ARN of the IAM Identity Center enabled application associated with the
	// workgroup.
	IdentityCenterApplicationArn *string `type:"string"`

	// The name of the workgroup.
	Name *string `type:"string"`

	// The state of the workgroup.
	State *string `type:"string" enum:"WorkGroupState"`
	// contains filtered or unexported fields
}

The summary information for the workgroup, which includes its name, state, description, and the date and time it was created.

func (WorkGroupSummary) GoString added in v1.17.0

func (s WorkGroupSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkGroupSummary) SetCreationTime added in v1.17.0

func (s *WorkGroupSummary) SetCreationTime(v time.Time) *WorkGroupSummary

SetCreationTime sets the CreationTime field's value.

func (*WorkGroupSummary) SetDescription added in v1.17.0

func (s *WorkGroupSummary) SetDescription(v string) *WorkGroupSummary

SetDescription sets the Description field's value.

func (*WorkGroupSummary) SetEngineVersion added in v1.37.4

func (s *WorkGroupSummary) SetEngineVersion(v *EngineVersion) *WorkGroupSummary

SetEngineVersion sets the EngineVersion field's value.

func (*WorkGroupSummary) SetIdentityCenterApplicationArn added in v1.48.13

func (s *WorkGroupSummary) SetIdentityCenterApplicationArn(v string) *WorkGroupSummary

SetIdentityCenterApplicationArn sets the IdentityCenterApplicationArn field's value.

func (*WorkGroupSummary) SetName added in v1.17.0

func (s *WorkGroupSummary) SetName(v string) *WorkGroupSummary

SetName sets the Name field's value.

func (*WorkGroupSummary) SetState added in v1.17.0

func (s *WorkGroupSummary) SetState(v string) *WorkGroupSummary

SetState sets the State field's value.

func (WorkGroupSummary) String added in v1.17.0

func (s WorkGroupSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Directories

Path Synopsis
Package athenaiface provides an interface to enable mocking the Amazon Athena service client for testing your code.
Package athenaiface provides an interface to enable mocking the Amazon Athena service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL