types

package
v1.21.4 Latest Latest
Warning

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

Go to latest
Published: Mar 29, 2024 License: Apache-2.0 Imports: 3 Imported by: 5

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException added in v1.12.0

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You don't have sufficient access to perform this action.

func (*AccessDeniedException) Error added in v1.12.0

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode added in v1.12.0

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault added in v1.12.0

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage added in v1.12.0

func (e *AccessDeniedException) ErrorMessage() string

type ArrayValue

type ArrayValue interface {
	// contains filtered or unexported methods
}

Contains an array.

The following types satisfy this interface:

ArrayValueMemberArrayValues
ArrayValueMemberBooleanValues
ArrayValueMemberDoubleValues
ArrayValueMemberLongValues
ArrayValueMemberStringValues
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/rdsdata/types"
)

func main() {
	var union types.ArrayValue
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ArrayValueMemberArrayValues:
		_ = v.Value // Value is []types.ArrayValue

	case *types.ArrayValueMemberBooleanValues:
		_ = v.Value // Value is []bool

	case *types.ArrayValueMemberDoubleValues:
		_ = v.Value // Value is []float64

	case *types.ArrayValueMemberLongValues:
		_ = v.Value // Value is []int64

	case *types.ArrayValueMemberStringValues:
		_ = v.Value // Value is []string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type ArrayValueMemberArrayValues

type ArrayValueMemberArrayValues struct {
	Value []ArrayValue
	// contains filtered or unexported fields
}

An array of arrays.

type ArrayValueMemberBooleanValues

type ArrayValueMemberBooleanValues struct {
	Value []bool
	// contains filtered or unexported fields
}

An array of Boolean values.

type ArrayValueMemberDoubleValues

type ArrayValueMemberDoubleValues struct {
	Value []float64
	// contains filtered or unexported fields
}

An array of floating-point numbers.

type ArrayValueMemberLongValues

type ArrayValueMemberLongValues struct {
	Value []int64
	// contains filtered or unexported fields
}

An array of integers.

type ArrayValueMemberStringValues

type ArrayValueMemberStringValues struct {
	Value []string
	// contains filtered or unexported fields
}

An array of strings.

type BadRequestException

type BadRequestException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

There is an error in the call or in a SQL statement. (This error only appears in calls from Aurora Serverless v1 databases.)

func (*BadRequestException) Error

func (e *BadRequestException) Error() string

func (*BadRequestException) ErrorCode

func (e *BadRequestException) ErrorCode() string

func (*BadRequestException) ErrorFault

func (e *BadRequestException) ErrorFault() smithy.ErrorFault

func (*BadRequestException) ErrorMessage

func (e *BadRequestException) ErrorMessage() string

type ColumnMetadata

type ColumnMetadata struct {

	// The type of the column.
	ArrayBaseColumnType int32

	// A value that indicates whether the column increments automatically.
	IsAutoIncrement bool

	// A value that indicates whether the column is case-sensitive.
	IsCaseSensitive bool

	// A value that indicates whether the column contains currency values.
	IsCurrency bool

	// A value that indicates whether an integer column is signed.
	IsSigned bool

	// The label for the column.
	Label *string

	// The name of the column.
	Name *string

	// A value that indicates whether the column is nullable.
	Nullable int32

	// The precision value of a decimal number column.
	Precision int32

	// The scale value of a decimal number column.
	Scale int32

	// The name of the schema that owns the table that includes the column.
	SchemaName *string

	// The name of the table that includes the column.
	TableName *string

	// The type of the column.
	Type int32

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

Contains the metadata for a column.

type DatabaseErrorException added in v1.19.0

type DatabaseErrorException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

There was an error in processing the SQL statement.

func (*DatabaseErrorException) Error added in v1.19.0

func (e *DatabaseErrorException) Error() string

func (*DatabaseErrorException) ErrorCode added in v1.19.0

func (e *DatabaseErrorException) ErrorCode() string

func (*DatabaseErrorException) ErrorFault added in v1.19.0

func (e *DatabaseErrorException) ErrorFault() smithy.ErrorFault

func (*DatabaseErrorException) ErrorMessage added in v1.19.0

func (e *DatabaseErrorException) ErrorMessage() string

type DatabaseNotFoundException added in v1.19.0

type DatabaseNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The DB cluster doesn't have a DB instance.

func (*DatabaseNotFoundException) Error added in v1.19.0

func (e *DatabaseNotFoundException) Error() string

func (*DatabaseNotFoundException) ErrorCode added in v1.19.0

func (e *DatabaseNotFoundException) ErrorCode() string

func (*DatabaseNotFoundException) ErrorFault added in v1.19.0

func (*DatabaseNotFoundException) ErrorMessage added in v1.19.0

func (e *DatabaseNotFoundException) ErrorMessage() string

type DatabaseUnavailableException added in v1.19.0

type DatabaseUnavailableException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The writer instance in the DB cluster isn't available.

func (*DatabaseUnavailableException) Error added in v1.19.0

func (*DatabaseUnavailableException) ErrorCode added in v1.19.0

func (e *DatabaseUnavailableException) ErrorCode() string

func (*DatabaseUnavailableException) ErrorFault added in v1.19.0

func (*DatabaseUnavailableException) ErrorMessage added in v1.19.0

func (e *DatabaseUnavailableException) ErrorMessage() string

type DecimalReturnType

type DecimalReturnType string
const (
	DecimalReturnTypeString       DecimalReturnType = "STRING"
	DecimalReturnTypeDoubleOrLong DecimalReturnType = "DOUBLE_OR_LONG"
)

Enum values for DecimalReturnType

func (DecimalReturnType) Values added in v0.29.0

Values returns all known values for DecimalReturnType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Field

type Field interface {
	// contains filtered or unexported methods
}

Contains a value.

The following types satisfy this interface:

FieldMemberArrayValue
FieldMemberBlobValue
FieldMemberBooleanValue
FieldMemberDoubleValue
FieldMemberIsNull
FieldMemberLongValue
FieldMemberStringValue
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/rdsdata/types"
)

func main() {
	var union types.Field
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.FieldMemberArrayValue:
		_ = v.Value // Value is types.ArrayValue

	case *types.FieldMemberBlobValue:
		_ = v.Value // Value is []byte

	case *types.FieldMemberBooleanValue:
		_ = v.Value // Value is bool

	case *types.FieldMemberDoubleValue:
		_ = v.Value // Value is float64

	case *types.FieldMemberIsNull:
		_ = v.Value // Value is bool

	case *types.FieldMemberLongValue:
		_ = v.Value // Value is int64

	case *types.FieldMemberStringValue:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type FieldMemberArrayValue

type FieldMemberArrayValue struct {
	Value ArrayValue
	// contains filtered or unexported fields
}

An array of values.

type FieldMemberBlobValue

type FieldMemberBlobValue struct {
	Value []byte
	// contains filtered or unexported fields
}

A value of BLOB data type.

type FieldMemberBooleanValue

type FieldMemberBooleanValue struct {
	Value bool
	// contains filtered or unexported fields
}

A value of Boolean data type.

type FieldMemberDoubleValue

type FieldMemberDoubleValue struct {
	Value float64
	// contains filtered or unexported fields
}

A value of double data type.

type FieldMemberIsNull

type FieldMemberIsNull struct {
	Value bool
	// contains filtered or unexported fields
}

A NULL value.

type FieldMemberLongValue

type FieldMemberLongValue struct {
	Value int64
	// contains filtered or unexported fields
}

A value of long data type.

type FieldMemberStringValue

type FieldMemberStringValue struct {
	Value string
	// contains filtered or unexported fields
}

A value of string data type.

type ForbiddenException

type ForbiddenException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

There are insufficient privileges to make the call.

func (*ForbiddenException) Error

func (e *ForbiddenException) Error() string

func (*ForbiddenException) ErrorCode

func (e *ForbiddenException) ErrorCode() string

func (*ForbiddenException) ErrorFault

func (e *ForbiddenException) ErrorFault() smithy.ErrorFault

func (*ForbiddenException) ErrorMessage

func (e *ForbiddenException) ErrorMessage() string

type HttpEndpointNotEnabledException added in v1.19.0

type HttpEndpointNotEnabledException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The HTTP endpoint for using RDS Data API isn't enabled for the DB cluster.

func (*HttpEndpointNotEnabledException) Error added in v1.19.0

func (*HttpEndpointNotEnabledException) ErrorCode added in v1.19.0

func (e *HttpEndpointNotEnabledException) ErrorCode() string

func (*HttpEndpointNotEnabledException) ErrorFault added in v1.19.0

func (*HttpEndpointNotEnabledException) ErrorMessage added in v1.19.0

func (e *HttpEndpointNotEnabledException) ErrorMessage() string

type InternalServerErrorException

type InternalServerErrorException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An internal error occurred.

func (*InternalServerErrorException) Error

func (*InternalServerErrorException) ErrorCode

func (e *InternalServerErrorException) ErrorCode() string

func (*InternalServerErrorException) ErrorFault

func (*InternalServerErrorException) ErrorMessage

func (e *InternalServerErrorException) ErrorMessage() string

type InvalidSecretException added in v1.19.0

type InvalidSecretException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The Secrets Manager secret used with the request isn't valid.

func (*InvalidSecretException) Error added in v1.19.0

func (e *InvalidSecretException) Error() string

func (*InvalidSecretException) ErrorCode added in v1.19.0

func (e *InvalidSecretException) ErrorCode() string

func (*InvalidSecretException) ErrorFault added in v1.19.0

func (e *InvalidSecretException) ErrorFault() smithy.ErrorFault

func (*InvalidSecretException) ErrorMessage added in v1.19.0

func (e *InvalidSecretException) ErrorMessage() string

type LongReturnType added in v1.12.0

type LongReturnType string
const (
	LongReturnTypeString LongReturnType = "STRING"
	LongReturnTypeLong   LongReturnType = "LONG"
)

Enum values for LongReturnType

func (LongReturnType) Values added in v1.12.0

func (LongReturnType) Values() []LongReturnType

Values returns all known values for LongReturnType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type NotFoundException

type NotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*NotFoundException) Error

func (e *NotFoundException) Error() string

func (*NotFoundException) ErrorCode

func (e *NotFoundException) ErrorCode() string

func (*NotFoundException) ErrorFault

func (e *NotFoundException) ErrorFault() smithy.ErrorFault

func (*NotFoundException) ErrorMessage

func (e *NotFoundException) ErrorMessage() string

type Record

type Record struct {

	// The values returned in the record.
	Values []Value
	// contains filtered or unexported fields
}

A record returned by a call. This data structure is only used with the deprecated ExecuteSql operation. Use the BatchExecuteStatement or ExecuteStatement operation instead.

type RecordsFormatType added in v1.12.0

type RecordsFormatType string
const (
	RecordsFormatTypeNone RecordsFormatType = "NONE"
	RecordsFormatTypeJson RecordsFormatType = "JSON"
)

Enum values for RecordsFormatType

func (RecordsFormatType) Values added in v1.12.0

Values returns all known values for RecordsFormatType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ResultFrame

type ResultFrame struct {

	// The records in the result set.
	Records []Record

	// The result-set metadata in the result set.
	ResultSetMetadata *ResultSetMetadata
	// contains filtered or unexported fields
}

The result set returned by a SQL statement. This data structure is only used with the deprecated ExecuteSql operation. Use the BatchExecuteStatement or ExecuteStatement operation instead.

type ResultSetMetadata

type ResultSetMetadata struct {

	// The number of columns in the result set.
	ColumnCount int64

	// The metadata of the columns in the result set.
	ColumnMetadata []ColumnMetadata
	// contains filtered or unexported fields
}

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

type ResultSetOptions

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 DecimalReturnType

	// A value that indicates how a field of LONG type is represented. Allowed values
	// are LONG and STRING . The default is LONG . Specify STRING if the length or
	// precision of numeric values might cause truncation or rounding errors.
	LongReturnType LongReturnType
	// contains filtered or unexported fields
}

