redshiftdataapiservice

package
v1.42.46 Latest Latest
Warning

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

 Go to latest Published: Feb 3, 2022 License: Apache-2.0 Imports: 10 Imported by: 24

Documentation

Overview

Package redshiftdataapiservice provides the client and types for making API requests to Redshift Data API Service.

You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You can run SQL statements, which are committed if the statement succeeds.

For more information about the Amazon Redshift Data API, see Using the Amazon Redshift Data API (https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html) in the Amazon Redshift Cluster Management Guide.

See https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20 for more information on this service.

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

Using the Client

To contact Redshift Data API Service 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 Redshift Data API Service client RedshiftDataAPIService for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/redshiftdataapiservice/#New

Index

Constants

View Source 
const (
	// StatementStatusStringSubmitted is a StatementStatusString enum value
	StatementStatusStringSubmitted = "SUBMITTED"

	// StatementStatusStringPicked is a StatementStatusString enum value
	StatementStatusStringPicked = "PICKED"

	// StatementStatusStringStarted is a StatementStatusString enum value
	StatementStatusStringStarted = "STARTED"

	// StatementStatusStringFinished is a StatementStatusString enum value
	StatementStatusStringFinished = "FINISHED"

	// StatementStatusStringAborted is a StatementStatusString enum value
	StatementStatusStringAborted = "ABORTED"

	// StatementStatusStringFailed is a StatementStatusString enum value
	StatementStatusStringFailed = "FAILED"
)
View Source 
const (
	// StatusStringSubmitted is a StatusString enum value
	StatusStringSubmitted = "SUBMITTED"

	// StatusStringPicked is a StatusString enum value
	StatusStringPicked = "PICKED"

	// StatusStringStarted is a StatusString enum value
	StatusStringStarted = "STARTED"

	// StatusStringFinished is a StatusString enum value
	StatusStringFinished = "FINISHED"

	// StatusStringAborted is a StatusString enum value
	StatusStringAborted = "ABORTED"

	// StatusStringFailed is a StatusString enum value
	StatusStringFailed = "FAILED"

	// StatusStringAll is a StatusString enum value
	StatusStringAll = "ALL"
)
View Source 
const (

	// ErrCodeActiveStatementsExceededException for service response error code
	// "ActiveStatementsExceededException".
	//
	// The number of active statements exceeds the limit.
	ErrCodeActiveStatementsExceededException = "ActiveStatementsExceededException"

	// ErrCodeBatchExecuteStatementException for service response error code
	// "BatchExecuteStatementException".
	//
	// An SQL statement encountered an environmental error while running.
	ErrCodeBatchExecuteStatementException = "BatchExecuteStatementException"

	// ErrCodeDatabaseConnectionException for service response error code
	// "DatabaseConnectionException".
	//
	// Connection to a database failed.
	ErrCodeDatabaseConnectionException = "DatabaseConnectionException"

	// ErrCodeExecuteStatementException for service response error code
	// "ExecuteStatementException".
	//
	// The SQL statement encountered an environmental error while running.
	ErrCodeExecuteStatementException = "ExecuteStatementException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// The Amazon Redshift Data API operation failed due to invalid input.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The Amazon Redshift Data API operation failed due to a missing resource.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The Amazon Redshift Data API operation failed due to invalid input.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "Redshift Data" // Name of service.
	EndpointsID = "redshift-data" // ID to lookup a service endpoint with.
	ServiceID   = "Redshift Data" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func StatementStatusString_Values added in v1.40.9 

func StatementStatusString_Values() []string

StatementStatusString_Values returns all elements of the StatementStatusString enum

func StatusString_Values 

func StatusString_Values() []string

StatusString_Values returns all elements of the StatusString enum

Types

type ActiveStatementsExceededException added in v1.37.11 

type ActiveStatementsExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The number of active statements exceeds the limit.

func (*ActiveStatementsExceededException) Code added in v1.37.11 

func (s *ActiveStatementsExceededException) Code() string

Code returns the exception type name.

func (*ActiveStatementsExceededException) Error added in v1.37.11 

func (s *ActiveStatementsExceededException) Error() string

func (ActiveStatementsExceededException) GoString added in v1.37.11 

func (s ActiveStatementsExceededException) 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 (*ActiveStatementsExceededException) Message added in v1.37.11 

func (s *ActiveStatementsExceededException) Message() string

Message returns the exception's message.

func (*ActiveStatementsExceededException) OrigErr added in v1.37.11 

func (s *ActiveStatementsExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ActiveStatementsExceededException) RequestID added in v1.37.11 

func (s *ActiveStatementsExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ActiveStatementsExceededException) StatusCode added in v1.37.11 

func (s *ActiveStatementsExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ActiveStatementsExceededException) String added in v1.37.11 

func (s ActiveStatementsExceededException) 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 BatchExecuteStatementException added in v1.40.9 

type BatchExecuteStatementException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`

	// Statement identifier of the exception.
	//
	// StatementId is a required field
	StatementId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

An SQL statement encountered an environmental error while running.

func (*BatchExecuteStatementException) Code added in v1.40.9 

func (s *BatchExecuteStatementException) Code() string

Code returns the exception type name.

func (*BatchExecuteStatementException) Error added in v1.40.9 

func (s *BatchExecuteStatementException) Error() string

func (BatchExecuteStatementException) GoString added in v1.40.9 

func (s BatchExecuteStatementException) 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 (*BatchExecuteStatementException) Message added in v1.40.9 

func (s *BatchExecuteStatementException) Message() string

Message returns the exception's message.

func (*BatchExecuteStatementException) OrigErr added in v1.40.9 

func (s *BatchExecuteStatementException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BatchExecuteStatementException) RequestID added in v1.40.9 

func (s *BatchExecuteStatementException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BatchExecuteStatementException) StatusCode added in v1.40.9 

func (s *BatchExecuteStatementException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (BatchExecuteStatementException) String added in v1.40.9 

func (s BatchExecuteStatementException) 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 BatchExecuteStatementInput added in v1.40.9 

type BatchExecuteStatementInput struct {

	// The cluster identifier. This parameter is required when connecting to a cluster
	// and authenticating using either Secrets Manager or temporary credentials.
	ClusterIdentifier *string `type:"string"`

	// The name of the database. This parameter is required when authenticating
	// using either Secrets Manager or temporary credentials.
	//
	// Database is a required field
	Database *string `type:"string" required:"true"`

	// The database user name. This parameter is required when connecting to a cluster
	// and authenticating using temporary credentials.
	DbUser *string `type:"string"`

	// The name or ARN of the secret that enables access to the database. This parameter
	// is required when authenticating using Secrets Manager.
	SecretArn *string `type:"string"`

	// One or more SQL statements to run.
	//
	// Sqls is a required field
	Sqls []*string `min:"1" type:"list" required:"true"`

	// The name of the SQL statements. You can name the SQL statements when you
	// create them to identify the query.
	StatementName *string `type:"string"`

	// A value that indicates whether to send an event to the Amazon EventBridge
	// event bus after the SQL statements run.
	WithEvent *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (BatchExecuteStatementInput) GoString added in v1.40.9 

func (s BatchExecuteStatementInput) 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 (*BatchExecuteStatementInput) SetClusterIdentifier added in v1.40.9 

func (s *BatchExecuteStatementInput) SetClusterIdentifier(v string) *BatchExecuteStatementInput

SetClusterIdentifier sets the ClusterIdentifier field's value.

func (*BatchExecuteStatementInput) SetDatabase added in v1.40.9 

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

SetDatabase sets the Database field's value.

func (*BatchExecuteStatementInput) SetDbUser added in v1.40.9 

func (s *BatchExecuteStatementInput) SetDbUser(v string) *BatchExecuteStatementInput

SetDbUser sets the DbUser field's value.

func (*BatchExecuteStatementInput) SetSecretArn added in v1.40.9 

func (s *BatchExecuteStatementInput) SetSecretArn(v string) *BatchExecuteStatementInput

SetSecretArn sets the SecretArn field's value.

func (*BatchExecuteStatementInput) SetSqls added in v1.40.9 

func (s *BatchExecuteStatementInput) SetSqls(v []*string) *BatchExecuteStatementInput

SetSqls sets the Sqls field's value.

func (*BatchExecuteStatementInput) SetStatementName added in v1.40.9 

func (s *BatchExecuteStatementInput) SetStatementName(v string) *BatchExecuteStatementInput

SetStatementName sets the StatementName field's value.

func (*BatchExecuteStatementInput) SetWithEvent added in v1.40.9 

func (s *BatchExecuteStatementInput) SetWithEvent(v bool) *BatchExecuteStatementInput

SetWithEvent sets the WithEvent field's value.

func (BatchExecuteStatementInput) String added in v1.40.9 

func (s BatchExecuteStatementInput) 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 (*BatchExecuteStatementInput) Validate added in v1.40.9 

func (s *BatchExecuteStatementInput) Validate() error

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

type BatchExecuteStatementOutput added in v1.40.9 

type BatchExecuteStatementOutput struct {

	// The cluster identifier. This parameter is not returned when connecting to
	// a serverless endpoint.
	ClusterIdentifier *string `type:"string"`

	// The date and time (UTC) the statement was created.
	CreatedAt *time.Time `type:"timestamp"`

	// The name of the database.
	Database *string `type:"string"`

	// The database user name.
	DbUser *string `type:"string"`

	// The identifier of the SQL statement whose results are to be fetched. This
	// value is a universally unique identifier (UUID) generated by Amazon Redshift
	// Data API. This identifier is returned by BatchExecuteStatment.
	Id *string `type:"string"`

	// The name or ARN of the secret that enables access to the database.
	SecretArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (BatchExecuteStatementOutput) GoString added in v1.40.9 

func (s BatchExecuteStatementOutput) 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 (*BatchExecuteStatementOutput) SetClusterIdentifier added in v1.40.9 

func (s *BatchExecuteStatementOutput) SetClusterIdentifier(v string) *BatchExecuteStatementOutput

SetClusterIdentifier sets the ClusterIdentifier field's value.

func (*BatchExecuteStatementOutput) SetCreatedAt added in v1.40.9 

func (s *BatchExecuteStatementOutput) SetCreatedAt(v time.Time) *BatchExecuteStatementOutput

SetCreatedAt sets the CreatedAt field's value.

func (*BatchExecuteStatementOutput) SetDatabase added in v1.40.9 

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

SetDatabase sets the Database field's value.

func (*BatchExecuteStatementOutput) SetDbUser added in v1.40.9 

func (s *BatchExecuteStatementOutput) SetDbUser(v string) *BatchExecuteStatementOutput

SetDbUser sets the DbUser field's value.

func (*BatchExecuteStatementOutput) SetId added in v1.40.9 

func (s *BatchExecuteStatementOutput) SetId(v string) *BatchExecuteStatementOutput

SetId sets the Id field's value.

func (*BatchExecuteStatementOutput) SetSecretArn added in v1.40.9 

func (s *BatchExecuteStatementOutput) SetSecretArn(v string) *BatchExecuteStatementOutput

SetSecretArn sets the SecretArn field's value.

func (BatchExecuteStatementOutput) String added in v1.40.9 

func (s BatchExecuteStatementOutput) 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 CancelStatementInput 

type CancelStatementInput struct {

	// The identifier of the SQL statement to cancel. This value is a universally
	// unique identifier (UUID) generated by Amazon Redshift Data API. This identifier
	// is returned by BatchExecuteStatment, ExecuteStatment, and ListStatements.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelStatementInput) GoString 

func (s CancelStatementInput) 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 (*CancelStatementInput) SetId 

func (s *CancelStatementInput) SetId(v string) *CancelStatementInput

SetId sets the Id field's value.

func (CancelStatementInput) String 

func (s CancelStatementInput) 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 (*CancelStatementInput) Validate 

func (s *CancelStatementInput) Validate() error

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

type CancelStatementOutput 

type CancelStatementOutput struct {

	// A value that indicates whether the cancel statement succeeded (true).
	Status *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (CancelStatementOutput) GoString 

func (s CancelStatementOutput) 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 (*CancelStatementOutput) SetStatus 

func (s *CancelStatementOutput) SetStatus(v bool) *CancelStatementOutput

SetStatus sets the Status field's value.

func (CancelStatementOutput) String 

func (s CancelStatementOutput) 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 ColumnMetadata 

type ColumnMetadata struct {

	// The default value of the column.
	ColumnDefault *string `locationName:"columnDefault" type:"string"`

	// A value that indicates whether the column is case-sensitive.
	IsCaseSensitive *bool `locationName:"isCaseSensitive" type:"boolean"`

	// A value that indicates whether the column contains currency values.
	IsCurrency *bool `locationName:"isCurrency" type:"boolean"`

	// A value that indicates whether an integer column is signed.
	IsSigned *bool `locationName:"isSigned" type:"boolean"`

	// The label for the column.
	Label *string `locationName:"label" type:"string"`

	// The length of the column.
	Length *int64 `locationName:"length" type:"integer"`

	// The name of the column.
	Name *string `locationName:"name" type:"string"`

	// A value that indicates whether the column is nullable.
	Nullable *int64 `locationName:"nullable" type:"integer"`

	// The precision value of a decimal number column.
	Precision *int64 `locationName:"precision" type:"integer"`

	// The scale value of a decimal number column.
	Scale *int64 `locationName:"scale" type:"integer"`

	// The name of the schema that contains the table that includes the column.
	SchemaName *string `locationName:"schemaName" type:"string"`

	// The name of the table that includes the column.
	TableName *string `locationName:"tableName" type:"string"`

	// The database-specific data type of the column.
	TypeName *string `locationName:"typeName" type:"string"`
	// contains filtered or unexported fields
}

The properties (metadata) of a column.

func (ColumnMetadata) GoString 

func (s ColumnMetadata) 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 (*ColumnMetadata) SetColumnDefault 

func (s *ColumnMetadata) SetColumnDefault(v string) *ColumnMetadata

SetColumnDefault sets the ColumnDefault field's value.

func (*ColumnMetadata) SetIsCaseSensitive 

func (s *ColumnMetadata) SetIsCaseSensitive(v bool) *ColumnMetadata

SetIsCaseSensitive sets the IsCaseSensitive field's value.

func (*ColumnMetadata) SetIsCurrency 

func (s *ColumnMetadata) SetIsCurrency(v bool) *ColumnMetadata

SetIsCurrency sets the IsCurrency field's value.

func (*ColumnMetadata) SetIsSigned 

func (s *ColumnMetadata) SetIsSigned(v bool) *ColumnMetadata

SetIsSigned sets the IsSigned field's value.

func (*ColumnMetadata) SetLabel 

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

SetLabel sets the Label field's value.

func (*ColumnMetadata) SetLength 

func (s *ColumnMetadata) SetLength(v int64) *ColumnMetadata

SetLength sets the Length field's value.

func (*ColumnMetadata) SetName 

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

SetName sets the Name field's value.

func (*ColumnMetadata) SetNullable 

func (s *ColumnMetadata) SetNullable(v int64) *ColumnMetadata

SetNullable sets the Nullable field's value.

func (*ColumnMetadata) SetPrecision 

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

SetPrecision sets the Precision field's value.

func (*ColumnMetadata) SetScale 

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

SetScale sets the Scale field's value.

func (*ColumnMetadata) SetSchemaName 

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

SetSchemaName sets the SchemaName field's value.

func (*ColumnMetadata) SetTableName 

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

SetTableName sets the TableName field's value.

func (*ColumnMetadata) SetTypeName 

func (s *ColumnMetadata) SetTypeName(v string) *ColumnMetadata

SetTypeName sets the TypeName field's value.

func (ColumnMetadata) String 

func (s ColumnMetadata) 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 DatabaseConnectionException added in v1.42.7 

type DatabaseConnectionException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Connection to a database failed.

func (*DatabaseConnectionException) Code added in v1.42.7 

func (s *DatabaseConnectionException) Code() string

Code returns the exception type name.

func (*DatabaseConnectionException) Error added in v1.42.7 

func (s *DatabaseConnectionException) Error() string

func (DatabaseConnectionException) GoString added in v1.42.7 

func (s DatabaseConnectionException) 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 (*DatabaseConnectionException) Message added in v1.42.7 

func (s *DatabaseConnectionException) Message() string

Message returns the exception's message.

func (*DatabaseConnectionException) OrigErr added in v1.42.7 

func (s *DatabaseConnectionException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DatabaseConnectionException) RequestID added in v1.42.7 

func (s *DatabaseConnectionException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DatabaseConnectionException) StatusCode added in v1.42.7 

func (s *DatabaseConnectionException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DatabaseConnectionException) String added in v1.42.7 

func (s DatabaseConnectionException) 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 DescribeStatementInput 

type DescribeStatementInput struct {

	// The identifier of the SQL statement to describe. This value is a universally
	// unique identifier (UUID) generated by Amazon Redshift Data API. A suffix
	// indicates the number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2
	// has a suffix of :2 that indicates the second SQL statement of a batch query.
	// This identifier is returned by BatchExecuteStatment, ExecuteStatement, and
	// ListStatements.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeStatementInput) GoString 

func (s DescribeStatementInput) 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 (*DescribeStatementInput) SetId 

func (s *DescribeStatementInput) SetId(v string) *DescribeStatementInput

SetId sets the Id field's value.

func (DescribeStatementInput) String 

func (s DescribeStatementInput) 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 (*DescribeStatementInput) Validate 

func (s *DescribeStatementInput) Validate() error

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

type DescribeStatementOutput 

type DescribeStatementOutput struct {

	// The cluster identifier.
	ClusterIdentifier *string `type:"string"`

	// The date and time (UTC) when the SQL statement was submitted to run.
	CreatedAt *time.Time `type:"timestamp"`

	// The name of the database.
	Database *string `type:"string"`

	// The database user name.
	DbUser *string `type:"string"`

	// The amount of time in nanoseconds that the statement ran.
	Duration *int64 `type:"long"`

	// The error message from the cluster if the SQL statement encountered an error
	// while running.
	Error *string `type:"string"`

	// A value that indicates whether the statement has a result set. The result
	// set can be empty. The value is true for an empty result set. The value is
	// true if any substatement returns a result set.
	HasResultSet *bool `type:"boolean"`

	// The identifier of the SQL statement described. This value is a universally
	// unique identifier (UUID) generated by Amazon Redshift Data API.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// The parameters for the SQL statement.
	QueryParameters []*SqlParameter `min:"1" type:"list"`

	// The SQL statement text.
	QueryString *string `type:"string"`

	// The process identifier from Amazon Redshift.
	RedshiftPid *int64 `type:"long"`

	// The identifier of the query generated by Amazon Redshift. These identifiers
	// are also available in the query column of the STL_QUERY system view.
	RedshiftQueryId *int64 `type:"long"`

	// Either the number of rows returned from the SQL statement or the number of
	// rows affected. If result size is greater than zero, the result rows can be
	// the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE,
	// COPY, and others. A -1 indicates the value is null.
	ResultRows *int64 `type:"long"`

	// The size in bytes of the returned results. A -1 indicates the value is null.
	ResultSize *int64 `type:"long"`

	// The name or Amazon Resource Name (ARN) of the secret that enables access
	// to the database.
	SecretArn *string `type:"string"`

	// The status of the SQL statement being described. Status values are defined
	// as follows:
	//
	//    * ABORTED - The query run was stopped by the user.
	//
	//    * ALL - A status value that includes all query statuses. This value can
	//    be used to filter results.
	//
	//    * FAILED - The query run failed.
	//
	//    * FINISHED - The query has finished running.
	//
	//    * PICKED - The query has been chosen to be run.
	//
	//    * STARTED - The query run has started.
	//
	//    * SUBMITTED - The query was submitted, but not yet processed.
	Status *string `type:"string" enum:"StatusString"`

	// The SQL statements from a multiple statement run.
	SubStatements []*SubStatementData `type:"list"`

	// The date and time (UTC) that the metadata for the SQL statement was last
	// updated. An example is the time the status last changed.
	UpdatedAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (DescribeStatementOutput) GoString 

func (s DescribeStatementOutput) 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 (*DescribeStatementOutput) SetClusterIdentifier 

func (s *DescribeStatementOutput) SetClusterIdentifier(v string) *DescribeStatementOutput

SetClusterIdentifier sets the ClusterIdentifier field's value.

func (*DescribeStatementOutput) SetCreatedAt 

func (s *DescribeStatementOutput) SetCreatedAt(v time.Time) *DescribeStatementOutput

SetCreatedAt sets the CreatedAt field's value.

func (*DescribeStatementOutput) SetDatabase 

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

SetDatabase sets the Database field's value.

func (*DescribeStatementOutput) SetDbUser 

func (s *DescribeStatementOutput) SetDbUser(v string) *DescribeStatementOutput

SetDbUser sets the DbUser field's value.

func (*DescribeStatementOutput) SetDuration 

func (s *DescribeStatementOutput) SetDuration(v int64) *DescribeStatementOutput

SetDuration sets the Duration field's value.

func (*DescribeStatementOutput) SetError 

func (s *DescribeStatementOutput) SetError(v string) *DescribeStatementOutput

SetError sets the Error field's value.

func (*DescribeStatementOutput) SetHasResultSet added in v1.37.11 

func (s *DescribeStatementOutput) SetHasResultSet(v bool) *DescribeStatementOutput

SetHasResultSet sets the HasResultSet field's value.

func (*DescribeStatementOutput) SetId 

func (s *DescribeStatementOutput) SetId(v string) *DescribeStatementOutput

SetId sets the Id field's value.

func (*DescribeStatementOutput) SetQueryParameters added in v1.38.62 

func (s *DescribeStatementOutput) SetQueryParameters(v []*SqlParameter) *DescribeStatementOutput

SetQueryParameters sets the QueryParameters field's value.

func (*DescribeStatementOutput) SetQueryString 

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

SetQueryString sets the QueryString field's value.

func (*DescribeStatementOutput) SetRedshiftPid 

func (s *DescribeStatementOutput) SetRedshiftPid(v int64) *DescribeStatementOutput

SetRedshiftPid sets the RedshiftPid field's value.

func (*DescribeStatementOutput) SetRedshiftQueryId 

func (s *DescribeStatementOutput) SetRedshiftQueryId(v int64) *DescribeStatementOutput

SetRedshiftQueryId sets the RedshiftQueryId field's value.

func (*DescribeStatementOutput) SetResultRows 

func (s *DescribeStatementOutput) SetResultRows(v int64) *DescribeStatementOutput

SetResultRows sets the ResultRows field's value.

func (*DescribeStatementOutput) SetResultSize 

func (s *DescribeStatementOutput) SetResultSize(v int64) *DescribeStatementOutput

SetResultSize sets the ResultSize field's value.

func (*DescribeStatementOutput) SetSecretArn 

func (s *DescribeStatementOutput) SetSecretArn(v string) *DescribeStatementOutput

SetSecretArn sets the SecretArn field's value.

func (*DescribeStatementOutput) SetStatus 

func (s *DescribeStatementOutput) SetStatus(v string) *DescribeStatementOutput

SetStatus sets the Status field's value.

func (*DescribeStatementOutput) SetSubStatements added in v1.40.9 

func (s *DescribeStatementOutput) SetSubStatements(v []*SubStatementData) *DescribeStatementOutput

SetSubStatements sets the SubStatements field's value.

func (*DescribeStatementOutput) SetUpdatedAt 

func (s *DescribeStatementOutput) SetUpdatedAt(v time.Time) *DescribeStatementOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (DescribeStatementOutput) String 

func (s DescribeStatementOutput) 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 DescribeTableInput 

type DescribeTableInput struct {

	// The cluster identifier. This parameter is required when connecting to a cluster
	// and authenticating using either Secrets Manager or temporary credentials.
	ClusterIdentifier *string `type:"string"`

	// A database name. The connected database is specified when you connect with
	// your authentication credentials.
	ConnectedDatabase *string `type:"string"`

	// The name of the database that contains the tables to be described. If ConnectedDatabase
	// is not specified, this is also the database to connect to with your authentication
	// credentials.
	//
	// Database is a required field
	Database *string `type:"string" required:"true"`

	// The database user name. This parameter is required when connecting to a cluster
	// and authenticating using temporary credentials.
	DbUser *string `type:"string"`

	// The maximum number of tables to return in the response. If more tables exist
	// than fit in one response, then NextToken is returned to page through the
	// results.
	MaxResults *int64 `type:"integer"`

	// A value that indicates the starting point for the next set of response records
	// in a subsequent request. If a value is returned in a response, you can retrieve
	// the next set of records by providing this returned NextToken value in the
	// next NextToken parameter and retrying the command. If the NextToken field
	// is empty, all response records have been retrieved for the request.
	NextToken *string `type:"string"`

	// The schema that contains the table. If no schema is specified, then matching
	// tables for all schemas are returned.
	Schema *string `type:"string"`

	// The name or ARN of the secret that enables access to the database. This parameter
	// is required when authenticating using Secrets Manager.
	SecretArn *string `type:"string"`

	// The table name. If no table is specified, then all tables for all matching
	// schemas are returned. If no table and no schema is specified, then all tables
	// for all schemas in the database are returned
	Table *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeTableInput) GoString 

func (s DescribeTableInput) 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 (*DescribeTableInput) SetClusterIdentifier 

func (s *DescribeTableInput) SetClusterIdentifier(v string) *DescribeTableInput

SetClusterIdentifier sets the ClusterIdentifier field's value.

func (*DescribeTableInput) SetConnectedDatabase added in v1.37.17 

func (s *DescribeTableInput) SetConnectedDatabase(v string) *DescribeTableInput

SetConnectedDatabase sets the ConnectedDatabase field's value.

func (*DescribeTableInput) SetDatabase 

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

SetDatabase sets the Database field's value.

func (*DescribeTableInput) SetDbUser 

func (s *DescribeTableInput) SetDbUser(v string) *DescribeTableInput

SetDbUser sets the DbUser field's value.

func (*DescribeTableInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*DescribeTableInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*DescribeTableInput) SetSchema 

func (s *DescribeTableInput) SetSchema(v string) *DescribeTableInput

SetSchema sets the Schema field's value.

func (*DescribeTableInput) SetSecretArn 

func (s *DescribeTableInput) SetSecretArn(v string) *DescribeTableInput

SetSecretArn sets the SecretArn field's value.

func (*DescribeTableInput) SetTable 

func (s *DescribeTableInput) SetTable(v string) *DescribeTableInput

SetTable sets the Table field's value.

func (DescribeTableInput) String 

func (s DescribeTableInput) 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 (*DescribeTableInput) Validate 

func (s *DescribeTableInput) Validate() error

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

type DescribeTableOutput 

type DescribeTableOutput struct {

	// A list of columns in the table.
	ColumnList []*ColumnMetadata `type:"list"`

	// A value that indicates the starting point for the next set of response records
	// in a subsequent request. If a value is returned in a response, you can retrieve
	// the next set of records by providing this returned NextToken value in the
	// next NextToken parameter and retrying the command. If the NextToken field
	// is empty, all response records have been retrieved for the request.
	NextToken *string `type:"string"`

	// The table name.
	TableName *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeTableOutput) GoString 

func (s DescribeTableOutput) 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 (*DescribeTableOutput) SetColumnList 

func (s *DescribeTableOutput) SetColumnList(v []*ColumnMetadata) *DescribeTableOutput

SetColumnList sets the ColumnList field's value.

func (*DescribeTableOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*DescribeTableOutput) SetTableName 

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

SetTableName sets the TableName field's value.

func (DescribeTableOutput) String 

func (s DescribeTableOutput) 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 ExecuteStatementException 

type ExecuteStatementException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The exception message.
	Message_ *string `locationName:"Message" type:"string"`

	// Statement identifier of the exception.
	//
	// StatementId is a required field
	StatementId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The SQL statement encountered an environmental error while running.

func (*ExecuteStatementException) Code 

func (s *ExecuteStatementException) Code() string

Code returns the exception type name.

func (*ExecuteStatementException) Error 

func (s *ExecuteStatementException) Error() string

func (ExecuteStatementException) GoString 

func (s ExecuteStatementException) 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 (*ExecuteStatementException) Message 

func (s *ExecuteStatementException) Message() string

Message returns the exception's message.

func (*ExecuteStatementException) OrigErr 

func (s *ExecuteStatementException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ExecuteStatementException) RequestID 

func (s *ExecuteStatementException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ExecuteStatementException) StatusCode 

func (s *ExecuteStatementException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ExecuteStatementException) String 

func (s ExecuteStatementException) 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 ExecuteStatementInput 

type ExecuteStatementInput struct {

	// The cluster identifier. This parameter is required when connecting to a cluster
	// and authenticating using either Secrets Manager or temporary credentials.
	ClusterIdentifier *string `type:"string"`

	// The name of the database. This parameter is required when authenticating
	// using either Secrets Manager or temporary credentials.
	//
	// Database is a required field
	Database *string `type:"string" required:"true"`

	// The database user name. This parameter is required when connecting to a cluster
	// and authenticating using temporary credentials.
	DbUser *string `type:"string"`

	// The parameters for the SQL statement.
	Parameters []*SqlParameter `min:"1" type:"list"`

	// The name or ARN of the secret that enables access to the database. This parameter
	// is required when authenticating using Secrets Manager.
	SecretArn *string `type:"string"`

	// The SQL statement text to run.
	//
	// Sql is a required field
	Sql *string `type:"string" required:"true"`

	// The name of the SQL statement. You can name the SQL statement when you create
	// it to identify the query.
	StatementName *string `type:"string"`

	// A value that indicates whether to send an event to the Amazon EventBridge
	// event bus after the SQL statement runs.
	WithEvent *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (ExecuteStatementInput) GoString 

func (s ExecuteStatementInput) 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 (*ExecuteStatementInput) SetClusterIdentifier 

func (s *ExecuteStatementInput) SetClusterIdentifier(v string) *ExecuteStatementInput

SetClusterIdentifier sets the ClusterIdentifier field's value.

func (*ExecuteStatementInput) SetDatabase 

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

SetDatabase sets the Database field's value.

func (*ExecuteStatementInput) SetDbUser 

func (s *ExecuteStatementInput) SetDbUser(v string) *ExecuteStatementInput

SetDbUser sets the DbUser field's value.

func (*ExecuteStatementInput) SetParameters added in v1.38.62 

func (s *ExecuteStatementInput) SetParameters(v []*SqlParameter) *ExecuteStatementInput

SetParameters sets the Parameters field's value.

func (*ExecuteStatementInput) SetSecretArn 

func (s *ExecuteStatementInput) SetSecretArn(v string) *ExecuteStatementInput

SetSecretArn sets the SecretArn field's value.

func (*ExecuteStatementInput) SetSql 

func (s *ExecuteStatementInput) SetSql(v string) *ExecuteStatementInput

SetSql sets the Sql field's value.

func (*ExecuteStatementInput) SetStatementName 

func (s *ExecuteStatementInput) SetStatementName(v string) *ExecuteStatementInput

SetStatementName sets the StatementName field's value.

func (*ExecuteStatementInput) SetWithEvent 

func (s *ExecuteStatementInput) SetWithEvent(v bool) *ExecuteStatementInput

SetWithEvent sets the WithEvent field's value.

func (ExecuteStatementInput) String 

func (s ExecuteStatementInput) 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 (*ExecuteStatementInput) Validate 

func (s *ExecuteStatementInput) Validate() error

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

type ExecuteStatementOutput 

type ExecuteStatementOutput struct {

	// The cluster identifier. This parameter is not returned when connecting to
	// a serverless endpoint.
	ClusterIdentifier *string `type:"string"`

	// The date and time (UTC) the statement was created.
	CreatedAt *time.Time `type:"timestamp"`

	// The name of the database.
	Database *string `type:"string"`

	// The database user name.
	DbUser *string `type:"string"`

	// The identifier of the SQL statement whose results are to be fetched. This
	// value is a universally unique identifier (UUID) generated by Amazon Redshift
	// Data API.
	Id *string `type:"string"`

	// The name or ARN of the secret that enables access to the database.
	SecretArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (ExecuteStatementOutput) GoString 

func (s ExecuteStatementOutput) 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 (*ExecuteStatementOutput) SetClusterIdentifier 

func (s *ExecuteStatementOutput) SetClusterIdentifier(v string) *ExecuteStatementOutput

SetClusterIdentifier sets the ClusterIdentifier field's value.

func (*ExecuteStatementOutput) SetCreatedAt 

func (s *ExecuteStatementOutput) SetCreatedAt(v time.Time) *ExecuteStatementOutput

SetCreatedAt sets the CreatedAt field's value.

func (*ExecuteStatementOutput) SetDatabase 

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

SetDatabase sets the Database field's value.

func (*ExecuteStatementOutput) SetDbUser 

func (s *ExecuteStatementOutput) SetDbUser(v string) *ExecuteStatementOutput

SetDbUser sets the DbUser field's value.

func (*ExecuteStatementOutput) SetId 

func (s *ExecuteStatementOutput) SetId(v string) *ExecuteStatementOutput

SetId sets the Id field's value.

func (*ExecuteStatementOutput) SetSecretArn 

func (s *ExecuteStatementOutput) SetSecretArn(v string) *ExecuteStatementOutput

SetSecretArn sets the SecretArn field's value.

func (ExecuteStatementOutput) String 

func (s ExecuteStatementOutput) 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 Field 

type Field struct {

	// A value of the BLOB data type.
	// BlobValue is automatically base64 encoded/decoded by the SDK.
	BlobValue []byte `locationName:"blobValue" type:"blob"`

	// A value of the Boolean data type.
	BooleanValue *bool `locationName:"booleanValue" type:"boolean"`

	// A value of the double data type.
	DoubleValue *float64 `locationName:"doubleValue" type:"double"`

	// A value that indicates whether the data is NULL.
	IsNull *bool `locationName:"isNull" type:"boolean"`

	// A value of the long data type.
	LongValue *int64 `locationName:"longValue" type:"long"`

	// A value of the string data type.
	StringValue *string `locationName:"stringValue" type:"string"`
	// contains filtered or unexported fields
}

A data value in a column.

func (Field) GoString 

func (s Field) 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 (*Field) SetBlobValue 

func (s *Field) SetBlobValue(v []byte) *Field

SetBlobValue sets the BlobValue field's value.

func (*Field) SetBooleanValue 

func (s *Field) SetBooleanValue(v bool) *Field

SetBooleanValue sets the BooleanValue field's value.

func (*Field) SetDoubleValue 

func (s *Field) SetDoubleValue(v float64) *Field

SetDoubleValue sets the DoubleValue field's value.

func (*Field) SetIsNull 

func (s *Field) SetIsNull(v bool) *Field

SetIsNull sets the IsNull field's value.

func (*Field) SetLongValue 

func (s *Field) SetLongValue(v int64) *Field

SetLongValue sets the LongValue field's value.

func (*Field) SetStringValue 

func (s *Field) SetStringValue(v string) *Field

SetStringValue sets the StringValue field's value.

func (Field) String 

func (s Field) 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 GetStatementResultInput 

type GetStatementResultInput struct {

	// The identifier of the SQL statement whose results are to be fetched. This
	// value is a universally unique identifier (UUID) generated by Amazon Redshift
	// Data API. A suffix indicates then number of the SQL statement. For example,
	// d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates
	// the second SQL statement of a batch query. This identifier is returned by
	// BatchExecuteStatment, ExecuteStatment, and ListStatements.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// A value that indicates the starting point for the next set of response records
	// in a subsequent request. If a value is returned in a response, you can retrieve
	// the next set of records by providing this returned NextToken value in the
	// next NextToken parameter and retrying the command. If the NextToken field
	// is empty, all response records have been retrieved for the request.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetStatementResultInput) GoString 

func (s GetStatementResultInput) 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 (*GetStatementResultInput) SetId 

func (s *GetStatementResultInput) SetId(v string) *GetStatementResultInput

SetId sets the Id field's value.

func (*GetStatementResultInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (GetStatementResultInput) String 

func (s GetStatementResultInput) 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 (*GetStatementResultInput) Validate 

func (s *GetStatementResultInput) Validate() error

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

type GetStatementResultOutput 

type GetStatementResultOutput struct {

	// The properties (metadata) of a column.
	ColumnMetadata []*ColumnMetadata `type:"list"`

	// A value that indicates the starting point for the next set of response records
	// in a subsequent request. If a value is returned in a response, you can retrieve
	// the next set of records by providing this returned NextToken value in the
	// next NextToken parameter and retrying the command. If the NextToken field
	// is empty, all response records have been retrieved for the request.
	NextToken *string `type:"string"`

	// The results of the SQL statement.
	//
	// Records is a required field
	Records [][]*Field `type:"list" required:"true"`

	// The total number of rows in the result set returned from a query. You can
	// use this number to estimate the number of calls to the GetStatementResult
	// operation needed to page through the results.
	TotalNumRows *int64 `type:"long"`
	// contains filtered or unexported fields
}

func (GetStatementResultOutput) GoString 

func (s GetStatementResultOutput) 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 (*GetStatementResultOutput) SetColumnMetadata 

func (s *GetStatementResultOutput) SetColumnMetadata(v []*ColumnMetadata) *GetStatementResultOutput

SetColumnMetadata sets the ColumnMetadata field's value.

func (*GetStatementResultOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*GetStatementResultOutput) SetRecords 

func (s *GetStatementResultOutput) SetRecords(v [][]*Field) *GetStatementResultOutput

SetRecords sets the Records field's value.

func (*GetStatementResultOutput) SetTotalNumRows 

func (s *GetStatementResultOutput) SetTotalNumRows(v int64) *GetStatementResultOutput

SetTotalNumRows sets the TotalNumRows field's value.

func (GetStatementResultOutput) String 

func (s GetStatementResultOutput) 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 

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The exception message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The Amazon Redshift Data API operation failed due to invalid input.

func (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

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 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String 

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 ListDatabasesInput 

type ListDatabasesInput struct {

	// The cluster identifier. This parameter is required when connecting to a cluster
	// and authenticating using either Secrets Manager or temporary credentials.
	ClusterIdentifier *string `type:"string"`

	// The name of the database. This parameter is required when authenticating
	// using either Secrets Manager or temporary credentials.
	//
	// Database is a required field
	Database *string `type:"string" required:"true"`

	// The database user name. This parameter is required when connecting to a cluster
	// and authenticating using temporary credentials.
	DbUser *string `type:"string"`

	// The maximum number of databases to return in the response. If more databases
	// exist than fit in one response, then NextToken is returned to page through
	// the results.
	MaxResults *int64 `type:"integer"`

	// A value that indicates the starting point for the next set of response records
	// in a subsequent request. If a value is returned in a response, you can retrieve
	// the next set of records by providing this returned NextToken value in the
	// next NextToken parameter and retrying the command. If the NextToken field
	// is empty, all response records have been retrieved for the request.
	NextToken *string `type:"string"`

	// The name or ARN of the secret that enables access to the database. This parameter
	// is required when authenticating using Secrets Manager.
	SecretArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListDatabasesInput) GoString 

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

func (s *ListDatabasesInput) SetClusterIdentifier(v string) *ListDatabasesInput

SetClusterIdentifier sets the ClusterIdentifier field's value.

func (*ListDatabasesInput) SetDatabase 

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

SetDatabase sets the Database field's value.

func (*ListDatabasesInput) SetDbUser 

func (s *ListDatabasesInput) SetDbUser(v string) *ListDatabasesInput

SetDbUser sets the DbUser field's value.

func (*ListDatabasesInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListDatabasesInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListDatabasesInput) SetSecretArn 

func (s *ListDatabasesInput) SetSecretArn(v string) *ListDatabasesInput

SetSecretArn sets the SecretArn field's value.

func (ListDatabasesInput) String 

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 

func (s *ListDatabasesInput) Validate() error

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

type ListDatabasesOutput 

type ListDatabasesOutput struct {

	// The names of databases.
	Databases []*string `type:"list"`

	// A value that indicates the starting point for the next set of response records
	// in a subsequent request. If a value is returned in a response, you can retrieve
	// the next set of records by providing this returned NextToken value in the
	// next NextToken parameter and retrying the command. If the NextToken field
	// is empty, all response records have been retrieved for the request.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListDatabasesOutput) GoString 

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

func (s *ListDatabasesOutput) SetDatabases(v []*string) *ListDatabasesOutput

SetDatabases sets the Databases field's value.

func (*ListDatabasesOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListDatabasesOutput) String 

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 ListSchemasInput 

type ListSchemasInput struct {

	// The cluster identifier. This parameter is required when connecting to a cluster
	// and authenticating using either Secrets Manager or temporary credentials.
	ClusterIdentifier *string `type:"string"`

	// A database name. The connected database is specified when you connect with
	// your authentication credentials.
	ConnectedDatabase *string `type:"string"`

	// The name of the database that contains the schemas to list. If ConnectedDatabase
	// is not specified, this is also the database to connect to with your authentication
	// credentials.
	//
	// Database is a required field
	Database *string `type:"string" required:"true"`

	// The database user name. This parameter is required when connecting to a cluster
	// and authenticating using temporary credentials.
	DbUser *string `type:"string"`

	// The maximum number of schemas to return in the response. If more schemas
	// exist than fit in one response, then NextToken is returned to page through
	// the results.
	MaxResults *int64 `type:"integer"`

	// A value that indicates the starting point for the next set of response records
	// in a subsequent request. If a value is returned in a response, you can retrieve
	// the next set of records by providing this returned NextToken value in the
	// next NextToken parameter and retrying the command. If the NextToken field
	// is empty, all response records have been retrieved for the request.
	NextToken *string `type:"string"`

	// A pattern to filter results by schema name. Within a schema pattern, "%"
	// means match any substring of 0 or more characters and "_" means match any
	// one character. Only schema name entries matching the search pattern are returned.
	SchemaPattern *string `type:"string"`

	// The name or ARN of the secret that enables access to the database. This parameter
	// is required when authenticating using Secrets Manager.
	SecretArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListSchemasInput) GoString 

func (s ListSchemasInput) 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 (*ListSchemasInput) SetClusterIdentifier 

func (s *ListSchemasInput) SetClusterIdentifier(v string) *ListSchemasInput

SetClusterIdentifier sets the ClusterIdentifier field's value.

func (*ListSchemasInput) SetConnectedDatabase added in v1.37.17 

func (s *ListSchemasInput) SetConnectedDatabase(v string) *ListSchemasInput

SetConnectedDatabase sets the ConnectedDatabase field's value.

func (*ListSchemasInput) SetDatabase 

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

SetDatabase sets the Database field's value.

func (*ListSchemasInput) SetDbUser 

func (s *ListSchemasInput) SetDbUser(v string) *ListSchemasInput

SetDbUser sets the DbUser field's value.

func (*ListSchemasInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListSchemasInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListSchemasInput) SetSchemaPattern 

func (s *ListSchemasInput) SetSchemaPattern(v string) *ListSchemasInput

SetSchemaPattern sets the SchemaPattern field's value.

func (*ListSchemasInput) SetSecretArn 

func (s *ListSchemasInput) SetSecretArn(v string) *ListSchemasInput

SetSecretArn sets the SecretArn field's value.

func (ListSchemasInput) String 

func (s ListSchemasInput) 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 (*ListSchemasInput) Validate 

func (s *ListSchemasInput) Validate() error

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

type ListSchemasOutput 

type ListSchemasOutput struct {

	// A value that indicates the starting point for the next set of response records
	// in a subsequent request. If a value is returned in a response, you can retrieve
	// the next set of records by providing this returned NextToken value in the
	// next NextToken parameter and retrying the command. If the NextToken field
	// is empty, all response records have been retrieved for the request.
	NextToken *string `type:"string"`

	// The schemas that match the request pattern.
	Schemas []*string `type:"list"`
	// contains filtered or unexported fields
}

func (ListSchemasOutput) GoString 

func (s ListSchemasOutput) 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 (*ListSchemasOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListSchemasOutput) SetSchemas 

func (s *ListSchemasOutput) SetSchemas(v []*string) *ListSchemasOutput

SetSchemas sets the Schemas field's value.

func (ListSchemasOutput) String 

func (s ListSchemasOutput) 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 ListStatementsInput 

type ListStatementsInput struct {

	// The maximum number of SQL statements to return in the response. If more SQL
	// statements exist than fit in one response, then NextToken is returned to
	// page through the results.
	MaxResults *int64 `type:"integer"`

	// A value that indicates the starting point for the next set of response records
	// in a subsequent request. If a value is returned in a response, you can retrieve
	// the next set of records by providing this returned NextToken value in the
	// next NextToken parameter and retrying the command. If the NextToken field
	// is empty, all response records have been retrieved for the request.
	NextToken *string `type:"string"`

	// A value that filters which statements to return in the response. If true,
	// all statements run by the caller's IAM role are returned. If false, only
	// statements run by the caller's IAM role in the current IAM session are returned.
	// The default is true.
	RoleLevel *bool `type:"boolean"`

	// The name of the SQL statement specified as input to BatchExecuteStatement
	// or ExecuteStatement to identify the query. You can list multiple statements
	// by providing a prefix that matches the beginning of the statement name. For
	// example, to list myStatement1, myStatement2, myStatement3, and so on, then
	// provide the a value of myStatement. Data API does a case-sensitive match
	// of SQL statement names to the prefix value you provide.
	StatementName *string `type:"string"`

	// The status of the SQL statement to list. Status values are defined as follows:
	//
	//    * ABORTED - The query run was stopped by the user.
	//
	//    * ALL - A status value that includes all query statuses. This value can
	//    be used to filter results.
	//
	//    * FAILED - The query run failed.
	//
	//    * FINISHED - The query has finished running.
	//
	//    * PICKED - The query has been chosen to be run.
	//
	//    * STARTED - The query run has started.
	//
	//    * SUBMITTED - The query was submitted, but not yet processed.
	Status *string `type:"string" enum:"StatusString"`
	// contains filtered or unexported fields
}

func (ListStatementsInput) GoString 

func (s ListStatementsInput) 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 (*ListStatementsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListStatementsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListStatementsInput) SetRoleLevel added in v1.37.11 

func (s *ListStatementsInput) SetRoleLevel(v bool) *ListStatementsInput

SetRoleLevel sets the RoleLevel field's value.

func (*ListStatementsInput) SetStatementName 

func (s *ListStatementsInput) SetStatementName(v string) *ListStatementsInput

SetStatementName sets the StatementName field's value.

func (*ListStatementsInput) SetStatus 

func (s *ListStatementsInput) SetStatus(v string) *ListStatementsInput

SetStatus sets the Status field's value.

func (ListStatementsInput) String 

func (s ListStatementsInput) 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 ListStatementsOutput 

type ListStatementsOutput struct {

	// A value that indicates the starting point for the next set of response records
	// in a subsequent request. If a value is returned in a response, you can retrieve
	// the next set of records by providing this returned NextToken value in the
	// next NextToken parameter and retrying the command. If the NextToken field
	// is empty, all response records have been retrieved for the request.
	NextToken *string `type:"string"`

	// The SQL statements.
	//
	// Statements is a required field
	Statements []*StatementData `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListStatementsOutput) GoString 

