package smithy

Import Path
	github.com/aws/smithy-go (on go.dev)

Dependency Relation
	imports 3 packages, and imported by 7 packages

Involved Source Files

	   #d doc.go
		Package smithy provides the core components for a Smithy SDK.

	      document.go
	      errors.go
	      go_module_metadata.go
	      validation.go
Package-Level Type Names (total 12, in which 11 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type APIError (interface)
		APIError provides the generic API and protocol agnostic error type all SDK
		generated exception types will implement.

		Methods (total 4, all are exported)
			( APIError) Error() builtin.string
			( APIError) ErrorCode() string
				ErrorCode returns the error code for the API exception.

			( APIError) ErrorFault() ErrorFault
				ErrorFault returns the fault for the API exception.

			( APIError) ErrorMessage() string
				ErrorMessage returns the error message for the API exception.

		Implemented By (at least 10, all are exported)
			*GenericAPIError
			*github.com/aws/aws-sdk-go-v2/service/s3/types.BucketAlreadyExists
			*github.com/aws/aws-sdk-go-v2/service/s3/types.BucketAlreadyOwnedByYou
			*github.com/aws/aws-sdk-go-v2/service/s3/types.InvalidObjectState
			*github.com/aws/aws-sdk-go-v2/service/s3/types.NoSuchBucket
			*github.com/aws/aws-sdk-go-v2/service/s3/types.NoSuchKey
			*github.com/aws/aws-sdk-go-v2/service/s3/types.NoSuchUpload
			*github.com/aws/aws-sdk-go-v2/service/s3/types.NotFound
			*github.com/aws/aws-sdk-go-v2/service/s3/types.ObjectAlreadyInActiveTierError
			*github.com/aws/aws-sdk-go-v2/service/s3/types.ObjectNotInActiveTierError
		Implements (at least one exported)
			 APIError : error

	 type CanceledError (struct)
		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.

		Fields (only one, which is exported)
			Err error
		Methods (total 3, all are exported)
			(*CanceledError) CanceledError() bool
				CanceledError returns true to satisfy interfaces checking for canceled errors.

			(*CanceledError) Error() string
			(*CanceledError) Unwrap() error
				Unwrap returns the underlying error, if there was one.

		Implements (at least one exported)
			*CanceledError : error

	 type DeserializationError (struct)
		DeserializationError provides a wrapper for an error that occurs during
		deserialization.

		Fields (total 2, both are exported)
			Err error
				//  original error

			Snapshot []byte
		Methods (total 2, both are exported)
			(*DeserializationError) Error() string
				Error returns a formatted error for DeserializationError

			(*DeserializationError) Unwrap() error
				Unwrap returns the underlying Error in DeserializationError

		Implements (at least one exported)
			*DeserializationError : error

	 type Document (interface)
		Document provides access to loosely structured data in a document-like
		format.

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

		Methods (total 2, both are exported)
			( Document) GetValue() (interface{}, error)
			( Document) UnmarshalDocument(interface{}) error

	 type ErrorFault int (basic type)
		ErrorFault provides the type for a Smithy API error fault.

		Methods (only one, which is exported)
			( ErrorFault) String() string
		Implements (at least 5, in which 2 are exported)
			 ErrorFault : expvar.Var
			 ErrorFault : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			 ErrorFault : github.com/aws/smithy-go/middleware.stringer
			 ErrorFault : context.stringer
			 ErrorFault : runtime.stringer
		As Outputs Of (at least 11, all are exported)
			func APIError.ErrorFault() ErrorFault
			func (*GenericAPIError).ErrorFault() ErrorFault
			func github.com/aws/aws-sdk-go-v2/service/s3/types.(*BucketAlreadyExists).ErrorFault() ErrorFault
			func github.com/aws/aws-sdk-go-v2/service/s3/types.(*BucketAlreadyOwnedByYou).ErrorFault() ErrorFault
			func github.com/aws/aws-sdk-go-v2/service/s3/types.(*InvalidObjectState).ErrorFault() ErrorFault
			func github.com/aws/aws-sdk-go-v2/service/s3/types.(*NoSuchBucket).ErrorFault() ErrorFault
			func github.com/aws/aws-sdk-go-v2/service/s3/types.(*NoSuchKey).ErrorFault() ErrorFault
			func github.com/aws/aws-sdk-go-v2/service/s3/types.(*NoSuchUpload).ErrorFault() ErrorFault
			func github.com/aws/aws-sdk-go-v2/service/s3/types.(*NotFound).ErrorFault() ErrorFault
			func github.com/aws/aws-sdk-go-v2/service/s3/types.(*ObjectAlreadyInActiveTierError).ErrorFault() ErrorFault
			func github.com/aws/aws-sdk-go-v2/service/s3/types.(*ObjectNotInActiveTierError).ErrorFault() ErrorFault
		As Types Of (total 3, all are exported)
			const FaultClient
			const FaultServer
			const FaultUnknown

	 type GenericAPIError (struct)
		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.

		Fields (total 3, all are exported)
			Code string
			Fault ErrorFault
			Message string
		Methods (total 4, all are exported)
			(*GenericAPIError) Error() string
			(*GenericAPIError) ErrorCode() string
				ErrorCode returns the error code for the API exception.

			(*GenericAPIError) ErrorFault() ErrorFault
				ErrorFault returns the fault for the API exception.

			(*GenericAPIError) ErrorMessage() string
				ErrorMessage returns the error message for the API exception.

		Implements (at least 2, both are exported)
			*GenericAPIError : APIError
			*GenericAPIError : error

	 type InvalidParamError (interface)
		An InvalidParamError represents an invalid parameter error type.

		Methods (total 4, all are exported)
			( InvalidParamError) AddNestedContext(string)
				AddNestedContext updates the error's context to include a nested level.

			( InvalidParamError) Error() builtin.string
			( InvalidParamError) Field() string
				Field name the error occurred on.

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

		Implemented By (at least 2, in which 1 are exported)
			*ParamRequiredError
			/* at least one unexported ... *//* at least one unexported: */
			*invalidParamError
		Implements (at least one exported)
			 InvalidParamError : error
		As Inputs Of (at least one exported)
			func (*InvalidParamsError).Add(err InvalidParamError)

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

		Fields (total 2, in which 1 are exported)
			Context string
				Context is the base context of the invalid parameter group.

			/* one unexported ... *//* one unexported: */
			errs []InvalidParamError
		Methods (total 5, all are exported)
			(*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.

			(*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.

			( InvalidParamsError) Error() string
				Error returns the string formatted form of the invalid parameters.

			( InvalidParamsError) Errs() []error
				Errs returns a slice of the invalid parameters

			(*InvalidParamsError) Len() int
				Len returns the number of invalid parameter errors

		Implements (at least one exported)
			 InvalidParamsError : error
		As Inputs Of (at least one exported)
			func (*InvalidParamsError).AddNested(nestedCtx string, nested InvalidParamsError)

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

		Fields (total 3, all are exported)
			Err error
			OperationName string
			ServiceID string
		Methods (total 4, all are exported)
			(*OperationError) Error() string
			(*OperationError) Operation() string
				Operation returns the name of the API operation the error occurred with.

			(*OperationError) Service() string
				Service returns the name of the API service the error occurred with.

			(*OperationError) Unwrap() error
				Unwrap returns the nested error if any, or nil.

		Implements (at least one exported)
			*OperationError : error

	 type ParamRequiredError (struct)
		An ParamRequiredError represents an required parameter error.

		Fields (total 5, none are exported)
			/* 5 unexporteds ... *//* 5 unexporteds: */
			invalidParamError invalidParamError
			invalidParamError.context string
			invalidParamError.field string
			invalidParamError.nestedContext string
			invalidParamError.reason string
		Methods (total 4, all are exported)
			(*ParamRequiredError) AddNestedContext(ctx string)
				AddNestedContext prepends a context to the field's path.

			( ParamRequiredError) Error() string
				Error returns the string version of the invalid parameter error.

			( ParamRequiredError) Field() string
				Field Returns the field and context the error occurred.

			(*ParamRequiredError) SetContext(ctx string)
				SetContext updates the base context of the error.

		Implements (at least 2, both are exported)
			*ParamRequiredError : InvalidParamError
			 ParamRequiredError : error
		As Outputs Of (at least one exported)
			func NewErrParamRequired(field string) *ParamRequiredError

	 type SerializationError (struct)
		SerializationError represents an error that occurred while attempting to serialize a request

		Fields (only one, which is exported)
			Err error
		Methods (total 2, both are exported)
			(*SerializationError) Error() string
				Error returns a formatted error for SerializationError

			(*SerializationError) Unwrap() error
				Unwrap returns the underlying Error in SerializationError

		Implements (at least one exported)
			*SerializationError : error

	/* one unexported ... *//* one unexported: */
	 type invalidParamError (struct)

		Fields (total 4, none are exported)
			/* 4 unexporteds ... *//* 4 unexporteds: */
			context string
			field string
			nestedContext string
			reason string
		Methods (total 4, all are exported)
			(*invalidParamError) AddNestedContext(ctx string)
				AddNestedContext prepends a context to the field's path.

			( invalidParamError) Error() string
				Error returns the string version of the invalid parameter error.

			( invalidParamError) Field() string
				Field Returns the field and context the error occurred.

			(*invalidParamError) SetContext(ctx string)
				SetContext updates the base context of the error.

		Implements (at least 2, both are exported)
			*invalidParamError : InvalidParamError
			 invalidParamError : error


Package-Level Functions (only one, which is exported)

	 func NewErrParamRequired(field string) *ParamRequiredError
		NewErrParamRequired creates a new required parameter error.


Package-Level Constants (total 4, in which 3 are exported)

	const FaultClient ErrorFault = 2
		ErrorFault enumeration values

	const FaultServer ErrorFault = 1
		ErrorFault enumeration values

	const FaultUnknown ErrorFault = 0
		ErrorFault enumeration values

	/* one unexported ... *//* one unexported: */
	const goModuleVersion = "1.13.5"
		goModuleVersion is the tagged release for this module

The pages are generated with Golds v0.4.9. (GOOS=linux GOARCH=amd64)