Documentation
¶
Overview ¶
Package kitchensinktestrestjson provides the API client, operations, and parameter types for the API.
Index ¶
- Constants
- Variables
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)deprecated
- func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
- func WithSigV4SigningName(name string) func(*Options)
- func WithSigV4SigningRegion(region string) func(*Options)
- type AuthResolverParameters
- type AuthSchemeResolver
- type Client
- func (c *Client) GetResource(ctx context.Context, params *GetResourceInput, optFns ...func(*Options)) (*GetResourceOutput, error)
- func (c *Client) GetStreamingResource(ctx context.Context, params *GetStreamingResourceInput, ...) (*GetStreamingResourceOutput, error)
- func (c *Client) Options() Options
- func (c *Client) PutCompressedData(ctx context.Context, params *PutCompressedDataInput, optFns ...func(*Options)) (*PutCompressedDataOutput, error)
- func (c *Client) SubscribeEvents(ctx context.Context, params *SubscribeEventsInput, optFns ...func(*Options)) (*SubscribeEventsOutput, error)
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type EventsReader
- type GetResourceInput
- type GetResourceOutput
- type GetStreamingResourceInput
- type GetStreamingResourceOutput
- func (v *GetStreamingResourceOutput) Deserialize(d smithy.ShapeDeserializer) error
- func (v *GetStreamingResourceOutput) GetPayloadStream() io.Reader
- func (v *GetStreamingResourceOutput) Serialize(s smithy.ShapeSerializer)
- func (v *GetStreamingResourceOutput) SerializeMembers(s smithy.ShapeSerializer)
- func (v *GetStreamingResourceOutput) SetPayloadStream(r io.ReadCloser)
- type HTTPClient
- type HTTPSignerV4
- type Options
- type PartialResult
- type PutCompressedDataInput
- type PutCompressedDataOutput
- type ResolveEndpoint
- type SubscribeEventsEventStream
- type SubscribeEventsInitialReply
- type SubscribeEventsInput
- type SubscribeEventsOutput
- func (v *SubscribeEventsOutput) Deserialize(d smithy.ShapeDeserializer) error
- func (o *SubscribeEventsOutput) GetInitialReply() <-chan SubscribeEventsInitialReply
- func (o *SubscribeEventsOutput) GetStream() *SubscribeEventsEventStream
- func (v *SubscribeEventsOutput) Serialize(s smithy.ShapeSerializer)
- func (v *SubscribeEventsOutput) SerializeMembers(s smithy.ShapeSerializer)
Constants ¶
const ServiceAPIVersion = "2025-03-01"
const ServiceID = "restJson1 kitchen sink"
Variables ¶
var TypeRegistry = &smithy.TypeRegistry{ Entries: map[string]*smithy.TypeRegistryEntry{ "aws.kitchensinktestrestjson#MessageEvent": { Schema: schemas.MessageEvent, New: func() any { return &types.MessageEvent{} }, }, "aws.kitchensinktestrestjson#ResourceNotFound": { Schema: schemas.ResourceNotFound, New: func() any { return &types.ResourceNotFound{} }, }, }, }
TypeRegistry is the type registry for this service.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver
deprecated
func WithEndpointResolver(v EndpointResolver) func(*Options)
Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.
To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.
func WithEndpointResolverV2 ¶
func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.
func WithSigV4SigningName ¶
WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.
func WithSigV4SigningRegion ¶
WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.
Types ¶
type AuthResolverParameters ¶
type AuthResolverParameters struct {
// The name of the operation being invoked.
Operation string
// The region in which the operation is being invoked.
Region string
}
AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.
type AuthSchemeResolver ¶
type AuthSchemeResolver interface {
ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}
AuthSchemeResolver returns a set of possible authentication options for an operation.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for the API.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) GetResource ¶
func (c *Client) GetResource(ctx context.Context, params *GetResourceInput, optFns ...func(*Options)) (*GetResourceOutput, error)
func (*Client) GetStreamingResource ¶
func (c *Client) GetStreamingResource(ctx context.Context, params *GetStreamingResourceInput, optFns ...func(*Options)) (*GetStreamingResourceOutput, error)
func (*Client) Options ¶
Options returns a copy of the client configuration.
Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.
func (*Client) PutCompressedData ¶
func (c *Client) PutCompressedData(ctx context.Context, params *PutCompressedDataInput, optFns ...func(*Options)) (*PutCompressedDataOutput, error)
func (*Client) SubscribeEvents ¶
func (c *Client) SubscribeEvents(ctx context.Context, params *SubscribeEventsInput, optFns ...func(*Options)) (*SubscribeEventsOutput, error)
type EndpointParameters ¶
type EndpointParameters struct {
// The AWS region
//
// AWS::Region
Region *string
}
EndpointParameters provides the parameters that influence how endpoints are resolved.
func (EndpointParameters) ValidateRequired ¶
func (p EndpointParameters) ValidateRequired() error
ValidateRequired validates required parameters are set.
func (EndpointParameters) WithDefaults ¶
func (p EndpointParameters) WithDefaults() EndpointParameters
WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type EndpointResolverV2 ¶
type EndpointResolverV2 interface {
// ResolveEndpoint attempts to resolve the endpoint with the provided options,
// returning the endpoint if found. Otherwise an error is returned.
ResolveEndpoint(ctx context.Context, params EndpointParameters) (
smithyendpoints.Endpoint, error,
)
}
EndpointResolverV2 provides the interface for resolving service endpoints.
func NewDefaultEndpointResolverV2 ¶
func NewDefaultEndpointResolverV2() EndpointResolverV2
type EventsReader ¶
EventsReader provides the interface for reading events from a stream.
The writer's Close method must allow multiple concurrent calls.
type GetResourceInput ¶
type GetResourceInput struct {
// This member is required.
Id *string
// contains filtered or unexported fields
}
func (*GetResourceInput) Deserialize ¶
func (v *GetResourceInput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetResourceInput) Serialize ¶
func (v *GetResourceInput) Serialize(s smithy.ShapeSerializer)
func (*GetResourceInput) SerializeMembers ¶
func (v *GetResourceInput) SerializeMembers(s smithy.ShapeSerializer)
type GetResourceOutput ¶
type GetResourceOutput struct {
Name *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GetResourceOutput) Deserialize ¶
func (v *GetResourceOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetResourceOutput) Serialize ¶
func (v *GetResourceOutput) Serialize(s smithy.ShapeSerializer)
func (*GetResourceOutput) SerializeMembers ¶
func (v *GetResourceOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetStreamingResourceInput ¶
type GetStreamingResourceInput struct {
// This member is required.
Id *string
// contains filtered or unexported fields
}
func (*GetStreamingResourceInput) Deserialize ¶
func (v *GetStreamingResourceInput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetStreamingResourceInput) Serialize ¶
func (v *GetStreamingResourceInput) Serialize(s smithy.ShapeSerializer)
func (*GetStreamingResourceInput) SerializeMembers ¶
func (v *GetStreamingResourceInput) SerializeMembers(s smithy.ShapeSerializer)
type GetStreamingResourceOutput ¶
type GetStreamingResourceOutput struct {
Body io.ReadCloser
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GetStreamingResourceOutput) Deserialize ¶
func (v *GetStreamingResourceOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetStreamingResourceOutput) GetPayloadStream ¶
func (v *GetStreamingResourceOutput) GetPayloadStream() io.Reader
func (*GetStreamingResourceOutput) Serialize ¶
func (v *GetStreamingResourceOutput) Serialize(s smithy.ShapeSerializer)
func (*GetStreamingResourceOutput) SerializeMembers ¶
func (v *GetStreamingResourceOutput) SerializeMembers(s smithy.ShapeSerializer)
func (*GetStreamingResourceOutput) SetPayloadStream ¶
func (v *GetStreamingResourceOutput) SetPayloadStream(r io.ReadCloser)
type HTTPSignerV4 ¶
type Options ¶
type Options struct {
// Set of options to modify how an operation is invoked. These apply to all
// operations invoked for this client. Use functional options on operation call to
// modify this list for per operation behavior.
APIOptions []func(*middleware.Stack) error
// The optional application specific identifier appended to the User-Agent header.
AppID string
// This endpoint will be given as input to an EndpointResolverV2. It is used for
// providing a custom base endpoint that is subject to modifications by the
// processing EndpointResolverV2.
BaseEndpoint *string
// Configures the events that will be sent to the configured logger.
ClientLogMode aws.ClientLogMode
// The credentials object to use when signing requests.
Credentials aws.CredentialsProvider
// The configuration DefaultsMode that the SDK should use when constructing the
// clients initial default settings.
DefaultsMode aws.DefaultsMode
// Disables SDK clock skew correction. When set, the SDK will not adjust request
// signing timestamps to compensate for clock drift between the client and the
// service.
DisableClockSkewCorrection bool
// Whether to disable automatic request compression for supported operations.
DisableRequestCompression bool
// The endpoint options to be used when attempting to resolve an endpoint.
EndpointOptions EndpointResolverOptions
// The service endpoint resolver.
//
// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
// value for this field will likely prevent you from using any endpoint-related
// service features released after the introduction of EndpointResolverV2 and
// BaseEndpoint.
//
// To migrate an EndpointResolver implementation that uses a custom endpoint, set
// the client option BaseEndpoint instead.
EndpointResolver EndpointResolver
// Resolves the endpoint used for a particular service operation.
EndpointResolverV2 EndpointResolverV2
// Signature Version 4 (SigV4) Signer
HTTPSignerV4 HTTPSignerV4
// The logger writer interface to write logging messages to.
Logger logging.Logger
// The client meter provider.
MeterProvider metrics.MeterProvider
// The region to send requests to. (Required)
Region string
// The minimum request body size, in bytes, at which compression should occur. The
// default value is 10 KiB. Values must fall within [0, 1MiB].
RequestMinCompressSizeBytes int64
// RetryMaxAttempts specifies the maximum number attempts an API client will call
// an operation that fails with a retryable error. A value of 0 is ignored, and
// will not be used to configure the API client created default retryer, or modify
// per operation call's retry max attempts.
//
// If specified in an operation call's functional options with a value that is
// different than the constructed client's Options, the Client's Retryer will be
// wrapped to use the operation's specific RetryMaxAttempts value.
RetryMaxAttempts int
// RetryMode specifies the retry mode the API client will be created with, if
// Retryer option is not also specified.
//
// When creating a new API Clients this member will only be used if the Retryer
// Options member is nil. This value will be ignored if Retryer is not nil.
//
// Currently does not support per operation call overrides, may in the future.
RetryMode aws.RetryMode
// Retryer guides how HTTP requests should be retried in case of recoverable
// failures. When nil the API client will use a default retryer. The kind of
// default retry created by the API client can be changed with the RetryMode
// option.
Retryer aws.Retryer
// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
// should not populate this structure programmatically, or rely on the values here
// within your applications.
RuntimeEnvironment aws.RuntimeEnvironment
// The client tracer provider.
TracerProvider tracing.TracerProvider
Protocol smithyhttp.ClientProtocol
// The HTTP client to invoke API calls with. Defaults to client's default HTTP
// implementation if nil.
HTTPClient HTTPClient
// Client registry of operation interceptors.
Interceptors smithyhttp.InterceptorRegistry
// The auth scheme resolver which determines how to authenticate for each
// operation.
AuthSchemeResolver AuthSchemeResolver
// The list of auth schemes supported by the client.
AuthSchemes []smithyhttp.AuthScheme
// Priority list of preferred auth scheme names (e.g. sigv4a).
AuthSchemePreference []string
// contains filtered or unexported fields
}
func (Options) GetIdentityResolver ¶
func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver
type PartialResult ¶
type PartialResult struct {
Output any
Metadata middleware.Metadata
Error error
}
PartialResult represents a placeholder value to return immediately when calling an event streaming operation. This contains no meaningful result for the caller
type PutCompressedDataInput ¶
type PutCompressedDataInput struct {
Data *string
// contains filtered or unexported fields
}
func (*PutCompressedDataInput) Deserialize ¶
func (v *PutCompressedDataInput) Deserialize(d smithy.ShapeDeserializer) error
func (*PutCompressedDataInput) Serialize ¶
func (v *PutCompressedDataInput) Serialize(s smithy.ShapeSerializer)
func (*PutCompressedDataInput) SerializeMembers ¶
func (v *PutCompressedDataInput) SerializeMembers(s smithy.ShapeSerializer)
type PutCompressedDataOutput ¶
type PutCompressedDataOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*PutCompressedDataOutput) Deserialize ¶
func (v *PutCompressedDataOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*PutCompressedDataOutput) Serialize ¶
func (v *PutCompressedDataOutput) Serialize(s smithy.ShapeSerializer)
func (*PutCompressedDataOutput) SerializeMembers ¶
func (v *PutCompressedDataOutput) SerializeMembers(s smithy.ShapeSerializer)
type ResolveEndpoint ¶
type ResolveEndpoint struct {
Resolver EndpointResolver
Options EndpointResolverOptions
}
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type SubscribeEventsEventStream ¶
type SubscribeEventsEventStream struct {
// EventsReader is the EventStream reader for the Events events. This value is
// automatically set by the SDK when the API call is made Use this member when unit
// testing your code with the SDK to mock out the EventStream Reader.
//
// Must not be nil.
Reader EventsReader
// contains filtered or unexported fields
}
SubscribeEventsEventStream provides the event stream handling for the SubscribeEvents operation.
For testing and mocking the event stream this type should be initialized via the NewSubscribeEventsEventStream constructor function. Using the functional options to pass in nested mock behavior.
func NewSubscribeEventsEventStream ¶
func NewSubscribeEventsEventStream(optFns ...func(*SubscribeEventsEventStream)) *SubscribeEventsEventStream
NewSubscribeEventsEventStream initializes an SubscribeEventsEventStream. This function should only be used for testing and mocking the SubscribeEventsEventStream stream within your application.
The Reader member must be set before reading events from the stream.
func (*SubscribeEventsEventStream) Close ¶
func (es *SubscribeEventsEventStream) Close() error
Close closes the stream. This will also cause the stream to be closed. Close must be called when done using the stream API. Not calling Close may result in resource leaks.
Will close the underlying EventStream writer and reader, and no more events can be sent or received.
func (*SubscribeEventsEventStream) Err ¶
func (es *SubscribeEventsEventStream) Err() error
Err returns any error that occurred while reading or writing EventStream Events from the service API's response. Returns nil if there were no errors.
func (*SubscribeEventsEventStream) Events ¶
func (es *SubscribeEventsEventStream) Events() <-chan types.Events
Events returns a channel to read events from.
type SubscribeEventsInitialReply ¶
type SubscribeEventsInitialReply struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type SubscribeEventsInput ¶
type SubscribeEventsInput struct {
// This member is required.
Id *string
// contains filtered or unexported fields
}
func (*SubscribeEventsInput) Deserialize ¶
func (v *SubscribeEventsInput) Deserialize(d smithy.ShapeDeserializer) error
func (*SubscribeEventsInput) Serialize ¶
func (v *SubscribeEventsInput) Serialize(s smithy.ShapeSerializer)
func (*SubscribeEventsInput) SerializeMembers ¶
func (v *SubscribeEventsInput) SerializeMembers(s smithy.ShapeSerializer)
type SubscribeEventsOutput ¶
type SubscribeEventsOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*SubscribeEventsOutput) Deserialize ¶
func (v *SubscribeEventsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*SubscribeEventsOutput) GetInitialReply ¶
func (o *SubscribeEventsOutput) GetInitialReply() <-chan SubscribeEventsInitialReply
func (*SubscribeEventsOutput) GetStream ¶
func (o *SubscribeEventsOutput) GetStream() *SubscribeEventsEventStream
GetStream returns the type to interact with the event stream.
func (*SubscribeEventsOutput) Serialize ¶
func (v *SubscribeEventsOutput) Serialize(s smithy.ShapeSerializer)
func (*SubscribeEventsOutput) SerializeMembers ¶
func (v *SubscribeEventsOutput) SerializeMembers(s smithy.ShapeSerializer)