package smithy

import "github.com/aws/smithy-go"

Package smithy provides the core components for a Smithy SDK.

Index ¶

• type APIError
• type CanceledError
• func (*CanceledError) CanceledError() bool
• func (e *CanceledError) Error() string
• func (e *CanceledError) Unwrap() error
• type DeserializationError
• func (e *DeserializationError) Error() string
• func (e *DeserializationError) Unwrap() error
• type Document
• type ErrorFault
• func (f ErrorFault) String() string
• type GenericAPIError
• func (e *GenericAPIError) Error() string
• func (e *GenericAPIError) ErrorCode() string
• func (e *GenericAPIError) ErrorFault() ErrorFault
• func (e *GenericAPIError) ErrorMessage() string
• type InvalidParamError
• type InvalidParamsError
• func (e *InvalidParamsError) Add(err InvalidParamError)
• func (e *InvalidParamsError) AddNested(nestedCtx string, nested InvalidParamsError)
• func (e InvalidParamsError) Error() string
• func (e InvalidParamsError) Errs() []error
• func (e *InvalidParamsError) Len() int
• type OperationError
• func (e *OperationError) Error() string
• func (e *OperationError) Operation() string
• func (e *OperationError) Service() string
• func (e *OperationError) Unwrap() error
• type ParamRequiredError
• func NewErrParamRequired(field string) *ParamRequiredError
• func (e *ParamRequiredError) AddNestedContext(ctx string)
• func (e ParamRequiredError) Error() string
• func (e ParamRequiredError) Field() string
• func (e *ParamRequiredError) SetContext(ctx string)
• type Properties
• func (m *Properties) Get(key any) any
• func (m *Properties) Has(key any) bool
• func (m *Properties) Set(key, value any)
• func (m *Properties) SetAll(other *Properties)
• func (m *Properties) Values() map[any]any
• type PropertiesReader
• type SerializationError
• func (e *SerializationError) Error() string
• func (e *SerializationError) Unwrap() error

Types ¶

type APIError ¶

type APIError interface {
	error

	// ErrorCode returns the error code for the API exception.
	ErrorCode() string
	// ErrorMessage returns the error message for the API exception.
	ErrorMessage() string
	// ErrorFault returns the fault for the API exception.
	ErrorFault() ErrorFault
}

APIError provides the generic API and protocol agnostic error type all SDK generated exception types will implement.

type CanceledError ¶

type CanceledError struct {
	Err error
}

CanceledError is the error that will be returned by an API request that was canceled. API operations given a Context may return this error when canceled.

func (*CanceledError) CanceledError ¶

func (*CanceledError) CanceledError() bool

CanceledError returns true to satisfy interfaces checking for canceled errors.

func (*CanceledError) Error ¶

func (e *CanceledError) Error() string

func (*CanceledError) Unwrap ¶

func (e *CanceledError) Unwrap() error

Unwrap returns the underlying error, if there was one.

type DeserializationError ¶

type DeserializationError struct {
	Err      error //  original error
	Snapshot []byte
}

DeserializationError provides a wrapper for an error that occurs during deserialization.

func (*DeserializationError) Error ¶

func (e *DeserializationError) Error() string

Error returns a formatted error for DeserializationError

func (*DeserializationError) Unwrap ¶

func (e *DeserializationError) Unwrap() error

Unwrap returns the underlying Error in DeserializationError

type Document ¶

type Document interface {
	UnmarshalDocument(interface{}) error
	GetValue() (interface{}, error)
}

Document provides access to loosely structured data in a document-like format.

Deprecated: See the github.com/aws/smithy-go/document package.

type ErrorFault ¶

type ErrorFault int

ErrorFault provides the type for a Smithy API error fault.

const (
	FaultUnknown ErrorFault = iota
	FaultServer
	FaultClient
)

ErrorFault enumeration values

func (ErrorFault) String ¶

func (f ErrorFault) String() string

type GenericAPIError ¶

type GenericAPIError struct {
	Code    string
	Message string
	Fault   ErrorFault
}

GenericAPIError provides a generic concrete API error type that SDKs can use to deserialize error responses into. Should be used for unmodeled or untyped errors.

func (*GenericAPIError) Error ¶

func (e *GenericAPIError) Error() string

func (*GenericAPIError) ErrorCode ¶

func (e *GenericAPIError) ErrorCode() string

ErrorCode returns the error code for the API exception.

func (*GenericAPIError) ErrorFault ¶

func (e *GenericAPIError) ErrorFault() ErrorFault

ErrorFault returns the fault for the API exception.

func (*GenericAPIError) ErrorMessage ¶

func (e *GenericAPIError) ErrorMessage() string

ErrorMessage returns the error message for the API exception.