func (s ListStatementsOutput) 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 (*ListStatementsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListStatementsOutput) SetStatements 

func (s *ListStatementsOutput) SetStatements(v []*StatementData) *ListStatementsOutput

SetStatements sets the Statements field's value.

func (ListStatementsOutput) String 

func (s ListStatementsOutput) 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 ListTablesInput 

type ListTablesInput struct {

	// The cluster identifier. This parameter is required when connecting to a cluster
	// and authenticating using either Secrets Manager or temporary credentials.
	ClusterIdentifier *string `type:"string"`

	// A database name. The connected database is specified when you connect with
	// your authentication credentials.
	ConnectedDatabase *string `type:"string"`

	// The name of the database that contains the tables to list. If ConnectedDatabase
	// is not specified, this is also the database to connect to with your authentication
	// credentials.
	//
	// Database is a required field
	Database *string `type:"string" required:"true"`

	// The database user name. This parameter is required when connecting to a cluster
	// and authenticating using temporary credentials.
	DbUser *string `type:"string"`

	// The maximum number of tables to return in the response. If more tables exist
	// than fit in one response, then NextToken is returned to page through the
	// results.
	MaxResults *int64 `type:"integer"`

	// A value that indicates the starting point for the next set of response records
	// in a subsequent request. If a value is returned in a response, you can retrieve
	// the next set of records by providing this returned NextToken value in the
	// next NextToken parameter and retrying the command. If the NextToken field
	// is empty, all response records have been retrieved for the request.
	NextToken *string `type:"string"`

	// A pattern to filter results by schema name. Within a schema pattern, "%"
	// means match any substring of 0 or more characters and "_" means match any
	// one character. Only schema name entries matching the search pattern are returned.
	// If SchemaPattern is not specified, then all tables that match TablePattern
	// are returned. If neither SchemaPattern or TablePattern are specified, then
	// all tables are returned.
	SchemaPattern *string `type:"string"`

	// The name or ARN of the secret that enables access to the database. This parameter
	// is required when authenticating using Secrets Manager.
	SecretArn *string `type:"string"`

	// A pattern to filter results by table name. Within a table pattern, "%" means
	// match any substring of 0 or more characters and "_" means match any one character.
	// Only table name entries matching the search pattern are returned. If TablePattern
	// is not specified, then all tables that match SchemaPatternare returned. If
	// neither SchemaPattern or TablePattern are specified, then all tables are
	// returned.
	TablePattern *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListTablesInput) GoString 

