rdsdataservice

package
v1.38.4 Latest Latest
Warning

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

 Go to latest Published: Mar 24, 2021 License: Apache-2.0 Imports: 9 Imported by: 33

Documentation

Overview

Package rdsdataservice provides the client and types for making API requests to AWS RDS DataService.

Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora Serverless DB cluster. To run these statements, you work with the Data Service API.

For more information about the Data Service API, see Using the Data API for Aurora Serverless (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the Amazon Aurora User Guide.

See https://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01 for more information on this service.

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

Using the Client

To contact AWS RDS DataService 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 AWS RDS DataService client RDSDataService for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/rdsdataservice/#New

Index

Constants

View Source 
const (
	// DecimalReturnTypeString is a DecimalReturnType enum value
	DecimalReturnTypeString = "STRING"

	// DecimalReturnTypeDoubleOrLong is a DecimalReturnType enum value
	DecimalReturnTypeDoubleOrLong = "DOUBLE_OR_LONG"
)
View Source 
const (
	// TypeHintJson is a TypeHint enum value
	TypeHintJson = "JSON"

	// TypeHintUuid is a TypeHint enum value
	TypeHintUuid = "UUID"

	// TypeHintTimestamp is a TypeHint enum value
	TypeHintTimestamp = "TIMESTAMP"

	// TypeHintDate is a TypeHint enum value
	TypeHintDate = "DATE"

	// TypeHintTime is a TypeHint enum value
	TypeHintTime = "TIME"

	// TypeHintDecimal is a TypeHint enum value
	TypeHintDecimal = "DECIMAL"
)
View Source 
const (

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	//
	// There is an error in the call or in a SQL statement.
	ErrCodeBadRequestException = "BadRequestException"

	// ErrCodeForbiddenException for service response error code
	// "ForbiddenException".
	//
	// There are insufficient privileges to make the call.
	ErrCodeForbiddenException = "ForbiddenException"

	// ErrCodeInternalServerErrorException for service response error code
	// "InternalServerErrorException".
	//
	// An internal error occurred.
	ErrCodeInternalServerErrorException = "InternalServerErrorException"

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	//
	// The resourceArn, secretArn, or transactionId value can't be found.
	ErrCodeNotFoundException = "NotFoundException"

	// ErrCodeServiceUnavailableError for service response error code
	// "ServiceUnavailableError".
	//
	// The service specified by the resourceArn parameter is not available.
	ErrCodeServiceUnavailableError = "ServiceUnavailableError"

	// ErrCodeStatementTimeoutException for service response error code
	// "StatementTimeoutException".
	//
	// The execution of the SQL statement timed out.
	ErrCodeStatementTimeoutException = "StatementTimeoutException"
)
View Source 
const (
	ServiceName = "RDS Data" // Name of service.
	EndpointsID = "rds-data" // ID to lookup a service endpoint with.
	ServiceID   = "RDS Data" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func DecimalReturnType_Values added in v1.34.3 

func DecimalReturnType_Values() []string

DecimalReturnType_Values returns all elements of the DecimalReturnType enum

func TypeHint_Values added in v1.34.3 

func TypeHint_Values() []string

TypeHint_Values returns all elements of the TypeHint enum

Types

type ArrayValue added in v1.24.4 

type ArrayValue struct {

	// An array of arrays.
	ArrayValues []*ArrayValue `locationName:"arrayValues" type:"list"`

	// An array of Boolean values.
	BooleanValues []*bool `locationName:"booleanValues" type:"list"`

	// An array of integers.
	DoubleValues []*float64 `locationName:"doubleValues" type:"list"`

	// An array of floating point numbers.
	LongValues []*int64 `locationName:"longValues" type:"list"`

	// An array of strings.
	StringValues []*string `locationName:"stringValues" type:"list"`
	// contains filtered or unexported fields
}

Contains an array.

func (ArrayValue) GoString added in v1.24.4 

func (s ArrayValue) GoString() string

GoString returns the string representation

func (*ArrayValue) SetArrayValues added in v1.24.4 

func (s *ArrayValue) SetArrayValues(v []*ArrayValue) *ArrayValue

SetArrayValues sets the ArrayValues field's value.

func (*ArrayValue) SetBooleanValues added in v1.24.4 

func (s *ArrayValue) SetBooleanValues(v []*bool) *ArrayValue

SetBooleanValues sets the BooleanValues field's value.

func (*ArrayValue) SetDoubleValues added in v1.24.4 

func (s *ArrayValue) SetDoubleValues(v []*float64) *ArrayValue

SetDoubleValues sets the DoubleValues field's value.

func (*ArrayValue) SetLongValues added in v1.24.4 

func (s *ArrayValue) SetLongValues(v []*int64) *ArrayValue

SetLongValues sets the LongValues field's value.

func (*ArrayValue) SetStringValues added in v1.24.4 

func (s *ArrayValue) SetStringValues(v []*string) *ArrayValue

SetStringValues sets the StringValues field's value.

func (ArrayValue) String added in v1.24.4 

func (s ArrayValue) String() string

String returns the string representation

type BadRequestException added in v1.28.0 

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

	// The error message returned by this BadRequestException error.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

There is an error in the call or in a SQL statement.

func (*BadRequestException) Code added in v1.28.0 

func (s *BadRequestException) Code() string

Code returns the exception type name.

func (*BadRequestException) Error added in v1.28.0 

func (s *BadRequestException) Error() string

func (BadRequestException) GoString added in v1.28.0 

func (s BadRequestException) GoString() string

GoString returns the string representation

func (*BadRequestException) Message added in v1.28.0 

func (s *BadRequestException) Message() string

Message returns the exception's message.

func (*BadRequestException) OrigErr added in v1.28.0 

func (s *BadRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BadRequestException) RequestID added in v1.28.0 

func (s *BadRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadRequestException) StatusCode added in v1.28.0 

func (s *BadRequestException) StatusCode() int

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

func (BadRequestException) String added in v1.28.0 

func (s BadRequestException) String() string

String returns the string representation

type BatchExecuteStatementInput added in v1.19.41 

type BatchExecuteStatementInput struct {

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

	// The parameter set for the batch operation.
	//
	// The SQL statement is executed as many times as the number of parameter sets
	// provided. To execute a SQL statement with no parameters, use one of the following
	// options:
	//
	//    * Specify one or more empty parameter sets.
	//
	//    * Use the ExecuteStatement operation instead of the BatchExecuteStatement
	//    operation.
	//
	// Array parameters are not supported.
	ParameterSets [][]*SqlParameter `locationName:"parameterSets" type:"list"`

	// The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"11" type:"string" required:"true"`

	// The name of the database schema.
	Schema *string `locationName:"schema" type:"string"`

	// The name or ARN of the secret that enables access to the DB cluster.
	//
	// SecretArn is a required field
	SecretArn *string `locationName:"secretArn" min:"11" type:"string" required:"true"`

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

	// The identifier of a transaction that was started by using the BeginTransaction
	// operation. Specify the transaction ID of the transaction that you want to
	// include the SQL statement in.
	//
	// If the SQL statement is not part of a transaction, don't set this parameter.
	TransactionId *string `locationName:"transactionId" type:"string"`
	// contains filtered or unexported fields
}

The request parameters represent the input of a SQL statement over an array of data.

func (BatchExecuteStatementInput) GoString added in v1.19.41 

func (s BatchExecuteStatementInput) GoString() string

GoString returns the string representation

func (*BatchExecuteStatementInput) SetDatabase added in v1.19.41 

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

SetDatabase sets the Database field's value.

func (*BatchExecuteStatementInput) SetParameterSets added in v1.19.41 

func (s *BatchExecuteStatementInput) SetParameterSets(v [][]*SqlParameter) *BatchExecuteStatementInput

SetParameterSets sets the ParameterSets field's value.

func (*BatchExecuteStatementInput) SetResourceArn added in v1.19.41 

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

SetResourceArn sets the ResourceArn field's value.

func (*BatchExecuteStatementInput) SetSchema added in v1.19.41 

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

SetSchema sets the Schema field's value.

func (*BatchExecuteStatementInput) SetSecretArn added in v1.19.41 

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

SetSecretArn sets the SecretArn field's value.

func (*BatchExecuteStatementInput) SetSql added in v1.19.41 

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

SetSql sets the Sql field's value.

func (*BatchExecuteStatementInput) SetTransactionId added in v1.19.41 

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

SetTransactionId sets the TransactionId field's value.

func (BatchExecuteStatementInput) String added in v1.19.41 

func (s BatchExecuteStatementInput) String() string

String returns the string representation

func (*BatchExecuteStatementInput) Validate added in v1.19.41 

func (s *BatchExecuteStatementInput) Validate() error

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

type BatchExecuteStatementOutput added in v1.19.41 

type BatchExecuteStatementOutput struct {

	// The execution results of each batch entry.
	UpdateResults []*UpdateResult `locationName:"updateResults" type:"list"`
	// contains filtered or unexported fields
}

The response elements represent the output of a SQL statement over an array of data.

func (BatchExecuteStatementOutput) GoString added in v1.19.41 

func (s BatchExecuteStatementOutput) GoString() string

GoString returns the string representation

func (*BatchExecuteStatementOutput) SetUpdateResults added in v1.19.41 

func (s *BatchExecuteStatementOutput) SetUpdateResults(v []*UpdateResult) *BatchExecuteStatementOutput

SetUpdateResults sets the UpdateResults field's value.

func (BatchExecuteStatementOutput) String added in v1.19.41 

func (s BatchExecuteStatementOutput) String() string

String returns the string representation

type BeginTransactionInput added in v1.19.41 

type BeginTransactionInput struct {

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

	// The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"11" type:"string" required:"true"`

	// The name of the database schema.
	Schema *string `locationName:"schema" type:"string"`

	// The name or ARN of the secret that enables access to the DB cluster.
	//
	// SecretArn is a required field
	SecretArn *string `locationName:"secretArn" min:"11" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request parameters represent the input of a request to start a SQL transaction.

func (BeginTransactionInput) GoString added in v1.19.41 

func (s BeginTransactionInput) GoString() string

GoString returns the string representation

func (*BeginTransactionInput) SetDatabase added in v1.19.41 

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

SetDatabase sets the Database field's value.

func (*BeginTransactionInput) SetResourceArn added in v1.19.41 

func (s *BeginTransactionInput) SetResourceArn(v string) *BeginTransactionInput

SetResourceArn sets the ResourceArn field's value.

func (*BeginTransactionInput) SetSchema added in v1.19.41 

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

SetSchema sets the Schema field's value.

func (*BeginTransactionInput) SetSecretArn added in v1.19.41 

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

SetSecretArn sets the SecretArn field's value.

func (BeginTransactionInput) String added in v1.19.41 

func (s BeginTransactionInput) String() string

String returns the string representation

func (*BeginTransactionInput) Validate added in v1.19.41 

func (s *BeginTransactionInput) Validate() error

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

type BeginTransactionOutput added in v1.19.41 

type BeginTransactionOutput struct {

	// The transaction ID of the transaction started by the call.
	TransactionId *string `locationName:"transactionId" type:"string"`
	// contains filtered or unexported fields
}

The response elements represent the output of a request to start a SQL transaction.

func (BeginTransactionOutput) GoString added in v1.19.41 

func (s BeginTransactionOutput) GoString() string

GoString returns the string representation

func (*BeginTransactionOutput) SetTransactionId added in v1.19.41 

func (s *BeginTransactionOutput) SetTransactionId(v string) *BeginTransactionOutput

SetTransactionId sets the TransactionId field's value.

func (BeginTransactionOutput) String added in v1.19.41 

func (s BeginTransactionOutput) String() string

String returns the string representation

type ColumnMetadata 

type ColumnMetadata struct {

	// The type of the column.
	ArrayBaseColumnType *int64 `locationName:"arrayBaseColumnType" type:"integer"`

	// A value that indicates whether the column increments automatically.
	IsAutoIncrement *bool `locationName:"isAutoIncrement" type:"boolean"`

	// 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 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 owns 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 type of the column.
	Type *int64 `locationName:"type" type:"integer"`

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

Contains the metadata for a column.

func (ColumnMetadata) GoString 

func (s ColumnMetadata) GoString() string

GoString returns the string representation

func (*ColumnMetadata) SetArrayBaseColumnType 

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

SetArrayBaseColumnType sets the ArrayBaseColumnType field's value.

func (*ColumnMetadata) SetIsAutoIncrement 

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

SetIsAutoIncrement sets the IsAutoIncrement 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) 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) SetType 

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

SetType sets the Type 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

type CommitTransactionInput added in v1.19.41 

type CommitTransactionInput struct {

	// The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"11" type:"string" required:"true"`

	// The name or ARN of the secret that enables access to the DB cluster.
	//
	// SecretArn is a required field
	SecretArn *string `locationName:"secretArn" min:"11" type:"string" required:"true"`

	// The identifier of the transaction to end and commit.
	//
	// TransactionId is a required field
	TransactionId *string `locationName:"transactionId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request parameters represent the input of a commit transaction request.

func (CommitTransactionInput) GoString added in v1.19.41 

func (s CommitTransactionInput) GoString() string

GoString returns the string representation

func (*CommitTransactionInput) SetResourceArn added in v1.19.41 

func (s *CommitTransactionInput) SetResourceArn(v string) *CommitTransactionInput

SetResourceArn sets the ResourceArn field's value.

func (*CommitTransactionInput) SetSecretArn added in v1.19.41 

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

SetSecretArn sets the SecretArn field's value.

func (*CommitTransactionInput) SetTransactionId added in v1.19.41 

func (s *CommitTransactionInput) SetTransactionId(v string) *CommitTransactionInput

SetTransactionId sets the TransactionId field's value.

func (CommitTransactionInput) String added in v1.19.41 

func (s CommitTransactionInput) String() string

String returns the string representation

func (*CommitTransactionInput) Validate added in v1.19.41 

func (s *CommitTransactionInput) Validate() error

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

type CommitTransactionOutput added in v1.19.41 

type CommitTransactionOutput struct {

	// The status of the commit operation.
	TransactionStatus *string `locationName:"transactionStatus" type:"string"`
	// contains filtered or unexported fields
}

The response elements represent the output of a commit transaction request.

func (CommitTransactionOutput) GoString added in v1.19.41 

func (s CommitTransactionOutput) GoString() string

GoString returns the string representation

func (*CommitTransactionOutput) SetTransactionStatus added in v1.19.41 

func (s *CommitTransactionOutput) SetTransactionStatus(v string) *CommitTransactionOutput

SetTransactionStatus sets the TransactionStatus field's value.

func (CommitTransactionOutput) String added in v1.19.41 

func (s CommitTransactionOutput) String() string

String returns the string representation

type ExecuteSqlInput 

type ExecuteSqlInput struct {

	// The Amazon Resource Name (ARN) of the secret that enables access to the DB
	// cluster.
	//
	// AwsSecretStoreArn is a required field
	AwsSecretStoreArn *string `locationName:"awsSecretStoreArn" min:"11" type:"string" required:"true"`

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

	// The ARN of the Aurora Serverless DB cluster.
	//
	// DbClusterOrInstanceArn is a required field
	DbClusterOrInstanceArn *string `locationName:"dbClusterOrInstanceArn" min:"11" type:"string" required:"true"`

	// The name of the database schema.
	Schema *string `locationName:"schema" type:"string"`

	// One or more SQL statements to run on the DB cluster.
	//
	// You can separate SQL statements from each other with a semicolon (;). Any
	// valid SQL statement is permitted, including data definition, data manipulation,
	// and commit statements.
	//
	// SqlStatements is a required field
	SqlStatements *string `locationName:"sqlStatements" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request parameters represent the input of a request to run one or more SQL statements.

func (ExecuteSqlInput) GoString 

func (s ExecuteSqlInput) GoString() string

GoString returns the string representation

func (*ExecuteSqlInput) SetAwsSecretStoreArn 

func (s *ExecuteSqlInput) SetAwsSecretStoreArn(v string) *ExecuteSqlInput

SetAwsSecretStoreArn sets the AwsSecretStoreArn field's value.

func (*ExecuteSqlInput) SetDatabase 

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

SetDatabase sets the Database field's value.

func (*ExecuteSqlInput) SetDbClusterOrInstanceArn 

func (s *ExecuteSqlInput) SetDbClusterOrInstanceArn(v string) *ExecuteSqlInput

SetDbClusterOrInstanceArn sets the DbClusterOrInstanceArn field's value.

func (*ExecuteSqlInput) SetSchema 

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

SetSchema sets the Schema field's value.

func (*ExecuteSqlInput) SetSqlStatements 

func (s *ExecuteSqlInput) SetSqlStatements(v string) *ExecuteSqlInput

SetSqlStatements sets the SqlStatements field's value.

func (ExecuteSqlInput) String 

func (s ExecuteSqlInput) String() string

String returns the string representation

func (*ExecuteSqlInput) Validate 

func (s *ExecuteSqlInput) Validate() error

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

type ExecuteSqlOutput 

type ExecuteSqlOutput struct {

	// The results of the SQL statement or statements.
	SqlStatementResults []*SqlStatementResult `locationName:"sqlStatementResults" type:"list"`
	// contains filtered or unexported fields
}

The response elements represent the output of a request to run one or more SQL statements.

func (ExecuteSqlOutput) GoString 

func (s ExecuteSqlOutput) GoString() string

GoString returns the string representation

func (*ExecuteSqlOutput) SetSqlStatementResults 

func (s *ExecuteSqlOutput) SetSqlStatementResults(v []*SqlStatementResult) *ExecuteSqlOutput

SetSqlStatementResults sets the SqlStatementResults field's value.

func (ExecuteSqlOutput) String 

func (s ExecuteSqlOutput) String() string

String returns the string representation

type ExecuteStatementInput added in v1.19.41 

type ExecuteStatementInput struct {

	// A value that indicates whether to continue running the statement after the
	// call times out. By default, the statement stops running when the call times
	// out.
	//
	// For DDL statements, we recommend continuing to run the statement after the
	// call times out. When a DDL statement terminates before it is finished running,
	// it can result in errors and possibly corrupted data structures.
	ContinueAfterTimeout *bool `locationName:"continueAfterTimeout" type:"boolean"`

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

	// A value that indicates whether to include metadata in the results.
	IncludeResultMetadata *bool `locationName:"includeResultMetadata" type:"boolean"`

	// The parameters for the SQL statement.
	//
	// Array parameters are not supported.
	Parameters []*SqlParameter `locationName:"parameters" type:"list"`

	// The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"11" type:"string" required:"true"`

	// Options that control how the result set is returned.
	ResultSetOptions *ResultSetOptions `locationName:"resultSetOptions" type:"structure"`

	// The name of the database schema.
	//
	// Currently, the schema parameter isn't supported.
	Schema *string `locationName:"schema" type:"string"`

	// The name or ARN of the secret that enables access to the DB cluster.
	//
	// SecretArn is a required field
	SecretArn *string `locationName:"secretArn" min:"11" type:"string" required:"true"`

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

	// The identifier of a transaction that was started by using the BeginTransaction
	// operation. Specify the transaction ID of the transaction that you want to
	// include the SQL statement in.
	//
	// If the SQL statement is not part of a transaction, don't set this parameter.
	TransactionId *string `locationName:"transactionId" type:"string"`
	// contains filtered or unexported fields
}

The request parameters represent the input of a request to run a SQL statement against a database.

func (ExecuteStatementInput) GoString added in v1.19.41 

func (s ExecuteStatementInput) GoString() string

GoString returns the string representation

func (*ExecuteStatementInput) SetContinueAfterTimeout added in v1.19.41 

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

SetContinueAfterTimeout sets the ContinueAfterTimeout field's value.

func (*ExecuteStatementInput) SetDatabase added in v1.19.41 

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

SetDatabase sets the Database field's value.

func (*ExecuteStatementInput) SetIncludeResultMetadata added in v1.19.41 

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

SetIncludeResultMetadata sets the IncludeResultMetadata field's value.

func (*ExecuteStatementInput) SetParameters added in v1.19.41 

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

SetParameters sets the Parameters field's value.

func (*ExecuteStatementInput) SetResourceArn added in v1.19.41 

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

SetResourceArn sets the ResourceArn field's value.

func (*ExecuteStatementInput) SetResultSetOptions added in v1.24.4 

func (s *ExecuteStatementInput) SetResultSetOptions(v *ResultSetOptions) *ExecuteStatementInput

SetResultSetOptions sets the ResultSetOptions field's value.

func (*ExecuteStatementInput) SetSchema added in v1.19.41 

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

SetSchema sets the Schema field's value.

func (*ExecuteStatementInput) SetSecretArn added in v1.19.41 

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

SetSecretArn sets the SecretArn field's value.

func (*ExecuteStatementInput) SetSql added in v1.19.41 

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

SetSql sets the Sql field's value.

func (*ExecuteStatementInput) SetTransactionId added in v1.19.41 

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

SetTransactionId sets the TransactionId field's value.

func (ExecuteStatementInput) String added in v1.19.41 

func (s ExecuteStatementInput) String() string

String returns the string representation

func (*ExecuteStatementInput) Validate added in v1.19.41 

func (s *ExecuteStatementInput) Validate() error

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

type ExecuteStatementOutput added in v1.19.41 

type ExecuteStatementOutput struct {

	// Metadata for the columns included in the results.
	ColumnMetadata []*ColumnMetadata `locationName:"columnMetadata" type:"list"`

	// Values for fields generated during the request.
	//
	//    <note> <p>The <code>generatedFields</code> data isn't supported by Aurora
	//    PostgreSQL. To get the values of generated fields, use the <code>RETURNING</code>
	//    clause. For more information, see <a href="https://www.postgresql.org/docs/10/dml-returning.html">Returning
	//    Data From Modified Rows</a> in the PostgreSQL documentation.</p> </note>
	GeneratedFields []*Field `locationName:"generatedFields" type:"list"`

	// The number of records updated by the request.
	NumberOfRecordsUpdated *int64 `locationName:"numberOfRecordsUpdated" type:"long"`

	// The records returned by the SQL statement.
	Records [][]*Field `locationName:"records" type:"list"`
	// contains filtered or unexported fields
}

The response elements represent the output of a request to run a SQL statement against a database.

func (ExecuteStatementOutput) GoString added in v1.19.41 

func (s ExecuteStatementOutput) GoString() string

GoString returns the string representation

func (*ExecuteStatementOutput) SetColumnMetadata added in v1.19.41 

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

SetColumnMetadata sets the ColumnMetadata field's value.

func (*ExecuteStatementOutput) SetGeneratedFields added in v1.19.41 

func (s *ExecuteStatementOutput) SetGeneratedFields(v []*Field) *ExecuteStatementOutput

SetGeneratedFields sets the GeneratedFields field's value.

func (*ExecuteStatementOutput) SetNumberOfRecordsUpdated added in v1.19.41 

func (s *ExecuteStatementOutput) SetNumberOfRecordsUpdated(v int64) *ExecuteStatementOutput

SetNumberOfRecordsUpdated sets the NumberOfRecordsUpdated field's value.

func (*ExecuteStatementOutput) SetRecords added in v1.19.41 

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

SetRecords sets the Records field's value.

func (ExecuteStatementOutput) String added in v1.19.41 

func (s ExecuteStatementOutput) String() string

String returns the string representation

type Field added in v1.19.41 

type Field struct {

	// An array of values.
	ArrayValue *ArrayValue `locationName:"arrayValue" type:"structure"`

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

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

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

	// A NULL value.
	IsNull *bool `locationName:"isNull" type:"boolean"`

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

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

Contains a value.

func (Field) GoString added in v1.19.41 

func (s Field) GoString() string

GoString returns the string representation

func (*Field) SetArrayValue added in v1.24.4 

func (s *Field) SetArrayValue(v *ArrayValue) *Field

SetArrayValue sets the ArrayValue field's value.

func (*Field) SetBlobValue added in v1.19.41 

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

SetBlobValue sets the BlobValue field's value.

func (*Field) SetBooleanValue added in v1.19.41 

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

SetBooleanValue sets the BooleanValue field's value.

func (*Field) SetDoubleValue added in v1.19.41 

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

SetDoubleValue sets the DoubleValue field's value.

func (*Field) SetIsNull added in v1.19.41 

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

SetIsNull sets the IsNull field's value.

func (*Field) SetLongValue added in v1.19.41 

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

SetLongValue sets the LongValue field's value.

func (*Field) SetStringValue added in v1.19.41 

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

SetStringValue sets the StringValue field's value.

func (Field) String added in v1.19.41 

func (s Field) String() string

String returns the string representation

type ForbiddenException added in v1.28.0 

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

	// The error message returned by this ForbiddenException error.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

There are insufficient privileges to make the call.

func (*ForbiddenException) Code added in v1.28.0 

func (s *ForbiddenException) Code() string

Code returns the exception type name.

func (*ForbiddenException) Error added in v1.28.0 

func (s *ForbiddenException) Error() string

func (ForbiddenException) GoString added in v1.28.0 

func (s ForbiddenException) GoString() string

GoString returns the string representation

func (*ForbiddenException) Message added in v1.28.0 

func (s *ForbiddenException) Message() string

Message returns the exception's message.

func (*ForbiddenException) OrigErr added in v1.28.0 

func (s *ForbiddenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ForbiddenException) RequestID added in v1.28.0 

func (s *ForbiddenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ForbiddenException) StatusCode added in v1.28.0 

func (s *ForbiddenException) StatusCode() int

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

func (ForbiddenException) String added in v1.28.0 

func (s ForbiddenException) String() string

String returns the string representation

type InternalServerErrorException added in v1.28.0 

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

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

An internal error occurred.

func (*InternalServerErrorException) Code added in v1.28.0 

func (s *InternalServerErrorException) Code() string

Code returns the exception type name.

func (*InternalServerErrorException) Error added in v1.28.0 

func (s *InternalServerErrorException) Error() string

func (InternalServerErrorException) GoString added in v1.28.0 

func (s InternalServerErrorException) GoString() string

GoString returns the string representation

func (*InternalServerErrorException) Message added in v1.28.0 

func (s *InternalServerErrorException) Message() string

Message returns the exception's message.

func (*InternalServerErrorException) OrigErr added in v1.28.0 

func (s *InternalServerErrorException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerErrorException) RequestID added in v1.28.0 

func (s *InternalServerErrorException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerErrorException) StatusCode added in v1.28.0 

func (s *InternalServerErrorException) StatusCode() int

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

func (InternalServerErrorException) String added in v1.28.0 

func (s InternalServerErrorException) String() string

String returns the string representation

type NotFoundException added in v1.28.0 

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

	// The error message returned by this NotFoundException error.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The resourceArn, secretArn, or transactionId value can't be found.

func (*NotFoundException) Code added in v1.28.0 

func (s *NotFoundException) Code() string

Code returns the exception type name.

func (*NotFoundException) Error added in v1.28.0 

func (s *NotFoundException) Error() string

func (NotFoundException) GoString added in v1.28.0 

func (s NotFoundException) GoString() string

GoString returns the string representation

func (*NotFoundException) Message added in v1.28.0 

func (s *NotFoundException) Message() string

Message returns the exception's message.

func (*NotFoundException) OrigErr added in v1.28.0 

func (s *NotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotFoundException) RequestID added in v1.28.0 

func (s *NotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotFoundException) StatusCode added in v1.28.0 

func (s *NotFoundException) StatusCode() int

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

func (NotFoundException) String added in v1.28.0 

func (s NotFoundException) String() string

String returns the string representation

type RDSDataService 

type RDSDataService struct {
	*client.Client
}

RDSDataService provides the API operation methods for making requests to AWS RDS DataService. See this package's package overview docs for details on the service.

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

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

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

func (*RDSDataService) BatchExecuteStatement added in v1.19.41 

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

BatchExecuteStatement API operation for AWS RDS DataService.

Runs a batch SQL statement over an array of data.

You can run bulk update and insert operations for multiple records using a DML statement with different parameter sets. Bulk operations can provide a significant performance improvement over individual insert and update operations.

If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically.

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 AWS RDS DataService's API operation BatchExecuteStatement for usage and error information.

Returned Error Types:

  • BadRequestException There is an error in the call or in a SQL statement.

  • StatementTimeoutException The execution of the SQL statement timed out.

  • InternalServerErrorException An internal error occurred.

  • ForbiddenException There are insufficient privileges to make the call.

  • ServiceUnavailableError The service specified by the resourceArn parameter is not available.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/BatchExecuteStatement

func (*RDSDataService) BatchExecuteStatementRequest added in v1.19.41 

func (c *RDSDataService) 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/rds-data-2018-08-01/BatchExecuteStatement

func (*RDSDataService) BatchExecuteStatementWithContext added in v1.19.41 

func (c *RDSDataService) 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 (*RDSDataService) BeginTransaction added in v1.19.41 

func (c *RDSDataService) BeginTransaction(input *BeginTransactionInput) (*BeginTransactionOutput, error)

BeginTransaction API operation for AWS RDS DataService.

Starts a SQL transaction. 

<important> <p>A transaction can run for a maximum of 24 hours. A transaction
is terminated and rolled back automatically after 24 hours.</p> <p>A transaction
times out if no calls use its transaction ID in three minutes. If a transaction
times out before it's committed, it's rolled back automatically.</p> <p>DDL
statements inside a transaction cause an implicit commit. We recommend
that you run each DDL statement in a separate <code>ExecuteStatement</code>
call with <code>continueAfterTimeout</code> enabled.</p> </important>

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 AWS RDS DataService's API operation BeginTransaction for usage and error information.

Returned Error Types:

  • BadRequestException There is an error in the call or in a SQL statement.

  • StatementTimeoutException The execution of the SQL statement timed out.

  • InternalServerErrorException An internal error occurred.

  • ForbiddenException There are insufficient privileges to make the call.

  • ServiceUnavailableError The service specified by the resourceArn parameter is not available.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/BeginTransaction

func (*RDSDataService) BeginTransactionRequest added in v1.19.41 

func (c *RDSDataService) BeginTransactionRequest(input *BeginTransactionInput) (req *request.Request, output *BeginTransactionOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/BeginTransaction

func (*RDSDataService) BeginTransactionWithContext added in v1.19.41 

func (c *RDSDataService) BeginTransactionWithContext(ctx aws.Context, input *BeginTransactionInput, opts ...request.Option) (*BeginTransactionOutput, error)

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

See BeginTransaction 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 (*RDSDataService) CommitTransaction added in v1.19.41 

func (c *RDSDataService) CommitTransaction(input *CommitTransactionInput) (*CommitTransactionOutput, error)

CommitTransaction API operation for AWS RDS DataService.

Ends a SQL transaction started with the BeginTransaction operation and commits the changes.

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 AWS RDS DataService's API operation CommitTransaction for usage and error information.

Returned Error Types:

  • BadRequestException There is an error in the call or in a SQL statement.

  • StatementTimeoutException The execution of the SQL statement timed out.

  • InternalServerErrorException An internal error occurred.

  • ForbiddenException There are insufficient privileges to make the call.

  • ServiceUnavailableError The service specified by the resourceArn parameter is not available.

  • NotFoundException The resourceArn, secretArn, or transactionId value can't be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/CommitTransaction

func (*RDSDataService) CommitTransactionRequest added in v1.19.41 

func (c *RDSDataService) CommitTransactionRequest(input *CommitTransactionInput) (req *request.Request, output *CommitTransactionOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/CommitTransaction

func (*RDSDataService) CommitTransactionWithContext added in v1.19.41 

func (c *RDSDataService) CommitTransactionWithContext(ctx aws.Context, input *CommitTransactionInput, opts ...request.Option) (*CommitTransactionOutput, error)

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

See CommitTransaction 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 (*RDSDataService) ExecuteSql deprecated 

func (c *RDSDataService) ExecuteSql(input *ExecuteSqlInput) (*ExecuteSqlOutput, error)

ExecuteSql API operation for AWS RDS DataService.

Runs one or more SQL statements.

This operation is deprecated. Use the BatchExecuteStatement or ExecuteStatement operation.

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 AWS RDS DataService's API operation ExecuteSql for usage and error information.

Returned Error Types:

  • BadRequestException There is an error in the call or in a SQL statement.

  • InternalServerErrorException An internal error occurred.

  • ForbiddenException There are insufficient privileges to make the call.

  • ServiceUnavailableError The service specified by the resourceArn parameter is not available.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ExecuteSql

Deprecated: The ExecuteSql API is deprecated, please use the ExecuteStatement API.

func (*RDSDataService) ExecuteSqlRequest deprecated 

func (c *RDSDataService) ExecuteSqlRequest(input *ExecuteSqlInput) (req *request.Request, output *ExecuteSqlOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ExecuteSql

Deprecated: The ExecuteSql API is deprecated, please use the ExecuteStatement API.

func (*RDSDataService) ExecuteSqlWithContext deprecated 

func (c *RDSDataService) ExecuteSqlWithContext(ctx aws.Context, input *ExecuteSqlInput, opts ...request.Option) (*ExecuteSqlOutput, error)

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

See ExecuteSql 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.

Deprecated: The ExecuteSql API is deprecated, please use the ExecuteStatement API.

func (*RDSDataService) ExecuteStatement added in v1.19.41 

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

ExecuteStatement API operation for AWS RDS DataService.

Runs a SQL statement against a database.

If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically.

The response size limit is 1 MB. If the call returns more than 1 MB of response data, the call is terminated.

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 AWS RDS DataService's API operation ExecuteStatement for usage and error information.

Returned Error Types:

  • BadRequestException There is an error in the call or in a SQL statement.

  • StatementTimeoutException The execution of the SQL statement timed out.

  • InternalServerErrorException An internal error occurred.

  • ForbiddenException There are insufficient privileges to make the call.

  • ServiceUnavailableError The service specified by the resourceArn parameter is not available.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ExecuteStatement

func (*RDSDataService) ExecuteStatementRequest added in v1.19.41 

func (c *RDSDataService) 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/rds-data-2018-08-01/ExecuteStatement

func (*RDSDataService) ExecuteStatementWithContext added in v1.19.41 

func (c *RDSDataService) 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 (*RDSDataService) RollbackTransaction added in v1.19.41 

func (c *RDSDataService) RollbackTransaction(input *RollbackTransactionInput) (*RollbackTransactionOutput, error)

RollbackTransaction API operation for AWS RDS DataService.

Performs a rollback of a transaction. Rolling back a transaction cancels its changes.

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 AWS RDS DataService's API operation RollbackTransaction for usage and error information.

Returned Error Types:

  • BadRequestException There is an error in the call or in a SQL statement.

  • StatementTimeoutException The execution of the SQL statement timed out.

  • InternalServerErrorException An internal error occurred.

  • ForbiddenException There are insufficient privileges to make the call.

  • ServiceUnavailableError The service specified by the resourceArn parameter is not available.

  • NotFoundException The resourceArn, secretArn, or transactionId value can't be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/RollbackTransaction

func (*RDSDataService) RollbackTransactionRequest added in v1.19.41 

func (c *RDSDataService) RollbackTransactionRequest(input *RollbackTransactionInput) (req *request.Request, output *RollbackTransactionOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/RollbackTransaction

func (*RDSDataService) RollbackTransactionWithContext added in v1.19.41 

func (c *RDSDataService) RollbackTransactionWithContext(ctx aws.Context, input *RollbackTransactionInput, opts ...request.Option) (*RollbackTransactionOutput, error)

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

See RollbackTransaction 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 Record 

type Record struct {

	// The values returned in the record.
	Values []*Value `locationName:"values" type:"list"`
	// contains filtered or unexported fields
}

A record returned by a call.

func (Record) GoString 

func (s Record) GoString() string

GoString returns the string representation

func (*Record) SetValues 

func (s *Record) SetValues(v []*Value) *Record

SetValues sets the Values field's value.

func (Record) String 

func (s Record) String() string

String returns the string representation

type ResultFrame 

type ResultFrame struct {

	// The records in the result set.
	Records []*Record `locationName:"records" type:"list"`

	// The result-set metadata in the result set.
	ResultSetMetadata *ResultSetMetadata `locationName:"resultSetMetadata" type:"structure"`
	// contains filtered or unexported fields
}

The result set returned by a SQL statement.

func (ResultFrame) GoString 

func (s ResultFrame) GoString() string

GoString returns the string representation

func (*ResultFrame) SetRecords 

func (s *ResultFrame) SetRecords(v []*Record) *ResultFrame

SetRecords sets the Records field's value.

func (*ResultFrame) SetResultSetMetadata 

func (s *ResultFrame) SetResultSetMetadata(v *ResultSetMetadata) *ResultFrame

SetResultSetMetadata sets the ResultSetMetadata field's value.

func (ResultFrame) String 

func (s ResultFrame) String() string

String returns the string representation

type ResultSetMetadata 

type ResultSetMetadata struct {

	// The number of columns in the result set.
	ColumnCount *int64 `locationName:"columnCount" type:"long"`

	// The metadata of the columns in the result set.
	ColumnMetadata []*ColumnMetadata `locationName:"columnMetadata" type:"list"`
	// contains filtered or unexported fields
}

The metadata of the result set returned by a SQL statement.

func (ResultSetMetadata) GoString 

func (s ResultSetMetadata) GoString() string

GoString returns the string representation

func (*ResultSetMetadata) SetColumnCount 

func (s *ResultSetMetadata) SetColumnCount(v int64) *ResultSetMetadata

SetColumnCount sets the ColumnCount field's value.

func (*ResultSetMetadata) SetColumnMetadata 

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

SetColumnMetadata sets the ColumnMetadata field's value.

func (ResultSetMetadata) String 

func (s ResultSetMetadata) String() string

String returns the string representation

type ResultSetOptions added in v1.24.4 

type ResultSetOptions struct {

	// A value that indicates how a field of DECIMAL type is represented in the
	// response. The value of STRING, the default, specifies that it is converted
	// to a String value. The value of DOUBLE_OR_LONG specifies that it is converted
	// to a Long value if its scale is 0, or to a Double value otherwise.
	//
	// Conversion to Double or Long can result in roundoff errors due to precision
	// loss. We recommend converting to String, especially when working with currency
	// values.
	DecimalReturnType *string `locationName:"decimalReturnType" type:"string" enum:"DecimalReturnType"`
	// contains filtered or unexported fields
}

Options that control how the result set is returned.

func (ResultSetOptions) GoString added in v1.24.4 

func (s ResultSetOptions) GoString() string

GoString returns the string representation

func (*ResultSetOptions) SetDecimalReturnType added in v1.24.4 

func (s *ResultSetOptions) SetDecimalReturnType(v string) *ResultSetOptions

SetDecimalReturnType sets the DecimalReturnType field's value.

func (ResultSetOptions) String added in v1.24.4 

func (s ResultSetOptions) String() string

String returns the string representation

type RollbackTransactionInput added in v1.19.41 

type RollbackTransactionInput struct {

	// The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"11" type:"string" required:"true"`

	// The name or ARN of the secret that enables access to the DB cluster.
	//
	// SecretArn is a required field
	SecretArn *string `locationName:"secretArn" min:"11" type:"string" required:"true"`

	// The identifier of the transaction to roll back.
	//
	// TransactionId is a required field
	TransactionId *string `locationName:"transactionId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request parameters represent the input of a request to perform a rollback of a transaction.

func (RollbackTransactionInput) GoString added in v1.19.41 

func (s RollbackTransactionInput) GoString() string

GoString returns the string representation

func (*RollbackTransactionInput) SetResourceArn added in v1.19.41 

func (s *RollbackTransactionInput) SetResourceArn(v string) *RollbackTransactionInput

SetResourceArn sets the ResourceArn field's value.

func (*RollbackTransactionInput) SetSecretArn added in v1.19.41 

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

SetSecretArn sets the SecretArn field's value.

func (*RollbackTransactionInput) SetTransactionId added in v1.19.41 

func (s *RollbackTransactionInput) SetTransactionId(v string) *RollbackTransactionInput

SetTransactionId sets the TransactionId field's value.

func (RollbackTransactionInput) String added in v1.19.41 

func (s RollbackTransactionInput) String() string

String returns the string representation

func (*RollbackTransactionInput) Validate added in v1.19.41 

func (s *RollbackTransactionInput) Validate() error

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

type RollbackTransactionOutput added in v1.19.41 

type RollbackTransactionOutput struct {

	// The status of the rollback operation.
	TransactionStatus *string `locationName:"transactionStatus" type:"string"`
	// contains filtered or unexported fields
}

The response elements represent the output of a request to perform a rollback of a transaction.

func (RollbackTransactionOutput) GoString added in v1.19.41 

func (s RollbackTransactionOutput) GoString() string

GoString returns the string representation

func (*RollbackTransactionOutput) SetTransactionStatus added in v1.19.41 

func (s *RollbackTransactionOutput) SetTransactionStatus(v string) *RollbackTransactionOutput

SetTransactionStatus sets the TransactionStatus field's value.

func (RollbackTransactionOutput) String added in v1.19.41 

func (s RollbackTransactionOutput) String() string

String returns the string representation

type ServiceUnavailableError added in v1.28.0 

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

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

The service specified by the resourceArn parameter is not available.

func (*ServiceUnavailableError) Code added in v1.28.0 

func (s *ServiceUnavailableError) Code() string

Code returns the exception type name.

func (*ServiceUnavailableError) Error added in v1.28.0 

func (s *ServiceUnavailableError) Error() string

func (ServiceUnavailableError) GoString added in v1.28.0 

func (s ServiceUnavailableError) GoString() string

GoString returns the string representation

func (*ServiceUnavailableError) Message added in v1.28.0 

func (s *ServiceUnavailableError) Message() string

Message returns the exception's message.

func (*ServiceUnavailableError) OrigErr added in v1.28.0 

func (s *ServiceUnavailableError) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceUnavailableError) RequestID added in v1.28.0 

func (s *ServiceUnavailableError) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceUnavailableError) StatusCode added in v1.28.0 

func (s *ServiceUnavailableError) StatusCode() int

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

func (ServiceUnavailableError) String added in v1.28.0 

func (s ServiceUnavailableError) String() string

String returns the string representation

type SqlParameter added in v1.19.41 

type SqlParameter struct {

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

	// A hint that specifies the correct object type for data type mapping. Possible
	// values are as follows:
	//
	//    * DATE - The corresponding String parameter value is sent as an object
	//    of DATE type to the database. The accepted format is YYYY-MM-DD.
	//
	//    * DECIMAL - The corresponding String parameter value is sent as an object
	//    of DECIMAL type to the database.
	//
	//    * JSON - The corresponding String parameter value is sent as an object
	//    of JSON type to the database.
	//
	//    * TIME - The corresponding String parameter value is sent as an object
	//    of TIME type to the database. The accepted format is HH:MM:SS[.FFF].
	//
	//    * TIMESTAMP - The corresponding String parameter value is sent as an object
	//    of TIMESTAMP type to the database. The accepted format is YYYY-MM-DD HH:MM:SS[.FFF].
	//
	//    * UUID - The corresponding String parameter value is sent as an object
	//    of UUID type to the database.
	TypeHint *string `locationName:"typeHint" type:"string" enum:"TypeHint"`

	// The value of the parameter.
	Value *Field `locationName:"value" type:"structure"`
	// contains filtered or unexported fields
}

A parameter used in a SQL statement.

func (SqlParameter) GoString added in v1.19.41 

func (s SqlParameter) GoString() string

GoString returns the string representation

func (*SqlParameter) SetName added in v1.19.41 

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

SetName sets the Name field's value.

func (*SqlParameter) SetTypeHint added in v1.25.43 

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

SetTypeHint sets the TypeHint field's value.

func (*SqlParameter) SetValue added in v1.19.41 

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

SetValue sets the Value field's value.

func (SqlParameter) String added in v1.19.41 

func (s SqlParameter) String() string

String returns the string representation

type SqlStatementResult 

type SqlStatementResult struct {

	// The number of records updated by a SQL statement.
	NumberOfRecordsUpdated *int64 `locationName:"numberOfRecordsUpdated" type:"long"`

	// The result set of the SQL statement.
	ResultFrame *ResultFrame `locationName:"resultFrame" type:"structure"`
	// contains filtered or unexported fields
}

The result of a SQL statement. 

<important> <p>This data type is deprecated.</p> </important>

func (SqlStatementResult) GoString 

func (s SqlStatementResult) GoString() string

GoString returns the string representation

func (*SqlStatementResult) SetNumberOfRecordsUpdated 

func (s *SqlStatementResult) SetNumberOfRecordsUpdated(v int64) *SqlStatementResult

SetNumberOfRecordsUpdated sets the NumberOfRecordsUpdated field's value.

func (*SqlStatementResult) SetResultFrame 

func (s *SqlStatementResult) SetResultFrame(v *ResultFrame) *SqlStatementResult

SetResultFrame sets the ResultFrame field's value.

func (SqlStatementResult) String 

func (s SqlStatementResult) String() string

String returns the string representation

type StatementTimeoutException added in v1.28.0 

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

	// The database connection ID that executed the SQL statement.
	DbConnectionId *int64 `locationName:"dbConnectionId" type:"long"`

	// The error message returned by this StatementTimeoutException error.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The execution of the SQL statement timed out.

func (*StatementTimeoutException) Code added in v1.28.0 

func (s *StatementTimeoutException) Code() string

Code returns the exception type name.

func (*StatementTimeoutException) Error added in v1.28.0 

func (s *StatementTimeoutException) Error() string

func (StatementTimeoutException) GoString added in v1.28.0 

func (s StatementTimeoutException) GoString() string

GoString returns the string representation

func (*StatementTimeoutException) Message added in v1.28.0 

func (s *StatementTimeoutException) Message() string

Message returns the exception's message.

func (*StatementTimeoutException) OrigErr added in v1.28.0 

func (s *StatementTimeoutException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*StatementTimeoutException) RequestID added in v1.28.0 

func (s *StatementTimeoutException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*StatementTimeoutException) StatusCode added in v1.28.0 

func (s *StatementTimeoutException) StatusCode() int

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

func (StatementTimeoutException) String added in v1.28.0 

func (s StatementTimeoutException) String() string

String returns the string representation

type StructValue 

type StructValue struct {

	// The attributes returned in the record.
	Attributes []*Value `locationName:"attributes" type:"list"`
	// contains filtered or unexported fields
}

A structure value returned by a call.

func (StructValue) GoString 

func (s StructValue) GoString() string

GoString returns the string representation

func (*StructValue) SetAttributes 

func (s *StructValue) SetAttributes(v []*Value) *StructValue

SetAttributes sets the Attributes field's value.

func (StructValue) String 

func (s StructValue) String() string

String returns the string representation

type UpdateResult added in v1.19.41 

type UpdateResult struct {

	// Values for fields generated during the request.
	GeneratedFields []*Field `locationName:"generatedFields" type:"list"`
	// contains filtered or unexported fields
}

The response elements represent the results of an update.

func (UpdateResult) GoString added in v1.19.41 

func (s UpdateResult) GoString() string

GoString returns the string representation

func (*UpdateResult) SetGeneratedFields added in v1.19.41 

func (s *UpdateResult) SetGeneratedFields(v []*Field) *UpdateResult

SetGeneratedFields sets the GeneratedFields field's value.

func (UpdateResult) String added in v1.19.41 

func (s UpdateResult) String() string

String returns the string representation

type Value 

type Value struct {

	// An array of column values.
	ArrayValues []*Value `locationName:"arrayValues" type:"list"`

	// A value for a column of big integer data type.
	BigIntValue *int64 `locationName:"bigIntValue" type:"long"`

	// A value for a column of BIT data type.
	BitValue *bool `locationName:"bitValue" type:"boolean"`

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

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

	// A value for a column of integer data type.
	IntValue *int64 `locationName:"intValue" type:"integer"`

	// A NULL value.
	IsNull *bool `locationName:"isNull" type:"boolean"`

	// A value for a column of real data type.
	RealValue *float64 `locationName:"realValue" type:"float"`

	// A value for a column of string data type.
	StringValue *string `locationName:"stringValue" type:"string"`

	// A value for a column of STRUCT data type.
	StructValue *StructValue `locationName:"structValue" type:"structure"`
	// contains filtered or unexported fields
}

Contains the value of a column. 

<important> <p>This data type is deprecated.</p> </important>

func (Value) GoString 

func (s Value) GoString() string

GoString returns the string representation

func (*Value) SetArrayValues 

func (s *Value) SetArrayValues(v []*Value) *Value

SetArrayValues sets the ArrayValues field's value.

func (*Value) SetBigIntValue 

func (s *Value) SetBigIntValue(v int64) *Value

SetBigIntValue sets the BigIntValue field's value.

func (*Value) SetBitValue 

func (s *Value) SetBitValue(v bool) *Value

SetBitValue sets the BitValue field's value.

func (*Value) SetBlobValue 

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

SetBlobValue sets the BlobValue field's value.

func (*Value) SetDoubleValue 

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

SetDoubleValue sets the DoubleValue field's value.

func (*Value) SetIntValue 

func (s *Value) SetIntValue(v int64) *Value

SetIntValue sets the IntValue field's value.

func (*Value) SetIsNull 

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

SetIsNull sets the IsNull field's value.

func (*Value) SetRealValue 

func (s *Value) SetRealValue(v float64) *Value

SetRealValue sets the RealValue field's value.

func (*Value) SetStringValue 

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

SetStringValue sets the StringValue field's value.

func (*Value) SetStructValue 

func (s *Value) SetStructValue(v *StructValue) *Value

SetStructValue sets the StructValue field's value.

func (Value) String 

func (s Value) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package rdsdataserviceiface provides an interface to enable mocking the AWS RDS DataService service client for testing your code.
 Package rdsdataserviceiface provides an interface to enable mocking the AWS RDS DataService 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.