Documentation

Overview

Package restxmlservice provides the client and types for making API requests to REST XML Service.

See https://docs.aws.amazon.com/goto/WebAPI/RESTXMLService-0000-00-00 for more information on this service.

See restxmlservice package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/restxmlservice/

Using the Client

To contact REST XML Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the REST XML Service client RESTXMLService for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/restxmlservice/#New

Index

Constants

View Source
const (

	// ErrCodeExceptionEvent for service response error code
	// "ExceptionEvent".
	ErrCodeExceptionEvent = "ExceptionEvent"

	// ErrCodeExceptionEvent2 for service response error code
	// "ExceptionEvent2".
	ErrCodeExceptionEvent2 = "ExceptionEvent2"
)
View Source
const (
	ServiceName = "RESTXMLService" // Name of service.
	EndpointsID = "restxmlservice" // ID to lookup a service endpoint with.
	ServiceID   = "RESTXMLService" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type EmptyEvent

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

func (EmptyEvent) GoString

func (s EmptyEvent) GoString() string

GoString returns the string representation

func (*EmptyEvent) MarshalEvent

func (s *EmptyEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (EmptyEvent) String

func (s EmptyEvent) String() string

String returns the string representation

func (*EmptyEvent) UnmarshalEvent

func (s *EmptyEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the EmptyEvent value. This method is only used internally within the SDK's EventStream handling.

type EmptyEventStreamEvent

type EmptyEventStreamEvent interface {
	eventstreamapi.Marshaler
	eventstreamapi.Unmarshaler
	// contains filtered or unexported methods
}

EmptyEventStreamEvent groups together all EventStream events writes for EmptyEventStream.

These events are:

type EmptyEventStreamReader

type EmptyEventStreamReader interface {
	// Returns a channel of events as they are read from the event stream.
	Events() <-chan EmptyEventStreamEvent

	// Close will stop the reader reading events from the stream.
	Close() error

	// Returns any error that has occurred while reading from the event stream.
	Err() error
}

EmptyEventStreamReader provides the interface for reading to the stream. The default implementation for this interface will be EmptyEventStream.

The reader's Close method must allow multiple concurrent calls.

These events are:

* EmptyEventStreamUnknownEvent

type EmptyEventStreamUnknownEvent

type EmptyEventStreamUnknownEvent struct {
	Type    string
	Message eventstream.Message
}

EmptyEventStreamUnknownEvent provides a failsafe event for the EmptyEventStream group of events when an unknown event is received.

func (*EmptyEventStreamUnknownEvent) MarshalEvent

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*EmptyEventStreamUnknownEvent) UnmarshalEvent

func (e *EmptyEventStreamUnknownEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the EmptyEventStream value. This method is only used internally within the SDK's EventStream handling.

type EmptyStreamEventStream

type EmptyStreamEventStream struct {

	// Reader is the EventStream reader for the EmptyEventStream
	// 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 EmptyEventStreamReader
	// contains filtered or unexported fields
}

EmptyStreamEventStream provides the event stream handling for the EmptyStream.

For testing and mocking the event stream this type should be initialized via the NewEmptyStreamEventStream constructor function. Using the functional options to pass in nested mock behavior.

func NewEmptyStreamEventStream

func NewEmptyStreamEventStream(opts ...func(*EmptyStreamEventStream)) *EmptyStreamEventStream

NewEmptyStreamEventStream initializes an EmptyStreamEventStream. This function should only be used for testing and mocking the EmptyStreamEventStream stream within your application.

The Reader member must be set before reading events from the stream.

es := NewEmptyStreamEventStream(func(o *EmptyStreamEventStream{
    es.Reader = myMockStreamReader
})

func (*EmptyStreamEventStream) Close

func (es *EmptyStreamEventStream) Close() (err 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.

You can use the closing of the Reader's Events channel to terminate your application's read from the API's stream.

func (*EmptyStreamEventStream) Err

func (es *EmptyStreamEventStream) 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 (*EmptyStreamEventStream) Events

func (es *EmptyStreamEventStream) Events() <-chan EmptyEventStreamEvent

Events returns a channel to read events from.

These events are:

* EmptyEventStreamUnknownEvent

type EmptyStreamInput

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

func (EmptyStreamInput) GoString

func (s EmptyStreamInput) GoString() string

GoString returns the string representation

func (EmptyStreamInput) String

func (s EmptyStreamInput) String() string

String returns the string representation

type EmptyStreamOutput

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

func (*EmptyStreamOutput) GetStream

func (s *EmptyStreamOutput) GetStream() *EmptyStreamEventStream

GetStream returns the type to interact with the event stream.

func (EmptyStreamOutput) GoString

func (s EmptyStreamOutput) GoString() string

GoString returns the string representation

func (EmptyStreamOutput) String

func (s EmptyStreamOutput) String() string

String returns the string representation

type EventStreamEvent

type EventStreamEvent interface {
	eventstreamapi.Marshaler
	eventstreamapi.Unmarshaler
	// contains filtered or unexported methods
}

EventStreamEvent groups together all EventStream events writes for EventStream.

These events are:

* EmptyEvent
* ExplicitPayloadEvent
* HeaderOnlyEvent
* ImplicitPayloadEvent
* PayloadOnlyEvent
* PayloadOnlyBlobEvent
* PayloadOnlyStringEvent

type EventStreamReader

type EventStreamReader interface {
	// Returns a channel of events as they are read from the event stream.
	Events() <-chan EventStreamEvent

	// Close will stop the reader reading events from the stream.
	Close() error

	// Returns any error that has occurred while reading from the event stream.
	Err() error
}

EventStreamReader provides the interface for reading to the stream. The default implementation for this interface will be EventStream.

The reader's Close method must allow multiple concurrent calls.

These events are:

* EmptyEvent
* ExplicitPayloadEvent
* HeaderOnlyEvent
* ImplicitPayloadEvent
* PayloadOnlyEvent
* PayloadOnlyBlobEvent
* PayloadOnlyStringEvent
* EventStreamUnknownEvent

type EventStreamUnknownEvent

type EventStreamUnknownEvent struct {
	Type    string
	Message eventstream.Message
}

EventStreamUnknownEvent provides a failsafe event for the EventStream group of events when an unknown event is received.

func (*EventStreamUnknownEvent) MarshalEvent

func (e *EventStreamUnknownEvent) MarshalEvent(pm protocol.PayloadMarshaler) (
	msg eventstream.Message, err error,
)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*EventStreamUnknownEvent) UnmarshalEvent

func (e *EventStreamUnknownEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the EventStream value. This method is only used internally within the SDK's EventStream handling.

type ExceptionEvent

type ExceptionEvent struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	IntVal *int64 `type:"integer"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

func (*ExceptionEvent) Code

func (s *ExceptionEvent) Code() string

Code returns the exception type name.

func (*ExceptionEvent) Error

func (s *ExceptionEvent) Error() string

func (ExceptionEvent) GoString

func (s ExceptionEvent) GoString() string

GoString returns the string representation

func (*ExceptionEvent) MarshalEvent

func (s *ExceptionEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*ExceptionEvent) Message

func (s *ExceptionEvent) Message() string

Message returns the exception's message.

func (*ExceptionEvent) OrigErr

func (s *ExceptionEvent) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ExceptionEvent) RequestID

func (s *ExceptionEvent) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ExceptionEvent) StatusCode

func (s *ExceptionEvent) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ExceptionEvent) String

func (s ExceptionEvent) String() string

String returns the string representation

func (*ExceptionEvent) UnmarshalEvent

func (s *ExceptionEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the ExceptionEvent value. This method is only used internally within the SDK's EventStream handling.

type ExceptionEvent2

type ExceptionEvent2 struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

func (*ExceptionEvent2) Code

func (s *ExceptionEvent2) Code() string

Code returns the exception type name.

func (*ExceptionEvent2) Error

func (s *ExceptionEvent2) Error() string

func (ExceptionEvent2) GoString

func (s ExceptionEvent2) GoString() string

GoString returns the string representation

func (*ExceptionEvent2) MarshalEvent

func (s *ExceptionEvent2) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*ExceptionEvent2) Message

func (s *ExceptionEvent2) Message() string

Message returns the exception's message.

func (*ExceptionEvent2) OrigErr

func (s *ExceptionEvent2) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ExceptionEvent2) RequestID

func (s *ExceptionEvent2) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ExceptionEvent2) StatusCode

func (s *ExceptionEvent2) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ExceptionEvent2) String

func (s ExceptionEvent2) String() string

String returns the string representation

func (*ExceptionEvent2) UnmarshalEvent

func (s *ExceptionEvent2) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the ExceptionEvent2 value. This method is only used internally within the SDK's EventStream handling.

type ExplicitPayloadEvent

type ExplicitPayloadEvent struct {
	LongVal *int64 `location:"header" type:"long"`

	NestedVal *NestedShape `locationName:"NestedVal" type:"structure"`

	StringVal *string `location:"header" type:"string"`
	// contains filtered or unexported fields
}

func (ExplicitPayloadEvent) GoString

func (s ExplicitPayloadEvent) GoString() string

GoString returns the string representation

func (*ExplicitPayloadEvent) MarshalEvent

func (s *ExplicitPayloadEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*ExplicitPayloadEvent) SetLongVal

SetLongVal sets the LongVal field's value.

func (*ExplicitPayloadEvent) SetNestedVal

SetNestedVal sets the NestedVal field's value.

func (*ExplicitPayloadEvent) SetStringVal

func (s *ExplicitPayloadEvent) SetStringVal(v string) *ExplicitPayloadEvent

SetStringVal sets the StringVal field's value.

func (ExplicitPayloadEvent) String

func (s ExplicitPayloadEvent) String() string

String returns the string representation

func (*ExplicitPayloadEvent) UnmarshalEvent

func (s *ExplicitPayloadEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the ExplicitPayloadEvent value. This method is only used internally within the SDK's EventStream handling.

type GetEventStreamEventStream

type GetEventStreamEventStream struct {

	// Reader is the EventStream reader for the EventStream
	// 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 EventStreamReader
	// contains filtered or unexported fields
}

GetEventStreamEventStream provides the event stream handling for the GetEventStream.

For testing and mocking the event stream this type should be initialized via the NewGetEventStreamEventStream constructor function. Using the functional options to pass in nested mock behavior.

func NewGetEventStreamEventStream

func NewGetEventStreamEventStream(opts ...func(*GetEventStreamEventStream)) *GetEventStreamEventStream

NewGetEventStreamEventStream initializes an GetEventStreamEventStream. This function should only be used for testing and mocking the GetEventStreamEventStream stream within your application.

The Reader member must be set before reading events from the stream.

es := NewGetEventStreamEventStream(func(o *GetEventStreamEventStream{
    es.Reader = myMockStreamReader
})

func (*GetEventStreamEventStream) Close

func (es *GetEventStreamEventStream) Close() (err 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.

You can use the closing of the Reader's Events channel to terminate your application's read from the API's stream.

func (*GetEventStreamEventStream) Err

func (es *GetEventStreamEventStream) 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 (*GetEventStreamEventStream) Events

func (es *GetEventStreamEventStream) Events() <-chan EventStreamEvent

Events returns a channel to read events from.

These events are:

* EmptyEvent
* ExplicitPayloadEvent
* HeaderOnlyEvent
* ImplicitPayloadEvent
* PayloadOnlyEvent
* PayloadOnlyBlobEvent
* PayloadOnlyStringEvent
* EventStreamUnknownEvent

type GetEventStreamInput

type GetEventStreamInput struct {
	InputVal *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetEventStreamInput) GoString

func (s GetEventStreamInput) GoString() string

GoString returns the string representation

func (*GetEventStreamInput) SetInputVal

func (s *GetEventStreamInput) SetInputVal(v string) *GetEventStreamInput

SetInputVal sets the InputVal field's value.

func (GetEventStreamInput) String

func (s GetEventStreamInput) String() string

String returns the string representation

type GetEventStreamOutput

type GetEventStreamOutput struct {
	IntVal *int64 `type:"integer"`

	StrVal *string `type:"string"`
	// contains filtered or unexported fields
}

func (*GetEventStreamOutput) GetStream

GetStream returns the type to interact with the event stream.

func (GetEventStreamOutput) GoString

func (s GetEventStreamOutput) GoString() string

GoString returns the string representation

func (*GetEventStreamOutput) SetIntVal

SetIntVal sets the IntVal field's value.

func (*GetEventStreamOutput) SetStrVal

SetStrVal sets the StrVal field's value.

func (GetEventStreamOutput) String

func (s GetEventStreamOutput) String() string

String returns the string representation

type HeaderOnlyEvent

type HeaderOnlyEvent struct {

	// BlobVal is automatically base64 encoded/decoded by the SDK.
	BlobVal []byte `location:"header" type:"blob"`

	BoolVal *bool `location:"header" type:"boolean"`

	ByteVal *int64 `location:"header" type:"byte"`

	IntegerVal *int64 `location:"header" type:"integer"`

	LongVal *int64 `location:"header" type:"long"`

	ShortVal *int64 `location:"header" type:"short"`

	StringVal *string `location:"header" type:"string"`

	TimeVal *time.Time `location:"header" type:"timestamp"`
	// contains filtered or unexported fields
}

func (HeaderOnlyEvent) GoString

func (s HeaderOnlyEvent) GoString() string

GoString returns the string representation

func (*HeaderOnlyEvent) MarshalEvent

func (s *HeaderOnlyEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*HeaderOnlyEvent) SetBlobVal

func (s *HeaderOnlyEvent) SetBlobVal(v []byte) *HeaderOnlyEvent

SetBlobVal sets the BlobVal field's value.

func (*HeaderOnlyEvent) SetBoolVal

func (s *HeaderOnlyEvent) SetBoolVal(v bool) *HeaderOnlyEvent

SetBoolVal sets the BoolVal field's value.

func (*HeaderOnlyEvent) SetByteVal

func (s *HeaderOnlyEvent) SetByteVal(v int64) *HeaderOnlyEvent

SetByteVal sets the ByteVal field's value.

func (*HeaderOnlyEvent) SetIntegerVal

func (s *HeaderOnlyEvent) SetIntegerVal(v int64) *HeaderOnlyEvent

SetIntegerVal sets the IntegerVal field's value.

func (*HeaderOnlyEvent) SetLongVal

func (s *HeaderOnlyEvent) SetLongVal(v int64) *HeaderOnlyEvent

SetLongVal sets the LongVal field's value.

func (*HeaderOnlyEvent) SetShortVal

func (s *HeaderOnlyEvent) SetShortVal(v int64) *HeaderOnlyEvent

SetShortVal sets the ShortVal field's value.

func (*HeaderOnlyEvent) SetStringVal

func (s *HeaderOnlyEvent) SetStringVal(v string) *HeaderOnlyEvent

SetStringVal sets the StringVal field's value.

func (*HeaderOnlyEvent) SetTimeVal

func (s *HeaderOnlyEvent) SetTimeVal(v time.Time) *HeaderOnlyEvent

SetTimeVal sets the TimeVal field's value.

func (HeaderOnlyEvent) String

func (s HeaderOnlyEvent) String() string

String returns the string representation

func (*HeaderOnlyEvent) UnmarshalEvent

func (s *HeaderOnlyEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the HeaderOnlyEvent value. This method is only used internally within the SDK's EventStream handling.

type ImplicitPayloadEvent

type ImplicitPayloadEvent struct {
	ByteVal *int64 `location:"header" type:"byte"`

	IntegerVal *int64 `type:"integer"`

	ShortVal *int64 `type:"short"`
	// contains filtered or unexported fields
}

func (ImplicitPayloadEvent) GoString

func (s ImplicitPayloadEvent) GoString() string

GoString returns the string representation

func (*ImplicitPayloadEvent) MarshalEvent

func (s *ImplicitPayloadEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*ImplicitPayloadEvent) SetByteVal

SetByteVal sets the ByteVal field's value.

func (*ImplicitPayloadEvent) SetIntegerVal

func (s *ImplicitPayloadEvent) SetIntegerVal(v int64) *ImplicitPayloadEvent

SetIntegerVal sets the IntegerVal field's value.

func (*ImplicitPayloadEvent) SetShortVal

func (s *ImplicitPayloadEvent) SetShortVal(v int64) *ImplicitPayloadEvent

SetShortVal sets the ShortVal field's value.

func (ImplicitPayloadEvent) String

func (s ImplicitPayloadEvent) String() string

String returns the string representation

func (*ImplicitPayloadEvent) UnmarshalEvent

func (s *ImplicitPayloadEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the ImplicitPayloadEvent value. This method is only used internally within the SDK's EventStream handling.

type NestedShape

type NestedShape struct {
	IntVal *int64 `type:"integer"`

	StrVal *string `type:"string"`
	// contains filtered or unexported fields
}

func (NestedShape) GoString

func (s NestedShape) GoString() string

GoString returns the string representation

func (*NestedShape) SetIntVal

func (s *NestedShape) SetIntVal(v int64) *NestedShape

SetIntVal sets the IntVal field's value.

func (*NestedShape) SetStrVal

func (s *NestedShape) SetStrVal(v string) *NestedShape

SetStrVal sets the StrVal field's value.

func (NestedShape) String

func (s NestedShape) String() string

String returns the string representation

type OtherOperationInput

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

func (OtherOperationInput) GoString

func (s OtherOperationInput) GoString() string

GoString returns the string representation

func (OtherOperationInput) String

func (s OtherOperationInput) String() string

String returns the string representation

type OtherOperationOutput

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

func (OtherOperationOutput) GoString

func (s OtherOperationOutput) GoString() string

GoString returns the string representation

func (OtherOperationOutput) String

func (s OtherOperationOutput) String() string

String returns the string representation

type PayloadOnlyBlobEvent

type PayloadOnlyBlobEvent struct {

	// BlobPayload is automatically base64 encoded/decoded by the SDK.
	BlobPayload []byte `type:"blob"`
	// contains filtered or unexported fields
}

func (PayloadOnlyBlobEvent) GoString

func (s PayloadOnlyBlobEvent) GoString() string

GoString returns the string representation

func (*PayloadOnlyBlobEvent) MarshalEvent

func (s *PayloadOnlyBlobEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*PayloadOnlyBlobEvent) SetBlobPayload

func (s *PayloadOnlyBlobEvent) SetBlobPayload(v []byte) *PayloadOnlyBlobEvent

SetBlobPayload sets the BlobPayload field's value.

func (PayloadOnlyBlobEvent) String

func (s PayloadOnlyBlobEvent) String() string

String returns the string representation

func (*PayloadOnlyBlobEvent) UnmarshalEvent

func (s *PayloadOnlyBlobEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the PayloadOnlyBlobEvent value. This method is only used internally within the SDK's EventStream handling.

type PayloadOnlyEvent

type PayloadOnlyEvent struct {
	NestedVal *NestedShape `locationName:"NestedVal" type:"structure"`
	// contains filtered or unexported fields
}

func (PayloadOnlyEvent) GoString

func (s PayloadOnlyEvent) GoString() string

GoString returns the string representation

func (*PayloadOnlyEvent) MarshalEvent

func (s *PayloadOnlyEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*PayloadOnlyEvent) SetNestedVal

func (s *PayloadOnlyEvent) SetNestedVal(v *NestedShape) *PayloadOnlyEvent

SetNestedVal sets the NestedVal field's value.

func (PayloadOnlyEvent) String

func (s PayloadOnlyEvent) String() string

String returns the string representation

func (*PayloadOnlyEvent) UnmarshalEvent

func (s *PayloadOnlyEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the PayloadOnlyEvent value. This method is only used internally within the SDK's EventStream handling.

type PayloadOnlyStringEvent

type PayloadOnlyStringEvent struct {
	StringPayload *string `locationName:"StringPayload" type:"string"`
	// contains filtered or unexported fields
}

func (PayloadOnlyStringEvent) GoString

func (s PayloadOnlyStringEvent) GoString() string

GoString returns the string representation

func (*PayloadOnlyStringEvent) MarshalEvent

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*PayloadOnlyStringEvent) SetStringPayload

func (s *PayloadOnlyStringEvent) SetStringPayload(v string) *PayloadOnlyStringEvent

SetStringPayload sets the StringPayload field's value.

func (PayloadOnlyStringEvent) String

func (s PayloadOnlyStringEvent) String() string

String returns the string representation

func (*PayloadOnlyStringEvent) UnmarshalEvent

func (s *PayloadOnlyStringEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the PayloadOnlyStringEvent value. This method is only used internally within the SDK's EventStream handling.

type RESTXMLService

type RESTXMLService struct {
	*client.Client
}

RESTXMLService provides the API operation methods for making requests to REST XML Service. See this package's package overview docs for details on the service.

RESTXMLService methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *RESTXMLService

New creates a new instance of the RESTXMLService client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a RESTXMLService client from just a session.
svc := restxmlservice.New(mySession)

// Create a RESTXMLService client with additional configuration
svc := restxmlservice.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*RESTXMLService) EmptyStream

func (c *RESTXMLService) EmptyStream(input *EmptyStreamInput) (*EmptyStreamOutput, error)

EmptyStream API operation for REST XML Service.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for REST XML Service's API operation EmptyStream for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/RESTXMLService-0000-00-00/EmptyStream

func (*RESTXMLService) EmptyStreamRequest

func (c *RESTXMLService) EmptyStreamRequest(input *EmptyStreamInput) (req *request.Request, output *EmptyStreamOutput)

EmptyStreamRequest generates a "aws/request.Request" representing the client's request for the EmptyStream operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See EmptyStream for more information on using the EmptyStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the EmptyStreamRequest method.
req, resp := client.EmptyStreamRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/RESTXMLService-0000-00-00/EmptyStream

func (*RESTXMLService) EmptyStreamWithContext

func (c *RESTXMLService) EmptyStreamWithContext(ctx aws.Context, input *EmptyStreamInput, opts ...request.Option) (*EmptyStreamOutput, error)

EmptyStreamWithContext is the same as EmptyStream with the addition of the ability to pass a context and additional request options.

See EmptyStream for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RESTXMLService) GetEventStream

func (c *RESTXMLService) GetEventStream(input *GetEventStreamInput) (*GetEventStreamOutput, error)

GetEventStream API operation for REST XML Service.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for REST XML Service's API operation GetEventStream for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/RESTXMLService-0000-00-00/GetEventStream

func (*RESTXMLService) GetEventStreamRequest

func (c *RESTXMLService) GetEventStreamRequest(input *GetEventStreamInput) (req *request.Request, output *GetEventStreamOutput)

GetEventStreamRequest generates a "aws/request.Request" representing the client's request for the GetEventStream operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetEventStream for more information on using the GetEventStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetEventStreamRequest method.
req, resp := client.GetEventStreamRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/RESTXMLService-0000-00-00/GetEventStream

func (*RESTXMLService) GetEventStreamWithContext

func (c *RESTXMLService) GetEventStreamWithContext(ctx aws.Context, input *GetEventStreamInput, opts ...request.Option) (*GetEventStreamOutput, error)

GetEventStreamWithContext is the same as GetEventStream with the addition of the ability to pass a context and additional request options.

See GetEventStream for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*RESTXMLService) OtherOperation

func (c *RESTXMLService) OtherOperation(input *OtherOperationInput) (*OtherOperationOutput, error)

OtherOperation API operation for REST XML Service.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for REST XML Service's API operation OtherOperation for usage and error information.

Returned Error Codes:

* ErrCodeExceptionEvent2 "ExceptionEvent2"

See also, https://docs.aws.amazon.com/goto/WebAPI/RESTXMLService-0000-00-00/OtherOperation

func (*RESTXMLService) OtherOperationRequest

func (c *RESTXMLService) OtherOperationRequest(input *OtherOperationInput) (req *request.Request, output *OtherOperationOutput)

OtherOperationRequest generates a "aws/request.Request" representing the client's request for the OtherOperation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See OtherOperation for more information on using the OtherOperation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the OtherOperationRequest method.
req, resp := client.OtherOperationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/RESTXMLService-0000-00-00/OtherOperation

func (*RESTXMLService) OtherOperationWithContext

func (c *RESTXMLService) OtherOperationWithContext(ctx aws.Context, input *OtherOperationInput, opts ...request.Option) (*OtherOperationOutput, error)

OtherOperationWithContext is the same as OtherOperation with the addition of the ability to pass a context and additional request options.

See OtherOperation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Directories

Path Synopsis
Package restxmlserviceiface provides an interface to enable mocking the REST XML Service service client for testing your code.
Package restxmlserviceiface provides an interface to enable mocking the REST XML Service service client for testing your code.