func (s ListTablesInput) 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 (*ListTablesInput) SetClusterIdentifier 

func (s *ListTablesInput) SetClusterIdentifier(v string) *ListTablesInput

SetClusterIdentifier sets the ClusterIdentifier field's value.

func (*ListTablesInput) SetConnectedDatabase added in v1.37.17 

func (s *ListTablesInput) SetConnectedDatabase(v string) *ListTablesInput

SetConnectedDatabase sets the ConnectedDatabase field's value.

func (*ListTablesInput) SetDatabase 

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

SetDatabase sets the Database field's value.

func (*ListTablesInput) SetDbUser 

func (s *ListTablesInput) SetDbUser(v string) *ListTablesInput

SetDbUser sets the DbUser field's value.

func (*ListTablesInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListTablesInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListTablesInput) SetSchemaPattern 

func (s *ListTablesInput) SetSchemaPattern(v string) *ListTablesInput

SetSchemaPattern sets the SchemaPattern field's value.

func (*ListTablesInput) SetSecretArn 

func (s *ListTablesInput) SetSecretArn(v string) *ListTablesInput

SetSecretArn sets the SecretArn field's value.

func (*ListTablesInput) SetTablePattern 

func (s *ListTablesInput) SetTablePattern(v string) *ListTablesInput

