...
AWS SDK for Go API Reference
import "github.com/aws/aws-sdk-go/service/qldbsession"
Overview
Constants

Overview ▾

Package qldbsession provides the client and types for making API requests to Amazon QLDB Session.

The transactional data APIs for Amazon QLDB

Instead of interacting directly with this API, we recommend using the QLDB driver or the QLDB shell to execute data transactions on a ledger.

* If you are working with an AWS SDK, use the QLDB driver. The driver
provides a high-level abstraction layer above this QLDB Session data plane
and manages SendCommand API calls for you. For information and a list
of supported programming languages, see Getting started with the driver
(https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-driver.html)
in the Amazon QLDB Developer Guide.

* If you are working with the AWS Command Line Interface (AWS CLI), use
the QLDB shell. The shell is a command line interface that uses the QLDB
driver to interact with a ledger. For information, see Accessing Amazon
QLDB using the QLDB shell (https://docs.aws.amazon.com/qldb/latest/developerguide/data-shell.html).

See https://docs.aws.amazon.com/goto/WebAPI/qldb-session-2019-07-11 for more information on this service.

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

Using the Client

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

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

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

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

The stub package, qldbsessioniface, can be used to provide alternative implementations of service clients, such as mocking the client for testing.

Operations ▾

Constants ▾

const (

    // ErrCodeBadRequestException for service response error code
    // "BadRequestException".
    //
    // Returned if the request is malformed or contains an error such as an invalid
    // parameter value or a missing required parameter.
    ErrCodeBadRequestException = "BadRequestException"

    // ErrCodeCapacityExceededException for service response error code
    // "CapacityExceededException".
    //
    // Returned when the request exceeds the processing capacity of the ledger.
    ErrCodeCapacityExceededException = "CapacityExceededException"

    // ErrCodeInvalidSessionException for service response error code
    // "InvalidSessionException".
    //
    // Returned if the session doesn't exist anymore because it timed out or expired.
    ErrCodeInvalidSessionException = "InvalidSessionException"

    // ErrCodeLimitExceededException for service response error code
    // "LimitExceededException".
    //
    // Returned if a resource limit such as number of active sessions is exceeded.
    ErrCodeLimitExceededException = "LimitExceededException"

    // ErrCodeOccConflictException for service response error code
    // "OccConflictException".
    //
    // Returned when a transaction cannot be written to the journal due to a failure
    // in the verification phase of optimistic concurrency control (OCC).
    ErrCodeOccConflictException = "OccConflictException"

    // ErrCodeRateExceededException for service response error code
    // "RateExceededException".
    //
    // Returned when the rate of requests exceeds the allowed throughput.
    ErrCodeRateExceededException = "RateExceededException"
)
const (
    ServiceName = "QLDB Session" // Name of service.
    EndpointsID = "session.qldb" // ID to lookup a service endpoint with.
    ServiceID   = "QLDB Session" // ServiceID is a unique identifier of a specific service.
)

Service information constants

type AbortTransactionRequest

type AbortTransactionRequest struct {
    // contains filtered or unexported fields
}

Contains the details of the transaction to abort.

func (AbortTransactionRequest) GoString

func (s AbortTransactionRequest) GoString() string

GoString returns the string representation

func (AbortTransactionRequest) String

func (s AbortTransactionRequest) String() string

String returns the string representation

type AbortTransactionResult

type AbortTransactionResult struct {

    // Contains server-side performance information for the command.
    TimingInformation *TimingInformation `type:"structure"`
    // contains filtered or unexported fields
}

Contains the details of the aborted transaction.

func (AbortTransactionResult) GoString

func (s AbortTransactionResult) GoString() string

GoString returns the string representation

func (*AbortTransactionResult) SetTimingInformation

func (s *AbortTransactionResult) SetTimingInformation(v *TimingInformation) *AbortTransactionResult

SetTimingInformation sets the TimingInformation field's value.

func (AbortTransactionResult) String

func (s AbortTransactionResult) String() string

String returns the string representation

type BadRequestException

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

    Code_ *string `locationName:"Code" type:"string"`

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

Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

func (*BadRequestException) Code

func (s *BadRequestException) Code() string

Code returns the exception type name.

func (*BadRequestException) Error

func (s *BadRequestException) Error() string

func (BadRequestException) GoString

func (s BadRequestException) GoString() string

GoString returns the string representation

func (*BadRequestException) Message

func (s *BadRequestException) Message() string

Message returns the exception's message.

func (*BadRequestException) OrigErr

func (s *BadRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BadRequestException) RequestID

func (s *BadRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadRequestException) StatusCode

func (s *BadRequestException) StatusCode() int

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

func (BadRequestException) String

func (s BadRequestException) String() string

String returns the string representation

type CapacityExceededException

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

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

Returned when the request exceeds the processing capacity of the ledger.

func (*CapacityExceededException) Code

func (s *CapacityExceededException) Code() string

Code returns the exception type name.

func (*CapacityExceededException) Error

func (s *CapacityExceededException) Error() string

func (CapacityExceededException) GoString

func (s CapacityExceededException) GoString() string

GoString returns the string representation

func (*CapacityExceededException) Message

func (s *CapacityExceededException) Message() string

Message returns the exception's message.

func (*CapacityExceededException) OrigErr

func (s *CapacityExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*CapacityExceededException) RequestID

func (s *CapacityExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*CapacityExceededException) StatusCode

func (s *CapacityExceededException) StatusCode() int

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

func (CapacityExceededException) String

func (s CapacityExceededException) String() string

String returns the string representation

type CommitTransactionRequest

type CommitTransactionRequest struct {

    // Specifies the commit digest for the transaction to commit. For every active
    // transaction, the commit digest must be passed. QLDB validates CommitDigest
    // and rejects the commit with an error if the digest computed on the client
    // does not match the digest computed by QLDB.
    //
    // The purpose of the CommitDigest parameter is to ensure that QLDB commits
    // a transaction if and only if the server has processed the exact set of statements
    // sent by the client, in the same order that client sent them, and with no
    // duplicates.
    //
    // CommitDigest is automatically base64 encoded/decoded by the SDK.
    //
    // CommitDigest is a required field
    CommitDigest []byte `type:"blob" required:"true"`

    // Specifies the transaction ID of the transaction to commit.
    //
    // TransactionId is a required field
    TransactionId *string `min:"22" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Contains the details of the transaction to commit.

func (CommitTransactionRequest) GoString

func (s CommitTransactionRequest) GoString() string

GoString returns the string representation

func (*CommitTransactionRequest) SetCommitDigest

func (s *CommitTransactionRequest) SetCommitDigest(v []byte) *CommitTransactionRequest

SetCommitDigest sets the CommitDigest field's value.

func (*CommitTransactionRequest) SetTransactionId

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

SetTransactionId sets the TransactionId field's value.

func (CommitTransactionRequest) String

func (s CommitTransactionRequest) String() string

String returns the string representation

func (*CommitTransactionRequest) Validate

func (s *CommitTransactionRequest) Validate() error

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

type CommitTransactionResult

type CommitTransactionResult struct {

    // The commit digest of the committed transaction.
    //
    // CommitDigest is automatically base64 encoded/decoded by the SDK.
    CommitDigest []byte `type:"blob"`

    // Contains metrics about the number of I/O requests that were consumed.
    ConsumedIOs *IOUsage `type:"structure"`

    // Contains server-side performance information for the command.
    TimingInformation *TimingInformation `type:"structure"`

    // The transaction ID of the committed transaction.
    TransactionId *string `min:"22" type:"string"`
    // contains filtered or unexported fields
}

Contains the details of the committed transaction.

func (CommitTransactionResult) GoString

func (s CommitTransactionResult) GoString() string

GoString returns the string representation

func (*CommitTransactionResult) SetCommitDigest

func (s *CommitTransactionResult) SetCommitDigest(v []byte) *CommitTransactionResult

SetCommitDigest sets the CommitDigest field's value.

func (*CommitTransactionResult) SetConsumedIOs

func (s *CommitTransactionResult) SetConsumedIOs(v *IOUsage) *CommitTransactionResult

SetConsumedIOs sets the ConsumedIOs field's value.

func (*CommitTransactionResult) SetTimingInformation

func (s *CommitTransactionResult) SetTimingInformation(v *TimingInformation) *CommitTransactionResult

SetTimingInformation sets the TimingInformation field's value.

func (*CommitTransactionResult) SetTransactionId

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

SetTransactionId sets the TransactionId field's value.

func (CommitTransactionResult) String

func (s CommitTransactionResult) String() string

String returns the string representation

type EndSessionRequest

type EndSessionRequest struct {
    // contains filtered or unexported fields
}

Specifies a request to end the session.

func (EndSessionRequest) GoString

func (s EndSessionRequest) GoString() string

GoString returns the string representation

func (EndSessionRequest) String

func (s EndSessionRequest) String() string

String returns the string representation

type EndSessionResult

type EndSessionResult struct {

    // Contains server-side performance information for the command.
    TimingInformation *TimingInformation `type:"structure"`
    // contains filtered or unexported fields
}

Contains the details of the ended session.

func (EndSessionResult) GoString

func (s EndSessionResult) GoString() string

GoString returns the string representation

func (*EndSessionResult) SetTimingInformation

func (s *EndSessionResult) SetTimingInformation(v *TimingInformation) *EndSessionResult

SetTimingInformation sets the TimingInformation field's value.

func (EndSessionResult) String

func (s EndSessionResult) String() string

String returns the string representation

type ExecuteStatementRequest

type ExecuteStatementRequest struct {

    // Specifies the parameters for the parameterized statement in the request.
    Parameters []*ValueHolder `type:"list"`

    // Specifies the statement of the request.
    //
    // Statement is a required field
    Statement *string `min:"1" type:"string" required:"true"`

    // Specifies the transaction ID of the request.
    //
    // TransactionId is a required field
    TransactionId *string `min:"22" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Specifies a request to execute a statement.

func (ExecuteStatementRequest) GoString

func (s ExecuteStatementRequest) GoString() string

GoString returns the string representation

func (*ExecuteStatementRequest) SetParameters

func (s *ExecuteStatementRequest) SetParameters(v []*ValueHolder) *ExecuteStatementRequest

SetParameters sets the Parameters field's value.

func (*ExecuteStatementRequest) SetStatement

func (s *ExecuteStatementRequest) SetStatement(v string) *ExecuteStatementRequest

SetStatement sets the Statement field's value.

func (*ExecuteStatementRequest) SetTransactionId

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

SetTransactionId sets the TransactionId field's value.

func (ExecuteStatementRequest) String

func (s ExecuteStatementRequest) String() string

String returns the string representation

func (*ExecuteStatementRequest) Validate

func (s *ExecuteStatementRequest) Validate() error

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

type ExecuteStatementResult

type ExecuteStatementResult struct {

    // Contains metrics about the number of I/O requests that were consumed.
    ConsumedIOs *IOUsage `type:"structure"`

    // Contains the details of the first fetched page.
    FirstPage *Page `type:"structure"`

    // Contains server-side performance information for the command.
    TimingInformation *TimingInformation `type:"structure"`
    // contains filtered or unexported fields
}

Contains the details of the executed statement.

func (ExecuteStatementResult) GoString

func (s ExecuteStatementResult) GoString() string

GoString returns the string representation

func (*ExecuteStatementResult) SetConsumedIOs

func (s *ExecuteStatementResult) SetConsumedIOs(v *IOUsage) *ExecuteStatementResult

SetConsumedIOs sets the ConsumedIOs field's value.

func (*ExecuteStatementResult) SetFirstPage

func (s *ExecuteStatementResult) SetFirstPage(v *Page) *ExecuteStatementResult

SetFirstPage sets the FirstPage field's value.

func (*ExecuteStatementResult) SetTimingInformation

func (s *ExecuteStatementResult) SetTimingInformation(v *TimingInformation) *ExecuteStatementResult

SetTimingInformation sets the TimingInformation field's value.

func (ExecuteStatementResult) String

func (s ExecuteStatementResult) String() string

String returns the string representation

type FetchPageRequest

type FetchPageRequest struct {

    // Specifies the next page token of the page to be fetched.
    //
    // NextPageToken is a required field
    NextPageToken *string `min:"4" type:"string" required:"true"`

    // Specifies the transaction ID of the page to be fetched.
    //
    // TransactionId is a required field
    TransactionId *string `min:"22" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Specifies the details of the page to be fetched.

func (FetchPageRequest) GoString

func (s FetchPageRequest) GoString() string

GoString returns the string representation

func (*FetchPageRequest) SetNextPageToken

func (s *FetchPageRequest) SetNextPageToken(v string) *FetchPageRequest

SetNextPageToken sets the NextPageToken field's value.

func (*FetchPageRequest) SetTransactionId

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

SetTransactionId sets the TransactionId field's value.

func (FetchPageRequest) String

func (s FetchPageRequest) String() string

String returns the string representation

func (*FetchPageRequest) Validate

func (s *FetchPageRequest) Validate() error

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

type FetchPageResult

type FetchPageResult struct {

    // Contains metrics about the number of I/O requests that were consumed.
    ConsumedIOs *IOUsage `type:"structure"`

    // Contains details of the fetched page.
    Page *Page `type:"structure"`

    // Contains server-side performance information for the command.
    TimingInformation *TimingInformation `type:"structure"`
    // contains filtered or unexported fields
}

Contains the page that was fetched.

func (FetchPageResult) GoString

func (s FetchPageResult) GoString() string

GoString returns the string representation

func (*FetchPageResult) SetConsumedIOs

func (s *FetchPageResult) SetConsumedIOs(v *IOUsage) *FetchPageResult

SetConsumedIOs sets the ConsumedIOs field's value.

func (*FetchPageResult) SetPage

func (s *FetchPageResult) SetPage(v *Page) *FetchPageResult

SetPage sets the Page field's value.

func (*FetchPageResult) SetTimingInformation

func (s *FetchPageResult) SetTimingInformation(v *TimingInformation) *FetchPageResult

SetTimingInformation sets the TimingInformation field's value.

func (FetchPageResult) String

func (s FetchPageResult) String() string

String returns the string representation

type IOUsage

type IOUsage struct {

    // The number of read I/O requests that the command made.
    ReadIOs *int64 `type:"long"`

    // The number of write I/O requests that the command made.
    WriteIOs *int64 `type:"long"`
    // contains filtered or unexported fields
}

Contains I/O usage metrics for a command that was invoked.

func (IOUsage) GoString

func (s IOUsage) GoString() string

GoString returns the string representation

func (*IOUsage) SetReadIOs

func (s *IOUsage) SetReadIOs(v int64) *IOUsage

SetReadIOs sets the ReadIOs field's value.

func (*IOUsage) SetWriteIOs

func (s *IOUsage) SetWriteIOs(v int64) *IOUsage

SetWriteIOs sets the WriteIOs field's value.

func (IOUsage) String

func (s IOUsage) String() string

String returns the string representation

type InvalidSessionException

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

    Code_ *string `locationName:"Code" type:"string"`

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

Returned if the session doesn't exist anymore because it timed out or expired.

func (*InvalidSessionException) Code

func (s *InvalidSessionException) Code() string

Code returns the exception type name.

func (*InvalidSessionException) Error

func (s *InvalidSessionException) Error() string

func (InvalidSessionException) GoString

func (s InvalidSessionException) GoString() string

GoString returns the string representation

func (*InvalidSessionException) Message

func (s *InvalidSessionException) Message() string

Message returns the exception's message.

func (*InvalidSessionException) OrigErr

func (s *InvalidSessionException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidSessionException) RequestID

func (s *InvalidSessionException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidSessionException) StatusCode

func (s *InvalidSessionException) StatusCode() int

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

func (InvalidSessionException) String

func (s InvalidSessionException) String() string

String returns the string representation

type LimitExceededException

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

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

Returned if a resource limit such as number of active sessions is exceeded.

func (*LimitExceededException) Code

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString

func (s LimitExceededException) GoString() string

GoString returns the string representation

func (*LimitExceededException) Message

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode

func (s *LimitExceededException) StatusCode() int

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

func (LimitExceededException) String

func (s LimitExceededException) String() string

String returns the string representation

type OccConflictException

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

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

Returned when a transaction cannot be written to the journal due to a failure in the verification phase of optimistic concurrency control (OCC).

func (*OccConflictException) Code

func (s *OccConflictException) Code() string

Code returns the exception type name.

func (*OccConflictException) Error

func (s *OccConflictException) Error() string

func (OccConflictException) GoString

func (s OccConflictException) GoString() string

GoString returns the string representation

func (*OccConflictException) Message

func (s *OccConflictException) Message() string

Message returns the exception's message.

func (*OccConflictException) OrigErr

func (s *OccConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*OccConflictException) RequestID

func (s *OccConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*OccConflictException) StatusCode

func (s *OccConflictException) StatusCode() int

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

func (OccConflictException) String

func (s OccConflictException) String() string

String returns the string representation

type Page

type Page struct {

    // The token of the next page.
    NextPageToken *string `min:"4" type:"string"`

    // A structure that contains values in multiple encoding formats.
    Values []*ValueHolder `type:"list"`
    // contains filtered or unexported fields
}

Contains details of the fetched page.

func (Page) GoString

func (s Page) GoString() string

GoString returns the string representation

func (*Page) SetNextPageToken

func (s *Page) SetNextPageToken(v string) *Page

SetNextPageToken sets the NextPageToken field's value.

func (*Page) SetValues

func (s *Page) SetValues(v []*ValueHolder) *Page

SetValues sets the Values field's value.

func (Page) String

func (s Page) String() string

String returns the string representation

type QLDBSession

type QLDBSession struct {
    *client.Client
}

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

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

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

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

func (*QLDBSession) SendCommand

func (c *QLDBSession) SendCommand(input *SendCommandInput) (*SendCommandOutput, error)

SendCommand API operation for Amazon QLDB Session.

Sends a command to an Amazon QLDB ledger.

Instead of interacting directly with this API, we recommend using the QLDB driver or the QLDB shell to execute data transactions on a ledger.

* If you are working with an AWS SDK, use the QLDB driver. The driver
provides a high-level abstraction layer above this QLDB Session data plane
and manages SendCommand API calls for you. For information and a list
of supported programming languages, see Getting started with the driver
(https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-driver.html)
in the Amazon QLDB Developer Guide.

* If you are working with the AWS Command Line Interface (AWS CLI), use
the QLDB shell. The shell is a command line interface that uses the QLDB
driver to interact with a ledger. For information, see Accessing Amazon
QLDB using the QLDB shell (https://docs.aws.amazon.com/qldb/latest/developerguide/data-shell.html).

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

See the AWS API reference guide for Amazon QLDB Session's API operation SendCommand for usage and error information.

Returned Error Types:

* BadRequestException
Returned if the request is malformed or contains an error such as an invalid
parameter value or a missing required parameter.

* InvalidSessionException
Returned if the session doesn't exist anymore because it timed out or expired.

* OccConflictException
Returned when a transaction cannot be written to the journal due to a failure
in the verification phase of optimistic concurrency control (OCC).

* RateExceededException
Returned when the rate of requests exceeds the allowed throughput.

* LimitExceededException
Returned if a resource limit such as number of active sessions is exceeded.

* CapacityExceededException
Returned when the request exceeds the processing capacity of the ledger.

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-session-2019-07-11/SendCommand

func (*QLDBSession) SendCommandRequest

func (c *QLDBSession) SendCommandRequest(input *SendCommandInput) (req *request.Request, output *SendCommandOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qldb-session-2019-07-11/SendCommand

func (*QLDBSession) SendCommandWithContext

func (c *QLDBSession) SendCommandWithContext(ctx aws.Context, input *SendCommandInput, opts ...request.Option) (*SendCommandOutput, error)

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

See SendCommand 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 RateExceededException

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

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

Returned when the rate of requests exceeds the allowed throughput.

func (*RateExceededException) Code

func (s *RateExceededException) Code() string

Code returns the exception type name.

func (*RateExceededException) Error

func (s *RateExceededException) Error() string

func (RateExceededException) GoString

func (s RateExceededException) GoString() string

GoString returns the string representation

func (*RateExceededException) Message

func (s *RateExceededException) Message() string

Message returns the exception's message.

func (*RateExceededException) OrigErr

func (s *RateExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*RateExceededException) RequestID

func (s *RateExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*RateExceededException) StatusCode

func (s *RateExceededException) StatusCode() int

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

func (RateExceededException) String

func (s RateExceededException) String() string

String returns the string representation

type SendCommandInput

type SendCommandInput struct {

    // Command to abort the current transaction.
    AbortTransaction *AbortTransactionRequest `type:"structure"`

    // Command to commit the specified transaction.
    CommitTransaction *CommitTransactionRequest `type:"structure"`

    // Command to end the current session.
    EndSession *EndSessionRequest `type:"structure"`

    // Command to execute a statement in the specified transaction.
    ExecuteStatement *ExecuteStatementRequest `type:"structure"`

    // Command to fetch a page.
    FetchPage *FetchPageRequest `type:"structure"`

    // Specifies the session token for the current command. A session token is constant
    // throughout the life of the session.
    //
    // To obtain a session token, run the StartSession command. This SessionToken
    // is required for every subsequent command that is issued during the current
    // session.
    SessionToken *string `min:"4" type:"string"`

    // Command to start a new session. A session token is obtained as part of the
    // response.
    StartSession *StartSessionRequest `type:"structure"`

    // Command to start a new transaction.
    StartTransaction *StartTransactionRequest `type:"structure"`
    // contains filtered or unexported fields
}

func (SendCommandInput) GoString

func (s SendCommandInput) GoString() string

GoString returns the string representation

func (*SendCommandInput) SetAbortTransaction

func (s *SendCommandInput) SetAbortTransaction(v *AbortTransactionRequest) *SendCommandInput

SetAbortTransaction sets the AbortTransaction field's value.

func (*SendCommandInput) SetCommitTransaction

func (s *SendCommandInput) SetCommitTransaction(v *CommitTransactionRequest) *SendCommandInput

SetCommitTransaction sets the CommitTransaction field's value.

func (*SendCommandInput) SetEndSession

func (s *SendCommandInput) SetEndSession(v *EndSessionRequest) *SendCommandInput

SetEndSession sets the EndSession field's value.

func (*SendCommandInput) SetExecuteStatement

func (s *SendCommandInput) SetExecuteStatement(v *ExecuteStatementRequest) *SendCommandInput

SetExecuteStatement sets the ExecuteStatement field's value.

func (*SendCommandInput) SetFetchPage

func (s *SendCommandInput) SetFetchPage(v *FetchPageRequest) *SendCommandInput

SetFetchPage sets the FetchPage field's value.

func (*SendCommandInput) SetSessionToken

func (s *SendCommandInput) SetSessionToken(v string) *SendCommandInput

SetSessionToken sets the SessionToken field's value.

func (*SendCommandInput) SetStartSession

func (s *SendCommandInput) SetStartSession(v *StartSessionRequest) *SendCommandInput

SetStartSession sets the StartSession field's value.

func (*SendCommandInput) SetStartTransaction

func (s *SendCommandInput) SetStartTransaction(v *StartTransactionRequest) *SendCommandInput

SetStartTransaction sets the StartTransaction field's value.

func (SendCommandInput) String

func (s SendCommandInput) String() string

String returns the string representation

func (*SendCommandInput) Validate

func (s *SendCommandInput) Validate() error

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

type SendCommandOutput

type SendCommandOutput struct {

    // Contains the details of the aborted transaction.
    AbortTransaction *AbortTransactionResult `type:"structure"`

    // Contains the details of the committed transaction.
    CommitTransaction *CommitTransactionResult `type:"structure"`

    // Contains the details of the ended session.
    EndSession *EndSessionResult `type:"structure"`

    // Contains the details of the executed statement.
    ExecuteStatement *ExecuteStatementResult `type:"structure"`

    // Contains the details of the fetched page.
    FetchPage *FetchPageResult `type:"structure"`

    // Contains the details of the started session that includes a session token.
    // This SessionToken is required for every subsequent command that is issued
    // during the current session.
    StartSession *StartSessionResult `type:"structure"`

    // Contains the details of the started transaction.
    StartTransaction *StartTransactionResult `type:"structure"`
    // contains filtered or unexported fields
}

func (SendCommandOutput) GoString

func (s SendCommandOutput) GoString() string

GoString returns the string representation

func (*SendCommandOutput) SetAbortTransaction

func (s *SendCommandOutput) SetAbortTransaction(v *AbortTransactionResult) *SendCommandOutput

SetAbortTransaction sets the AbortTransaction field's value.

func (*SendCommandOutput) SetCommitTransaction

func (s *SendCommandOutput) SetCommitTransaction(v *CommitTransactionResult) *SendCommandOutput

SetCommitTransaction sets the CommitTransaction field's value.

func (*SendCommandOutput) SetEndSession

func (s *SendCommandOutput) SetEndSession(v *EndSessionResult) *SendCommandOutput

SetEndSession sets the EndSession field's value.

func (*SendCommandOutput) SetExecuteStatement

func (s *SendCommandOutput) SetExecuteStatement(v *ExecuteStatementResult) *SendCommandOutput

SetExecuteStatement sets the ExecuteStatement field's value.

func (*SendCommandOutput) SetFetchPage

func (s *SendCommandOutput) SetFetchPage(v *FetchPageResult) *SendCommandOutput

SetFetchPage sets the FetchPage field's value.

func (*SendCommandOutput) SetStartSession

func (s *SendCommandOutput) SetStartSession(v *StartSessionResult) *SendCommandOutput

SetStartSession sets the StartSession field's value.

func (*SendCommandOutput) SetStartTransaction

func (s *SendCommandOutput) SetStartTransaction(v *StartTransactionResult) *SendCommandOutput

SetStartTransaction sets the StartTransaction field's value.

func (SendCommandOutput) String

func (s SendCommandOutput) String() string

String returns the string representation

type StartSessionRequest

type StartSessionRequest struct {

    // The name of the ledger to start a new session against.
    //
    // LedgerName is a required field
    LedgerName *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Specifies a request to start a new session.

func (StartSessionRequest) GoString

func (s StartSessionRequest) GoString() string

GoString returns the string representation

func (*StartSessionRequest) SetLedgerName

func (s *StartSessionRequest) SetLedgerName(v string) *StartSessionRequest

SetLedgerName sets the LedgerName field's value.

func (StartSessionRequest) String

func (s StartSessionRequest) String() string

String returns the string representation

func (*StartSessionRequest) Validate

func (s *StartSessionRequest) Validate() error

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

type StartSessionResult

type StartSessionResult struct {

    // Session token of the started session. This SessionToken is required for every
    // subsequent command that is issued during the current session.
    SessionToken *string `min:"4" type:"string"`

    // Contains server-side performance information for the command.
    TimingInformation *TimingInformation `type:"structure"`
    // contains filtered or unexported fields
}

Contains the details of the started session.

func (StartSessionResult) GoString

func (s StartSessionResult) GoString() string

GoString returns the string representation

func (*StartSessionResult) SetSessionToken

func (s *StartSessionResult) SetSessionToken(v string) *StartSessionResult

SetSessionToken sets the SessionToken field's value.

func (*StartSessionResult) SetTimingInformation

func (s *StartSessionResult) SetTimingInformation(v *TimingInformation) *StartSessionResult

SetTimingInformation sets the TimingInformation field's value.

func (StartSessionResult) String

func (s StartSessionResult) String() string

String returns the string representation

type StartTransactionRequest

type StartTransactionRequest struct {
    // contains filtered or unexported fields
}

Specifies a request to start a transaction.

func (StartTransactionRequest) GoString

func (s StartTransactionRequest) GoString() string

GoString returns the string representation

func (StartTransactionRequest) String

func (s StartTransactionRequest) String() string

String returns the string representation

type StartTransactionResult

type StartTransactionResult struct {

    // Contains server-side performance information for the command.
    TimingInformation *TimingInformation `type:"structure"`

    // The transaction ID of the started transaction.
    TransactionId *string `min:"22" type:"string"`
    // contains filtered or unexported fields
}

Contains the details of the started transaction.

func (StartTransactionResult) GoString

func (s StartTransactionResult) GoString() string

GoString returns the string representation

func (*StartTransactionResult) SetTimingInformation

func (s *StartTransactionResult) SetTimingInformation(v *TimingInformation) *StartTransactionResult

SetTimingInformation sets the TimingInformation field's value.

func (*StartTransactionResult) SetTransactionId

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

SetTransactionId sets the TransactionId field's value.

func (StartTransactionResult) String

func (s StartTransactionResult) String() string

String returns the string representation

type TimingInformation

type TimingInformation struct {

    // The amount of time that QLDB spent on processing the command, measured in
    // milliseconds.
    ProcessingTimeMilliseconds *int64 `type:"long"`
    // contains filtered or unexported fields
}

Contains server-side performance information for a command. Amazon QLDB captures timing information between the times when it receives the request and when it sends the corresponding response.

func (TimingInformation) GoString

func (s TimingInformation) GoString() string

GoString returns the string representation

func (*TimingInformation) SetProcessingTimeMilliseconds

func (s *TimingInformation) SetProcessingTimeMilliseconds(v int64) *TimingInformation

SetProcessingTimeMilliseconds sets the ProcessingTimeMilliseconds field's value.

func (TimingInformation) String

func (s TimingInformation) String() string

String returns the string representation

type ValueHolder

type ValueHolder struct {

    // An Amazon Ion binary value contained in a ValueHolder structure.
    //
    // IonBinary is automatically base64 encoded/decoded by the SDK.
    IonBinary []byte `min:"1" type:"blob"`

    // An Amazon Ion plaintext value contained in a ValueHolder structure.
    IonText *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

A structure that can contain a value in multiple encoding formats.

func (ValueHolder) GoString

func (s ValueHolder) GoString() string

GoString returns the string representation

func (*ValueHolder) SetIonBinary

func (s *ValueHolder) SetIonBinary(v []byte) *ValueHolder

SetIonBinary sets the IonBinary field's value.

func (*ValueHolder) SetIonText

func (s *ValueHolder) SetIonText(v string) *ValueHolder

SetIonText sets the IonText field's value.

func (ValueHolder) String

func (s ValueHolder) String() string

String returns the string representation

func (*ValueHolder) Validate

func (s *ValueHolder) Validate() error

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