Options that control how the result set is returned.

type SecretsErrorException added in v1.19.0

type SecretsErrorException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

There was a problem with the Secrets Manager secret used with the request, caused by one of the following conditions:

  • RDS Data API timed out retrieving the secret.
  • The secret provided wasn't found.
  • The secret couldn't be decrypted.

func (*SecretsErrorException) Error added in v1.19.0

func (e *SecretsErrorException) Error() string

func (*SecretsErrorException) ErrorCode added in v1.19.0

func (e *SecretsErrorException) ErrorCode() string

func (*SecretsErrorException) ErrorFault added in v1.19.0

func (e *SecretsErrorException) ErrorFault() smithy.ErrorFault

func (*SecretsErrorException) ErrorMessage added in v1.19.0

func (e *SecretsErrorException) ErrorMessage() string

type ServiceUnavailableError

type ServiceUnavailableError struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The service specified by the resourceArn parameter isn't available.

func (*ServiceUnavailableError) Error

func (e *ServiceUnavailableError) Error() string

func (*ServiceUnavailableError) ErrorCode

func (e *ServiceUnavailableError) ErrorCode() string

func (*ServiceUnavailableError) ErrorFault

func (e *ServiceUnavailableError) ErrorFault() smithy.ErrorFault

func (*ServiceUnavailableError) ErrorMessage