SetTablePattern sets the TablePattern field's value.

func (ListTablesInput) String 

func (s ListTablesInput) 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 (*ListTablesInput) Validate 

func (s *ListTablesInput) Validate() error

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

type ListTablesOutput 

type ListTablesOutput struct {

	// A value that indicates the starting point for the next set of response records
	// in a subsequent request. If a value is returned in a response, you can retrieve
	// the next set of records by providing this returned NextToken value in the
	// next NextToken parameter and retrying the command. If the NextToken field
	// is empty, all response records have been retrieved for the request.
	NextToken *string `type:"string"`

	// The tables that match the request pattern.
	Tables []*TableMember `type:"list"`
	// contains filtered or unexported fields
}

func (ListTablesOutput) GoString 

func (s ListTablesOutput) 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 (*ListTablesOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListTablesOutput) SetTables 

func (s *ListTablesOutput) SetTables(v []*TableMember) *ListTablesOutput

SetTables sets the Tables field's value.

func (ListTablesOutput) String 

func (s ListTablesOutput) 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 RedshiftDataAPIService 

type RedshiftDataAPIService struct {
	*client.Client
}

RedshiftDataAPIService provides the API operation methods for making requests to Redshift Data API Service. See this package's package overview docs for details on the service.

RedshiftDataAPIService 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) *RedshiftDataAPIService

