restxmlservice

package
v1.14.30 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 19, 2018 License: Apache-2.0 Imports: 17 Imported by: 0

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 (
	ServiceName = "RESTXMLService" // Name of service.
	EndpointsID = "restxmlservice" // ID to lookup a service endpoint with.
	ServiceID   = "RESTXMLService" // ServiceID is a unique identifer 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) 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 added in v1.14.20 

type EmptyEventStreamEvent interface {
	// contains filtered or unexported methods
}

EmptyEventStreamEvent groups together all EventStream events read from the EmptyStream API.

These events are:

type EmptyStreamEventStream added in v1.14.20 

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 EmptyStreamEventStreamReader

	// StreamCloser is the io.Closer for the EventStream connection. For HTTP
	// EventStream this is the response Body. The stream will be closed when
	// the Close method of the EventStream is called.
	StreamCloser io.Closer
}

EmptyStreamEventStream provides handling of EventStreams for the EmptyStream API.

Use this type to receive EmptyEventStream events. The events can be read from the Events channel member.

The events that can be received are:

func (*EmptyStreamEventStream) Close added in v1.14.20 

func (es *EmptyStreamEventStream) Close() (err error)

Close closes the EventStream. This will also cause the Events channel to be closed. You can use the closing of the Events channel to terminate your application's read from the API's EventStream.

Will close the underlying EventStream reader. For EventStream over HTTP connection this will also close the HTTP connection.

Close must be called when done using the EventStream API. Not calling Close may result in resource leaks.

func (*EmptyStreamEventStream) Err added in v1.14.20 

func (es *EmptyStreamEventStream) Err() error

Err returns any error that occurred while reading EventStream Events from the service API's response. Returns nil if there were no errors.

func (*EmptyStreamEventStream) Events added in v1.14.20 

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

Events returns a channel to read EventStream Events from the EmptyStream API.

These events are:

type EmptyStreamEventStreamReader added in v1.14.20 

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

	// Close will close the underlying event stream reader. For event stream over
	// HTTP this will also close the HTTP connection.
	Close() error

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

EmptyStreamEventStreamReader provides the interface for reading EventStream Events from the EmptyStream API. The default implementation for this interface will be EmptyStreamEventStream.

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

These events are:

type EmptyStreamInput added in v1.14.20 

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

func (EmptyStreamInput) GoString added in v1.14.20 

func (s EmptyStreamInput) GoString() string

GoString returns the string representation

func (EmptyStreamInput) String added in v1.14.20 

func (s EmptyStreamInput) String() string

String returns the string representation

type EmptyStreamOutput added in v1.14.20 

type EmptyStreamOutput struct {

	// Use EventStream to use the API's stream.
	EventStream *EmptyStreamEventStream `type:"structure"`
	// contains filtered or unexported fields
}

func (EmptyStreamOutput) GoString added in v1.14.20 

func (s EmptyStreamOutput) GoString() string

GoString returns the string representation

func (*EmptyStreamOutput) SetEventStream added in v1.14.20 

func (s *EmptyStreamOutput) SetEventStream(v *EmptyStreamEventStream) *EmptyStreamOutput

SetEventStream sets the EventStream field's value.

func (EmptyStreamOutput) String added in v1.14.20 

func (s EmptyStreamOutput) String() string

String returns the string representation

type EventStreamEvent 

type EventStreamEvent interface {
	// contains filtered or unexported methods
}

EventStreamEvent groups together all EventStream events read from the GetEventStream API.

These events are:

  • EmptyEvent
  • ExplicitPayloadEvent
  • HeaderOnlyEvent
  • ImplicitPayloadEvent
  • PayloadOnlyEvent
  • PayloadOnlyBlobEvent
  • PayloadOnlyStringEvent

type ExceptionEvent 

type ExceptionEvent struct {
	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) 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) 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 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) SetLongVal 

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

SetLongVal sets the LongVal field's value.

func (*ExplicitPayloadEvent) SetNestedVal 

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

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 GetEventStreamEventStreamReader

	// StreamCloser is the io.Closer for the EventStream connection. For HTTP
	// EventStream this is the response Body. The stream will be closed when
	// the Close method of the EventStream is called.
	StreamCloser io.Closer
}

GetEventStreamEventStream provides handling of EventStreams for the GetEventStream API.

Use this type to receive EventStream events. The events can be read from the Events channel member.

The events that can be received are:

  • EmptyEvent
  • ExplicitPayloadEvent
  • HeaderOnlyEvent
  • ImplicitPayloadEvent
  • PayloadOnlyEvent
  • PayloadOnlyBlobEvent
  • PayloadOnlyStringEvent

func (*GetEventStreamEventStream) Close 

func (es *GetEventStreamEventStream) Close() (err error)

Close closes the EventStream. This will also cause the Events channel to be closed. You can use the closing of the Events channel to terminate your application's read from the API's EventStream.

Will close the underlying EventStream reader. For EventStream over HTTP connection this will also close the HTTP connection.

Close must be called when done using the EventStream API. Not calling Close may result in resource leaks.

func (*GetEventStreamEventStream) Err 

func (es *GetEventStreamEventStream) Err() error

Err returns any error that occurred while reading 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 EventStream Events from the GetEventStream API.

These events are:

  • EmptyEvent
  • ExplicitPayloadEvent
  • HeaderOnlyEvent
  • ImplicitPayloadEvent
  • PayloadOnlyEvent
  • PayloadOnlyBlobEvent
  • PayloadOnlyStringEvent

type GetEventStreamEventStreamReader 

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

	// Close will close the underlying event stream reader. For event stream over
	// HTTP this will also close the HTTP connection.
	Close() error

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

GetEventStreamEventStreamReader provides the interface for reading EventStream Events from the GetEventStream API. The default implementation for this interface will be GetEventStreamEventStream.

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

These events are:

  • EmptyEvent
  • ExplicitPayloadEvent
  • HeaderOnlyEvent
  • ImplicitPayloadEvent
  • PayloadOnlyEvent
  • PayloadOnlyBlobEvent
  • PayloadOnlyStringEvent

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 {

	// Use EventStream to use the API's stream.
	EventStream *GetEventStreamEventStream `type:"structure"`

	IntVal *int64 `type:"integer"`

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

func (GetEventStreamOutput) GoString 

func (s GetEventStreamOutput) GoString() string

GoString returns the string representation

func (*GetEventStreamOutput) SetEventStream 

func (s *GetEventStreamOutput) SetEventStream(v *GetEventStreamEventStream) *GetEventStreamOutput

SetEventStream sets the EventStream field's value.

func (*GetEventStreamOutput) SetIntVal 

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

SetIntVal sets the IntVal field's value.

func (*GetEventStreamOutput) SetStrVal 

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

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" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

func (HeaderOnlyEvent) GoString 

func (s HeaderOnlyEvent) GoString() string

GoString returns the string representation

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) SetByteVal 

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

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 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) 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) 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 added in v1.14.20 

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

func (PayloadOnlyStringEvent) GoString added in v1.14.20 

func (s PayloadOnlyStringEvent) GoString() string

GoString returns the string representation

func (*PayloadOnlyStringEvent) SetStringPayload added in v1.14.20 

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

SetStringPayload sets the StringPayload field's value.

func (PayloadOnlyStringEvent) String added in v1.14.20 

func (s PayloadOnlyStringEvent) String() string

String returns the string representation

func (*PayloadOnlyStringEvent) UnmarshalEvent added in v1.14.20 

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: 

// 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 added in v1.14.20 

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 added in v1.14.20 

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 successfuly.

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 added in v1.14.20 

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 successfuly.

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.

Source Files

View all Source files

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.