Documentation
¶
Overview ¶
Package jsonrpc10 provides the API client, operations, and parameter types for the API.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- type Client
- func (c *Client) EmptyInputAndEmptyOutput(ctx context.Context, params *EmptyInputAndEmptyOutputInput, ...) (*EmptyInputAndEmptyOutputOutput, error)
- func (c *Client) GreetingWithErrors(ctx context.Context, params *GreetingWithErrorsInput, optFns ...func(*Options)) (*GreetingWithErrorsOutput, error)
- func (c *Client) JsonUnions(ctx context.Context, params *JsonUnionsInput, optFns ...func(*Options)) (*JsonUnionsOutput, error)
- func (c *Client) NoInputAndNoOutput(ctx context.Context, params *NoInputAndNoOutputInput, optFns ...func(*Options)) (*NoInputAndNoOutputOutput, error)
- func (c *Client) NoInputAndOutput(ctx context.Context, params *NoInputAndOutputInput, optFns ...func(*Options)) (*NoInputAndOutputOutput, error)
- type EmptyInputAndEmptyOutputInput
- type EmptyInputAndEmptyOutputOutput
- type EndpointResolver
- type EndpointResolverFunc
- type GreetingWithErrorsInput
- type GreetingWithErrorsOutput
- type HTTPClient
- type JsonUnionsInput
- type JsonUnionsOutput
- type NoInputAndNoOutputInput
- type NoInputAndNoOutputOutput
- type NoInputAndOutputInput
- type NoInputAndOutputOutput
- type Options
- type ResolveEndpoint
- type ResolverOptions
Constants ¶
const ServiceAPIVersion = "2020-07-14"
const ServiceID = "JSON RPC 10"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
Types ¶
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) EmptyInputAndEmptyOutput ¶
func (c *Client) EmptyInputAndEmptyOutput(ctx context.Context, params *EmptyInputAndEmptyOutputInput, optFns ...func(*Options)) (*EmptyInputAndEmptyOutputOutput, error)
The example tests how requests and responses are serialized when there's no request or response payload because the operation has an empty input and empty output structure that reuses the same shape. While this should be rare, code generators must support this.
func (*Client) GreetingWithErrors ¶
func (c *Client) GreetingWithErrors(ctx context.Context, params *GreetingWithErrorsInput, optFns ...func(*Options)) (*GreetingWithErrorsOutput, error)
This operation has three possible return values:
- A successful response in
the form of GreetingWithErrorsOutput
An InvalidGreeting error.
A
ComplexError error.
Implementations must be able to successfully take a response and properly deserialize successful and error responses.
func (*Client) JsonUnions ¶
func (c *Client) JsonUnions(ctx context.Context, params *JsonUnionsInput, optFns ...func(*Options)) (*JsonUnionsOutput, error)
This operation uses unions for inputs and outputs.
func (*Client) NoInputAndNoOutput ¶
func (c *Client) NoInputAndNoOutput(ctx context.Context, params *NoInputAndNoOutputInput, optFns ...func(*Options)) (*NoInputAndNoOutputOutput, error)
The example tests how requests and responses are serialized when there's no request or response payload because the operation has no input or output. While this should be rare, code generators must support this.
func (*Client) NoInputAndOutput ¶
func (c *Client) NoInputAndOutput(ctx context.Context, params *NoInputAndOutputInput, optFns ...func(*Options)) (*NoInputAndOutputOutput, error)
The example tests how requests and responses are serialized when there's no request or response payload because the operation has no input and the output is empty. While this should be rare, code generators must support this.
type EmptyInputAndEmptyOutputInput ¶
type EmptyInputAndEmptyOutputInput struct {
}
type EmptyInputAndEmptyOutputOutput ¶
type EmptyInputAndEmptyOutputOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
}
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func WithEndpointResolver ¶
func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver
WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options ResolverOptions) (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 ResolverOptions) (endpoint aws.Endpoint, err error)
type GreetingWithErrorsInput ¶
type GreetingWithErrorsInput struct {
}
type GreetingWithErrorsOutput ¶
type GreetingWithErrorsOutput struct {
Greeting *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
}
type JsonUnionsInput ¶
type JsonUnionsInput struct {
// A union with a representative set of types for members.
Contents types.MyUnion
}
A shared structure that contains a single union member.
type JsonUnionsOutput ¶
type JsonUnionsOutput struct {
// A union with a representative set of types for members.
Contents types.MyUnion
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
}
A shared structure that contains a single union member.
type NoInputAndNoOutputInput ¶
type NoInputAndNoOutputInput struct {
}
type NoInputAndNoOutputOutput ¶
type NoInputAndNoOutputOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
}
type NoInputAndOutputInput ¶
type NoInputAndOutputInput struct {
}
type NoInputAndOutputOutput ¶
type NoInputAndOutputOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
}
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 endpoint options to be used when attempting to resolve an endpoint.
EndpointOptions ResolverOptions
// The service endpoint resolver.
EndpointResolver EndpointResolver
// The region to send requests to. (Required)
Region string
// Retryer guides how HTTP requests should be retried in case of recoverable
// failures. When nil the API client will use a default retryer.
Retryer retry.Retryer
// The HTTP client to invoke API calls with. Defaults to client's default HTTP
// implementation if nil.
HTTPClient HTTPClient
}
type ResolveEndpoint ¶
type ResolveEndpoint struct {
Resolver EndpointResolver
Options ResolverOptions
}
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 ResolverOptions ¶
type ResolverOptions = internalendpoints.Options
ResolverOptions is the service endpoint resolver options