New creates a new instance of the RedshiftDataAPIService 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 RedshiftDataAPIService client from just a session.
svc := redshiftdataapiservice.New(mySession)

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

func (*RedshiftDataAPIService) BatchExecuteStatement added in v1.40.9 

func (c *RedshiftDataAPIService) BatchExecuteStatement(input *BatchExecuteStatementInput) (*BatchExecuteStatementOutput, error)

BatchExecuteStatement API operation for Redshift Data API Service.

Runs one or more SQL statements, which can be data manipulation language (DML) or data definition language (DDL). Depending on the authorization method, use one of the following combinations of request parameters:

  • Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name.

  • Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required. When connecting to a serverless endpoint, specify the database 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 Redshift Data API Service's API operation BatchExecuteStatement for usage and error information.

Returned Error Types:

  • ValidationException The Amazon Redshift Data API operation failed due to invalid input.

  • ActiveStatementsExceededException The number of active statements exceeds the limit.

  • BatchExecuteStatementException An SQL statement encountered an environmental error while running.

See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/BatchExecuteStatement

func (*RedshiftDataAPIService) BatchExecuteStatementRequest added in v1.40.9 

func (c *RedshiftDataAPIService) BatchExecuteStatementRequest(input *BatchExecuteStatementInput) (req *request.Request, output *BatchExecuteStatementOutput)

BatchExecuteStatementRequest generates a "aws/request.Request" representing the client's request for the BatchExecuteStatement 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 BatchExecuteStatement for more information on using the BatchExecuteStatement 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 BatchExecuteStatementRequest method.
req, resp := client.BatchExecuteStatementRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/BatchExecuteStatement

func (*RedshiftDataAPIService) BatchExecuteStatementWithContext added in v1.40.9 

func (c *RedshiftDataAPIService) BatchExecuteStatementWithContext(ctx aws.Context, input *BatchExecuteStatementInput, opts ...request.Option) (*BatchExecuteStatementOutput, error)

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

See BatchExecuteStatement 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 (*RedshiftDataAPIService) CancelStatement 

func (c *RedshiftDataAPIService) CancelStatement(input *CancelStatementInput) (*CancelStatementOutput, error)

CancelStatement API operation for Redshift Data API Service.

Cancels a running query. To be canceled, a query must be 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 Redshift Data API Service's API operation CancelStatement for usage and error information.

Returned Error Types:

  • ValidationException The Amazon Redshift Data API operation failed due to invalid input.

  • ResourceNotFoundException The Amazon Redshift Data API operation failed due to a missing resource.

  • InternalServerException The Amazon Redshift Data API operation failed due to invalid input.

  • DatabaseConnectionException Connection to a database failed.

See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/CancelStatement

func (*RedshiftDataAPIService) CancelStatementRequest 

func (c *RedshiftDataAPIService) CancelStatementRequest(input *CancelStatementInput) (req *request.Request, output *CancelStatementOutput)

CancelStatementRequest generates a "aws/request.Request" representing the client's request for the CancelStatement 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 CancelStatement for more information on using the CancelStatement 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 CancelStatementRequest method.
req, resp := client.CancelStatementRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/CancelStatement

func (*RedshiftDataAPIService) CancelStatementWithContext 

func (c *RedshiftDataAPIService) CancelStatementWithContext(ctx aws.Context, input *CancelStatementInput, opts ...request.Option) (*CancelStatementOutput, error)

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

See CancelStatement 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 (*RedshiftDataAPIService) DescribeStatement 

func (c *RedshiftDataAPIService) DescribeStatement(input *DescribeStatementInput) (*DescribeStatementOutput, error)

DescribeStatement API operation for Redshift Data API Service.

Describes the details about a specific instance when a query was run by the Amazon Redshift Data API. The information includes when the query started, when it finished, the query status, the number of rows returned, and the SQL 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 Redshift Data API Service's API operation DescribeStatement for usage and error information.

Returned Error Types:

  • ValidationException The Amazon Redshift Data API operation failed due to invalid input.

  • ResourceNotFoundException The Amazon Redshift Data API operation failed due to a missing resource.

  • InternalServerException The Amazon Redshift Data API operation failed due to invalid input.

See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/DescribeStatement

func (*RedshiftDataAPIService) DescribeStatementRequest 

func (c *RedshiftDataAPIService) DescribeStatementRequest(input *DescribeStatementInput) (req *request.Request, output *DescribeStatementOutput)

DescribeStatementRequest generates a "aws/request.Request" representing the client's request for the DescribeStatement 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 DescribeStatement for more information on using the DescribeStatement 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 DescribeStatementRequest method.
req, resp := client.DescribeStatementRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/DescribeStatement

func (*RedshiftDataAPIService) DescribeStatementWithContext 

func (c *RedshiftDataAPIService) DescribeStatementWithContext(ctx aws.Context, input *DescribeStatementInput, opts ...request.Option) (*DescribeStatementOutput, error)

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

See DescribeStatement 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 (*RedshiftDataAPIService) DescribeTable 

func (c *RedshiftDataAPIService) DescribeTable(input *DescribeTableInput) (*DescribeTableOutput, error)

DescribeTable API operation for Redshift Data API Service.

Describes the detailed information about a table from metadata in the cluster. The information includes its columns. A token is returned to page through the column list. Depending on the authorization method, use one of the following combinations of request parameters:

  • Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name.

  • Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required. When connecting to a serverless endpoint, specify the database 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 Redshift Data API Service's API operation DescribeTable for usage and error information.

Returned Error Types:

  • ValidationException The Amazon Redshift Data API operation failed due to invalid input.

  • InternalServerException The Amazon Redshift Data API operation failed due to invalid input.

  • DatabaseConnectionException Connection to a database failed.

See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/DescribeTable

func (*RedshiftDataAPIService) DescribeTablePages 

func (c *RedshiftDataAPIService) DescribeTablePages(input *DescribeTableInput, fn func(*DescribeTableOutput, bool) bool) error

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

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

func (*RedshiftDataAPIService) DescribeTablePagesWithContext 

func (c *RedshiftDataAPIService) DescribeTablePagesWithContext(ctx aws.Context, input *DescribeTableInput, fn func(*DescribeTableOutput, bool) bool, opts ...request.Option) error

DescribeTablePagesWithContext same as DescribeTablePages 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 (*RedshiftDataAPIService) DescribeTableRequest 

func (c *RedshiftDataAPIService) DescribeTableRequest(input *DescribeTableInput) (req *request.Request, output *DescribeTableOutput)

DescribeTableRequest generates a "aws/request.Request" representing the client's request for the DescribeTable 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 DescribeTable for more information on using the DescribeTable 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 DescribeTableRequest method.
req, resp := client.DescribeTableRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/DescribeTable