func (e *ServiceUnavailableError) ErrorMessage() string

type SqlParameter

type SqlParameter struct {

	// The name of the parameter.
	Name *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 TypeHint

	// The value of the parameter.
	Value Field
	// contains filtered or unexported fields
}

A parameter used in a SQL statement.

type SqlStatementResult

type SqlStatementResult struct {

	// The number of records updated by a SQL statement.
	NumberOfRecordsUpdated int64

	// The result set of the SQL statement.
	ResultFrame *ResultFrame
	// contains filtered or unexported fields
}

The result of a SQL statement. This data structure is only used with the deprecated ExecuteSql operation. Use the BatchExecuteStatement or ExecuteStatement operation instead.

type StatementTimeoutException

type StatementTimeoutException struct {
	Message *string

	ErrorCodeOverride *string

	DbConnectionId int64
	// contains filtered or unexported fields
}

The execution of the SQL statement timed out.

func (*StatementTimeoutException) Error

func (e *StatementTimeoutException) Error() string

func (*StatementTimeoutException) ErrorCode

func (e *StatementTimeoutException) ErrorCode() string

func (*StatementTimeoutException) ErrorFault

func (*StatementTimeoutException) ErrorMessage

func (e *StatementTimeoutException) ErrorMessage() string

type StructValue

