Documentation ¶
Overview ¶
Package awsrestjson provides the API client, operations, and parameter types for the API.
A REST JSON service that sends JSON requests and responses.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)
- type AllQueryStringTypesInput
- type AllQueryStringTypesOutput
- type Client
- func (c *Client) AllQueryStringTypes(ctx context.Context, params *AllQueryStringTypesInput, ...) (*AllQueryStringTypesOutput, error)
- func (c *Client) ConstantAndVariableQueryString(ctx context.Context, params *ConstantAndVariableQueryStringInput, ...) (*ConstantAndVariableQueryStringOutput, error)
- func (c *Client) ConstantQueryString(ctx context.Context, params *ConstantQueryStringInput, ...) (*ConstantQueryStringOutput, error)
- func (c *Client) EmptyInputAndEmptyOutput(ctx context.Context, params *EmptyInputAndEmptyOutputInput, ...) (*EmptyInputAndEmptyOutputOutput, error)
- func (c *Client) EndpointOperation(ctx context.Context, params *EndpointOperationInput, optFns ...func(*Options)) (*EndpointOperationOutput, error)
- func (c *Client) EndpointWithHostLabelOperation(ctx context.Context, params *EndpointWithHostLabelOperationInput, ...) (*EndpointWithHostLabelOperationOutput, error)
- func (c *Client) GreetingWithErrors(ctx context.Context, params *GreetingWithErrorsInput, optFns ...func(*Options)) (*GreetingWithErrorsOutput, error)
- func (c *Client) HttpPayloadTraits(ctx context.Context, params *HttpPayloadTraitsInput, optFns ...func(*Options)) (*HttpPayloadTraitsOutput, error)
- func (c *Client) HttpPayloadTraitsWithMediaType(ctx context.Context, params *HttpPayloadTraitsWithMediaTypeInput, ...) (*HttpPayloadTraitsWithMediaTypeOutput, error)
- func (c *Client) HttpPayloadWithStructure(ctx context.Context, params *HttpPayloadWithStructureInput, ...) (*HttpPayloadWithStructureOutput, error)
- func (c *Client) HttpPrefixHeaders(ctx context.Context, params *HttpPrefixHeadersInput, optFns ...func(*Options)) (*HttpPrefixHeadersOutput, error)
- func (c *Client) HttpPrefixHeadersResponse(ctx context.Context, params *HttpPrefixHeadersResponseInput, ...) (*HttpPrefixHeadersResponseOutput, error)
- func (c *Client) HttpRequestWithGreedyLabelInPath(ctx context.Context, params *HttpRequestWithGreedyLabelInPathInput, ...) (*HttpRequestWithGreedyLabelInPathOutput, error)
- func (c *Client) HttpRequestWithLabels(ctx context.Context, params *HttpRequestWithLabelsInput, ...) (*HttpRequestWithLabelsOutput, error)
- func (c *Client) HttpRequestWithLabelsAndTimestampFormat(ctx context.Context, params *HttpRequestWithLabelsAndTimestampFormatInput, ...) (*HttpRequestWithLabelsAndTimestampFormatOutput, error)
- func (c *Client) HttpResponseCode(ctx context.Context, params *HttpResponseCodeInput, optFns ...func(*Options)) (*HttpResponseCodeOutput, error)
- func (c *Client) IgnoreQueryParamsInResponse(ctx context.Context, params *IgnoreQueryParamsInResponseInput, ...) (*IgnoreQueryParamsInResponseOutput, error)
- func (c *Client) InlineDocument(ctx context.Context, params *InlineDocumentInput, optFns ...func(*Options)) (*InlineDocumentOutput, error)
- func (c *Client) InlineDocumentAsPayload(ctx context.Context, params *InlineDocumentAsPayloadInput, ...) (*InlineDocumentAsPayloadOutput, error)
- func (c *Client) InputAndOutputWithHeaders(ctx context.Context, params *InputAndOutputWithHeadersInput, ...) (*InputAndOutputWithHeadersOutput, error)
- func (c *Client) JsonBlobs(ctx context.Context, params *JsonBlobsInput, optFns ...func(*Options)) (*JsonBlobsOutput, error)
- func (c *Client) JsonEnums(ctx context.Context, params *JsonEnumsInput, optFns ...func(*Options)) (*JsonEnumsOutput, error)
- func (c *Client) JsonLists(ctx context.Context, params *JsonListsInput, optFns ...func(*Options)) (*JsonListsOutput, error)
- func (c *Client) JsonMaps(ctx context.Context, params *JsonMapsInput, optFns ...func(*Options)) (*JsonMapsOutput, error)
- func (c *Client) JsonTimestamps(ctx context.Context, params *JsonTimestampsInput, optFns ...func(*Options)) (*JsonTimestampsOutput, error)
- func (c *Client) JsonUnions(ctx context.Context, params *JsonUnionsInput, optFns ...func(*Options)) (*JsonUnionsOutput, error)
- func (c *Client) MediaTypeHeader(ctx context.Context, params *MediaTypeHeaderInput, optFns ...func(*Options)) (*MediaTypeHeaderOutput, 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)
- func (c *Client) NullAndEmptyHeadersClient(ctx context.Context, params *NullAndEmptyHeadersClientInput, ...) (*NullAndEmptyHeadersClientOutput, error)
- func (c *Client) NullAndEmptyHeadersServer(ctx context.Context, params *NullAndEmptyHeadersServerInput, ...) (*NullAndEmptyHeadersServerOutput, error)
- func (c *Client) OmitsNullSerializesEmptyString(ctx context.Context, params *OmitsNullSerializesEmptyStringInput, ...) (*OmitsNullSerializesEmptyStringOutput, error)
- func (c *Client) QueryIdempotencyTokenAutoFill(ctx context.Context, params *QueryIdempotencyTokenAutoFillInput, ...) (*QueryIdempotencyTokenAutoFillOutput, error)
- func (c *Client) QueryParamsAsStringListMap(ctx context.Context, params *QueryParamsAsStringListMapInput, ...) (*QueryParamsAsStringListMapOutput, error)
- func (c *Client) QueryPrecedence(ctx context.Context, params *QueryPrecedenceInput, optFns ...func(*Options)) (*QueryPrecedenceOutput, error)
- func (c *Client) RecursiveShapes(ctx context.Context, params *RecursiveShapesInput, optFns ...func(*Options)) (*RecursiveShapesOutput, error)
- func (c *Client) SimpleScalarProperties(ctx context.Context, params *SimpleScalarPropertiesInput, ...) (*SimpleScalarPropertiesOutput, error)
- func (c *Client) StreamingTraits(ctx context.Context, params *StreamingTraitsInput, optFns ...func(*Options)) (*StreamingTraitsOutput, error)
- func (c *Client) StreamingTraitsRequireLength(ctx context.Context, params *StreamingTraitsRequireLengthInput, ...) (*StreamingTraitsRequireLengthOutput, error)
- func (c *Client) StreamingTraitsWithMediaType(ctx context.Context, params *StreamingTraitsWithMediaTypeInput, ...) (*StreamingTraitsWithMediaTypeOutput, error)
- func (c *Client) TimestampFormatHeaders(ctx context.Context, params *TimestampFormatHeadersInput, ...) (*TimestampFormatHeadersOutput, error)
- type ConstantAndVariableQueryStringInput
- type ConstantAndVariableQueryStringOutput
- type ConstantQueryStringInput
- type ConstantQueryStringOutput
- type EmptyInputAndEmptyOutputInput
- type EmptyInputAndEmptyOutputOutput
- type EndpointOperationInput
- type EndpointOperationOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointWithHostLabelOperationInput
- type EndpointWithHostLabelOperationOutput
- type GreetingWithErrorsInput
- type GreetingWithErrorsOutput
- type HTTPClient
- type HttpPayloadTraitsInput
- type HttpPayloadTraitsOutput
- type HttpPayloadTraitsWithMediaTypeInput
- type HttpPayloadTraitsWithMediaTypeOutput
- type HttpPayloadWithStructureInput
- type HttpPayloadWithStructureOutput
- type HttpPrefixHeadersInput
- type HttpPrefixHeadersOutput
- type HttpPrefixHeadersResponseInput
- type HttpPrefixHeadersResponseOutput
- type HttpRequestWithGreedyLabelInPathInput
- type HttpRequestWithGreedyLabelInPathOutput
- type HttpRequestWithLabelsAndTimestampFormatInput
- type HttpRequestWithLabelsAndTimestampFormatOutput
- type HttpRequestWithLabelsInput
- type HttpRequestWithLabelsOutput
- type HttpResponseCodeInput
- type HttpResponseCodeOutput
- type IdempotencyTokenProvider
- type IgnoreQueryParamsInResponseInput
- type IgnoreQueryParamsInResponseOutput
- type InlineDocumentAsPayloadInput
- type InlineDocumentAsPayloadOutput
- type InlineDocumentInput
- type InlineDocumentOutput
- type InputAndOutputWithHeadersInput
- type InputAndOutputWithHeadersOutput
- type JsonBlobsInput
- type JsonBlobsOutput
- type JsonEnumsInput
- type JsonEnumsOutput
- type JsonListsInput
- type JsonListsOutput
- type JsonMapsInput
- type JsonMapsOutput
- type JsonTimestampsInput
- type JsonTimestampsOutput
- type JsonUnionsInput
- type JsonUnionsOutput
- type MediaTypeHeaderInput
- type MediaTypeHeaderOutput
- type NoInputAndNoOutputInput
- type NoInputAndNoOutputOutput
- type NoInputAndOutputInput
- type NoInputAndOutputOutput
- type NullAndEmptyHeadersClientInput
- type NullAndEmptyHeadersClientOutput
- type NullAndEmptyHeadersServerInput
- type NullAndEmptyHeadersServerOutput
- type OmitsNullSerializesEmptyStringInput
- type OmitsNullSerializesEmptyStringOutput
- type Options
- type QueryIdempotencyTokenAutoFillInput
- type QueryIdempotencyTokenAutoFillOutput
- type QueryParamsAsStringListMapInput
- type QueryParamsAsStringListMapOutput
- type QueryPrecedenceInput
- type QueryPrecedenceOutput
- type RecursiveShapesInput
- type RecursiveShapesOutput
- type ResolveEndpoint
- type SimpleScalarPropertiesInput
- type SimpleScalarPropertiesOutput
- type StreamingTraitsInput
- type StreamingTraitsOutput
- type StreamingTraitsRequireLengthInput
- type StreamingTraitsRequireLengthOutput
- type StreamingTraitsWithMediaTypeInput
- type StreamingTraitsWithMediaTypeOutput
- type TimestampFormatHeadersInput
- type TimestampFormatHeadersOutput
Constants ¶
const ServiceAPIVersion = "2019-12-16"
const ServiceID = "Rest Json Protocol"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶ added in v0.2.1
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver ¶
func WithEndpointResolver(v EndpointResolver) func(*Options)
WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.
Types ¶
type AllQueryStringTypesInput ¶
type AllQueryStringTypesInput struct { QueryBoolean *bool QueryBooleanList []bool QueryByte *int8 QueryDouble *float64 QueryDoubleList []float64 QueryEnum types.FooEnum QueryEnumList []types.FooEnum QueryFloat *float32 QueryInteger *int32 QueryIntegerList []int32 QueryIntegerSet []int32 QueryLong *int64 QueryParamsMapOfStrings map[string]string QueryShort *int16 QueryString *string QueryStringList []string QueryStringSet []string QueryTimestamp *time.Time QueryTimestampList []time.Time }
type AllQueryStringTypesOutput ¶
type AllQueryStringTypesOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
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) AllQueryStringTypes ¶
func (c *Client) AllQueryStringTypes(ctx context.Context, params *AllQueryStringTypesInput, optFns ...func(*Options)) (*AllQueryStringTypesOutput, error)
This example uses all query string types.
func (*Client) ConstantAndVariableQueryString ¶
func (c *Client) ConstantAndVariableQueryString(ctx context.Context, params *ConstantAndVariableQueryStringInput, optFns ...func(*Options)) (*ConstantAndVariableQueryStringOutput, error)
This example uses fixed query string params and variable query string params. The fixed query string parameters and variable parameters must both be serialized (implementations may need to merge them together).
func (*Client) ConstantQueryString ¶
func (c *Client) ConstantQueryString(ctx context.Context, params *ConstantQueryStringInput, optFns ...func(*Options)) (*ConstantQueryStringOutput, error)
This example uses a constant query string parameters and a label. This simply tests that labels and query string parameters are compatible. The fixed query string parameter named "hello" should in no way conflict with the label, {hello}.
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) EndpointOperation ¶ added in v0.2.4
func (c *Client) EndpointOperation(ctx context.Context, params *EndpointOperationInput, optFns ...func(*Options)) (*EndpointOperationOutput, error)
func (*Client) EndpointWithHostLabelOperation ¶ added in v0.2.4
func (c *Client) EndpointWithHostLabelOperation(ctx context.Context, params *EndpointWithHostLabelOperationInput, optFns ...func(*Options)) (*EndpointWithHostLabelOperationOutput, error)
func (*Client) GreetingWithErrors ¶
func (c *Client) GreetingWithErrors(ctx context.Context, params *GreetingWithErrorsInput, optFns ...func(*Options)) (*GreetingWithErrorsOutput, error)
This operation has four possible return values:
* A successful response in the form of GreetingWithErrorsOutput
* An InvalidGreeting error.
* A BadRequest error.
* A FooError.
Implementations must be able to successfully take a response and properly (de)serialize successful and error responses based on the the presence of the
func (*Client) HttpPayloadTraits ¶
func (c *Client) HttpPayloadTraits(ctx context.Context, params *HttpPayloadTraitsInput, optFns ...func(*Options)) (*HttpPayloadTraitsOutput, error)
This examples serializes a blob shape in the payload. In this example, no JSON document is synthesized because the payload is not a structure or a union type.
func (*Client) HttpPayloadTraitsWithMediaType ¶
func (c *Client) HttpPayloadTraitsWithMediaType(ctx context.Context, params *HttpPayloadTraitsWithMediaTypeInput, optFns ...func(*Options)) (*HttpPayloadTraitsWithMediaTypeOutput, error)
This examples uses a @mediaType trait on the payload to force a custom content-type to be serialized.
func (*Client) HttpPayloadWithStructure ¶
func (c *Client) HttpPayloadWithStructure(ctx context.Context, params *HttpPayloadWithStructureInput, optFns ...func(*Options)) (*HttpPayloadWithStructureOutput, error)
This examples serializes a structure in the payload. Note that serializing a structure changes the wrapper element name to match the targeted structure.
func (*Client) HttpPrefixHeaders ¶
func (c *Client) HttpPrefixHeaders(ctx context.Context, params *HttpPrefixHeadersInput, optFns ...func(*Options)) (*HttpPrefixHeadersOutput, error)
This examples adds headers to the input of a request and response by prefix.
func (*Client) HttpPrefixHeadersResponse ¶
func (c *Client) HttpPrefixHeadersResponse(ctx context.Context, params *HttpPrefixHeadersResponseInput, optFns ...func(*Options)) (*HttpPrefixHeadersResponseOutput, error)
Clients that perform this test extract all headers from the response.
func (*Client) HttpRequestWithGreedyLabelInPath ¶
func (c *Client) HttpRequestWithGreedyLabelInPath(ctx context.Context, params *HttpRequestWithGreedyLabelInPathInput, optFns ...func(*Options)) (*HttpRequestWithGreedyLabelInPathOutput, error)
func (*Client) HttpRequestWithLabels ¶
func (c *Client) HttpRequestWithLabels(ctx context.Context, params *HttpRequestWithLabelsInput, optFns ...func(*Options)) (*HttpRequestWithLabelsOutput, error)
The example tests how requests are serialized when there's no input payload but there are HTTP labels.
func (*Client) HttpRequestWithLabelsAndTimestampFormat ¶
func (c *Client) HttpRequestWithLabelsAndTimestampFormat(ctx context.Context, params *HttpRequestWithLabelsAndTimestampFormatInput, optFns ...func(*Options)) (*HttpRequestWithLabelsAndTimestampFormatOutput, error)
The example tests how requests serialize different timestamp formats in the URI path.
func (*Client) HttpResponseCode ¶
func (c *Client) HttpResponseCode(ctx context.Context, params *HttpResponseCodeInput, optFns ...func(*Options)) (*HttpResponseCodeOutput, error)
func (*Client) IgnoreQueryParamsInResponse ¶
func (c *Client) IgnoreQueryParamsInResponse(ctx context.Context, params *IgnoreQueryParamsInResponseInput, optFns ...func(*Options)) (*IgnoreQueryParamsInResponseOutput, error)
This example ensures that query string bound request parameters are serialized in the body of responses if the structure is used in both the request and response.
func (*Client) InlineDocument ¶
func (c *Client) InlineDocument(ctx context.Context, params *InlineDocumentInput, optFns ...func(*Options)) (*InlineDocumentOutput, error)
This example serializes an inline document as part of the payload.
func (*Client) InlineDocumentAsPayload ¶
func (c *Client) InlineDocumentAsPayload(ctx context.Context, params *InlineDocumentAsPayloadInput, optFns ...func(*Options)) (*InlineDocumentAsPayloadOutput, error)
This example serializes an inline document as the entire HTTP payload.
func (*Client) InputAndOutputWithHeaders ¶
func (c *Client) InputAndOutputWithHeaders(ctx context.Context, params *InputAndOutputWithHeadersInput, optFns ...func(*Options)) (*InputAndOutputWithHeadersOutput, error)
The example tests how requests and responses are serialized when there is no input or output payload but there are HTTP header bindings.
func (*Client) JsonBlobs ¶
func (c *Client) JsonBlobs(ctx context.Context, params *JsonBlobsInput, optFns ...func(*Options)) (*JsonBlobsOutput, error)
Blobs are base64 encoded
func (*Client) JsonEnums ¶
func (c *Client) JsonEnums(ctx context.Context, params *JsonEnumsInput, optFns ...func(*Options)) (*JsonEnumsOutput, error)
This example serializes enums as top level properties, in lists, sets, and maps.
func (*Client) JsonLists ¶
func (c *Client) JsonLists(ctx context.Context, params *JsonListsInput, optFns ...func(*Options)) (*JsonListsOutput, error)
This test case serializes JSON lists for the following cases for both input and output:
* Normal JSON lists.
* Normal JSON sets.
* JSON lists of lists.
* Lists of structures.
func (*Client) JsonMaps ¶
func (c *Client) JsonMaps(ctx context.Context, params *JsonMapsInput, optFns ...func(*Options)) (*JsonMapsOutput, error)
The example tests basic map serialization.
func (*Client) JsonTimestamps ¶
func (c *Client) JsonTimestamps(ctx context.Context, params *JsonTimestampsInput, optFns ...func(*Options)) (*JsonTimestampsOutput, error)
This tests how timestamps are serialized, including using the default format of date-time and various @timestampFormat trait values.
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) MediaTypeHeader ¶
func (c *Client) MediaTypeHeader(ctx context.Context, params *MediaTypeHeaderInput, optFns ...func(*Options)) (*MediaTypeHeaderOutput, error)
This example ensures that mediaType strings are base64 encoded in headers.
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.
func (*Client) NullAndEmptyHeadersClient ¶
func (c *Client) NullAndEmptyHeadersClient(ctx context.Context, params *NullAndEmptyHeadersClientInput, optFns ...func(*Options)) (*NullAndEmptyHeadersClientOutput, error)
Null and empty headers are not sent over the wire.
func (*Client) NullAndEmptyHeadersServer ¶
func (c *Client) NullAndEmptyHeadersServer(ctx context.Context, params *NullAndEmptyHeadersServerInput, optFns ...func(*Options)) (*NullAndEmptyHeadersServerOutput, error)
Null and empty headers are not sent over the wire.
func (*Client) OmitsNullSerializesEmptyString ¶
func (c *Client) OmitsNullSerializesEmptyString(ctx context.Context, params *OmitsNullSerializesEmptyStringInput, optFns ...func(*Options)) (*OmitsNullSerializesEmptyStringOutput, error)
Omits null, but serializes empty string value.
func (*Client) QueryIdempotencyTokenAutoFill ¶
func (c *Client) QueryIdempotencyTokenAutoFill(ctx context.Context, params *QueryIdempotencyTokenAutoFillInput, optFns ...func(*Options)) (*QueryIdempotencyTokenAutoFillOutput, error)
Automatically adds idempotency tokens.
func (*Client) QueryParamsAsStringListMap ¶ added in v0.2.8
func (c *Client) QueryParamsAsStringListMap(ctx context.Context, params *QueryParamsAsStringListMapInput, optFns ...func(*Options)) (*QueryParamsAsStringListMapOutput, error)
func (*Client) QueryPrecedence ¶ added in v0.2.8
func (c *Client) QueryPrecedence(ctx context.Context, params *QueryPrecedenceInput, optFns ...func(*Options)) (*QueryPrecedenceOutput, error)
func (*Client) RecursiveShapes ¶
func (c *Client) RecursiveShapes(ctx context.Context, params *RecursiveShapesInput, optFns ...func(*Options)) (*RecursiveShapesOutput, error)
Recursive shapes
func (*Client) SimpleScalarProperties ¶
func (c *Client) SimpleScalarProperties(ctx context.Context, params *SimpleScalarPropertiesInput, optFns ...func(*Options)) (*SimpleScalarPropertiesOutput, error)
func (*Client) StreamingTraits ¶
func (c *Client) StreamingTraits(ctx context.Context, params *StreamingTraitsInput, optFns ...func(*Options)) (*StreamingTraitsOutput, error)
This examples serializes a streaming blob shape in the request body. In this example, no JSON document is synthesized because the payload is not a structure or a union type.
func (*Client) StreamingTraitsRequireLength ¶
func (c *Client) StreamingTraitsRequireLength(ctx context.Context, params *StreamingTraitsRequireLengthInput, optFns ...func(*Options)) (*StreamingTraitsRequireLengthOutput, error)
This examples serializes a streaming blob shape with a required content length in the request body. In this example, no JSON document is synthesized because the payload is not a structure or a union type.
func (*Client) StreamingTraitsWithMediaType ¶
func (c *Client) StreamingTraitsWithMediaType(ctx context.Context, params *StreamingTraitsWithMediaTypeInput, optFns ...func(*Options)) (*StreamingTraitsWithMediaTypeOutput, error)
This examples serializes a streaming media-typed blob shape in the request body. This examples uses a @mediaType trait on the payload to force a custom content-type to be serialized.
func (*Client) TimestampFormatHeaders ¶
func (c *Client) TimestampFormatHeaders(ctx context.Context, params *TimestampFormatHeadersInput, optFns ...func(*Options)) (*TimestampFormatHeadersOutput, error)
This example tests how timestamp request and response headers are serialized.
type ConstantAndVariableQueryStringOutput ¶
type ConstantAndVariableQueryStringOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ConstantQueryStringInput ¶
type ConstantQueryStringInput struct { // This member is required. Hello *string }
type ConstantQueryStringOutput ¶
type ConstantQueryStringOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EmptyInputAndEmptyOutputInput ¶
type EmptyInputAndEmptyOutputInput struct { }
type EmptyInputAndEmptyOutputOutput ¶
type EmptyInputAndEmptyOutputOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EndpointOperationInput ¶ added in v0.2.4
type EndpointOperationInput struct { }
type EndpointOperationOutput ¶ added in v0.2.4
type EndpointOperationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶ added in v0.2.2
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 ¶ added in v0.1.3
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type EndpointWithHostLabelOperationInput ¶ added in v0.2.4
type EndpointWithHostLabelOperationInput struct { // This member is required. Label *string }
type EndpointWithHostLabelOperationOutput ¶ added in v0.2.4
type EndpointWithHostLabelOperationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GreetingWithErrorsInput ¶
type GreetingWithErrorsInput struct { }
type GreetingWithErrorsOutput ¶
type GreetingWithErrorsOutput struct { Greeting *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type HttpPayloadTraitsInput ¶
type HttpPayloadTraitsOutput ¶
type HttpPayloadTraitsOutput struct { Blob []byte Foo *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type HttpPayloadTraitsWithMediaTypeOutput ¶
type HttpPayloadTraitsWithMediaTypeOutput struct { // This value conforms to the media type: text/plain Blob []byte Foo *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type HttpPayloadWithStructureInput ¶
type HttpPayloadWithStructureInput struct {
Nested *types.NestedPayload
}
type HttpPayloadWithStructureOutput ¶
type HttpPayloadWithStructureOutput struct { Nested *types.NestedPayload // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type HttpPrefixHeadersInput ¶
type HttpPrefixHeadersOutput ¶
type HttpPrefixHeadersOutput struct { Foo *string // Map keys will be normalized to lower-case. FooMap map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type HttpPrefixHeadersResponseInput ¶
type HttpPrefixHeadersResponseInput struct { }
type HttpPrefixHeadersResponseOutput ¶
type HttpPrefixHeadersResponseOutput struct { // Map keys will be normalized to lower-case. PrefixHeaders map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type HttpRequestWithGreedyLabelInPathOutput ¶
type HttpRequestWithGreedyLabelInPathOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type HttpRequestWithLabelsAndTimestampFormatInput ¶
type HttpRequestWithLabelsAndTimestampFormatInput struct { // This member is required. DefaultFormat *time.Time // This member is required. MemberDateTime *time.Time // This member is required. MemberEpochSeconds *time.Time // This member is required. MemberHttpDate *time.Time // This member is required. TargetDateTime *time.Time // This member is required. TargetEpochSeconds *time.Time // This member is required. TargetHttpDate *time.Time }
type HttpRequestWithLabelsAndTimestampFormatOutput ¶
type HttpRequestWithLabelsAndTimestampFormatOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type HttpRequestWithLabelsInput ¶
type HttpRequestWithLabelsInput struct { // Serialized in the path as true or false. // // This member is required. Boolean *bool // This member is required. Double *float64 // This member is required. Float *float32 // This member is required. Integer *int32 // This member is required. Long *int64 // This member is required. Short *int16 // This member is required. String_ *string // Note that this member has no format, so it's serialized as an RFC 3399 // date-time. // // This member is required. Timestamp *time.Time }
type HttpRequestWithLabelsOutput ¶
type HttpRequestWithLabelsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type HttpResponseCodeInput ¶
type HttpResponseCodeInput struct { }
type HttpResponseCodeOutput ¶
type HttpResponseCodeOutput struct { Status *int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type IdempotencyTokenProvider ¶
IdempotencyTokenProvider interface for providing idempotency token
type IgnoreQueryParamsInResponseInput ¶
type IgnoreQueryParamsInResponseInput struct { }
type IgnoreQueryParamsInResponseOutput ¶
type IgnoreQueryParamsInResponseOutput struct { Baz *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type InlineDocumentAsPayloadOutput ¶
type InlineDocumentAsPayloadOutput struct { DocumentValue smithy.Document // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type InlineDocumentInput ¶
type InlineDocumentOutput ¶
type InlineDocumentOutput struct { DocumentValue smithy.Document StringValue *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type InputAndOutputWithHeadersInput ¶
type InputAndOutputWithHeadersInput struct { HeaderBooleanList []bool HeaderByte *int8 HeaderDouble *float64 HeaderEnum types.FooEnum HeaderEnumList []types.FooEnum HeaderFalseBool *bool HeaderFloat *float32 HeaderInteger *int32 HeaderIntegerList []int32 HeaderLong *int64 HeaderShort *int16 HeaderString *string HeaderStringList []string HeaderStringSet []string HeaderTimestampList []time.Time HeaderTrueBool *bool }
type InputAndOutputWithHeadersOutput ¶
type InputAndOutputWithHeadersOutput struct { HeaderBooleanList []bool HeaderByte *int8 HeaderDouble *float64 HeaderEnum types.FooEnum HeaderEnumList []types.FooEnum HeaderFalseBool *bool HeaderFloat *float32 HeaderInteger *int32 HeaderIntegerList []int32 HeaderLong *int64 HeaderShort *int16 HeaderString *string HeaderStringList []string HeaderStringSet []string HeaderTimestampList []time.Time HeaderTrueBool *bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type JsonBlobsInput ¶
type JsonBlobsInput struct {
Data []byte
}
type JsonBlobsOutput ¶
type JsonBlobsOutput struct { Data []byte // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type JsonEnumsInput ¶
type JsonEnumsOutput ¶
type JsonListsInput ¶
type JsonListsOutput ¶
type JsonListsOutput struct { BooleanList []bool EnumList []types.FooEnum IntegerList []int32 // A list of lists of strings. NestedStringList [][]string SparseStringList []*string StringList []string StringSet []string StructureList []types.StructureListMember TimestampList []time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type JsonMapsInput ¶
type JsonMapsInput struct { DenseBooleanMap map[string]bool DenseNumberMap map[string]int32 DenseStringMap map[string]string DenseStructMap map[string]types.GreetingStruct SparseBooleanMap map[string]*bool SparseNumberMap map[string]*int32 SparseStringMap map[string]*string SparseStructMap map[string]*types.GreetingStruct }
type JsonMapsOutput ¶
type JsonMapsOutput struct { DenseBooleanMap map[string]bool DenseNumberMap map[string]int32 DenseStringMap map[string]string DenseStructMap map[string]types.GreetingStruct SparseBooleanMap map[string]*bool SparseNumberMap map[string]*int32 SparseStringMap map[string]*string SparseStructMap map[string]*types.GreetingStruct // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type JsonTimestampsInput ¶
type JsonTimestampsOutput ¶
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 MediaTypeHeaderInput ¶
type MediaTypeHeaderInput struct { // This value conforms to the media type: application/json Json *string }
type MediaTypeHeaderOutput ¶
type MediaTypeHeaderOutput struct { // This value conforms to the media type: application/json Json *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
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 NullAndEmptyHeadersClientOutput ¶
type NullAndEmptyHeadersClientOutput struct { A *string B *string C []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type NullAndEmptyHeadersServerOutput ¶
type NullAndEmptyHeadersServerOutput struct { A *string B *string C []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type OmitsNullSerializesEmptyStringOutput ¶
type OmitsNullSerializesEmptyStringOutput 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 // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Provides idempotency tokens values that will be automatically populated into // idempotent API operations. IdempotencyTokenProvider IdempotencyTokenProvider // The logger writer interface to write logging messages to. Logger logging.Logger // 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 aws.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
type QueryIdempotencyTokenAutoFillInput ¶
type QueryIdempotencyTokenAutoFillInput struct {
Token *string
}
type QueryIdempotencyTokenAutoFillOutput ¶
type QueryIdempotencyTokenAutoFillOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type QueryParamsAsStringListMapInput ¶ added in v0.2.8
type QueryParamsAsStringListMapOutput ¶ added in v0.2.8
type QueryParamsAsStringListMapOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type QueryPrecedenceInput ¶ added in v0.2.8
type QueryPrecedenceOutput ¶ added in v0.2.8
type QueryPrecedenceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type RecursiveShapesInput ¶
type RecursiveShapesInput struct {
Nested *types.RecursiveShapesInputOutputNested1
}
type RecursiveShapesOutput ¶
type RecursiveShapesOutput struct { Nested *types.RecursiveShapesInputOutputNested1 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
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 SimpleScalarPropertiesOutput ¶
type SimpleScalarPropertiesOutput struct { ByteValue *int8 DoubleValue *float64 FalseBooleanValue *bool FloatValue *float32 Foo *string IntegerValue *int32 LongValue *int64 ShortValue *int16 StringValue *string TrueBooleanValue *bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type StreamingTraitsInput ¶
type StreamingTraitsOutput ¶
type StreamingTraitsOutput struct { Blob io.ReadCloser Foo *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type StreamingTraitsRequireLengthOutput ¶
type StreamingTraitsRequireLengthOutput struct { Blob io.ReadCloser Foo *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type StreamingTraitsWithMediaTypeOutput ¶
type StreamingTraitsWithMediaTypeOutput struct { // This value conforms to the media type: text/plain Blob io.ReadCloser Foo *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type TimestampFormatHeadersOutput ¶
type TimestampFormatHeadersOutput struct { DefaultFormat *time.Time MemberDateTime *time.Time MemberEpochSeconds *time.Time MemberHttpDate *time.Time TargetDateTime *time.Time TargetEpochSeconds *time.Time TargetHttpDate *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Source Files ¶
- api_client.go
- api_op_AllQueryStringTypes.go
- api_op_ConstantAndVariableQueryString.go
- api_op_ConstantQueryString.go
- api_op_EmptyInputAndEmptyOutput.go
- api_op_EndpointOperation.go
- api_op_EndpointWithHostLabelOperation.go
- api_op_GreetingWithErrors.go
- api_op_HttpPayloadTraits.go
- api_op_HttpPayloadTraitsWithMediaType.go
- api_op_HttpPayloadWithStructure.go
- api_op_HttpPrefixHeaders.go
- api_op_HttpPrefixHeadersResponse.go
- api_op_HttpRequestWithGreedyLabelInPath.go
- api_op_HttpRequestWithLabels.go
- api_op_HttpRequestWithLabelsAndTimestampFormat.go
- api_op_HttpResponseCode.go
- api_op_IgnoreQueryParamsInResponse.go
- api_op_InlineDocument.go
- api_op_InlineDocumentAsPayload.go
- api_op_InputAndOutputWithHeaders.go
- api_op_JsonBlobs.go
- api_op_JsonEnums.go
- api_op_JsonLists.go
- api_op_JsonMaps.go
- api_op_JsonTimestamps.go
- api_op_JsonUnions.go
- api_op_MediaTypeHeader.go
- api_op_NoInputAndNoOutput.go
- api_op_NoInputAndOutput.go
- api_op_NullAndEmptyHeadersClient.go
- api_op_NullAndEmptyHeadersServer.go
- api_op_OmitsNullSerializesEmptyString.go
- api_op_QueryIdempotencyTokenAutoFill.go
- api_op_QueryParamsAsStringListMap.go
- api_op_QueryPrecedence.go
- api_op_RecursiveShapes.go
- api_op_SimpleScalarProperties.go
- api_op_StreamingTraits.go
- api_op_StreamingTraitsRequireLength.go
- api_op_StreamingTraitsWithMediaType.go
- api_op_TimestampFormatHeaders.go
- deserializers.go
- doc.go
- endpoints.go
- serializers.go
- validators.go