func (*RedshiftDataAPIService) DescribeTableWithContext 

func (c *RedshiftDataAPIService) DescribeTableWithContext(ctx aws.Context, input *DescribeTableInput, opts ...request.Option) (*DescribeTableOutput, error)

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

See DescribeTable 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 (*RedshiftDataAPIService) ExecuteStatement 

func (c *RedshiftDataAPIService) ExecuteStatement(input *ExecuteStatementInput) (*ExecuteStatementOutput, error)

ExecuteStatement API operation for Redshift Data API Service.

Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL). This statement must be a single SQL statement. Depending on the authorization method, use one of the following combinations of request parameters:

  • Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name.

  • Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required. When connecting to a serverless endpoint, specify the database 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 Redshift Data API Service's API operation ExecuteStatement for usage and error information.

Returned Error Types:

  • ValidationException The Amazon Redshift Data API operation failed due to invalid input.

  • ExecuteStatementException The SQL statement encountered an environmental error while running.

  • ActiveStatementsExceededException The number of active statements exceeds the limit.

See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ExecuteStatement

func (*RedshiftDataAPIService) ExecuteStatementRequest 

func (c *RedshiftDataAPIService) ExecuteStatementRequest(input *ExecuteStatementInput) (req *request.Request, output *ExecuteStatementOutput)

ExecuteStatementRequest generates a "aws/request.Request" representing the client's request for the ExecuteStatement 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 ExecuteStatement for more information on using the ExecuteStatement 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 ExecuteStatementRequest method.
req, resp := client.ExecuteStatementRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ExecuteStatement

func (*RedshiftDataAPIService) ExecuteStatementWithContext 

func (c *RedshiftDataAPIService) ExecuteStatementWithContext(ctx aws.Context, input *ExecuteStatementInput, opts ...request.Option) (*ExecuteStatementOutput, error)

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

See ExecuteStatement 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 (*RedshiftDataAPIService) GetStatementResult 

func (c *RedshiftDataAPIService) GetStatementResult(input *GetStatementResultInput) (*GetStatementResultOutput, error)

GetStatementResult API operation for Redshift Data API Service.

Fetches the temporarily cached result of an SQL statement. A token is returned to page through the statement results.

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 Redshift Data API Service's API operation GetStatementResult for usage and error information.

Returned Error Types:

  • ValidationException The Amazon Redshift Data API operation failed due to invalid input.

  • ResourceNotFoundException The Amazon Redshift Data API operation failed due to a missing resource.

  • InternalServerException The Amazon Redshift Data API operation failed due to invalid input.

See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/GetStatementResult

func (*RedshiftDataAPIService) GetStatementResultPages 

func (c *RedshiftDataAPIService) GetStatementResultPages(input *GetStatementResultInput, fn func(*GetStatementResultOutput, bool) bool) error

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

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

func (*RedshiftDataAPIService) GetStatementResultPagesWithContext 

func (c *RedshiftDataAPIService) GetStatementResultPagesWithContext(ctx aws.Context, input *GetStatementResultInput, fn func(*GetStatementResultOutput, bool) bool, opts ...request.Option) error

GetStatementResultPagesWithContext same as GetStatementResultPages 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 (*RedshiftDataAPIService) GetStatementResultRequest 

func (c *RedshiftDataAPIService) GetStatementResultRequest(input *GetStatementResultInput) (req *request.Request, output *GetStatementResultOutput)

GetStatementResultRequest generates a "aws/request.Request" representing the client's request for the GetStatementResult 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 GetStatementResult for more information on using the GetStatementResult 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 GetStatementResultRequest method.
req, resp := client.GetStatementResultRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/GetStatementResult

func (*RedshiftDataAPIService) GetStatementResultWithContext 

func (c *RedshiftDataAPIService) GetStatementResultWithContext(ctx aws.Context, input *GetStatementResultInput, opts ...request.Option) (*GetStatementResultOutput, error)

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

See GetStatementResult 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 (*RedshiftDataAPIService) ListDatabases 

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

ListDatabases API operation for Redshift Data API Service.

List the databases in a cluster. A token is returned to page through the database list. Depending on the authorization method, use one of the following combinations of request parameters:

  • Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name.

  • Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required. When connecting to a serverless endpoint, specify the database 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 Redshift Data API Service's API operation ListDatabases for usage and error information.

Returned Error Types:

  • ValidationException The Amazon Redshift Data API operation failed due to invalid input.

  • InternalServerException The Amazon Redshift Data API operation failed due to invalid input.

  • DatabaseConnectionException Connection to a database failed.

See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListDatabases

func (*RedshiftDataAPIService) ListDatabasesPages 

func (c *RedshiftDataAPIService) 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 *redshiftdataapiservice.ListDatabasesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*RedshiftDataAPIService) ListDatabasesPagesWithContext 

func (c *RedshiftDataAPIService) 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 (*RedshiftDataAPIService) ListDatabasesRequest 

func (c *RedshiftDataAPIService) 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/redshift-data-2019-12-20/ListDatabases

func (*RedshiftDataAPIService) ListDatabasesWithContext 

func (c *RedshiftDataAPIService) 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 (*RedshiftDataAPIService) ListSchemas 

func (c *RedshiftDataAPIService) ListSchemas(input *ListSchemasInput) (*ListSchemasOutput, error)

ListSchemas API operation for Redshift Data API Service.

Lists the schemas in a database. A token is returned to page through the schema list. Depending on the authorization method, use one of the following combinations of request parameters:

  • Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name.

  • Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required. When connecting to a serverless endpoint, specify the database 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 Redshift Data API Service's API operation ListSchemas for usage and error information.

Returned Error Types:

  • ValidationException The Amazon Redshift Data API operation failed due to invalid input.

  • InternalServerException The Amazon Redshift Data API operation failed due to invalid input.

  • DatabaseConnectionException Connection to a database failed.

See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListSchemas

func (*RedshiftDataAPIService) ListSchemasPages 

func (c *RedshiftDataAPIService) ListSchemasPages(input *ListSchemasInput, fn func(*ListSchemasOutput, bool) bool) error

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

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

func (*RedshiftDataAPIService) ListSchemasPagesWithContext 

func (c *RedshiftDataAPIService) ListSchemasPagesWithContext(ctx aws.Context, input *ListSchemasInput, fn func(*ListSchemasOutput, bool) bool, opts ...request.Option) error

ListSchemasPagesWithContext same as ListSchemasPages 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 (*RedshiftDataAPIService) ListSchemasRequest 

func (c *RedshiftDataAPIService) ListSchemasRequest(input *ListSchemasInput) (req *request.Request, output *ListSchemasOutput)

ListSchemasRequest generates a "aws/request.Request" representing the client's request for the ListSchemas 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 ListSchemas for more information on using the ListSchemas 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 ListSchemasRequest method.
req, resp := client.ListSchemasRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListSchemas

func (*RedshiftDataAPIService) ListSchemasWithContext 

func (c *RedshiftDataAPIService) ListSchemasWithContext(ctx aws.Context, input *ListSchemasInput, opts ...request.Option) (*ListSchemasOutput, error)

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

See ListSchemas 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 (*RedshiftDataAPIService) ListStatements 

func (c *RedshiftDataAPIService) ListStatements(input *ListStatementsInput) (*ListStatementsOutput, error)

ListStatements API operation for Redshift Data API Service.

List of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list.

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 Redshift Data API Service's API operation ListStatements for usage and error information.

Returned Error Types:

  • ValidationException The Amazon Redshift Data API operation failed due to invalid input.

  • InternalServerException The Amazon Redshift Data API operation failed due to invalid input.

See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListStatements

func (*RedshiftDataAPIService) ListStatementsPages 

func (c *RedshiftDataAPIService) ListStatementsPages(input *ListStatementsInput, fn func(*ListStatementsOutput, bool) bool) error

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

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

func (*RedshiftDataAPIService) ListStatementsPagesWithContext 

func (c *RedshiftDataAPIService) ListStatementsPagesWithContext(ctx aws.Context, input *ListStatementsInput, fn func(*ListStatementsOutput, bool) bool, opts ...request.Option) error

ListStatementsPagesWithContext same as ListStatementsPages 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 (*RedshiftDataAPIService) ListStatementsRequest 

func (c *RedshiftDataAPIService) ListStatementsRequest(input *ListStatementsInput) (req *request.Request, output *ListStatementsOutput)

ListStatementsRequest generates a "aws/request.Request" representing the client's request for the ListStatements 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 ListStatements for more information on using the ListStatements 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 ListStatementsRequest method.
req, resp := client.ListStatementsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListStatements

func (*RedshiftDataAPIService) ListStatementsWithContext 

func (c *RedshiftDataAPIService) ListStatementsWithContext(ctx aws.Context, input *ListStatementsInput, opts ...request.Option) (*ListStatementsOutput, error)

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

See ListStatements 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 (*RedshiftDataAPIService) ListTables 

func (c *RedshiftDataAPIService) ListTables(input *ListTablesInput) (*ListTablesOutput, error)

ListTables API operation for Redshift Data API Service.

List the tables in a database. If neither SchemaPattern nor TablePattern are specified, then all tables in the database are returned. A token is returned to page through the table list. Depending on the authorization method, use one of the following combinations of request parameters:

  • Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name.

  • Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required. When connecting to a serverless endpoint, specify the database 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 Redshift Data API Service's API operation ListTables for usage and error information.

Returned Error Types:

  • ValidationException The Amazon Redshift Data API operation failed due to invalid input.

  • InternalServerException The Amazon Redshift Data API operation failed due to invalid input.

  • DatabaseConnectionException Connection to a database failed.

See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListTables

func (*RedshiftDataAPIService) ListTablesPages 

func (c *RedshiftDataAPIService) ListTablesPages(input *ListTablesInput, fn func(*ListTablesOutput, bool) bool) error

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

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

func (*RedshiftDataAPIService) ListTablesPagesWithContext 