type StructValue struct {

	// The attributes returned in the record.
	Attributes []Value
	// contains filtered or unexported fields
}

A structure value returned by a call. This data structure is only used with the deprecated ExecuteSql operation. Use the BatchExecuteStatement or ExecuteStatement operation instead.

type TransactionNotFoundException added in v1.19.0

type TransactionNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The transaction ID wasn't found.

func (*TransactionNotFoundException) Error added in v1.19.0

func (*TransactionNotFoundException) ErrorCode added in v1.19.0

func (e *TransactionNotFoundException) ErrorCode() string

func (*TransactionNotFoundException) ErrorFault added in v1.19.0

func (*TransactionNotFoundException) ErrorMessage added in v1.19.0

func (e *TransactionNotFoundException) ErrorMessage() string

type TypeHint

type TypeHint string
const (
	TypeHintJson      TypeHint = "JSON"
	TypeHintUuid      TypeHint = "UUID"
	TypeHintTimestamp TypeHint = "TIMESTAMP"
	TypeHintDate      TypeHint = "DATE"
	TypeHintTime      TypeHint = "TIME"
	TypeHintDecimal   TypeHint = "DECIMAL"
)

Enum values for TypeHint

func (TypeHint) Values added in v0.29.0

func (TypeHint) Values() []TypeHint