type InvalidParamError ¶

type InvalidParamError interface {
	error

	// Field name the error occurred on.
	Field() string

	// SetContext updates the context of the error.
	SetContext(string)

	// AddNestedContext updates the error's context to include a nested level.
	AddNestedContext(string)
}

An InvalidParamError represents an invalid parameter error type.

type InvalidParamsError ¶

type InvalidParamsError struct {
	// Context is the base context of the invalid parameter group.
	Context string
	// contains filtered or unexported fields
}

An InvalidParamsError provides wrapping of invalid parameter errors found when validating API operation input parameters.

func (*InvalidParamsError) Add ¶

func (e *InvalidParamsError) Add(err InvalidParamError)

Add adds a new invalid parameter error to the collection of invalid parameters. The context of the invalid parameter will be updated to reflect this collection.

func (*InvalidParamsError) AddNested ¶

func (e *InvalidParamsError) AddNested(nestedCtx string, nested InvalidParamsError)

AddNested adds the invalid parameter errors from another InvalidParamsError value into this collection. The nested errors will have their nested context updated and base context to reflect the merging.

Use for nested validations errors.

func (InvalidParamsError) Error ¶

func (e InvalidParamsError) Error() string

Error returns the string formatted form of the invalid parameters.

func (InvalidParamsError) Errs ¶

func (e InvalidParamsError) Errs() []error

Errs returns a slice of the invalid parameters

func (*InvalidParamsError) Len ¶

func (e *InvalidParamsError) Len() int

Len returns the number of invalid parameter errors

type OperationError ¶

type OperationError struct {
	ServiceID     string
	OperationName string
	Err           error
}

OperationError decorates an underlying error which occurred while invoking an operation with names of the operation and API.

func (*OperationError) Error ¶

func (e *OperationError) Error() string

func (*OperationError) Operation ¶

func (e *OperationError) Operation() string

Operation returns the name of the API operation the error occurred with.

func (*OperationError) Service ¶

func (e *OperationError) Service() string

Service returns the name of the API service the error occurred with.

func (*OperationError) Unwrap ¶

func (e *OperationError) Unwrap() error

Unwrap returns the nested error if any, or nil.

type ParamRequiredError ¶

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

An ParamRequiredError represents an required parameter error.

func NewErrParamRequired ¶

func NewErrParamRequired(field string) *ParamRequiredError

NewErrParamRequired creates a new required parameter error.

func (*ParamRequiredError) AddNestedContext ¶

func (e *ParamRequiredError) AddNestedContext(ctx string)

AddNestedContext prepends a context to the field's path.

func (ParamRequiredError) Error ¶

func (e ParamRequiredError) Error() string

Error returns the string version of the invalid parameter error.

func (ParamRequiredError) Field ¶

func (e ParamRequiredError) Field() string

Field Returns the field and context the error occurred.

func (*ParamRequiredError) SetContext ¶

func (e *ParamRequiredError) SetContext(ctx string)

SetContext updates the base context of the error.

type Properties ¶

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

Properties provides storing and reading metadata values. Keys may be any comparable value type. Get and Set will panic if a key is not comparable.

The zero value for a Properties instance is ready for reads/writes without any additional initialization.

func (*Properties) Get ¶

func (m *Properties) Get(key any) any

Get attempts to retrieve the value the key points to. Returns nil if the key was not found.

Panics if key type is not comparable.

func (*Properties) Has ¶

func (m *Properties) Has(key any) bool

Has returns whether the key exists in the metadata.

Panics if the key type is not comparable.

func (*Properties) Set ¶

func (m *Properties) Set(key, value any)

Set stores the value pointed to by the key. If a value already exists at that key it will be replaced with the new value.

Panics if the key type is not comparable.

func (*Properties) SetAll ¶

func (m *Properties) SetAll(other *Properties)

SetAll accepts all of the given Properties into the receiver, overwriting any existing keys in the case of conflicts.

func (*Properties) Values ¶

func (m *Properties) Values() map[any]any

Values returns a shallow clone of the property set's values.

type PropertiesReader ¶

type PropertiesReader interface {
	Get(key any) any
}

PropertiesReader provides an interface for reading metadata from the underlying metadata container.

type SerializationError ¶

type SerializationError struct {
	Err error // original error
}

SerializationError represents an error that occurred while attempting to serialize a request

func (*SerializationError) Error ¶

func (e *SerializationError) Error() string

Error returns a formatted error for SerializationError

func (*SerializationError) Unwrap ¶

func (e *SerializationError) Unwrap() error

Unwrap returns the underlying Error in SerializationError

Source Files ¶

doc.go document.go errors.go go_module_metadata.go properties.go validation.go

Directories ¶