func (c *RedshiftDataAPIService) ListTablesPagesWithContext(ctx aws.Context, input *ListTablesInput, fn func(*ListTablesOutput, bool) bool, opts ...request.Option) error

ListTablesPagesWithContext same as ListTablesPages 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 (*RedshiftDataAPIService) ListTablesRequest 

func (c *RedshiftDataAPIService) ListTablesRequest(input *ListTablesInput) (req *request.Request, output *ListTablesOutput)

ListTablesRequest generates a "aws/request.Request" representing the client's request for the ListTables 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 ListTables for more information on using the ListTables 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 ListTablesRequest method.
req, resp := client.ListTablesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListTables

func (*RedshiftDataAPIService) ListTablesWithContext 

func (c *RedshiftDataAPIService) ListTablesWithContext(ctx aws.Context, input *ListTablesInput, opts ...request.Option) (*ListTablesOutput, error)

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

See ListTables 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 ResourceNotFoundException 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The exception message.
	Message_ *string `locationName:"Message" type:"string"`

	// Resource identifier associated with the exception.
	//
	// ResourceId is a required field
	ResourceId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The Amazon Redshift Data API operation failed due to a missing resource.

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

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 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String 

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 SqlParameter added in v1.38.62 

type SqlParameter struct {

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

	// The value of the parameter. Amazon Redshift implicitly converts to the proper
	// data type. For more inforation, see Data types (https://docs.aws.amazon.com/redshift/latest/dg/c_Supported_data_types.html)
	// in the Amazon Redshift Database Developer Guide.
	//
	// Value is a required field
	Value *string `locationName:"value" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A parameter used in a SQL statement.

func (SqlParameter) GoString added in v1.38.62 

func (s SqlParameter) 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 (*SqlParameter) SetName added in v1.38.62 

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

SetName sets the Name field's value.

func (*SqlParameter) SetValue added in v1.38.62 

func (s *SqlParameter) SetValue(v string) *SqlParameter

SetValue sets the Value field's value.

func (SqlParameter) String added in v1.38.62 

func (s SqlParameter) 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 (*SqlParameter) Validate added in v1.38.62 

func (s *SqlParameter) Validate() error

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

type StatementData 

type StatementData struct {

	// The date and time (UTC) the statement was created.
	CreatedAt *time.Time `type:"timestamp"`

	// The SQL statement identifier. This value is a universally unique identifier
	// (UUID) generated by Amazon Redshift Data API.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// A value that indicates whether the statement is a batch query request.
	IsBatchStatement *bool `type:"boolean"`

	// The parameters used in a SQL statement.
	QueryParameters []*SqlParameter `min:"1" type:"list"`

	// The SQL statement.
	QueryString *string `type:"string"`

	// One or more SQL statements. Each query string in the array corresponds to
	// one of the queries in a batch query request.
	QueryStrings []*string `type:"list"`

	// The name or Amazon Resource Name (ARN) of the secret that enables access
	// to the database.
	SecretArn *string `type:"string"`

	// The name of the SQL statement.
	StatementName *string `type:"string"`

	// The status of the SQL statement. An example is the that the SQL statement
	// finished.
	Status *string `type:"string" enum:"StatusString"`

	// The date and time (UTC) that the statement metadata was last updated.
	UpdatedAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

The SQL statement to run.

func (StatementData) GoString 

func (s StatementData) 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 (*StatementData) SetCreatedAt 

func (s *StatementData) SetCreatedAt(v time.Time) *StatementData

SetCreatedAt sets the CreatedAt field's value.

func (*StatementData) SetId 

func (s *StatementData) SetId(v string) *StatementData

SetId sets the Id field's value.

func (*StatementData) SetIsBatchStatement added in v1.40.9 

func (s *StatementData) SetIsBatchStatement(v bool) *StatementData

SetIsBatchStatement sets the IsBatchStatement field's value.

func (*StatementData) SetQueryParameters added in v1.38.62 

func (s *StatementData) SetQueryParameters(v []*SqlParameter) *StatementData

SetQueryParameters sets the QueryParameters field's value.

func (*StatementData) SetQueryString 

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

SetQueryString sets the QueryString field's value.

func (*StatementData) SetQueryStrings added in v1.40.9 

func (s *StatementData) SetQueryStrings(v []*string) *StatementData

SetQueryStrings sets the QueryStrings field's value.

func (*StatementData) SetSecretArn 

func (s *StatementData) SetSecretArn(v string) *StatementData

SetSecretArn sets the SecretArn field's value.

func (*StatementData) SetStatementName 

func (s *StatementData) SetStatementName(v string) *StatementData

SetStatementName sets the StatementName field's value.

func (*StatementData) SetStatus 

func (s *StatementData) SetStatus(v string) *StatementData

SetStatus sets the Status field's value.

func (*StatementData) SetUpdatedAt 

func (s *StatementData) SetUpdatedAt(v time.Time) *StatementData

SetUpdatedAt sets the UpdatedAt field's value.

func (StatementData) String 

func (s StatementData) 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 SubStatementData added in v1.40.9 

type SubStatementData struct {

	// The date and time (UTC) the statement was created.
	CreatedAt *time.Time `type:"timestamp"`

	// The amount of time in nanoseconds that the statement ran.
	Duration *int64 `type:"long"`

	// The error message from the cluster if the SQL statement encountered an error
	// while running.
	Error *string `type:"string"`

	// A value that indicates whether the statement has a result set. The result
	// set can be empty. The value is true for an empty result set.
	HasResultSet *bool `type:"boolean"`

	// The identifier of the SQL statement. This value is a universally unique identifier
	// (UUID) generated by Amazon Redshift Data API. A suffix indicates the number
	// of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2
	// has a suffix of :2 that indicates the second SQL statement of a batch query.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// The SQL statement text.
	QueryString *string `type:"string"`

	// The SQL statement identifier. This value is a universally unique identifier
	// (UUID) generated by Amazon Redshift Data API.
	RedshiftQueryId *int64 `type:"long"`

	// Either the number of rows returned from the SQL statement or the number of
	// rows affected. If result size is greater than zero, the result rows can be
	// the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE,
	// COPY, and others. A -1 indicates the value is null.
	ResultRows *int64 `type:"long"`

	// The size in bytes of the returned results. A -1 indicates the value is null.
	ResultSize *int64 `type:"long"`

	// The status of the SQL statement. An example is the that the SQL statement
	// finished.
	Status *string `type:"string" enum:"StatementStatusString"`

	// The date and time (UTC) that the statement metadata was last updated.
	UpdatedAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Information about an SQL statement.

func (SubStatementData) GoString added in v1.40.9 

func (s SubStatementData) 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 (*SubStatementData) SetCreatedAt added in v1.40.9 

func (s *SubStatementData) SetCreatedAt(v time.Time) *SubStatementData

SetCreatedAt sets the CreatedAt field's value.

func (*SubStatementData) SetDuration added in v1.40.9 

func (s *SubStatementData) SetDuration(v int64) *SubStatementData

SetDuration sets the Duration field's value.

func (*SubStatementData) SetError added in v1.40.9 

func (s *SubStatementData) SetError(v string) *SubStatementData

SetError sets the Error field's value.

func (*SubStatementData) SetHasResultSet added in v1.40.9 

func (s *SubStatementData) SetHasResultSet(v bool) *SubStatementData

SetHasResultSet sets the HasResultSet field's value.

func (*SubStatementData) SetId added in v1.40.9 

func (s *SubStatementData) SetId(v string) *SubStatementData

SetId sets the Id field's value.

func (*SubStatementData) SetQueryString added in v1.40.9 

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

SetQueryString sets the QueryString field's value.

func (*SubStatementData) SetRedshiftQueryId added in v1.40.9 

func (s *SubStatementData) SetRedshiftQueryId(v int64) *SubStatementData

SetRedshiftQueryId sets the RedshiftQueryId field's value.

func (*SubStatementData) SetResultRows added in v1.40.9 

func (s *SubStatementData) SetResultRows(v int64) *SubStatementData

SetResultRows sets the ResultRows field's value.

func (*SubStatementData) SetResultSize added in v1.40.9 

func (s *SubStatementData) SetResultSize(v int64) *SubStatementData

SetResultSize sets the ResultSize field's value.

func (*SubStatementData) SetStatus added in v1.40.9 

func (s *SubStatementData) SetStatus(v string) *SubStatementData

SetStatus sets the Status field's value.

func (*SubStatementData) SetUpdatedAt added in v1.40.9 

func (s *SubStatementData) SetUpdatedAt(v time.Time) *SubStatementData

SetUpdatedAt sets the UpdatedAt field's value.

func (SubStatementData) String added in v1.40.9 

func (s SubStatementData) 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 TableMember 

type TableMember struct {

	// The name of the table.
	Name *string `locationName:"name" type:"string"`

	// The schema containing the table.
	Schema *string `locationName:"schema" type:"string"`

	// The type of the table. Possible values include TABLE, VIEW, SYSTEM TABLE,
	// GLOBAL TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM.
	Type *string `locationName:"type" type:"string"`
	// contains filtered or unexported fields
}

The properties of a table.

func (TableMember) GoString 

func (s TableMember) 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 (*TableMember) SetName 

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

SetName sets the Name field's value.

func (*TableMember) SetSchema 

func (s *TableMember) SetSchema(v string) *TableMember

SetSchema sets the Schema field's value.

func (*TableMember) SetType 

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

SetType sets the Type field's value.

func (TableMember) String 

func (s TableMember) 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 ValidationException 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The exception message.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The Amazon Redshift Data API operation failed due to invalid input.

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) 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 (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String 

func (s ValidationException) 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".

Source Files

View all Source files

Directories

Path Synopsis
Package redshiftdataapiserviceiface provides an interface to enable mocking the Redshift Data API Service service client for testing your code.
 Package redshiftdataapiserviceiface provides an interface to enable mocking the Redshift Data API Service service client for testing your code.

Jump to

Keyboard shortcuts

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