Values returns all known values for TypeHint. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type UnknownUnionMember

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type UnsupportedResultException added in v1.19.0

type UnsupportedResultException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

There was a problem with the result because of one of the following conditions:

  • It contained an unsupported data type.
  • It contained a multidimensional array.
  • The size was too large.

func (*UnsupportedResultException) Error added in v1.19.0

func (*UnsupportedResultException) ErrorCode added in v1.19.0

func (e *UnsupportedResultException) ErrorCode() string

func (*UnsupportedResultException) ErrorFault added in v1.19.0

func (*UnsupportedResultException) ErrorMessage added in v1.19.0

func (e *UnsupportedResultException) ErrorMessage() string

type UpdateResult

type UpdateResult struct {

	// Values for fields generated during the request.
	GeneratedFields []Field
	// contains filtered or unexported fields
}

The response elements represent the results of an update.

type Value

type Value interface {
	// contains filtered or unexported methods
}

Contains the value of a column. This data structure is only used with the deprecated ExecuteSql operation. Use the BatchExecuteStatement or ExecuteStatement operation instead.

The following types satisfy this interface:

ValueMemberArrayValues
ValueMemberBigIntValue
ValueMemberBitValue
ValueMemberBlobValue
ValueMemberDoubleValue
ValueMemberIntValue
ValueMemberIsNull
ValueMemberRealValue
ValueMemberStringValue
ValueMemberStructValue
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/rdsdata/types"
)

func main() {
	var union types.Value
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ValueMemberArrayValues:
		_ = v.Value // Value is []types.Value

	case *types.ValueMemberBigIntValue:
		_ = v.Value // Value is int64

	case *types.ValueMemberBitValue:
		_ = v.Value // Value is bool

	case *types.ValueMemberBlobValue:
		_ = v.Value // Value is []byte

	case *types.ValueMemberDoubleValue:
		_ = v.Value // Value is float64

	case *types.ValueMemberIntValue:
		_ = v.Value // Value is int32

	case *types.ValueMemberIsNull:
		_ = v.Value // Value is bool

	case *types.ValueMemberRealValue:
		_ = v.Value // Value is float32

	case *types.ValueMemberStringValue:
		_ = v.Value // Value is string

	case *types.ValueMemberStructValue:
		_ = v.Value // Value is types.StructValue

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type ValueMemberArrayValues

type ValueMemberArrayValues struct {
	Value []Value
	// contains filtered or unexported fields
}

An array of column values.

type ValueMemberBigIntValue

type ValueMemberBigIntValue struct {
	Value int64
	// contains filtered or unexported fields
}

A value for a column of big integer data type.

type ValueMemberBitValue

type ValueMemberBitValue struct {
	Value bool
	// contains filtered or unexported fields
}

A value for a column of BIT data type.

type ValueMemberBlobValue

type ValueMemberBlobValue struct {
	Value []byte
	// contains filtered or unexported fields
}

A value for a column of BLOB data type.

type ValueMemberDoubleValue

type ValueMemberDoubleValue struct {
	Value float64
	// contains filtered or unexported fields
}

A value for a column of double data type.

type ValueMemberIntValue

type ValueMemberIntValue struct {
	Value int32
	// contains filtered or unexported fields
}

A value for a column of integer data type.

type ValueMemberIsNull

type ValueMemberIsNull struct {
	Value bool
	// contains filtered or unexported fields
}

A NULL value.

type ValueMemberRealValue

type ValueMemberRealValue struct {
	Value float32
	// contains filtered or unexported fields
}

A value for a column of real data type.

type ValueMemberStringValue

type ValueMemberStringValue struct {
	Value string
	// contains filtered or unexported fields
}

A value for a column of string data type.

type ValueMemberStructValue

type ValueMemberStructValue struct {
	Value StructValue
	// contains filtered or unexported fields
}

A value for a column of STRUCT data type.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL